Public Member Functions | Public Attributes

FBButton Class Reference

Search for all occurrences

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.

Definition at line 1060 of file fbcontrols.h.

#include <fbcontrols.h>

Inheritance diagram for FBButton:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBButton ()
 Constructor.
FBColor GetStateColor (FBButtonState pState)
 Queries the color associated with a button state.
void SetStateColor (FBButtonState pState, const FBColor &pColor)
 Returns whether or not the item pIndex is currently selected.
void SetImageFileNames (const char *pUpImage, const char *pDownImage=0, const char *pThirdImage=0, bool pFromResources=false)
 Sets the image used to generate a kFBBitmap2States.
void HookToButton (FBButton *pButton)
 Sets a link to another button.

Public Attributes

FBPropertyInt State
 Read Write Property: Current state of button.
FBPropertyButtonStyle Style
 Read Write Property: Button style.
FBPropertyTextJustify Justify
 Read Write Property: Current state of button.
FBPropertyButtonLook Look
 Read Write Property: Current state of button.
FBPropertyEvent OnClick
 Event: Button clicked.
FBPropertyEvent OnDragAndDrop
 Event: Something was dragged.

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:
pStateThe state to be queried.
Returns:
The color vector.
void SetStateColor ( FBButtonState  pState,
const FBColor pColor 
)

Returns whether or not the item pIndex is currently selected.

Parameters:
pStateThe state to be set.
pColorThe desired color vector.
void SetImageFileNames ( const char *  pUpImage,
const char *  pDownImage = 0,
const char *  pThirdImage = 0,
bool  pFromResources = false 
)

Sets the image used to generate a kFBBitmap2States.

Parameters:
pUpImageThe image used when button is unpushed
pDownImageThe image used when button is pushed
pThirdImage
pFromResourcesAdd resource path to image path.
void HookToButton ( FBButton pButton)

Sets a link to another button.

Parameters:
pButtonTarget button

Member Data Documentation

Read Write Property: Current state of button.

Definition at line 1092 of file fbcontrols.h.

FBPropertyButtonStyle Style

Read Write Property: Button style.

Definition at line 1093 of file fbcontrols.h.

FBPropertyTextJustify Justify

Read Write Property: Current state of button.

Definition at line 1094 of file fbcontrols.h.

FBPropertyButtonLook Look

Read Write Property: Current state of button.

Definition at line 1095 of file fbcontrols.h.

Event: Button clicked.

Definition at line 1097 of file fbcontrols.h.

Event: Something was dragged.

Definition at line 1098 of file fbcontrols.h.


The documentation for this class was generated from the following file:

FBButton FBButton FBButton FBButton FBButton FBButton FBButton FBButton FBButton FBButton
FBButton FBButton FBButton FBButton FBButton FBButton FBButton FBButton FBButton FBButton