Inheritance diagram for iWidgetTree:

Detailed Description

Widget tree interface.

Public Member Functions
virtual iWidgetTreeNode *	GetRootNode () const =0
	Get the root tree node. {Property}. More...

virtual tU32	GetNumNodes () const =0
	Get the number of nodes. {Property}. More...

virtual iWidgetTreeNode *	GetNode (tU32 anIndex) const =0
	Get the node at the specified index. {Property}. More...

virtual tU32	GetNumSelectedNodes () const =0
	Get the number of nodes selected. {Property}. More...

virtual iWidgetTreeNode *	GetSelectedNode (tU32 anIndex) const =0
	Get the selected node at the specified index. {Property}. More...

virtual tBool	Clear ()=0
	Clear the tree. More...

virtual tBool	ClearSelection ()=0
	Clear the selection of all nodes. More...

virtual iWidgetTreeNode *	GetNodeFromPosition (const sVec2f &avAbsPos) const =0
	Get a node from an absolute position. More...

virtual eWidgetTreeNodeDropMode	GetNodeDropMode (iWidgetTreeNode *apNode, const sVec2f &avAbsPos) const =0
	Get the drop mode of the specified node from the specified absolute position. More...

virtual void	SetSecondarySelection (iWidgetTreeNode *apNode)=0
	Set the secondary selection item. {Property}. More...

virtual iWidgetTreeNode *	GetSecondarySelection () const =0
	Get the secondary selection item. {Property}. More...

virtual iWidgetTreeNode *	GetPivotSelection () const =0
	Get the pivot selection. {Property}. More...

virtual void	ScrollToNode (iWidgetTreeNode *apNode)=0
	Scroll to the specified item node. {Propety}. More...

virtual tBool	SaveTreeStates (iDataTable *apStates)=0
	Save tree states. More...

virtual tBool	LoadTreeStates (iDataTable *apStates, ni::tBool abLoadMatchingNames)=0
	Load tree states. More...

virtual tBool	PushStates ()=0
	Push the tree's states. More...

virtual tBool	PopStates (ni::tBool abLoadMatchingNames)=0
	Pop the tree's states. More...

virtual void	SetNumVisibleAttributes (tU32 anCount)=0
	Set the number of visible attributes. {Property}. More...

virtual tU32	GetNumVisibleAttributes () const =0
	Get the number of visible attributes. {Property}. More...

virtual void	SetAttributeIcon (tU32 anIndex, iOverlay *apIcon)=0
	Set the specified attribute's icon. {Property}. More...

virtual iOverlay *	GetAttributeIcon (tU32 anIndex) const =0
	Get the specified attribute's icon. {Property}. More...

virtual void	SetAttributeName (tU32 anIndex, iHString *ahspName)=0
	Set the specified attribute's name. {Property}. More...

virtual iHString *	GetAttributeName (tU32 anIndex) const =0
	Get the specified attribute's name. {Property}. More...

virtual tBool	SetHoverNode (tU32 anNodeTreeIndex)=0
	Set the hover node. {Property}. More...

virtual tU32	GetHoverNode () const =0
	Get the hover node. {Property}. More...

Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual iWidgetTreeNode* GetRootNode ( ) const

pure virtual

Get the root tree node. {Property}.

virtual tU32 GetNumNodes ( ) const

pure virtual

Get the number of nodes. {Property}.

virtual iWidgetTreeNode* GetNode ( tU32 anIndex ) const

pure virtual

Get the node at the specified index. {Property}.

virtual tU32 GetNumSelectedNodes ( ) const

pure virtual

Get the number of nodes selected. {Property}.

virtual iWidgetTreeNode* GetSelectedNode ( tU32 anIndex ) const

pure virtual

Get the selected node at the specified index. {Property}.

virtual tBool Clear ( )

pure virtual

Clear the tree.

Remarks: This clear the root node, notify node and selection.

virtual tBool ClearSelection ( )

pure virtual

Clear the selection of all nodes.

virtual iWidgetTreeNode* GetNodeFromPosition ( const sVec2f & avAbsPos ) const

pure virtual

Get a node from an absolute position.

virtual eWidgetTreeNodeDropMode GetNodeDropMode	(	iWidgetTreeNode *	apNode,
		const sVec2f &	avAbsPos
	)		const

pure virtual

Get the drop mode of the specified node from the specified absolute position.

virtual void SetSecondarySelection ( iWidgetTreeNode * apNode )

pure virtual

Set the secondary selection item. {Property}.

virtual iWidgetTreeNode* GetSecondarySelection ( ) const

pure virtual

Get the secondary selection item. {Property}.

virtual iWidgetTreeNode* GetPivotSelection ( ) const

pure virtual

Get the pivot selection. {Property}.

virtual void ScrollToNode ( iWidgetTreeNode * apNode )

pure virtual

Scroll to the specified item node. {Propety}.

virtual tBool SaveTreeStates ( iDataTable * apStates )

pure virtual

Save tree states.

Remarks: Tree states are the expanded status, selected status and scrolling.

virtual tBool LoadTreeStates	(	iDataTable *	apStates,
		ni::tBool	abLoadMatchingNames
	)

pure virtual

Load tree states.

virtual tBool PushStates ( )

pure virtual

Push the tree's states.

virtual tBool PopStates ( ni::tBool abLoadMatchingNames )

pure virtual

Pop the tree's states.

virtual void SetNumVisibleAttributes ( tU32 anCount )

pure virtual

Set the number of visible attributes. {Property}.

virtual tU32 GetNumVisibleAttributes ( ) const

pure virtual

Get the number of visible attributes. {Property}.

virtual void SetAttributeIcon	(	tU32	anIndex,
		iOverlay *	apIcon
	)

pure virtual

Set the specified attribute's icon. {Property}.

virtual iOverlay* GetAttributeIcon ( tU32 anIndex ) const

pure virtual

Get the specified attribute's icon. {Property}.

virtual void SetAttributeName	(	tU32	anIndex,
		iHString *	ahspName
	)

pure virtual

Set the specified attribute's name. {Property}.

virtual iHString* GetAttributeName ( tU32 anIndex ) const

pure virtual

Get the specified attribute's name. {Property}.

virtual tBool SetHoverNode ( tU32 anNodeTreeIndex )

pure virtual

Set the hover node. {Property}.

Remarks: The id should be the node's tree index.

virtual tU32 GetHoverNode ( ) const

pure virtual

Get the hover node. {Property}.

Remarks: The id is the node's tree index.

Detailed Description

Public Member Functions

Member Function Documentation