FBVisualContainer Class Reference


Detailed Description

Used to create a container for a tool UI.

Examples
UI/Container.py, UI/PropertyDrop.py, UI/TutorialBox.py
Inheritance diagram for FBVisualContainer:

List of all members.

Public Member Functions

 __init__ ()
 Constructor.
bool ItemIconSet (uintptr_t pRef, FBImage pImage, bool pUseACopyOfTheImage=True)
 Set an item's icon.
bool ItemIconSet (uintptr_t pRef, FBImageContainer pImage, bool pUseACopyOfTheImage=True)
bool ItemIconSet (uintptr_t pRef, str pFilename)
 Set an item's icon.
bool ItemNameEdit (uintptr_t pRef)
 Edit a container item.
int GetSelection ()
 Get the selected item.

Public Attributes

FBPropertyStringList Items
 List: Names of items in container.
FBPropertyBase ItemIndex
 Read Write Property: Current item selected.
FBPropertyOrientation Orientation
 Read Write Property: Orientation of container.
FBPropertyBase 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.
FBPropertyBase ItemWidth
 Read Write Property: Item width.
FBPropertyBase ItemHeight
 Read Write Property: Item height.
FBPropertyEvent OnChange
 Event: Container contents changed.
FBPropertyEvent OnDblClick
 Event: Double click.
FBPropertyEvent OnDragAndDrop
 Event: Drag and Drop event.

Member Function Documentation

bool ItemIconSet ( uintptr_t  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).
bool ItemIconSet ( uintptr_t  pRef,
FBImageContainer  pImage,
bool  pUseACopyOfTheImage = True 
)
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).
bool ItemIconSet ( uintptr_t  pRef,
str  pFilename 
)

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).
bool ItemNameEdit ( uintptr_t  pRef)

Edit a container item.

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

Get the selected item.

Returns:
Index of current selection.

Member Data Documentation

List: Names of items in container.

FBPropertyBase ItemIndex

Read Write Property: Current item selected.

FBPropertyOrientation Orientation

Read Write Property: Orientation of container.

FBPropertyBase 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.

FBPropertyBase ItemWidth

Read Write Property: Item width.

FBPropertyBase ItemHeight

Read Write Property: Item height.

FBPropertyEvent OnChange

Event: Container contents changed.

FBPropertyEvent OnDblClick

Event: Double click.

FBPropertyEvent OnDragAndDrop

Event: Drag and Drop event.


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