FBTree Class Reference

#include <mobu-python-api.h>

Class Description

Tree list view.

+ Inheritance diagram for FBTree:

Public Member Functions

 __reduce__ ()
 
 Clear (FBTree arg1)
 Clear the tree (remove all nodes). More...
 
 __init__ (object arg1)
 Constructor. More...
 
object GetRoot (FBTree arg1)
 Get the root node. More...
 
object InsertLast (FBTree arg1, FBTreeNode arg2, str arg3)
 Insert node at the end. More...
 
- Public Member Functions inherited from FBVisualComponent
 __reduce__ ()
 
bool AddChild (FBVisualComponent arg1, FBVisualComponent arg2, object arg3)
 Add a child component. More...
 
object GetChild (FBVisualComponent arg1, object arg2)
 Get a child component. More...
 
bool IsView (FBVisualComponent arg1)
 Is component a view? More...
 
 Refresh (FBVisualComponent arg1, object arg2)
 Refresh component. More...
 
 ViewExpose (FBVisualComponent arg1)
 Exposed view callback function. More...
 
 ViewInput (FBVisualComponent arg1, object arg2, object arg3, FBInputType arg4, object arg5, object arg6)
 Input callback function. More...
 
int GetQWidgetAddress (FBVisualComponent arg1)
 Get internal QWidget. More...
 
 __init__ (...)
 Constructor. More...
 
- Public Member Functions inherited from FBComponent
 __reduce__ ()
 
FBPropertyList PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
 Get list of properties which have been modified since last loading. More...
 
str ClassName (FBComponent arg1)
 Get the class name. More...
 
 DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Disable a specific Object Flags. More...
 
 EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Enable a specific Object Flags. More...
 
bool FBCreate (FBComponent arg1)
 Open Reality Creation function. More...
 
 FBDelete (FBComponent arg1)
 Open Reality deletion function. More...
 
 FBDestroy (FBComponent arg1)
 Open Reality destruction function. More...
 
FBObjectFlag GetObjectFlags (FBComponent arg1)
 Get all Object Flags (concatenated). More...
 
bool GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
 Check to see if an object status is enabled. More...
 
bool HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Check whether a specific object flag is enabled. More...
 
bool Is (FBComponent arg1, object arg2)
 Returns true if object is of type TypeId. More...
 
bool ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessObjectNamespace. More...
 
int PropertyAdd (FBComponent arg1, FBProperty arg2)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
 Add a reference property to the component's property manager. More...
 
object PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
 Create user or dynamic property. More...
 
 PropertyRemove (FBComponent arg1, FBProperty arg2)
 Remove a Property from the component's Property manager. More...
 
 SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 SetObjectFlags. More...
 
 SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
 Enable/Disable a specific Object Status. More...
 
 HardSelect (FBComponent arg1)
 HardSelect. More...
 
object GetOwnerFileReference (FBComponent arg1)
 Get the owner FileReference object. More...
 
 __init__ (...)
 Constructor. More...
 
- Public Member Functions inherited from FBPlug
 __reduce__ ()
 
bool BeginChange (FBPlug arg1)
 Begins a change on multiple plugs. More...
 
str ClassName (FBPlug arg1)
 internal System vars. More...
 
bool ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a destination connection. More...
 
bool ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a destination connection. More...
 
bool ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a source connection. More...
 
bool ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a source connection. More...
 
 DisconnectAllDst (FBPlug arg1)
 Remove all destination connections. More...
 
 DisconnectAllSrc (FBPlug arg1)
 Remove all source connections. More...
 
bool DisconnectDst (FBPlug arg1, FBPlug arg2)
 Remove a destination connection. More...
 
bool DisconnectDstAt (FBPlug arg1, object arg2)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrc (FBPlug arg1, FBPlug arg2)
 Remove a source connection. More...
 
bool DisconnectSrcAt (FBPlug arg1, object arg2)
 Remove a source connection at a specified index. More...
 
 EndChange (FBPlug arg1)
 Ends a change on multiple plugs. More...
 
object GetDst (FBPlug arg1, object arg2)
 Get a destination connection's plug at specified index. More...
 
int GetDstCount (FBPlug arg1)
 Get destination connection count. More...
 
FBConnectionType GetDstType (FBPlug arg1, object arg2)
 Get a destination connection's type at specified index. More...
 
object GetOwned (FBPlug arg1, object arg2)
 Get the owned plug at specified index. More...
 
int GetOwnedCount (FBPlug arg1)
 Get the owned plug count. More...
 
object GetOwner (FBPlug arg1)
 Get the owner of this plug. More...
 
object GetSrc (FBPlug arg1, object arg2)
 Get a source connection's plug at specified index. More...
 
int GetSrcCount (FBPlug arg1)
 Get source connection count. More...
 
FBConnectionType GetSrcType (FBPlug arg1, object arg2)
 Get a source connection's type at specified index. More...
 
bool Is (FBPlug arg1, object arg2)
 Is( int pTypeId ) More...
 
