Open Reality Reference Guide
FBTree Class Reference

Tree list view. More...

#include <fbcontrols.h>

Inheritance diagram for FBTree:

Public Member Functions

 FBTree ()
 Constructor. More...
 
FBTreeNodeGetRoot ()
 Get the root node. More...
 
void Clear ()
 Clear the tree (remove all nodes). More...
 
FBTreeNodeInsertLast (FBTreeNode *pNode, const char *pName)
 Insert node at the end. More...
 
- Public Member Functions inherited from FBVisualComponent
 FBVisualComponent (HIObject pObject)
 Constructor. More...
 
 IObject_Declare (override)
 
 ICallback_Declare (override)
 
virtual HIKtView GetKtView ()
 Get internal toolkit object. More...
 
QWidget * GetQWidgetAddress ()
 Get internal QWidget. More...
 
virtual bool AddChild (FBVisualComponent *pChild, int pId=0)
 Add a child component. More...
 
virtual FBVisualComponentGetChild (int pId=0)
 Get a child component. More...
 
virtual void Refresh (bool pNow=false)
 Refresh component. More...
 
virtual void ViewExpose ()
 Exposed view callback function. More...
 
virtual void ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
 Input callback function. More...
 
virtual bool IsView ()
 Is component a view? More...
 
- Public Member Functions inherited from FBComponent
 FBComponent (HIObject pObject)
 Constructor. More...
 
virtual ~FBComponent ()
 Destructor. More...
 
virtual bool FBCreate ()
 Open Reality Creation function. More...
 
virtual void FBDestroy ()
 Open Reality destruction function. More...
 
virtual void FBDelete () override
 Open Reality deletion function. More...
 
virtual bool SetHIObject (HIObject pObject, bool pSDKComponent) override
 Assign component to an internal pointer. More...
 
virtual int PropertyAdd (FBProperty *pProperty)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
 Add a reference property to the component's property manager. More...
 
void PropertyRemove (FBProperty *pProperty)
 Remove a Property from the component's Property manager. More...
 
void PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading. More...
 
FBPropertyPropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
 Create user or dynamic property. More...
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated). More...
 
void SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags. More...
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled. More...
 
void EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags. More...
 
void DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags. More...
 
void SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status. More...
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled. More...
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
 ProcessObjectNamespace. More...
 
virtual const char * ClassName () override
 Get the class name. More...
 
virtual bool UseCustomPropertyViewSet () const
 Use the custom property viewSet or not. More...
 
const char * GetFullName (void)
 Get the full name. More...
 
void SetOwnerNamespace (FBNamespace *pOwnerNSObj)
 Set the owner Namespace object. More...
 
FBNamespaceGetOwnerNamespace (void)
 Get the owner Namespace object. More...
 
FBFileReferenceGetOwnerFileReference (void)
 Get the owner FileReference object. More...
 
void HardSelect ()
 HardSelect. More...
 
virtual bool Is (int pTypeId) override
 Returns true if object is of type TypeId. More...
 
virtual int GetTypeId () override
 GetTypeId( int pTypeId ) More...
 
- Public Member Functions inherited from FBWrapperHolder
FBScriptWrapperGetWrapper ()
 Return the wrapper interface of this FBObject. More...
 
void AddWrapper (FBScriptWrapper *)
 
void RemoveWrapper (FBScriptWrapper *)
 

Public Attributes

FBPropertyEvent OnSelect
 Event: A node was selected. Use FBEventTreeSelect to cast event. More...
 
FBPropertyEvent OnClick
 Event: Click on a node of the tree. Use OnSelect. More...
 
FBPropertyEvent OnClickCheck
 Event: Click on a node checkbox of the tree. More...
 
FBPropertyEvent OnDblClick
 Event: Double-Click on a node of the tree. Use FBEventTreeSelect to cast event. More...
 
FBPropertyEvent OnDeselect
 Event: Deselection on a node of the tree. More...
 
FBPropertyEvent OnExpanded
 Event: Click on the "+" sign before a non-leaf node More...
 
FBPropertyEvent OnExpanding
 Event: Is fired before the node expand. To refuse expanding set AllowExpansion to false. More...
 
