Python Reference Guide
FBView Class Reference

Generic view. More...

Inheritance diagram for FBView:

Public Member Functions

 FBView ()
 Constructor. More...
 
 DrawString (str pText, float pX, float pY, int pEnable=-1)
 Draw a string in the view. More...
 
bool IsView ()
 Checks if object is a view. More...
 
 Refresh (bool pNow=False)
 Refresh view. More...
 
bool SetViewport (int pX, int pY, int pW, int pH)
 Set view's viewport. More...
 
- Public Member Functions inherited from FBVisualComponent
 FBVisualComponent ()
 Constructor. More...
 
bool AddChild (FBVisualComponent pChild, int pId=0)
 Add a child component. More...
 
FBVisualComponent GetChild (int pId=0)
 Get a child component. More...
 
QWidget GetQWidgetAddress ()
 Get internal QWidget. More...
 
bool IsView ()
 Is component a view? More...
 
 Refresh (bool pNow=False)
 Refresh component. More...
 
 ViewExpose ()
 Exposed view callback function. More...
 
 ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
 Input callback function. More...
 

Public Attributes

bool DoubleBuffer
 Read Only Property: Indicates if the view is double buffered.
More...
 
bool GraphicOGL
 Read Only Property: Indicates if the view is OpenGL.
More...
 
- Public Attributes inherited from FBVisualComponent
str RegionName
 Read Write Property: Region name. More...
 
int RegionOffsetX
 Read Write Property: Region X offset. More...
 
int RegionOffsetY
 Read Write Property: Region Y offset. More...
 
int RegionOffsetWidth
 Read Write Property: Region width offset. More...
 
int RegionOffsetHeight
 Read Write Property: Region height offset. More...
 
float RegionRatioX
 Read Write Property: Ratio for X attachment. More...
 
float RegionRatioY
 Read Write Property: Ratio for Y attachment. More...
 
float RegionRatioWidth
 Read Write Property: Ratio for Width attachment. More...
 
float RegionRatioHeight
 Read Write Property: Ratio for Height attachment.
More...
 
FBAttachType RegionAttachTypeX
 Read Write Property: X Attachment type. More...
 
FBAttachType RegionAttachTypeY
 Read Write Property: Y Attachment type. More...
 
FBAttachType RegionAttachTypeWidth
 Read Write Property: Width Attachment type. More...
 
FBAttachType RegionAttachTypeHeight
 Read Write Property: Height Attachment type. More...
 
FBVisualComponent RegionAttachToX
 Read Write Property X Attachment source. More...
 
FBVisualComponent RegionAttachToY
 Read Write Property: Y Attachment source. More...
 
FBVisualComponent RegionAttachToWidth
 Read Write Property: Width Attachment source. More...
 
FBVisualComponent RegionAttachToHeight
 Read Write Property: Height Attachment source.
More...
 
int RegionPosMaxX
 Read Write Property: Region X position Max More...
 
int RegionPosMinX
 Read Write Property: Region X position Min More...
 
int RegionPosMaxY
 Read Write Property: Region Y position Max More...
 
int RegionPosMinY
 Read Write Property: Region Y position Min More...
 
str BorderCaption
 Read Write Property: Caption to display in border. More...
 
bool BorderShowCaption
 Read Write Property: Show caption? More...
 
FBBorderStyle BorderStyle
 Read Write Property: Style of border. More...
 
bool BorderInSet
 Read Write Property: Is border inset? More...
 
int BorderWidth
 Read Write Property: Width of border. More...
 
int BorderSpacing
 Read Write Property: Spacing of border. More...
 
float BorderMaxAngle
 Read Write Property: Max angle for rounding. More...
 
int BorderCornerRadius
 Read Write Property: Corner radius (rounded).
More...
 
str Caption
 Property: Widget caption.
More...
 
bool Enabled
 Read Write Property: Is visual enabled?
More...
 
int Height
 Read Write Property: Height.
More...
 
str Hint
 Read Write Property: Hint to show.
More...
 
int Left
 Read Write Property: Left coordinate.
More...
 
bool ReadOnly
 Read Write Property: Is visual component read only?
More...
 
int Top
 Read Write Property: Top coordinate.
More...
 
bool Visible
 Read Write Property: Is visual component visible?
More...
 
int Width
 Read Write Property: Width.
More...
 

Detailed Description

Generic view.


Constructor & Destructor Documentation

◆ FBView()

FBView ( )

Constructor.

Member Function Documentation

◆ DrawString()

DrawString ( str  pText,
float  pX,
float  pY,
int  pEnable = -1 
)

Draw a string in the view.

Parameters
pTextText to draw.
pXX position of string.
pYY position of string.
pEnableIs string enabled? (default =-1)

◆ IsView()

bool IsView ( )

Checks if object is a view.

Returns
Is object a view? (true or false)

◆ Refresh()

Refresh ( bool  pNow = False)

Refresh view.

Parameters
pNowIf true, refresh immediately (default = false).

◆ SetViewport()

bool SetViewport ( int  pX,
int  pY,
int  pW,
int  pH 
)

Set view's viewport.

Parameters
pXViewport X value.
pYViewport Y value.
pWViewport W (width) value.
pHViewport H (height) value.
Returns
Operation was successful (true or false).

Member Data Documentation

◆ DoubleBuffer

bool DoubleBuffer

Read Only Property: Indicates if the view is double buffered.

◆ GraphicOGL

bool GraphicOGL

Read Only Property: Indicates if the view is OpenGL.