iWidgetTreeNode Struct Reference

Inheritance diagram for iWidgetTreeNode:

Detailed Description

Widget tree node interface.

Nodes
virtual iWidget *	GetParentWidget () const =0
	Get the parent widget tree. {Property}. More...
virtual iWidgetTreeNode *	GetParentNode () const =0
	Get the parent node. More...
virtual sRectf	GetNodeRect () const =0
	Get the node's rectangle. More...
virtual sRectf	GetScrolledNodeRect () const =0
	Get the node's scrolled rectangle. More...
virtual sRectf	GetAbsoluteNodeRect () const =0
	Get the node's absolute rectangle. More...
virtual sRectf	GetTextRect () const =0
	Get the node's text rectangle. More...
virtual sRectf	GetScrolledTextRect () const =0
	Get the node's scrolled text rectangle. More...
virtual sRectf	GetAbsoluteTextRect () const =0
	Get the node's absolute rectangle. More...
virtual tU32	GetIndex () const =0
	Get the node index. {Property}. More...
virtual tU32	GetTreeIndex () const =0
	Get the tree index. {Property}. More...
virtual tU32	GetNumChildNodes () const =0
	Get the number of child nodes. {Property}. More...
virtual iWidgetTreeNode *	GetChildNode (tU32 anIndex) const =0
	Get the child node at the specified index. {Property}. More...
virtual tU32	GetChildNodeIndex (const iWidgetTreeNode *apNode) const =0
	Get the index of the specified child node. {Property}. More...
virtual iWidgetTreeNode *	GetChildNodeFromName (const achar *aaszName) const =0
	Get the first child node with the specified name. {Property}. More...
virtual iWidgetTreeNode *	AddChildNode (const achar *aaszName)=0
	Add a new child node. More...
virtual iWidgetTreeNode *	AddChildNodeBefore (const achar *aaszName, tU32 anIndex)=0
	Add a new child node before the specified index. More...
virtual tBool	RemoveChildNode (iWidgetTreeNode *apNode)=0
	Remove a child node. More...
virtual tBool	Clear ()=0
	Remove all children. More...
virtual iWidgetTreeNode *	FindNodeFromName (const achar *aaszName) const =0
	Find the first node with the specified name. More...
virtual iWidgetTreeNode *	FindNodeFromUserdata (const iUnknown *apUserdata) const =0
	Find the first node with the specified userdata. More...
virtual iWidgetTreeNode *	FindNodeFromWidget (const iWidget *apWidget) const =0
	Find the first node with the specified widget. More...
virtual iWidgetTreeNode *	FindNodeFromPosition (const sVec2f &avPos) const =0
	Find the node that is below the specified position, position in absolute coordinates. More...
virtual iWidgetTreeNode *	GetPrevSibling () const =0
	Get the previous sibiling of this tree node. {Property}. More...
virtual iWidgetTreeNode *	GetNextSibling () const =0
	Get the next sibiling of this tree node. {Property}. More...
virtual iWidgetTreeNode *	GetAbove () const =0
	Get the node above of this node, can be in another parent node. {Property}. More...
virtual iWidgetTreeNode *	GetBelow () const =0
	Get the node below of this node, can be in another parent node. {Property}. More...

Properties
virtual tBool	SetFlags (tWidgetTreeNodeFlags aFlags)=0
	Set the node's flags. {Property}. More...
virtual tWidgetTreeNodeFlags	GetFlags () const =0
	Get the node's flags. {Property}. More...
virtual tBool	SetName (const achar *aVal)=0
	Set the node's name. {Property}. More...
virtual const achar *	GetName () const =0
	Get the node's name. {Property}. More...
virtual tBool	SetIcon (iOverlay *aVal)=0
	Set the node's icon {Property}. More...
virtual iOverlay *	GetIcon () const =0
	Get the node's icon {Property}. More...
virtual tBool	SetSelected (tBool abSelected)=0
	Set the node's selected status. {Property}. More...
virtual tBool	GetSelected () const =0
	Get the node's selected status. {Property}. More...
virtual tBool	SetExpanded (tBool abExpanded)=0
	Set the node's expanded status. {Property}. More...
virtual tBool	GetExpanded () const =0
	Get the node's expanded status. {Property}. More...