FBPropertyEvent OnCollapsed
 Event: Click on the "-" sign before a non-leaf node. More...
 
FBPropertyEvent OnCollapsing
 Event: Fired before the node collapse. To refuse collapsing, set AllowCollapse to false. More...
 
FBPropertyEvent OnChange
 Event: Change of the selection. More...
 
FBPropertyEvent OnDragAndDrop
 Event: Drag and drop of an element. More...
 
FBPropertyEvent OnEditNode
 Event: Called upon node edition. More...
 
FBPropertyInt SelectedCount
 Read Only Property: Count of selected items. More...
 
FBPropertyInt VisibleItemCount
 Read Only Property: Count of visible items. More...
 
FBPropertyBool AllowExpansion
 Read Write Property: When OnExpanding occurs, set this to true to allow expansion. More...
 
FBPropertyBool AllowCollapse
 Read Write Property: When OnCollapsing occurs, set this to true to allow collapse.
More...
 
FBPropertyBool MultiDrag
 Read Write Property: Tells whether multiple drag/drop is allowed or not. 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...
 
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...
 
FBPropertyBool CheckBoxes
 Read Write Property: Draw check boxe for each node.
More...
 
FBPropertyBool ShowLines
 Read Write Property: On node selection, will draw entire line selected
More...
 
FBPropertyInt ItemHeight
 Read Write Property: Height of an item. More...
 
FBPropertyBool MultiSelect
 Read Write Property: Tells whether multiple selection is allowed or not. More...
 
FBPropertyBool EditNodeOn2Select
 Read Write Property: Set to true, to allow automatic node editing on second select.
More...
 
FBPropertyInt TreeHeight
 Read Only Property: Height of the tree.
More...
 
FBPropertyInt TreeWidth
 Read Only Property: Width of the tree. More...
 
FBPropertyBool SelectionActive
 Read Write Property: Tells whether selection is allowed or not. More...
 
FBPropertyBool DeselectOnCollapse
 Read Write Property: Tells whether node are deselected if parent node is collapsed. 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...
 
FBPropertyBool HighlightOnRightClick
 Read Write Property: Hightlight node on right click. More...
 
FBPropertyBool AutoScrollOnExpand
 Read Write Property: Allow automatic scroll on expand, default is true. More...
 
FBPropertyBool AutoExpandOnDragOver
 Read Write Property: Allow automatic expand on drag over, default is false. More...
 
FBPropertyBool AutoExpandOnDblClick
 Read Write Property: Allow automatic expand on double click, default is false. More...
 
FBPropertyListTreeNode SelectedNodes
 Read Only Property: List of selected nodes. More...
 
- Public Attributes inherited from FBVisualComponent
struct FBVisualComponent::__Region Region
 
struct K_DLLEXPORT FBVisualComponent::__Border Border
 
FBPropertyString Caption
 Property: Widget caption. More...
 
FBPropertyBool Visible
 Read Write Property: Is visual component visible? More...
 
FBPropertyBool ReadOnly
 Read Write Property: Is visual component read only? More...
 
FBPropertyBool Enabled
 Read Write Property: Is visual enabled? More...
 
FBPropertyString Hint
 Read Write Property: Hint to show. 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...
 
FBPropertyEvent OnEnter
 Event: On mouse enter. More...
 
FBPropertyEvent OnExit
 Event: On mouse exit. More...
 
- Public Attributes inherited from FBComponent
FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyListComponent Components
 List: List of components. More...
 
FBPropertyListComponent Parents
 List: Parents. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
FBPropertyString LongName
 Read Write Property: Name and namespace for object.
More...
 
FBPropertyFolder Folder
 Read Write Property: The folder that contain this component. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FBComponent
static int GetInternalClassId ()
 
static void FBComponentSetName (FBComponent *pObject, const char *pName)
 
static const char * FBComponentGetName (FBComponent *pObject)
 
static void FBComponentSetLongName (FBComponent *pObject, const char *pName)
 
static const char * FBComponentGetLongName (FBComponent *pObject)
 
- Static Public Attributes inherited from FBComponent
static int TypeInfo
 Contains the Type information of the object. More...
 
- Protected Member Functions inherited from FBVisualComponent
virtual HIKtObject GetHIKtObject ()
 Get internal toolkit object. More...
 
