Class TGUITreeViewNode

Description

Hierarchy

Fields

Methods

Properties

Unit

Irrlicht

Declaration

type TGUITreeViewNode = class(TReferenceCounted)

Description

Node for gui tree view.

Hierarchy

TInterfacedObject
TWrapper
TReferenceCounted
TGUITreeViewNode

Overview

Methods

	`function AddChildBack(const Text: StringType; const Icon: StringType = ''; ImageIndex: LongInt = -1; SelectedImageIndex: LongInt = -1; Data: Pointer = nil): TGUITreeViewNode; inline;`
	`function AddChildFront(const Text: StringType; const Icon: StringType = ''; ImageIndex: LongInt = -1; SelectedImageIndex: LongInt = -1; Data: Pointer = nil): TGUITreeViewNode; inline;`
	`function DeleteChild(Child: TGUITreeViewNode): Boolean; inline;`
	`function GetFirstChild: TGUITreeViewNode; inline;`
	`function GetIcon: StringType; inline;`
	`function GetLastChild: TGUITreeViewNode; inline;`
	`function GetNextSibling: TGUITreeViewNode; inline;`
	`function GetNextVisible: TGUITreeViewNode; inline;`
	`function GetOwner: TGUIElement; inline;`
	`function GetParent: TGUITreeViewNode; inline;`
	`function GetPrevSibling: TGUITreeViewNode; inline;`
	`function InsertChildAfter(Other: TGUITreeViewNode; const Text: StringType; const Icon: StringType = ''; ImageIndex: LongInt = -1; SelectedImageIndex: LongInt = -1; Data: Pointer = nil): TGUITreeViewNode; inline;`
	`function InsertChildBefore(Other: TGUITreeViewNode; const Text: StringType; const Icon: StringType = ''; ImageIndex: LongInt = -1; SelectedImageIndex: LongInt = -1; Data: Pointer = nil): TGUITreeViewNode; inline;`
	`function MoveChildDown(Child: TGUITreeViewNode): Boolean; inline;`
	`function MoveChildUp(Child: TGUITreeViewNode): Boolean; inline;`
	`procedure ClearChildren; inline;`

Properties

	`property ChildCount: LongWord read GetChildCount;`
	`property Data: Pointer read GetData write SetData;`
	`property Expanded: Boolean read GetExpanded write SetExpanded;`
	`property HasChildren: Boolean read GetHasChildren;`
	`property ImageIndex: LongWord read GetImageIndex write SetImageIndex;`
	`property IsRoot: Boolean read GetIsRoot;`
	`property Level: LongInt read GetLevel;`
	`property Selected: Boolean read GetSelected write SetSelected;`
	`property SelectedImageIndex: LongWord read GetSelectedImageIndex write SetSelectedImageIndex;`
	`property Text: StringType read GetText write SetText;`
	`property Visible: Boolean read IsVisible;`

Description

Methods

function AddChildBack(const Text: StringType; const Icon: StringType = ''; ImageIndex: LongInt = -1; SelectedImageIndex: LongInt = -1; Data: Pointer = nil): TGUITreeViewNode; inline;

Adds a new node after the last child node.

Parameters

Text: Of the new node
Icon: Text of the new node
ImageIndex: Index of the image for the new node (-1 = none)
SelectedImageIndex: Index of the selected image for the new node (-1 = same as imageIndex)
Data: User data pointer of the new node

Returns

The new node.

function AddChildFront(const Text: StringType; const Icon: StringType = ''; ImageIndex: LongInt = -1; SelectedImageIndex: LongInt = -1; Data: Pointer = nil): TGUITreeViewNode; inline;

Adds a new node before the first child node.

Parameters

Text: Of the new node
Icon: Text of the new node
ImageIndex: Index of the image for the new node (-1 = none)
SelectedImageIndex: Index of the selected image for the new node (-1 = same as imageIndex)
Data: User data pointer of the new node

Returns

The new node.

