FBContainer Class Reference

FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer FBContainer

Inheritance diagram for FBContainer:

[legend]

List of all members.

---

Detailed Description

Container.

See samples: Container.py, PropertyDrop.py, TutorialBox.py.

Public Member Functions
	FBContainer ()
	Constructor.
int	GetSelection ()
	Get the selected item.
bool	ItemIconSet (kReference pRef, FBImageContainer pImage, bool pUseACopyOfTheImage=True)
	Set an item's icon.
bool	ItemIconSet (kReference pRef, str pFilename)
	Set an item's icon.
bool	ItemNameEdit (kReference pRef)
	Edit a container item.
Public Attributes
FBIconPosition	IconPosition
	Read Write Property: Where the icon is positioned for the items.
int	ItemHeight
	Read Write Property: Item height.
int	ItemIndex
	Read Write Property: Current item selected.
int	ItemWidth
	Read Write Property: Item width.
bool	ItemWrap
	Read Write Property: Are items wrapped when enough space is available?
FBStringList	Items
	List: Names of items in container.
FBEvent	OnChange
	Event: Container contents changed.
FBEvent	OnDblClick
	Event: Double click.
FBEvent	OnDragAndDrop
	Event: Drag and Drop event.
FBOrientation	Orientation
	Read Write Property: Orientation of container.

---

Constructor & Destructor Documentation

FBContainer

(

)

Constructor.

---

Member Function Documentation

int GetSelection

(

)

Get the selected item.

Returns:

Index of current selection.

bool ItemIconSet	(	kReference	pRef,
		FBImageContainer	pImage,
		bool	pUseACopyOfTheImage = True
	)

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	(	kReference	pRef,
		str	pFilename
	)

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

(

kReference

pRef

)

Edit a container item.

Parameters:

pRef

Reference of container to edit.

Returns:

Operation was successful (true or false).

---

Member Data Documentation

FBIconPosition IconPosition

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

int ItemHeight

Read Write Property: Item height.

int ItemIndex

Read Write Property: Current item selected.

int ItemWidth

Read Write Property: Item width.

bool ItemWrap

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

FBStringList Items

List: Names of items in container.

FBEvent OnChange

Event: Container contents changed.

FBEvent OnDblClick

Event: Double click.

FBEvent OnDragAndDrop

Event: Drag and Drop event.

FBOrientation Orientation

Read Write Property: Orientation of container.

---