FBButton Class Reference

Used to create and manage buttons in a user interface. More...

Inheritance diagram for FBButton:

Public Member Functions
	FBButton ()
	Constructor. More...
FBColor	GetStateColor (FBButtonState pState)
	Queries the color associated with a button state. More...
	SetImageFileNames (str pUpImage, str pDownImage=0, str pThirdImage=0, bool pFromResources=False)
	Sets the image used to generate a kFBBitmap2States. More...
	SetStateColor (FBButtonState pState, FBColor pColor)
	Returns whether or not the item pIndex is currently selected. 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
FBTextJustify	Justify
	Read Write Property: Current state of button. More...
FBButtonLook	Look
	Read Write Property: Current state of button. More...
FBEvent	OnClick
	Event: Button clicked. More...
int	State
	Read Write Property: Current state of button. More...
FBButtonStyle	Style
	Read Write Property: Button style. 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

Used to create and manage buttons in a user interface.

This class includes functionality to create buttons in a user interface and add a callback. In MotionBuilder, buttons are created within regions, which are in turn created in layouts with FBLayout. For usage, see the Python sample Button.py. See also: FBButtonStyle, FBTextJustify, FBButtonLook.

See samples: Button.py, Popup.py, RadioButton.py.

Constructor & Destructor Documentation

FBButton()

FBButton

(

)

Constructor.

Member Function Documentation

GetStateColor()

FBColor GetStateColor

(

FBButtonState

pState

)

Queries the color associated with a button state.

This method is only useful for buttons of style kFB2States.

Parameters

pState

The state to be queried.

Returns

The color vector.

SetImageFileNames()

SetImageFileNames	(	str	pUpImage,
		str	pDownImage = 0,
		str	pThirdImage = 0,
		bool	pFromResources = False
	)

Sets the image used to generate a kFBBitmap2States.

Parameters

pUpImage	The image used when button is unpushed
pDownImage	The image used when button is pushed
pFromResources	Add resource path to image path.

SetStateColor()

SetStateColor	(	FBButtonState	pState,
		FBColor	pColor
	)

Returns whether or not the item pIndex is currently selected.

Parameters

pState	The state to be set.
pColor	The desired color vector.

Member Data Documentation

Justify

FBTextJustify Justify

Read Write Property: Current state of button.

Look

FBButtonLook Look

Read Write Property: Current state of button.

OnClick

FBEvent OnClick

Event: Button clicked.

State

int State

Read Write Property: Current state of button.

Style

FBButtonStyle Style

Read Write Property: Button style.