virtual tBool	SetUserdata (iUnknown *apUserData)=0
	Set the node's user data. {Property}. More...
virtual iUnknown *	GetUserdata () const =0
	Get the node's user data. {Property}. More...
virtual tBool	SetWidget (iWidget *apWidget)=0
	Set the node's widget. {Property}. More...
virtual iWidget *	GetWidget () const =0
	Get the node's widget. {Property}. More...
virtual void	SetTextColor (tU32 anColor)=0
	Set the text foreground color. {Property}. More...
virtual tU32	GetTextColor () const =0
	Get the text foreground color. {Property}. More...
virtual void	SetTextBackColor (tU32 anColor)=0
	Set the text background color. {Property}. More...
virtual tU32	GetTextBackColor () const =0
	Get the text background color. {Property}. More...
virtual void	SetRowColor (tU32 anRow)=0
	Set an explicit row background color. {Property}. More...
virtual tU32	GetRowColor () const =0
	Get an explicit row background color. {Property}. More...

Attributes
virtual void	SetAttributes (tU32 anAttributes)=0
	Set the node's attributes. {Property}. More...
virtual tU32	GetAttributes () const =0
	Get the node's attributes. {Property}. More...
virtual void	SetVisibleAttributesMask (tU32 anAttributes)=0
	Set the visible attributes mask. {Property}. More...
virtual tU32	GetVisibleAttributesMask () const =0
	Set the visible attributes mask. {Property}. More...

Additional Inherited Members
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 iWidget* GetParentWidget ( ) const

pure virtual

Get the parent widget tree. {Property}.

virtual iWidgetTreeNode* GetParentNode ( ) const

pure virtual

Get the parent node.

Remarks

NULL if root node. {Property}

virtual sRectf GetNodeRect ( ) const

pure virtual

Get the node's rectangle.

Remarks

Zero if the node is not visible. {Property}

virtual sRectf GetScrolledNodeRect ( ) const

pure virtual

Get the node's scrolled rectangle.

Remarks

Zero if the node is not visible. {Property}

virtual sRectf GetAbsoluteNodeRect ( ) const

pure virtual

Get the node's absolute rectangle.

Remarks

Zero if the node is not visible. {Property}

virtual sRectf GetTextRect ( ) const

pure virtual

Get the node's text rectangle.

Remarks

Zero if the node is not visible. {Property}

virtual sRectf GetScrolledTextRect ( ) const

pure virtual

Get the node's scrolled text rectangle.

Remarks

Zero if the node is not visible. {Property}

virtual sRectf GetAbsoluteTextRect ( ) const

pure virtual

Get the node's absolute rectangle.

Remarks

Zero if the node is not visible. {Property}

virtual tU32 GetIndex ( ) const

pure virtual

Get the node index. {Property}.

virtual tU32 GetTreeIndex ( ) const

pure virtual

Get the tree index. {Property}.

virtual tU32 GetNumChildNodes ( ) const

pure virtual

Get the number of child nodes. {Property}.

virtual iWidgetTreeNode* GetChildNode ( tU32  anIndex ) const

pure virtual

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

virtual tU32 GetChildNodeIndex ( const iWidgetTreeNode *  apNode ) const

pure virtual

Get the index of the specified child node. {Property}.

Remarks

Return eInvalidHandle if the specified node isnt a child of this node.

virtual iWidgetTreeNode* GetChildNodeFromName ( const achar *  aaszName ) const

pure virtual

Get the first child node with the specified name. {Property}.

Remarks

This function will search in the children nodes as well.

virtual iWidgetTreeNode* AddChildNode ( const achar *  aaszName )

pure virtual

Add a new child node.

virtual iWidgetTreeNode* AddChildNodeBefore ( const achar *  aaszName, tU32  anIndex  )

pure virtual

Add a new child node before the specified index.

Remarks

If the index is out of range it behaves like AddChildNode (aka add a node at the end)

virtual tBool RemoveChildNode ( iWidgetTreeNode *  apNode )

pure virtual

Remove a child node.

Remarks

This function will search in the children nodes as well.

virtual tBool Clear ( )

pure virtual

Remove all children.

virtual iWidgetTreeNode* FindNodeFromName ( const achar *  aaszName ) const