function DeleteChild(Child: TGUITreeViewNode): Boolean; inline;

Deletes a child node.

Returns

True if the node was found as a child and is deleted.

	`function GetFirstChild: TGUITreeViewNode; inline;`
Returns the first child node, if any, else nil.

	`function GetIcon: StringType; inline;`
Returns the node's icon string.

	`function GetLastChild: TGUITreeViewNode; inline;`
Returns the last child node, if any, else nil.

	`function GetNextSibling: TGUITreeViewNode; inline;`
Returns the node following this one in the parent node's children list.

	`function GetNextVisible: TGUITreeViewNode; inline;`
Returns the next visible node. A node is visible when all it's parents are expanded. This function may be used to traverse a tree like using the "up" or "down" arrows.

	`function GetOwner: TGUIElement; inline;`
Returns the owning GUITreeView.

	`function GetParent: TGUITreeViewNode; inline;`
Returns the parent node, or nil if this is the root node.

	`function GetPrevSibling: TGUITreeViewNode; inline;`
Returns the node preceding this one in the parent node's children list.

function InsertChildAfter(Other: TGUITreeViewNode; const Text: StringType; const Icon: StringType = ''; ImageIndex: LongInt = -1; SelectedImageIndex: LongInt = -1; Data: Pointer = nil): TGUITreeViewNode; inline;

Adds a new node after another one.

Parameters

Other: The node to insert after.
Text: Of the new node
Icon: Text of the new node
ImageIndex: Index of the image for the new node (-1 = none)
SelectedImageIndex: Index of the selected image for the new node (-1 = same as imageIndex)
Data: User data pointer of the new node

Returns

The new node.

function InsertChildBefore(Other: TGUITreeViewNode; const Text: StringType; const Icon: StringType = ''; ImageIndex: LongInt = -1; SelectedImageIndex: LongInt = -1; Data: Pointer = nil): TGUITreeViewNode; inline;

Adds a new node before another one.

Parameters

Other: The node to insert after.
Text: Of the new node
Icon: Text of the new node
ImageIndex: Index of the image for the new node (-1 = none)
SelectedImageIndex: Index of the selected image for the new node (-1 = same as imageIndex)
Data: User data pointer of the new node

Returns

The new node.

function MoveChildDown(Child: TGUITreeViewNode): Boolean; inline;

Moves a child node down by one position.

Returns

True if the node was found as a child node and was not already the last child.

function MoveChildUp(Child: TGUITreeViewNode): Boolean; inline;

Moves a child node up by one position.

Returns

True if the node was found as a child node and was not already the first child.

	`procedure ClearChildren; inline;`
Removes all childs (recursive) from this node.

Properties

	`property ChildCount: LongWord read GetChildCount;`
The number of child nodes.

	`property Data: Pointer read GetData write SetData;`
The user `data` pointer of this node. This pointer is never dereferenced and may therefore safely contain a casted Integer.

	`property Expanded: Boolean read GetExpanded write SetExpanded;`
Specifies whether the node is `expanded` and its children are visible.

	`property HasChildren: Boolean read GetHasChildren;`
Tells whether this node has any children.

	`property ImageIndex: LongWord read GetImageIndex write SetImageIndex;`
The index of this node's image in the TreeView's image list.

	`property IsRoot: Boolean read GetIsRoot;`
Tells whether this node is a root node.

	`property Level: LongInt read GetLevel;`
The `level` of this node in the owning TreeView's hierarchy. The root node has `level` 0.

	`property Selected: Boolean read GetSelected write SetSelected;`
Specifies whether this node is currently `selected`.

	`property SelectedImageIndex: LongWord read GetSelectedImageIndex write SetSelectedImageIndex;`
The index of this node's "selected" image in the TreeView's image list.

	`property Text: StringType read GetText write SetText;`
The node's caption.

	`property Visible: Boolean read IsVisible;`
True if this node is `visible` (all parents are expanded)

Generated by PasDoc 0.12.1 on 2012-09-14 17:32:22