Vcl.Outline.TOutlineNode.GetNextChild

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetNextChild(Value: LongInt): LongInt;

C++

int __fastcall GetNextChild(int Value);

Properties

Type Visibility Source Unit Parent
function public
Vcl.Outline.pas
Vcl.Outline.hpp
Vcl.Outline TOutlineNode

Description

Returns the Index value of the next child of an outline node.

Call GetNextChild to obtain the index of the next immediate descendant of a node, following the child node with the index given by the Value parameter. If the child node indicated by Value has no next sibling, or if the child node indicated by Value is not an immediate descendant of the outline node, GetNextChild returns -1.

Index values reflect a depth-first traversal of the outline. Thus, the node returned by GetNextChild is not simply the node with an index of Value+1, unless the node with index Value has no descendants. GetNextChild allows a breadth-first traversal of the outline.

See Also