bool IsSDKComponent (FBPlug arg1)
 Return whether or not item is an SDK component. More...
 
 MoveSrcAt (...)
 
bool ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (FBPlug arg1, object arg2, object arg3)
 Swap source connection at index A with source connection at index B. More...
 
 SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's self has changed. More...
 
 SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
 Revert the plug's modification to original status. More...
 
 __init__ (...)
 
method staticmethod (function)
 
- Public Member Functions inherited from FBPythonWrapper
 __reduce__ ()
 
 __init__ (...)
 

Public Attributes

FBPropertyBool AllowCollapse
 Read Write Property: When OnCollapsing occurs, set this to true to allow collapse. More...
 
FBPropertyBool AllowExpansion
 Read Write Property: When OnExpanding occurs, set this to true to allow expansion. More...
 
FBPropertyBool AutoExpandOnDblClick
 Read Write Property: Allow automatic expand on double click, default is false. More...
 
FBPropertyBool AutoExpandOnDragOver
 Read Write Property: Allow automatic expand on drag over, default is false. More...
 
FBPropertyBool 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. More...
 
FBPropertyBool AutoScrollOnExpand
 Read Write Property: Allow automatic scroll on expand, default is true. More...
 
FBPropertyBool CheckBoxes
 Read Write Property: Draw check boxe for each node. More...
 
FBPropertyBool DeselectOnCollapse
 Read Write Property: Tells whether node are deselected if parent node is collapsed. More...
 
FBPropertyBool EditNodeOn2Select
 Read Write Property: Set to true, to allow automatic node editing on second select. More...
 
FBPropertyBool HighlightOnRightClick
 Read Write Property: Hightlight node on right click. More...
 
FBPropertyInt Indent
 Read Write Property: Use Indent to determine how far child nodes are indented from their parent nodes when the parent is expanded. More...
 
FBPropertyInt ItemHeight
 Read Write Property: Height of an item. More...
 
FBPropertyBool MultiDrag
 Read Write Property: Tells whether multiple drag/drop is allowed or not. More...
 
FBPropertyBool MultiSelect
 Read Write Property: Tells whether multiple selection is allowed or not. More...
 
FBPropertyBool NoSelectOnDrag
 Read Write Property: Tells whether node are selected if drag is start and node is not already selected. More...
 
FBPropertyBool NoSelectOnRightClick
 Read Write Property: Tells whether node are selected if right click on node. More...
 
FBPropertyInt SelectedCount
 Read Only Property: Count of selected items. More...
 
FBPropertyBool SelectionActive
 Read Write Property: Tells whether selection is allowed or not. More...
 
FBPropertyBool ShowLines
 Read Write Property: On node selection, will draw entire line selected More...
 
FBPropertyInt TreeHeight
 Read Only Property: Height of the tree. More...
 
FBPropertyInt TreeWidth
 Read Only Property: Width of the tree. More...
 
FBPropertyInt VisibleItemCount
 Read Only Property: Count of visible items. More...
 
ORSDK2018::FBPropertyListTreeNode SelectedNodes
 Read Only Property: List of selected nodes. More...
 
ORSDK2018::FBPropertyEvent OnChange
 Event: Change of the selection. More...
 
ORSDK2018::FBPropertyEvent OnClick
 Event: Click on a node of the tree. More...
 
ORSDK2018::FBPropertyEvent OnClickCheck
 Event: Click on a node checkbox of the tree. More...
 
ORSDK2018::FBPropertyEvent OnDblClick
 Event: Double-Click on a node of the tree. More...
 
ORSDK2018::FBPropertyEvent OnCollapsed
 Event: Click on the "-" sign before a non-leaf node. More...
 
ORSDK2018::FBPropertyEvent OnCollapsing
 Event: Fired before the node collapse. More...
 
ORSDK2018::FBPropertyEvent OnExpanded
 Event: Click on the "+" sign before a non-leaf node More...
 
ORSDK2018::FBPropertyEvent OnExpanding
 Event: Is fired before the node expand. More...
 
ORSDK2018::FBPropertyEvent OnSelect
 Event: A node was selected. More...
 
ORSDK2018::FBPropertyEvent OnDragAndDrop
 Event: Drag and drop of an element. More...
 
- Public Attributes inherited from FBVisualComponent
ORSDK2018::FBPropertyString Caption
 Property: Widget caption. More...
 
FBPropertyBool Enabled
 Read Write Property: Is visual enabled? More...
 
ORSDK2018::FBPropertyString Hint
 Read Write Property: Hint to show. More...
 
FBPropertyBool ReadOnly
 Read Write Property: Is visual component read only? More...
 
FBPropertyBool Visible
 Read Write Property: Is visual component visible? More...
 
FBPropertyInt Left
 Read Write Property: Left coordinate. More...
 
FBPropertyInt Top
 Read Write Property: Top coordinate. More...
 
FBPropertyInt Width
 Read Write Property: Width. More...
 
FBPropertyInt Height
 Read Write Property: Height. More...
 
object RegionName
 
