[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'ComCtrls' (#lcl)

TTreeNodes

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

A collection or list of TTreeNode

Declaration

Source position: comctrls.pp line 2233

type TTreeNodes = class(TPersistent)

protected

  function InternalAddObject();

  

InternalAddObject - method for adding text of data within the structure of the current node; returns the value of the new updated node

  procedure DefineProperties(); override;

  

  function GetCount;

  

GetCount - returns the number of nodes in the collection

  function GetOwner; override;

  procedure SetItem();

  

SetItem - method for recording details of specified node

  procedure SetUpdateState();

  

SetUpdateState - records status of update process

public

  constructor Create();

  

Create - constructor for TTreeNodes: calls inherited Create

  destructor Destroy; override;

  

Destroy - destructor for TTreeNodes: calls inherited Destroy

  function Add();

  

Add - adds a sibling node with specified text string, and returns the new node

  function AddChild();

  

AddChild - adds a child node with specified text to the parent node, and returns the new node

  function AddChildFirst();

  

AddChildFirst - adds a node with specified text as the first child of the parent node, and returns the new node

  function AddChildObject();

  

AddChildObject - adds a child node with specified text and data-pointer to the parent node and returns the new node

  function AddChildObjectFirst();

  

AddChildObjectFirst - adds a node with specified text and data as the first child of the parent node, and returns the new node

  function AddFirst();

  

AddFirst - adds a node with specified text as the first node in the same level as SiblingNode. and returns the new node

  function AddObject();

  

AddObject - adds a node with specified text and data-pointer in the same level as SiblingNode. and returns the new node

  function AddObjectFirst();

  

AddObjectFirst - adds a node with specified text and data-pointer as the first node in the same level as SiblingNode. and returns the new node

  procedure Assign(); override;

  

Assign - if Source is of correct type, copies properties directly, otherwise calls inherited Assign which probably raises an exception

  procedure BeginUpdate;

  

BeginUpdate - start the update process

  procedure Clear;

  

Clear the current node

  procedure ClearMultiSelection();

  

ClearMultiSelection - clears a series of nodes in a multi-selection (provided the selection has not already been cleared)

  procedure SelectOnlyThis();

  

SelectOnlyThis - method for selecting only the indicated node

  function IsMultiSelection;

  

IsMultiSelection - returns True if this node is part if a multi-selection

  procedure Delete();

  

Delete this node

  procedure EndUpdate;

  

EndUpdate - finish the update process

  function GetEnumerator;

  function GetFirstNode;

  

GetFirstNode - returns the first node in the collection

  function GetLastNode;

  

GetLastNode - last top level node

  function GetLastSubNode;

  

GetLastSubNode - absolute last node

  function GetLastExpandedSubNode;

  

GetLastExpandedSubNode - absolute last node

  function GetSelections();

  function FindTopLvlNode();

  

FindTopLvlNode - returns a top level node containing the specified text string

  function FindNodeWithText();

  

FindNodeWithText - returns a node containing the specified text string

  function FindNodeWithData();

  

FindNodeWithData - returns a node containing the specified data pointer

  function Insert();

  

Insert a node with the specified text just before the specified Next node, and returns the new node

  function InsertObject();

  

InsertObject - inserts a new node with specified text and data just before the specified Next node, and returns the new node

  function InsertBehind();

  

InsertBehind - inserts a new node with specified text just behind specified Previous node, and returns the new node

  function InsertObjectBehind();

  

InsertObjectBehind - inserts a new node with specified text and data-pointer just behind specified Previous node, and returns the new node

  procedure SelectionsChanged();

  procedure SortTopLevelNodes();

  

SortTopLevelNodes - sorts the top level nodes, using the specified comparison method

  procedure ConsistencyCheck;

  

ConsistencyCheck - makes sure all references to and from the nodes are consistent

  procedure WriteDebugReport();

  

WriteDebugReport - for debugging

  property Count: Integer; [r]

  

Count - the number of nodes in the collection

  property Item: TTreeNode; default; [r]

  

Item - finds the node corresponding to the given index

  property KeepCollapsedNodes: Boolean; [rw]

  

KeepCollapsedNodes - if True, preserves the nodes that have been collapsed

  property Owner: TCustomTreeView; [r]

  

Owner - the TTreeView that owns the collection of nodes

  property SelectionCount: Cardinal; [r]

  property TopLvlCount: Integer; [r]

  

TopLvlCount - the number of nodes at the top level of the tree structure

  property TopLvlItems: TTreeNode; [rw]

  

TopLvlItems - the list of nodes at the top level of the tree structure

end;

Inheritance

TTreeNodes

  

A collection or list of TTreeNode

|

TPersistent

|

TObject

The latest version of this document can be found at lazarus-ccr.sourceforge.net.