- Protected Member Functions inherited from FBPlug
bool IsSDKComponent ()
 Return whether or not item is an SDK component. More...
 
bool ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool DisconnectDst (FBPlug *pDst)
 Remove a destination connection. More...
 
bool DisconnectSrc (FBPlug *pSrc)
 Remove a source connection. More...
 
void DisconnectAllSrc ()
 Remove all source connections. More...
 
void DisconnectAllDst ()
 Remove all destination connections. More...
 
bool DisconnectDstAt (int pIndex)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrcAt (int pIndex)
 Remove a source connection at a specified index. More...
 
bool ReplaceDstAt (int pIndex, FBPlug *pDst)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (int pIndex, FBPlug *pSrc)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (int pIndexA, int pIndexB)
 Swap source connection at index A with source connection at index B. More...
 
bool MoveSrcAt (int pIndex, int pAtIndex)
 Move source connection at pIndex to pAtIndex. More...
 
bool MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
 Move source connection pSrc to the position of pAtSrc. More...
 
int GetSrcCount ()
 Get source connection count. More...
 
FBPlugGetSrc (int pIndex)
 Get a source connection's plug at specified index. More...
 
FBConnectionType GetSrcType (int pIndex)
 Get a source connection's type at specified index. More...
 
int GetDstCount ()
 Get destination connection count. More...
 
FBPlugGetDst (int pIndex)
 Get a destination connection's plug at specified index. More...
 
FBConnectionType GetDstType (int pIndex)
 Get a destination connection's type at specified index. More...
 
bool BeginChange ()
 Begins a change on multiple plugs. More...
 
void EndChange ()
 Ends a change on multiple plugs. More...
 
void SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlugModificationFlag pFlag)
 Tell if the plug's self has changed. More...
 
void SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlugModificationFlag pFlag)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
 Revert the plug's modification to original status. More...
 
void SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
 Set the plug's status flag. More...
 
bool GetStatusFlag (FBPlugStatusFlag pStatus) const
 Tell if the plug's status has changed. More...
 
FBPlugGetOwner ()
 Get the owner of this plug. More...
 
FBPlugGetOwned (int pIndex)
 Get the owned plug at specified index. More...
 
int GetOwnedCount ()
 Get the owned plug count. More...
 
virtual bool PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
 PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...
 
virtual bool PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
 PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...
 
virtual bool PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
 PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...
 
- Static Protected Member Functions inherited from FBPlug
static int GetInternalClassId ()
 Internal class Id. More...
 
- Protected Attributes inherited from FBPlug
bool mAllocated
 Contain the Allocation State of the Component. More...
 
HIObject mObject
 Handle on the Plug. More...
 
bool mSDKComponent
 bool Plug is an SDK component.
More...
 
- Static Protected Attributes inherited from FBPlug
static const char * ClassGroupName
 ClassGroupName of the object. More...
 
static int TypeInfo
 TypeInfo. More...
 
static int mGlobalTypeInfo
 Represente the Type Index. More...
 

Detailed Description

Tree list view.

Definition at line 1831 of file fbcontrols.h.

Constructor & Destructor Documentation

◆ FBTree()

FBTree ( )

Constructor.

Member Function Documentation

◆ Clear()

void 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,
const char *  pName 
)

Insert node at the end.

Parameters
pNodeNode under which the new node will appear.
pNameText to display for this node.
Returns
the newly created node.

Member Data Documentation

◆ AllowCollapse

FBPropertyBool AllowCollapse

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

Definition at line 1871 of file fbcontrols.h.

◆ AllowExpansion

FBPropertyBool AllowExpansion

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

Definition at line 1870 of file fbcontrols.h.

◆ AutoExpandOnDblClick

FBPropertyBool AutoExpandOnDblClick

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

Definition at line 1889 of file fbcontrols.h.

◆ AutoExpandOnDragOver

FBPropertyBool AutoExpandOnDragOver

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

Definition at line 1888 of file fbcontrols.h.

◆ AutoScroll

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.

Definition at line 1873 of file fbcontrols.h.

◆ AutoScrollOnExpand

FBPropertyBool AutoScrollOnExpand

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

