Tree list view. More...

#include <fbcontrols.h>

Inheritance diagram for FBTree:

[legend]

Public Member Functions
	FBTree ()
	Constructor.

FBTreeNode *	GetRoot ()
	Get the root node.

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

FBTreeNode *	InsertLast (FBTreeNode pNode, const char pName)
	Insert node at the end.

Public Member Functions inherited from FBVisualComponent
	FBVisualComponent (HIObject pObject)
	Constructor.

	IObject_Declare (override)

	ICallback_Declare (override)

virtual HIKtView	GetKtView ()
	Get internal toolkit object.

QWidget *	GetQWidgetAddress ()
	Get internal QWidget.

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

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

virtual void	Refresh (bool pNow=false)
	Refresh component.

virtual void	ViewExpose ()
	Exposed view callback function.

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

virtual bool	IsView ()
	Is component a view?

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

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

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

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

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

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

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

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

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

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

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

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

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

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyEvent	OnSelect
	Event: A node was selected. Use FBEventTreeSelect to cast event.

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

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

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

FBPropertyEvent	OnDeselect
	Event: Deselection on a node of the tree.

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

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

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

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

FBPropertyEvent	OnChange
	Event: Change of the selection.

FBPropertyEvent	OnDragAndDrop
	Event: Drag and drop of an element.

FBPropertyEvent	OnEditNode
	Event: Called upon node edition.

FBPropertyEvent	OnDeleteNode
	Event: Called upon node deletion.

FBPropertyInt	SelectedCount
	Read Only Property: Count of selected items.

FBPropertyInt	VisibleItemCount
	Read Only Property: Count of visible items.

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

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

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

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.

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

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

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

FBPropertyInt	ItemHeight
	Read Write Property: Height of an item.

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

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

FBPropertyInt	TreeHeight
	Read Only Property: Height of the tree.

FBPropertyInt	TreeWidth
	Read Only Property: Width of the tree.

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

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

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.

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

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

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

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

FBPropertyListTreeNode	SelectedNodes
	Read Only Property: List of selected nodes.

Public Attributes inherited from FBVisualComponent
struct FBVisualComponent::__Region	Region

struct K_DLLEXPORT FBVisualComponent::__Border	Border

FBPropertyString	Caption
	Property: Widget caption.

FBPropertyBool	Visible
	Read Write Property: Is visual component visible?

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

FBPropertyBool	Enabled
	Read Write Property: Is visual enabled?

FBPropertyString	Hint
	Read Write Property: Hint to show.

FBPropertyInt	Left
	Read Write Property: Left coordinate.

FBPropertyInt	Top
	Read Write Property: Top coordinate.

FBPropertyInt	Width
	Read Write Property: Width.

FBPropertyInt	Height
	Read Write Property: Height.

FBPropertyEvent	OnEnter
	Event: On mouse enter.

FBPropertyEvent	OnExit
	Event: On mouse exit.

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

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

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

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.

Protected Member Functions inherited from FBVisualComponent
virtual HIKtObject	GetHIKtObject ()
	Get internal toolkit object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

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.

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.

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.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Tree list view.

Definition at line 1853 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

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

FBPropertyBool AllowCollapse

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

Definition at line 1894 of file fbcontrols.h.

◆ AllowExpansion

FBPropertyBool AllowExpansion

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

Definition at line 1893 of file fbcontrols.h.

◆ AutoExpandOnDblClick

FBPropertyBool AutoExpandOnDblClick

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

Definition at line 1912 of file fbcontrols.h.

◆ AutoExpandOnDragOver

FBPropertyBool AutoExpandOnDragOver

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

Definition at line 1911 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 1896 of file fbcontrols.h.

◆ AutoScrollOnExpand

FBPropertyBool AutoScrollOnExpand

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

Definition at line 1910 of file fbcontrols.h.

◆ CheckBoxes

FBPropertyBool CheckBoxes

Read Write Property: Draw check boxe for each node.

Definition at line 1898 of file fbcontrols.h.

