FBContainer Class Reference

Search for all occurrences

---

Detailed Description

Used to create a container for a tool UI.

Examples

UI/Container.py, UI/PropertyDrop.py, UI/TutorialBox.py

Inheritance diagram for FBContainer:

List of all members.

Public Member Functions
	__init__ ()
	Constructor.
bool	ItemIconSet (int pRef, HFBImageContainer pImage, bool pUseACopyOfTheImage=True)
	Set an item's icon.
bool	ItemIconSet (int pRef, str pFilename)
	Set an item's icon.
bool	ItemNameEdit (int 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

__init__

(

)

Search for all occurrences

Constructor.

Examples

UI/Container.py, UI/PropertyDrop.py, UI/TutorialBox.py

bool ItemIconSet	(	int	pRef,
		HFBImageContainer	pImage,
		bool	pUseACopyOfTheImage = True
	)

Search for all occurrences

Set an item's icon.

Parameters:

pRef	Reference to item in container.
pImage	Handle to image to use.
pUseACopyOfTheImage	Create a copy of the image?(default=true)

Returns:

Operation was successful (true or false).

bool ItemIconSet	(	int	pRef,
		str	pFilename
	)

Search for all occurrences

Set an item's icon.

Parameters:

pRef	Reference to item in container.
pFilename	Name of file where image is located.

Returns:

Operation was successful (true or false).

bool ItemNameEdit

(

int

pRef

)

Search for all occurrences

Edit a container item.

Parameters:

pRef	Reference of container to edit.

Returns:

Operation was successful (true or false).

int GetSelection

(

)

Search for all occurrences

Get the selected item.

Returns:

Index of current selection.

---

Member Data Documentation

FBPropertyStringList Items

Search for all occurrences

List: Names of items in container.

FBPropertyBase ItemIndex

Search for all occurrences

Read Write Property: Current item selected.

FBPropertyOrientation Orientation

Search for all occurrences

Read Write Property: Orientation of container.

FBPropertyBase ItemWrap

Search for all occurrences

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

FBPropertyIconPosition IconPosition

Search for all occurrences

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

FBPropertyBase ItemWidth

Search for all occurrences

Read Write Property: Item width.

FBPropertyBase ItemHeight

Search for all occurrences

Read Write Property: Item height.

FBPropertyEvent OnChange

Search for all occurrences

Event: Container contents changed.

FBPropertyEvent OnDblClick

Search for all occurrences

Event: Double click.

FBPropertyEvent OnDragAndDrop

Search for all occurrences

Event: Drag and Drop event.