From b693b70363d825501e8346f5e11401c93dcb98ac Mon Sep 17 00:00:00 2001 From: dsiders Date: Mon, 6 Mar 2023 01:59:06 +0000 Subject: [PATCH] Docs: LazControls/treefilteredit. Updates content in topics, including: * TImageIndexEvent * TFilterNodeEvent * TTreeFilterBranch.AddNodeData * TTreeFilterBranch.Items --- .../lazcontrols/docs/treefilteredit.xml | 78 ++++++++++++++++--- 1 file changed, 66 insertions(+), 12 deletions(-) diff --git a/components/lazcontrols/docs/treefilteredit.xml b/components/lazcontrols/docs/treefilteredit.xml index d564e6d592..750d8f2a8f 100644 --- a/components/lazcontrols/docs/treefilteredit.xml +++ b/components/lazcontrols/docs/treefilteredit.xml @@ -19,21 +19,55 @@ is part of the LazControls package. - - - + +Specifies an event handler used to get the position of the image for a tree node. + + +

+TImageIndexEvent is an Integer object function type +which specifies an event handler signalled to get the position for an image +associated with a tree node in a tree view control. Arguments passed to the +object method indicates the text for the tree node, it data, and its enabled +state in the tree. +

+

+The return value contains the ordinal position for the image selected for a +tree node. It is stored in both the ImageIndex and SelectedIndex properties +for the TTreeNode instance. +

+

+TImageIndexEvent is the type used to implement the OnGetImageIndex event +handler in the TTreeFilterEdit control. The event is signalled when +TTreeFilterBranch sorts, filters and displays the tree nodes on its +TTreeFilterEdit and TTreeView controls. +

+
+ + + + +
- + +Ordinal position for the image selected for a tree node in the event handler +routine. + - + +Text for the tree node used in the event handler. + - + +Object reference with the data for the tree node. + - + +Returns True if the tree node is enabled. + @@ -115,13 +149,19 @@ Text, a data reference, and an associated file name can be added for the node. - + +Text for the tree node data. + - + +Object reference with the user-specified data for the tree node. + - + +Full file path and name for a tree node used in a directory hierarchy. + @@ -234,9 +274,23 @@ Ordinal position where tree node data is relocated in the method. - + +Contains the original tree node data for the class instance. + - +

+Items is a read-only TStringList property which contains +the original data displayed for a branch in a filtered tree view control. It +contains data for the tree nodes stored using AddNodeData, and maintained +using GeteData / DeleteData / FreeNodeData / ClearNodeData. Items is used when +the tree nodes are sorted and filtered in the class instance. +

+ + + + + +