FBButton Class Reference

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

#include <pyfbsdk_generated.h>

Inheritance diagram for FBButton:

Public Member Functions
	FBButton ()
	Constructor.
FBColor	GetStateColor (FBButtonState pState)
	Queries the color associated with a button state.
	SetImageFileNames (str pUpImage, str pDownImage=0, str pThirdImage=0, bool pFromResources=False)
	Sets the image used to generate a kFBBitmap2States.
	SetStateColor (FBButtonState pState, FBColor pColor)
	Returns whether or not the item pIndex is currently selected.
Public Member Functions inherited from FBVisualComponent
	FBVisualComponent ()
	Constructor.
bool	AddChild (FBVisualComponent pChild, int pId=0)
	Add a child component.
FBVisualComponent	GetChild (int pId=0)
	Get a child component.
QWidget	GetQWidgetAddress ()
	Get internal QWidget.
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 Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
FBTextJustify	Justify
	Read Write Property: Current state of button.
FBButtonLook	Look
	Read Write Property: Current state of button.
FBEvent	OnClick
	Event: Button clicked.
int	State
	Read Write Property: Current state of button.
FBButtonStyle	Style
	Read Write Property: Button style.
Public Attributes inherited from FBVisualComponent
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.
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

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.