TTreeNode.GetNextVisibleSibling function
Gets the next visible node at the same level in the node tree.
Declaration
function GetNextVisibleSibling(aEnabledOnly: Boolean=False): TTreeNodeArguments
aEnabledOnly | True if the sibling node must also be enabled. False if Enabled is not examined. |
Function result
Next visible sibling node in the tree hierarchy, or Nil when a sibling node is not found.
Description
GetNextVisibleSibling is a
TTreeNode function used to
locate the next sibling node that has its Visible and Expanded properties
enabled. A sibling node is one which exists at the same Level as the current
node in the node hierarchy; in other words, it is one of the child nodes in
the Parent for the current node.
AEnabledOnly indicates whether the node in the return value must also have its Enabled property set. The default value (False) indicates that the Enabled property for the node is not examined.
GetNextVisibleSibling calls GetNextSibling to start the search for a visible sibling node with the required node states. The return value is Nil if there are no sibling nodes after the current node, or a sibling node with the required node states was not found.
GetNextVisibleSibling is used in TTreeNode methods like BottomExpanded, GetNextVisible, GetNextExpanded, and GetFirstVisibleChild. It is also called from methods like TTreeNodes.MultiSelect and TCustomTreeview.DoPaintNode when a tree node is selected or drawn on the TreeView control.
Modified in LCL version 3.0. Refactored to include the AEnabledOnly argument.
See also
An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.