◆ DeselectOnCollapse

FBPropertyBool DeselectOnCollapse

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

Definition at line 1906 of file fbcontrols.h.

◆ EditNodeOn2Select

FBPropertyBool EditNodeOn2Select

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

Definition at line 1902 of file fbcontrols.h.

◆ HighlightOnRightClick

FBPropertyBool HighlightOnRightClick

Read Write Property: Hightlight node on right click.

Definition at line 1909 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 1897 of file fbcontrols.h.

◆ ItemHeight

FBPropertyInt ItemHeight

Read Write Property: Height of an item.

Definition at line 1900 of file fbcontrols.h.

◆ MultiDrag

FBPropertyBool MultiDrag

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

Definition at line 1895 of file fbcontrols.h.

◆ MultiSelect

FBPropertyBool MultiSelect

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

Definition at line 1901 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 1907 of file fbcontrols.h.

◆ NoSelectOnRightClick

FBPropertyBool NoSelectOnRightClick

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

Definition at line 1908 of file fbcontrols.h.

◆ OnChange

FBPropertyEvent OnChange

Event: Change of the selection.

Definition at line 1886 of file fbcontrols.h.

◆ OnClick

FBPropertyEvent OnClick

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

Definition at line 1878 of file fbcontrols.h.

◆ OnClickCheck

FBPropertyEvent OnClickCheck

Event: Click on a node checkbox of the tree.

Definition at line 1879 of file fbcontrols.h.

◆ OnCollapsed

FBPropertyEvent OnCollapsed

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

Definition at line 1884 of file fbcontrols.h.

◆ OnCollapsing

FBPropertyEvent OnCollapsing

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

Definition at line 1885 of file fbcontrols.h.

◆ OnDblClick

FBPropertyEvent OnDblClick

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

Definition at line 1880 of file fbcontrols.h.

◆ OnDeleteNode

FBPropertyEvent OnDeleteNode

Event: Called upon node deletion.

Definition at line 1889 of file fbcontrols.h.

◆ OnDeselect

FBPropertyEvent OnDeselect

Event: Deselection on a node of the tree.

Definition at line 1881 of file fbcontrols.h.

◆ OnDragAndDrop

FBPropertyEvent OnDragAndDrop

Event: Drag and drop of an element.

Definition at line 1887 of file fbcontrols.h.

◆ OnEditNode

FBPropertyEvent OnEditNode

Event: Called upon node edition.

Definition at line 1888 of file fbcontrols.h.

◆ OnExpanded

FBPropertyEvent OnExpanded

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

Definition at line 1882 of file fbcontrols.h.

◆ OnExpanding

FBPropertyEvent OnExpanding

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

Definition at line 1883 of file fbcontrols.h.

◆ OnSelect

FBPropertyEvent OnSelect

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

Definition at line 1876 of file fbcontrols.h.

◆ SelectedCount

FBPropertyInt SelectedCount

Read Only Property: Count of selected items.

Definition at line 1891 of file fbcontrols.h.

◆ SelectedNodes

FBPropertyListTreeNode SelectedNodes

Read Only Property: List of selected nodes.

Definition at line 1913 of file fbcontrols.h.

◆ SelectionActive

FBPropertyBool SelectionActive

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

Definition at line 1905 of file fbcontrols.h.

◆ ShowLines

FBPropertyBool ShowLines

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

Definition at line 1899 of file fbcontrols.h.

◆ TreeHeight

FBPropertyInt TreeHeight

Read Only Property: Height of the tree.

Definition at line 1903 of file fbcontrols.h.

◆ TreeWidth

FBPropertyInt TreeWidth

Read Only Property: Width of the tree.

Definition at line 1904 of file fbcontrols.h.

◆ VisibleItemCount

FBPropertyInt VisibleItemCount

Read Only Property: Count of visible items.

Definition at line 1892 of file fbcontrols.h.

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

fbcontrols.h

Public Member Functions

Public Attributes

Additional Inherited Members