pure virtual

Find the first node with the specified name.

Remarks

This include this node.

virtual iWidgetTreeNode* FindNodeFromUserdata ( const iUnknown *  apUserdata ) const

pure virtual

Find the first node with the specified userdata.

Remarks

This include this node.

virtual iWidgetTreeNode* FindNodeFromWidget ( const iWidget *  apWidget ) const

pure virtual

Find the first node with the specified widget.

Remarks

This include this node.

virtual iWidgetTreeNode* FindNodeFromPosition ( const sVec2f &  avPos ) const

pure virtual

Find the node that is below the specified position, position in absolute coordinates.

Remarks

This include this node.

virtual iWidgetTreeNode* GetPrevSibling ( ) const

pure virtual

Get the previous sibiling of this tree node. {Property}.

Remarks

Return NULL if it's the first child of its parent.

virtual iWidgetTreeNode* GetNextSibling ( ) const

pure virtual

Get the next sibiling of this tree node. {Property}.

Remarks

Return NULL if it's the last child of its parent.

virtual iWidgetTreeNode* GetAbove ( ) const

pure virtual

Get the node above of this node, can be in another parent node. {Property}.

Remarks

Return null if its the node the most above.

virtual iWidgetTreeNode* GetBelow ( ) const

pure virtual

Get the node below of this node, can be in another parent node. {Property}.

Remarks

Return null if its the node the most below.

virtual tBool SetFlags ( tWidgetTreeNodeFlags  aFlags )

pure virtual

Set the node's flags. {Property}.

virtual tWidgetTreeNodeFlags GetFlags ( ) const

pure virtual

Get the node's flags. {Property}.

virtual tBool SetName ( const achar *  aVal )

pure virtual

Set the node's name. {Property}.

virtual const achar* GetName ( ) const

pure virtual

Get the node's name. {Property}.

virtual tBool SetIcon ( iOverlay *  aVal )

pure virtual

Set the node's icon {Property}.

virtual iOverlay* GetIcon ( ) const

pure virtual

Get the node's icon {Property}.

virtual tBool SetSelected ( tBool  abSelected )

pure virtual

Set the node's selected status. {Property}.

Remarks

When set/unset selected the node's tree selection list will be automatically updated.

virtual tBool GetSelected ( ) const

pure virtual

Get the node's selected status. {Property}.

virtual tBool SetExpanded ( tBool  abExpanded )

pure virtual

Set the node's expanded status. {Property}.

virtual tBool GetExpanded ( ) const

pure virtual

Get the node's expanded status. {Property}.

virtual tBool SetUserdata ( iUnknown *  apUserData )

pure virtual

Set the node's user data. {Property}.

virtual iUnknown* GetUserdata ( ) const

pure virtual

Get the node's user data. {Property}.

virtual tBool SetWidget ( iWidget *  apWidget )

pure virtual

Set the node's widget. {Property}.

virtual iWidget* GetWidget ( ) const

pure virtual

Get the node's widget. {Property}.

virtual void SetTextColor ( tU32  anColor )

pure virtual

Set the text foreground color. {Property}.

virtual tU32 GetTextColor ( ) const

pure virtual

Get the text foreground color. {Property}.

virtual void SetTextBackColor ( tU32  anColor )

pure virtual

Set the text background color. {Property}.

virtual tU32 GetTextBackColor ( ) const

pure virtual

Get the text background color. {Property}.

virtual void SetRowColor ( tU32  anRow )

pure virtual

Set an explicit row background color. {Property}.

Remarks

Enabled if the color is different of 0x00000000

virtual tU32 GetRowColor ( ) const

pure virtual

Get an explicit row background color. {Property}.

virtual void SetAttributes ( tU32  anAttributes )

pure virtual

Set the node's attributes. {Property}.

virtual tU32 GetAttributes ( ) const

pure virtual

Get the node's attributes. {Property}.

virtual void SetVisibleAttributesMask ( tU32  anAttributes )

pure virtual

Set the visible attributes mask. {Property}.

Remarks

By default is 0xFFFFFFFF, all visible

virtual tU32 GetVisibleAttributesMask ( ) const

pure virtual

Set the visible attributes mask. {Property}.