object RegionOffsetX
 
object RegionOffsetY
 
object RegionOffsetWidth
 
object RegionOffsetHeight
 
object RegionRatioX
 
object RegionRatioY
 
object RegionRatioWidth
 
object RegionRatioHeight
 
object RegionAttachTypeX
 
object RegionAttachTypeY
 
object RegionAttachTypeWidth
 
object RegionAttachTypeHeight
 
object RegionAttachToX
 
object RegionAttachToY
 
object RegionAttachToWidth
 
object RegionAttachToHeight
 
object RegionPosMinX
 
object RegionPosMaxX
 
object RegionPosMinY
 
object RegionPosMaxY
 
object BorderCaption
 
object BorderShowCaption
 
object BorderStyle
 
object BorderWidth
 
object BorderSpacing
 
object BorderInSet
 
object BorderMaxAngle
 
object BorderCornerRadius
 
- Public Attributes inherited from FBComponent
object OwnerNamespace
 
ORSDK2018::FBPropertyListComponent Components
 List: List of components. More...
 
ORSDK2018::FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
ORSDK2018::FBPropertyString LongName
 Read Write Property: Name and namespace for object. More...
 
object FullName
 
ORSDK2018::FBPropertyListComponent Parents
 List: Parents. More...
 
ORSDK2018::FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
- Public Attributes inherited from FBPythonWrapper
object OnUnbind
 

Member Function Documentation

__init__ ( object  arg1)

Constructor.

Python Docstring:

__init__( (object)arg1) -> None 

C++ Signature:

 FBTree() 
__reduce__ ( )
Clear ( FBTree  arg1)

Clear the tree (remove all nodes).

Python Docstring:

Clear( (FBTree)arg1) -> None 

C++ Signature:

void Clear() 
object GetRoot ( FBTree  arg1)

Get the root node.

Python Docstring:

GetRoot( (FBTree)arg1) -> object 

C++ Signature:

ORSDK2018::FBTreeNode * GetRoot() 
Returns
the root node of the tree.
object InsertLast ( FBTree  arg1,
FBTreeNode  arg2,
str  arg3 
)

Insert node at the end.

Python Docstring:

InsertLast( (FBTree)arg1, (FBTreeNode)arg2, (str)arg3) -> object 

C++ Signature:

ORSDK2018::FBTreeNode * InsertLast(ORSDK2018::FBTreeNode * pNode, const char * pName) 
Parameters
pNodeNode under which the new node will appear.
pNameText to display for this node.
Returns
the newly created node.

Member Data Documentation

FBPropertyBool AllowCollapse

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

FBPropertyBool AllowExpansion

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

FBPropertyBool AutoExpandOnDblClick

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

FBPropertyBool AutoExpandOnDragOver

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

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

FBPropertyBool AutoScrollOnExpand

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

FBPropertyBool CheckBoxes

Read Write Property: Draw check boxe for each node.

FBPropertyBool DeselectOnCollapse

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

FBPropertyBool EditNodeOn2Select

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

FBPropertyBool HighlightOnRightClick

Read Write Property: Hightlight node on right click.

FBPropertyInt Indent

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

FBPropertyInt ItemHeight

Read Write Property: Height of an item.

FBPropertyBool MultiDrag

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

FBPropertyBool MultiSelect

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

FBPropertyBool NoSelectOnDrag

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

FBPropertyBool NoSelectOnRightClick

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

ORSDK2018::FBPropertyEvent OnChange

Event: Change of the selection.

ORSDK2018::FBPropertyEvent OnClick

Event: Click on a node of the tree.

Use OnSelect.

ORSDK2018::FBPropertyEvent OnClickCheck

Event: Click on a node checkbox of the tree.

ORSDK2018::FBPropertyEvent OnCollapsed

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

ORSDK2018::FBPropertyEvent OnCollapsing

Event: Fired before the node collapse.

To refuse collapsing, set AllowCollapse to false.

ORSDK2018::FBPropertyEvent OnDblClick

Event: Double-Click on a node of the tree.

Use FBEventTreeSelect to cast event.

ORSDK2018::FBPropertyEvent OnDragAndDrop

Event: Drag and drop of an element.

ORSDK2018::FBPropertyEvent OnExpanded

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

ORSDK2018::FBPropertyEvent OnExpanding

Event: Is fired before the node expand.

To refuse expanding set AllowExpansion to false.

ORSDK2018::FBPropertyEvent OnSelect

Event: A node was selected.

Use FBEventTreeSelect to cast event.

FBPropertyInt SelectedCount

Read Only Property: Count of selected items.

ORSDK2018::FBPropertyListTreeNode SelectedNodes

Read Only Property: List of selected nodes.

FBPropertyBool SelectionActive

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

FBPropertyBool ShowLines

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

FBPropertyInt TreeHeight

Read Only Property: Height of the tree.

FBPropertyInt TreeWidth

Read Only Property: Width of the tree.

FBPropertyInt VisibleItemCount

Read Only Property: Count of visible items.