FBButton Class Reference

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

List of all members.


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.


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)
  Sets the image used to generate a kFBBitmap2States.
  SetStateColor (FBButtonState pState, FBColor pColor)
  Returns whether or not the item pIndex is currently selected.

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.

Constructor & Destructor Documentation

FBButton (  ) 

Constructor.


Member Function Documentation

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 ( str  pUpImage,
str  pDownImage = 0,
str  pThirdImage = 0  
)

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

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

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.


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