FBVisualComponent Class Reference

FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent FBVisualComponent
Inheritance diagram for FBVisualComponent:
Inheritance graph
[legend]

List of all members.


Detailed Description

Visual Component base class.

All of the user interface elements available in the SDK derive from this class.


Public Member Functions

  FBVisualComponent ()
  Constructor.
bool  AddChild (FBVisualComponent pChild, int pId=0)
  Add a child component.
FBVisualComponent  GetChild (int pId=0)
  Get a child component.
bool  IsView ()
  Is component a view?
  Refresh (bool pNow=False)
  Refresh component.
  ViewExpose ()
  Exposed view callback function.
  ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
  Input callback function.

Public Attributes

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

Constructor & Destructor Documentation

FBVisualComponent (  ) 

Constructor.


Member Function Documentation

bool AddChild ( FBVisualComponent  pChild,
int  pId = 0  
)

Add a child component.

Parameters:
pChild  Visual component to add as a child.
pId  User reference number to associate with pChild(default=0).
Returns:
Operation was successful (true or false).

FBVisualComponent GetChild ( int  pId = 0  ) 

Get a child component.

Parameters:
pId  User reference number to look for child with(default=0).
Returns:
Handle to child (NULL if not found).

bool IsView (  ) 

Is component a view?

Returns:
true if component is a view.

Reimplemented in FBView.

Refresh ( bool  pNow = False  ) 

Refresh component.

Parameters:
pNow  Refresh immediately if true (default = false).

Reimplemented in FBView.

ViewExpose (  ) 

Exposed view callback function.

ViewInput ( int  pMouseX,
int  pMouseY,
FBInputType  pAction,
int  pButtonKey,
int  pModifier  
)

Input callback function.

Parameters:
pMouseX  Mouse X position.
pMouseY  Mouse Y position.
pAction  Mouse action.
pButtonKey  Keyboard input.
pModifier  Keyboard intput modifier.

Member Data Documentation

str RegionName

Read Write Property: Region name.

int RegionOffsetX

Read Write Property: Region X offset.

int RegionOffsetY

Read Write Property: Region Y offset.

int RegionOffsetWidth

Read Write Property: Region width offset.

int RegionOffsetHeight

Read Write Property: Region height offset.

float RegionRatioX

Read Write Property: Ratio for X attachment.

float RegionRatioY

Read Write Property: Ratio for Y attachment.

float RegionRatioWidth

Read Write Property: Ratio for Width attachment.

float RegionRatioHeight

Read Write Property: Ratio for Height attachment.

FBAttachType RegionAttachTypeX

Read Write Property: X Attachment type.

FBAttachType RegionAttachTypeY

Read Write Property: Y Attachment type.

FBAttachType RegionAttachTypeWidth

Read Write Property: Width Attachment type.

FBAttachType RegionAttachTypeHeight

Read Write Property: Height Attachment type.

FBVisualComponent RegionAttachToX

Read Write Property X Attachment source.

FBVisualComponent RegionAttachToY

Read Write Property: Y Attachment source.

FBVisualComponent RegionAttachToWidth

Read Write Property: Width Attachment source.

FBVisualComponent RegionAttachToHeight

Read Write Property: Height Attachment source.

int RegionPosMaxX

Read Write Property: Region X position Max

int RegionPosMinX

Read Write Property: Region X position Min

int RegionPosMaxY

Read Write Property: Region Y position Max

int RegionPosMinY

Read Write Property: Region Y position Min

str BorderCaption

Read Write Property: Caption to display in border.

bool BorderShowCaption

Read Write Property: Show caption?

FBBorderStyle BorderStyle

Read Write Property: Style of border.

bool BorderInSet

Read Write Property: Is border inset?

int BorderWidth

Read Write Property: Width of border.

int BorderSpacing

Read Write Property: Spacing of border.

float BorderMaxAngle

Read Write Property: Max angle for rounding.

int BorderCornerRadius

Read Write Property: Corner radius (rounded).

str Caption

Property: Widget caption.

Reimplemented in FBFilePopup, FBFolderPopup, FBPopup, FBProgress, and FBSpread.

bool Enabled

Read Write Property: Is visual enabled?

int Height

Read Write Property: Height.

Reimplemented in FBImageContainer.

str Hint

Read Write Property: Hint to show.

int Left

Read Write Property: Left coordinate.

bool ReadOnly

Read Write Property: Is visual component read only?

int Top

Read Write Property: Top coordinate.

bool Visible

Read Write Property: Is visual component visible?

int Width

Read Write Property: Width.

Reimplemented in FBImageContainer.


Generated on Tue Feb 9 19:34:02 2010 for Python Reference Guide by  doxygen 1.5.3