Tree list view. More...

#include <pyfbsdk.h>

Inheritance diagram for FBTree:

[legend]

Public Member Functions
	FBTree ()
	Constructor.

	Clear ()
	Clear the tree (remove all nodes).

FBTreeNode	GetRoot ()
	Get the root node.

FBTreeNode	InsertLast (FBTreeNode pNode, str pName)
	Insert node at the end.

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	AllowCollapse
	Read Write Property: When OnCollapsing occurs, set this to true to allow collapse.

bool	AllowExpansion
	Read Write Property: When OnExpanding occurs, set this to true to allow expansion.

bool	AutoExpandOnDblClick
	Read Write Property: Allow automatic expand on double click, default is false.

bool	AutoExpandOnDragOver
	Read Write Property: Allow automatic expand on drag over, default is false.

bool	AutoScroll
	Read Write Property: If AutoScroll property is True then the tree window will be automatically scrolled when the user drags item(s) over the boundaries of the tree.

bool	AutoScrollOnExpand
	Read Write Property: Allow automatic scroll on expand, default is true.

bool	CheckBoxes
	Read Write Property: Draw check boxe for each node.

bool	DeselectOnCollapse
	Read Write Property: Tells whether node are deselected if parent node is collapsed.

bool	EditNodeOn2Select
	Read Write Property: Set to true, to allow automatic node editing on second select.

bool	HighlightOnRightClick
	Read Write Property: Hightlight node on right click.

int	Indent
	Read Write Property: Use Indent to determine how far child nodes are indented from their parent nodes when the parent is expanded.

int	ItemHeight
	Read Write Property: Height of an item.

bool	MultiDrag
	Read Write Property: Tells whether multiple drag/drop is allowed or not.

bool	MultiSelect
	Read Write Property: Tells whether multiple selection is allowed or not.

bool	NoSelectOnDrag
	Read Write Property: Tells whether node are selected if drag is start and node is not already selected.

bool	NoSelectOnRightClick
	Read Write Property: Tells whether node are selected if right click on node.

FBEvent	OnChange
	Event: Change of the selection.

FBEvent	OnClick
	Event: Click on a node of the tree. Use OnSelect.

FBEvent	OnClickCheck
	Event: Click on a node checkbox of the tree.

FBEvent	OnCollapsed
	Event: Click on the "-" sign before a non-leaf node.

FBEvent	OnCollapsing
	Event: Fired before the node collapse. To refuse collapsing, set AllowCollapse to false.

FBEvent	OnDblClick
	Event: Double-Click on a node of the tree. Use FBEventTreeSelect to cast event.

FBEvent	OnDragAndDrop
	Event: Drag and drop of an element.

FBEvent	OnExpanded
	Event: Click on the "+" sign before a non-leaf node

FBEvent	OnExpanding
	Event: Is fired before the node expand. To refuse expanding set AllowExpansion to false.

FBEvent	OnSelect
	Event: A node was selected. Use FBEventTreeSelect to cast event.

int	SelectedCount
	Read Only Property: Count of selected items.

FBListTreeNode	SelectedNodes
	Read Only Property: List of selected nodes.

bool	SelectionActive
	Read Write Property: Tells whether selection is allowed or not.

bool	ShowLines
	Read Write Property: On node selection, will draw entire line selected

int	TreeHeight
	Read Only Property: Height of the tree.

int	TreeWidth
	Read Only Property: Width of the tree.

int	VisibleItemCount
	Read Only Property: Count of visible items.

Public Attributes inherited from FBVisualComponent
str	RegionName
	Read Write Property: Region name.

int	RegionOffsetX
	Read Write Property: Region X offset.

int	RegionOffsetY
	Read Write Property: Region Y offset.

int	RegionOffsetWidth
	Read Write Property: Region width offset.

int	RegionOffsetHeight
	Read Write Property: Region height offset.

float	RegionRatioX
	Read Write Property: Ratio for X attachment.

float	RegionRatioY
	Read Write Property: Ratio for Y attachment.

float	RegionRatioWidth
	Read Write Property: Ratio for Width attachment.

float	RegionRatioHeight
	Read Write Property: Ratio for Height attachment.

FBAttachType	RegionAttachTypeX
	Read Write Property: X Attachment type.

FBAttachType	RegionAttachTypeY
	Read Write Property: Y Attachment type.

FBAttachType	RegionAttachTypeWidth
	Read Write Property: Width Attachment type.

FBAttachType	RegionAttachTypeHeight
	Read Write Property: Height Attachment type.

FBVisualComponent	RegionAttachToX
	Read Write Property X Attachment source.

FBVisualComponent	RegionAttachToY
	Read Write Property: Y Attachment source.

FBVisualComponent	RegionAttachToWidth
	Read Write Property: Width Attachment source.

FBVisualComponent	RegionAttachToHeight
	Read Write Property: Height Attachment source.

int	RegionPosMaxX
	Read Write Property: Region X position Max

int	RegionPosMinX
	Read Write Property: Region X position Min

int	RegionPosMaxY
	Read Write Property: Region Y position Max