Definition at line 1887 of file fbcontrols.h.

◆ CheckBoxes

FBPropertyBool CheckBoxes

Read Write Property: Draw check boxe for each node.

Definition at line 1875 of file fbcontrols.h.

◆ DeselectOnCollapse

FBPropertyBool DeselectOnCollapse

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

Definition at line 1883 of file fbcontrols.h.

◆ EditNodeOn2Select

FBPropertyBool EditNodeOn2Select

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

Definition at line 1879 of file fbcontrols.h.

◆ HighlightOnRightClick

FBPropertyBool HighlightOnRightClick

Read Write Property: Hightlight node on right click.

Definition at line 1886 of file fbcontrols.h.

◆ Indent

FBPropertyInt Indent

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

Definition at line 1874 of file fbcontrols.h.

◆ ItemHeight

FBPropertyInt ItemHeight

Read Write Property: Height of an item.

Definition at line 1877 of file fbcontrols.h.

◆ MultiDrag

FBPropertyBool MultiDrag

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

Definition at line 1872 of file fbcontrols.h.

◆ MultiSelect

FBPropertyBool MultiSelect

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

Definition at line 1878 of file fbcontrols.h.

◆ NoSelectOnDrag

FBPropertyBool NoSelectOnDrag

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

Definition at line 1884 of file fbcontrols.h.

◆ NoSelectOnRightClick

FBPropertyBool NoSelectOnRightClick

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

Definition at line 1885 of file fbcontrols.h.

◆ OnChange

FBPropertyEvent OnChange

Event: Change of the selection.

Definition at line 1864 of file fbcontrols.h.

◆ OnClick

FBPropertyEvent OnClick

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

Definition at line 1856 of file fbcontrols.h.

◆ OnClickCheck

FBPropertyEvent OnClickCheck

Event: Click on a node checkbox of the tree.

Definition at line 1857 of file fbcontrols.h.

◆ OnCollapsed

FBPropertyEvent OnCollapsed

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

Definition at line 1862 of file fbcontrols.h.

◆ OnCollapsing

FBPropertyEvent OnCollapsing

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

Definition at line 1863 of file fbcontrols.h.

◆ OnDblClick

FBPropertyEvent OnDblClick

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

Definition at line 1858 of file fbcontrols.h.

◆ OnDeselect

FBPropertyEvent OnDeselect

Event: Deselection on a node of the tree.

Definition at line 1859 of file fbcontrols.h.

◆ OnDragAndDrop

FBPropertyEvent OnDragAndDrop

Event: Drag and drop of an element.

Definition at line 1865 of file fbcontrols.h.

◆ OnEditNode

FBPropertyEvent OnEditNode

Event: Called upon node edition.

Definition at line 1866 of file fbcontrols.h.

◆ OnExpanded

FBPropertyEvent OnExpanded

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

Definition at line 1860 of file fbcontrols.h.

◆ OnExpanding

FBPropertyEvent OnExpanding

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

Definition at line 1861 of file fbcontrols.h.

◆ OnSelect

FBPropertyEvent OnSelect

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

Definition at line 1854 of file fbcontrols.h.

◆ SelectedCount

FBPropertyInt SelectedCount

Read Only Property: Count of selected items.

Definition at line 1868 of file fbcontrols.h.

◆ SelectedNodes

FBPropertyListTreeNode SelectedNodes

Read Only Property: List of selected nodes.

Definition at line 1890 of file fbcontrols.h.

◆ SelectionActive

FBPropertyBool SelectionActive

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

Definition at line 1882 of file fbcontrols.h.

◆ ShowLines

FBPropertyBool ShowLines

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

Definition at line 1876 of file fbcontrols.h.

◆ TreeHeight

FBPropertyInt TreeHeight

Read Only Property: Height of the tree.

Definition at line 1880 of file fbcontrols.h.

◆ TreeWidth

FBPropertyInt TreeWidth

Read Only Property: Width of the tree.

Definition at line 1881 of file fbcontrols.h.

◆ VisibleItemCount

FBPropertyInt VisibleItemCount

Read Only Property: Count of visible items.

Definition at line 1869 of file fbcontrols.h.


The documentation for this class was generated from the following file: