LavishGUI:lguitreenode (Data Type)

From Lavish Software Wiki
Jump to navigation Jump to search

Description

Object Type Vitals
lguitreenode
Defined By LavishGUI
Inherits none
Reduces To same as Handle
Variable Object Type none
Uses Sub-Types no
C/C++ Type LGUITree*

Members

  • int Handle: A handle to this node that may be used in lguitree.GetNode
  • string Text: The text displayed for this node
  • int TextColor: The text color for this node
  • lguitexture Image: The image displayed for this node in non-collapsible state
  • lguitexture ImageCollapsible: The image displayed for this node in collapsible state
  • lguitexture ImageCollapsed: The image displayed for this node in collapsed state
  • lguitreenode Parent: The parent node
  • lguitreenode Children: The first child node
  • lguitreenode Next: The next sibling
  • lguitreenode Previous: The previous sibling
  • bool Expanded: TRUE if this element is expanded
  • lguitree Tree: The tree containing this node
  • string GetMetadata[key]: Retrieves metadata for this node with the given key.
  • bool IsSelected: TRUE if this is the selected node
  • lguitreenode AddChild[text,color]: Adds a child with the given text and color (color is optional), at the end of the list of children
  • lguitreenode InsertSiblingBefore[text,color]: Adds a sibling with the given text and color (color is optional), before this node
  • lguitreenode InsertSiblingAfter[text,color]: Adds a sibling with the given text and color (color is optional), after this node

Methods

  • AddChild[text,color]: Adds a child with the given text and color (color is optional), at the end of the list of children
  • InsertSiblingBefore[text,color]: Adds a sibling with the given text and color (color is optional), before this node
  • InsertSiblingAfter[text,color]: Adds a sibling with the given text and color (color is optional), after this node
  • SetText[text]: Sets the text for this node
  • SetTextColor[color]: Sets the color for this node
  • Select: Causes this node to be the selected node
  • Remove: Removes this node and all of its children from the tree
  • RemoveChildren: Removes all children of this node
  • Expand: Expands this node
  • Collapse: Collapses this node
  • ToggleExpand: Toggles the expanded state (expands or collapses the node)
  • SetMetadata[key,value]: Adds metadata to this element, using the given key and value. The metadata value can later be retrieved with the GetMetadata member by passing the key.
  • UnsetMetadata[key]: Un-sets the metadata with this key.


Examples

See Also