int	RegionPosMinY
	Read Write Property: Region Y position Min

str	BorderCaption
	Read Write Property: Caption to display in border.

bool	BorderShowCaption
	Read Write Property: Show caption?

FBBorderStyle	BorderStyle
	Read Write Property: Style of border.

bool	BorderInSet
	Read Write Property: Is border inset?

int	BorderWidth
	Read Write Property: Width of border.

int	BorderSpacing
	Read Write Property: Spacing of border.

float	BorderMaxAngle
	Read Write Property: Max angle for rounding.

int	BorderCornerRadius
	Read Write Property: Corner radius (rounded).

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

Tree list view.

See sample: Tree.py.

Constructor & Destructor Documentation

◆ FBTree()

FBTree ( )

Constructor.

Member Function Documentation

◆ Clear()

Clear ( )

Clear the tree (remove all nodes).

◆ GetRoot()

FBTreeNode GetRoot ( )

Get the root node.

Returns: the root node of the tree.

◆ InsertLast()

FBTreeNode InsertLast	(	FBTreeNode	pNode,
		str	pName
	)

Insert node at the end.

Parameters

pNode	Node under which the new node will appear.
pName	Text to display for this node.

Returns: the newly created node.

Member Data Documentation

◆ AllowCollapse

bool AllowCollapse

Read Write Property: When OnCollapsing occurs, set this to true to allow collapse.

◆ AllowExpansion

bool AllowExpansion

Read Write Property: When OnExpanding occurs, set this to true to allow expansion.

◆ AutoExpandOnDblClick

bool AutoExpandOnDblClick

Read Write Property: Allow automatic expand on double click, default is false.

◆ AutoExpandOnDragOver

bool AutoExpandOnDragOver

Read Write Property: Allow automatic expand on drag over, default is false.

◆ AutoScroll

bool AutoScroll

Read Write Property: If AutoScroll property is True then the tree window will be automatically scrolled when the user drags item(s) over the boundaries of the tree.

◆ AutoScrollOnExpand

bool AutoScrollOnExpand

Read Write Property: Allow automatic scroll on expand, default is true.

◆ CheckBoxes

bool CheckBoxes

Read Write Property: Draw check boxe for each node.

◆ DeselectOnCollapse

bool DeselectOnCollapse

Read Write Property: Tells whether node are deselected if parent node is collapsed.

◆ EditNodeOn2Select

bool EditNodeOn2Select

Read Write Property: Set to true, to allow automatic node editing on second select.

◆ HighlightOnRightClick

bool HighlightOnRightClick

Read Write Property: Hightlight node on right click.

◆ Indent

int Indent

Read Write Property: Use Indent to determine how far child nodes are indented from their parent nodes when the parent is expanded.

◆ ItemHeight

int ItemHeight

Read Write Property: Height of an item.

◆ MultiDrag

bool MultiDrag

Read Write Property: Tells whether multiple drag/drop is allowed or not.

◆ MultiSelect

bool MultiSelect

Read Write Property: Tells whether multiple selection is allowed or not.

◆ NoSelectOnDrag

bool NoSelectOnDrag

Read Write Property: Tells whether node are selected if drag is start and node is not already selected.

◆ NoSelectOnRightClick

bool NoSelectOnRightClick

Read Write Property: Tells whether node are selected if right click on node.

◆ OnChange

FBEvent OnChange

Event: Change of the selection.

◆ OnClick

FBEvent OnClick

Event: Click on a node of the tree. Use OnSelect.

◆ OnClickCheck

FBEvent OnClickCheck

Event: Click on a node checkbox of the tree.

◆ OnCollapsed

FBEvent OnCollapsed

Event: Click on the "-" sign before a non-leaf node.

◆ OnCollapsing

FBEvent OnCollapsing

Event: Fired before the node collapse. To refuse collapsing, set AllowCollapse to false.

◆ OnDblClick

FBEvent OnDblClick

Event: Double-Click on a node of the tree. Use FBEventTreeSelect to cast event.

◆ OnDragAndDrop

FBEvent OnDragAndDrop

Event: Drag and drop of an element.

◆ OnExpanded

FBEvent OnExpanded

Event: Click on the "+" sign before a non-leaf node

◆ OnExpanding

FBEvent OnExpanding

Event: Is fired before the node expand. To refuse expanding set AllowExpansion to false.

◆ OnSelect

FBEvent OnSelect

Event: A node was selected. Use FBEventTreeSelect to cast event.

◆ SelectedCount

int SelectedCount

Read Only Property: Count of selected items.

◆ SelectedNodes

FBListTreeNode SelectedNodes

Read Only Property: List of selected nodes.

◆ SelectionActive

bool SelectionActive

Read Write Property: Tells whether selection is allowed or not.

◆ ShowLines

bool ShowLines

Read Write Property: On node selection, will draw entire line selected

◆ TreeHeight

int TreeHeight

Read Only Property: Height of the tree.

◆ TreeWidth

int TreeWidth

Read Only Property: Width of the tree.

◆ VisibleItemCount

int VisibleItemCount

Read Only Property: Count of visible items.

Public Member Functions

Public Attributes