Public Member Functions | Public Attributes

FBVisualContainer Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014, MotionBuilder 2013.


Search for all occurrences

Detailed Description

Used to create a container for a tool UI.

Definition at line 1662 of file fbcontrols.h.

#include <fbcontrols.h>

Inheritance diagram for FBVisualContainer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBVisualContainer ()
 Constructor.
bool ItemIconSet (kReference pRef, FBImage *pImage, bool pUseACopyOfTheImage=true)
 Set an item's icon.
virtual K_DEPRECATED_2014 bool ItemIconSet (kReference pRef, FBImageContainer *pImage, bool pUseACopyOfTheImage=true)
virtual bool ItemIconSet (kReference pRef, const char *pFilename)
 Set an item's icon.
virtual bool ItemNameEdit (kReference pRef)
 Edit a container item.
virtual int GetSelection ()
 Get the selected item.

Public Attributes

FBPropertyStringList Items
 List: Names of items in container.
FBPropertyInt ItemIndex
 Read Write Property: Current item selected.
FBPropertyOrientation Orientation
 Read Write Property: Orientation of container.
FBPropertyBool ItemWrap
 Read Write Property: Are items wrapped when enough space is available?
FBPropertyIconPosition IconPosition
 Read Write Property: Where the icon is positioned for the items.
FBPropertyInt ItemWidth
 Read Write Property: Item width.
FBPropertyInt ItemHeight
 Read Write Property: Item height.
FBPropertyEvent OnChange
 Event: Container contents changed.
FBPropertyEvent OnDblClick
 Event: Double click.
FBPropertyEvent OnDragAndDrop
 Event: Drag and Drop event.

Constructor & Destructor Documentation

Constructor.


Member Function Documentation

bool ItemIconSet ( kReference  pRef,
FBImage pImage,
bool  pUseACopyOfTheImage = true 
)

Set an item's icon.

Parameters:
pRefReference to item in container.
pImageHandle to image to use.
pUseACopyOfTheImageCreate a copy of the image?(default=true)
Returns:
Operation was successful (true or false).
virtual K_DEPRECATED_2014 bool ItemIconSet ( kReference  pRef,
FBImageContainer pImage,
bool  pUseACopyOfTheImage = true 
) [virtual]
Deprecated:
Set an item's icon.

Useless function to be removed.

Parameters:
pRefReference to item in container.
pFilenameName of file where image is located.
pUseACopyOfTheImageCreate a copy of the image?(default=true)
Returns:
Operation was successful (true or false).
virtual bool ItemIconSet ( kReference  pRef,
const char *  pFilename 
) [virtual]

Set an item's icon.

Parameters:
pRefReference to item in container.
pFilenameName of file where image is located.
Returns:
Operation was successful (true or false).
virtual bool ItemNameEdit ( kReference  pRef) [virtual]

Edit a container item.

Parameters:
pRefReference of container to edit.
Returns:
Operation was successful (true or false).
virtual int GetSelection ( ) [virtual]

Get the selected item.

Returns:
Index of current selection.

Member Data Documentation

List: Names of items in container.

Definition at line 1703 of file fbcontrols.h.

Read Write Property: Current item selected.

Definition at line 1705 of file fbcontrols.h.

FBPropertyOrientation Orientation

Read Write Property: Orientation of container.

Definition at line 1706 of file fbcontrols.h.

Read Write Property: Are items wrapped when enough space is available?

Definition at line 1707 of file fbcontrols.h.

FBPropertyIconPosition IconPosition

Read Write Property: Where the icon is positioned for the items.

Definition at line 1708 of file fbcontrols.h.

Read Write Property: Item width.

Definition at line 1709 of file fbcontrols.h.

Read Write Property: Item height.

Definition at line 1710 of file fbcontrols.h.

Event: Container contents changed.

Definition at line 1712 of file fbcontrols.h.

Event: Double click.

Definition at line 1713 of file fbcontrols.h.

Event: Drag and Drop event.

Definition at line 1714 of file fbcontrols.h.


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

FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer
FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer FBVisualContainer