diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index 49d46cbd5b..6700a3935a 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -9463,14 +9463,16 @@ cdsIndeterminate - + + ApplyChanges - implement any pending changes - + + DoChange - system message to implement changes @@ -9623,7 +9625,7 @@ cdsIndeterminate - + @@ -9797,7 +9799,7 @@ cdsIndeterminate - + @@ -9857,7 +9859,7 @@ cdsIndeterminate - + @@ -11119,7 +11121,8 @@ Const - + + Collapse - method for collapsing tree view to show only the main stems. Apply recursively if Recurse is True @@ -11130,7 +11133,8 @@ Const - + + CustomSort - if True, the customised sort method specified in SortProc is to be used @@ -11145,7 +11149,9 @@ Const - + + DefaultTreeViewSort + @@ -14790,7 +14796,8 @@ For the meaning of this options, see the documentation of TTreeView. - + + GetHitTestInfoAt - returns the result of a hit test at the point (X, Y) @@ -14809,7 +14816,8 @@ For the meaning of this options, see the documentation of TTreeView. - + + GetNodeAt - returns the TreeNode at position (X. Y) @@ -14881,7 +14889,8 @@ For the meaning of this options, see the documentation of TTreeView. - + + IsEditing - returns True if editing is in progress @@ -14892,7 +14901,8 @@ For the meaning of this options, see the documentation of TTreeView. - + + BeginUpdate - start the updae of the display @@ -14906,21 +14916,24 @@ For the meaning of this options, see the documentation of TTreeView. - + + FullCollapse - method to collapse the treeview fully, ie show just the root - + + FullExpand - method to expand the treeview fully, and show all the branches - + + LoadFromFile - load the data from the specified file @@ -14931,7 +14944,8 @@ For the meaning of this options, see the documentation of TTreeView. - + + LoadFromStream - load data from the specified stream @@ -14942,7 +14956,8 @@ For the meaning of this options, see the documentation of TTreeView. - + + SaveToFile - saves the data to the specified file @@ -14953,7 +14968,8 @@ For the meaning of this options, see the documentation of TTreeView. - + + SaveToStream - save the data to the specified stream @@ -14964,7 +14980,8 @@ For the meaning of this options, see the documentation of TTreeView. - + + WriteDebugReport - used for debugging @@ -14979,21 +14996,24 @@ For the meaning of this options, see the documentation of TTreeView. - + + LockSelectionChangeEvent - if the selection has changed, lock its status - + + UnlockSelectionChangeEvent - unlock a selection to allow it to be changed - + + GetFirstMultiSelected - returns the first node from a multiple selection @@ -15004,7 +15024,8 @@ For the meaning of this options, see the documentation of TTreeView. - + + SelectionVisible - returns True if a selection is visible @@ -15015,14 +15036,16 @@ For the meaning of this options, see the documentation of TTreeView. - + + MakeSelectionVisible - method for making a selection visible - + + BackgroundColor for the treeview @@ -15034,13 +15057,15 @@ For the meaning of this options, see the documentation of TTreeView. - + + BottomItem - the last item on the list - + + DefaultItemHeight - default height for items on the list @@ -15052,73 +15077,83 @@ For the meaning of this options, see the documentation of TTreeView. - + + ExpandSignType - the symbols to denote whether a list is expanded or collapsed; default is plus or minus - + + InsertMarkNode - place a marker on the specified node - + + InsertMarkType - the type of marker to be inserted - + + KeepCollapsedNodes - if True, the collapsed nodes are to be retained - + The set of Options for displaying the tree view - + + ScrollBars - the style of scroll bars for the treeview display - + The Selected tree nodes - + + SelectionColor - the colour to be used for the selected nodes, to distinguish them from the others - + + SeparatorColor - the colour to be used for separators - + + TopItem - the first node on the list - + + TreeLineColor - the colour to be used for the lines showing the tree structure - + + ExpandSignColor - the colour to be used for the expand/collapse symbols @@ -15140,110 +15175,112 @@ For the meaning of this options, see the documentation of TTreeView. - + - + + + AutoExpand - automatically expand the tree when an item is selected + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - - - - - - - + - + + HideSelection - the selected items are to be hidden @@ -15259,132 +15296,142 @@ For the meaning of this options, see the documentation of TTreeView. + + Indent - the amount by which each successive branching level is to be indented + + + + + - + - + - + - - - - - - - + - + + ReadOnly - the view can only be viewed, not written or modified - + + RightClickSelect - a right-click with the mouse automatically selects the item + + RowSelect - select a row + + + + + - - - - - - - + - + + ShowButtons - show the toolbuttons on the treeview - + - + + ShowLines - show the connecting lines of the tree structure - + + ShowRoot - show the root element of the tree - + + SortType - the type of sorting to be performed + + StateImages - the images used to depict the state of the tree (expanded or collapsed?) + + + + + - + - - - - - - - + - + + ToolTips - the popup hints that appear as the mouse hovers over an item - + @@ -15403,42 +15450,47 @@ For the meaning of this options, see the documentation of TTreeView. - + + OnChange - event handler for a change in the data - + + OnChanging - event handler for use during a change in the data - + - + + OnCollapsed - event handler when the tree is collapsed - + + OnCollapsing - event handler for use during the collapsing process - + + OnCompare - event handler for comparing entries - + @@ -15462,133 +15514,141 @@ For the meaning of this options, see the documentation of TTreeView. - + + + OnDeletion - event handler for deletion of an item + + + + + - - - - - - - + - + + OnEdited - event handler when an item has been edited + + OnEditing - event handler during the editing process + + + + + - + - - - - - - - + - + + OnExpanded - event handler when the tree has been expanded - + + OnExpanding - event handler while the tree is expanding - + + OnGetImageIndex - event handler for finding the index of an image + + OnGetSelectedIndex - event handler for finding the index of a selected item + + + + + - + - + - + - + - - - - - - - + + + OnSelectionChanged - event handler for a change in the items selected + + + + + - - - - - - - + @@ -15598,13 +15658,13 @@ For the meaning of this options, see the documentation of TTreeView. The Items to be displayed in the tree view - ie the actual data - + - + @@ -16106,6 +16166,72 @@ For the meaning of this options, see the documentation of TTreeView. + + + DefaultTreeViewSort - returns result of string comparison between names of Node1 and Node2 + + +

+ DefaultTreeViewSort compares the text of two TreeNodes and returns the following result: +

+
+
< 0
+
if Node1.Text<Node2.Text.
+
0
+
if Node1.Text=Node2.Text.
+
> 0
+
if Node1.Text>Node2.Text.
+
+

The comparision takes into account Ansi characters, i.e. it takes +care of strange accented characters. Contrary to , +the comparision is case sensitive. +

+
+
+ + + + CreateSection - method for creating a header section + + + + CreateSections - method for creating a collection of header sections + + + + + SectionClick - method for emulating the OnSectionClick event + + + + SectionResize - method for emulating the OnSectionResize event + + + + SectionTrack - method for emulating the OnSectionTrack event + + + + SectionSeparatorDblClick - method for emulating the OnSectionSeparatorDblClick event + + + + SectionEndDrag - method for emulating the OnSectionEndDrag event + + + + SectionDrag - method to emulate the OnSectionDrag event + + + + + + + + + UpdateState - bring the state of the control up-to-date + +