List of items. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBList:

[legend]

Public Member Functions
	FBList ()
	Constructor.

bool	IsSelected (int pIndex)
	Returns whether or not the item pIndex is currently selected.

	Selected (int pIndex, bool pSelected)
	Set the current selected state of item at pIndex to pSelected.

Public Member Functions inherited from FBVisualComponent
	FBVisualComponent ()
	Constructor.

bool	AddChild (FBVisualComponent pChild, int pId=0)
	Add a child component.

FBVisualComponent	GetChild (int pId=0)
	Get a child component.

QWidget	GetQWidgetAddress ()
	Get internal QWidget.

bool	IsView ()
	Is component a view?

	Refresh (bool pNow=False)
	Refresh component.

	ViewExpose ()
	Exposed view callback function.

	ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
	Input callback function.

Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.

str	ClassName ()
	Get the class name.

	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

bool	FBCreate ()
	Open Reality Creation function.

	FBDelete ()
	Open Reality deletion function.

	FBDestroy ()
	Open Reality destruction function.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.

	HardSelect ()
	HardSelect.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

bool	Is (int pTypeId)
	Returns true if object is of type TypeId.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.

int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.

FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.

	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.

	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
bool	ExtendedSelect
	Read Write Property: Extended selection state?

int	ItemIndex
	Read Write Property: Current item index.

FBStringList	Items
	List: Names of items in list.

bool	MultiSelect
	Read Write Property: Can multiple items be selected?

FBEvent	OnChange
	Event: List changed.

FBEvent	OnDragAndDrop
	Event: Drag and drop event.

FBListStyle	Style
	Read Write Property: Style or direction of list.

Public Attributes inherited from FBVisualComponent
str	Caption
	Property: Widget caption.

bool	Enabled
	Read Write Property: Is visual enabled?

int	Height
	Read Write Property: Height.

str	Hint
	Read Write Property: Hint to show.

int	Left
	Read Write Property: Left coordinate.

bool	ReadOnly
	Read Write Property: Is visual component read only?

int	Top
	Read Write Property: Top coordinate.

bool	Visible
	Read Write Property: Is visual component visible?

int	Width
	Read Write Property: Width.

Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.

str	LongName
	Read Write Property: Name and namespace for object.

str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.

FBListComponent	Parents
	List: Parents.

FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

bool	Selected
	Read Write Property: Selected property.

int	TypeInfo
	Contains the Type information of the object.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

Detailed Description

List of items.

See samples: List.py, ToolCommunicationReceiver.py.

Constructor & Destructor Documentation

◆ FBList()

FBList ( )

Constructor.

Member Function Documentation

◆ IsSelected()

bool IsSelected ( int pIndex )

Returns whether or not the item pIndex is currently selected.

Parameters

pIndex Index to see if select or not.

Returns: true if item at pIndex is selected.

◆ Selected()

Selected	(	int	pIndex,
		bool	pSelected
	)

Set the current selected state of item at pIndex to pSelected.

Parameters

pIndex	Index to affect item at.
pSelected	State to set item at pIndex to.

Member Data Documentation

◆ ExtendedSelect

bool ExtendedSelect

Read Write Property: Extended selection state?

◆ ItemIndex

int ItemIndex

Read Write Property: Current item index.

◆ Items

FBStringList Items

List: Names of items in list.

◆ MultiSelect

bool MultiSelect

Read Write Property: Can multiple items be selected?

◆ OnChange

FBEvent OnChange

Event: List changed.

◆ OnDragAndDrop

FBEvent OnDragAndDrop

Event: Drag and drop event.

◆ Style

FBListStyle Style

Read Write Property: Style or direction of list.

Public Member Functions

Public Attributes