diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index 48d64ad064..8eeea4b5a1 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -15160,9 +15160,6 @@ Set Wrapable to text to allow a new row or column to be created when the cumulative button width is larger than the width for the tool bar. Or set the Wrap property in a specific tool button to True to force it and subsequent controls onto a new row or column.

- - This topic needs some work. - @@ -17425,7 +17422,8 @@ AToolbar.ButtonHeight := 30; - Code comments say its not used. It is used in MouseUp. Also says it is defined but not used in VCL. Is that correct? + Code comments say its not used. It is used in MouseUp. + Also says it is defined but not used in VCL. It is documented, so apparently used in VCL. @@ -20516,7 +20514,11 @@ AToolbar.ButtonHeight := 30; Implements an enumerator for items in the TTreeNodes container. - + +

+ Implements the Current property and MoveNext method used to navigate the tree nodes in the container. The nodes in the container are passed as an argument to the Create constructor. +

+ @@ -20581,7 +20583,7 @@ AToolbar.ButtonHeight := 30; - PNodeCache - pointer to TNodeCache. + PNodeCache - pointer to TNodeCache type. @@ -20596,13 +20598,13 @@ AToolbar.ButtonHeight := 30; - + Member with the TTreeNode instance for the cache entry. - + Ordinal position for the tree node in the cache storage. @@ -20688,25 +20690,35 @@ AToolbar.ButtonHeight := 30; - InternalAddObject - method for adding text of data within the structure of the current node; returns the value of the new updated node. + Creates or updates a tree node with the specified text and a pointer to data. - + +

+ Expands the parent for the Node (when assigned). Updates the accessibility role, description, and value when enabled in the tree view which owns the container. Updates the scroll bars for the tree view control prior to exit. +

+

+ Used in the implementation of methods like: AddNode, AddObject, Insert, AddChildObject, et. al. +

+ + + Raises an ETreeNodeError exception if the Owner for the container (the tree view control) has not been assigned. + - + TTreeNode instance created or updated in the method. - + An existing tree node to update, or Nil to create a new tree node. - + Text for the tree node. - + Pointer to the data for the tree node. - + Position in the tree hierarchy where the node is stored. @@ -20715,7 +20727,9 @@ AToolbar.ButtonHeight := 30; - + + TFiler instance used to read or write properties for the class instance during LCL streaming. + @@ -20812,7 +20826,7 @@ AToolbar.ButtonHeight := 30; - Adds a node tree with the specified text as a child of the specified parent node. + Adds a tree node with the specified text as a child of the specified parent node. @@ -22452,9 +22466,13 @@ AToolbar.ButtonHeight := 30; - GetNodeAtY - returns the node at the specified vertical coordinate. + Gets an expanded node at the specified vertical coordinate. - + +

+ Used in the implementation of the GetNodeAt, GetNodeWithExpandSignAt, GetInsertMarkAt, and GetHitTestInfoAt methods. +

+ @@ -22464,19 +22482,27 @@ AToolbar.ButtonHeight := 30; - - - + + Gets an expanded tree node for the specified screen coordinates. + +

+ Used to implement the EnsureNodeIsVisible method. +

+ - - + + The expanded tree node found at the vertical coordinate, or Nil when a node is not found. - - + + + Horizontal coordinate used to detected the border, expand indicator, or display text for the tree node. + - - + + + Vertical coordinate for the expanded node to locate in the node hierarchy. + @@ -22485,7 +22511,7 @@ AToolbar.ButtonHeight := 30; - + Calculated usable client height after borders are removed. @@ -22494,7 +22520,7 @@ AToolbar.ButtonHeight := 30; - + Calculated usable client width after borders are removed. @@ -22503,7 +22529,7 @@ AToolbar.ButtonHeight := 30; - True when Indent has a value other than the default (-1). + True when Indent has a value other than the default value (-1). @@ -22659,44 +22685,60 @@ AToolbar.ButtonHeight := 30; - Performs actions needed when mouse is clicked on a tree node in the control. + Performs actions needed when the Left mouse is clicked on the tree view control.

- Click is an overridden method in TCustomTreeView. It calls the inherited method when a tree node has been selected using a mouse down event. No actions are performed in the method when a tree node has not been selected using the mouse. + Click is an overridden method in TCustomTreeView. It calls the inherited method when the mouse event occurs on a node with an expand / collapse indicator. Click is called when the mouse up event is handled for the corresponding mouse down event.

+ + TControl.Click - Performs actions needed when the Left mouse button is double clicked on a selected tree node. + Performs actions needed when the Left mouse button is double clicked on the tree view control.

- DblClick is an overridden method in TCustomTreeView. It calls the inherited method when a tree node has been double clicked using the mouse. No actions are performed in the method when a tree node has not been selected and a double click event occurs. + DblClick is an overridden method in TCustomTreeView. It calls the inherited method when the mouse event occurs on a node with an expand / collapse indicator. DblClick is called when the mouse up event is handled for the corresponding mouse down event.

+ + TControl.DblClick - - - + + Performs actions needed when the Left mouse is triple clicked on the tree view control. + +

+ TripleClick is an overridden method in TCustomTreeView. It calls the inherited method when the mouse event occurs on a node with an expand / collapse indicator. TripleClick is called when the mouse up event is handled for the corresponding mouse down event. +

+ + + TControl.TripleClick - - - + + Performs actions needed when the Left mouse is quadruple clicked on the tree view control. + +

+ QuadClick is an overridden method in TCustomTreeView. It calls the inherited method when the mouse event occurs on a node with an expand / collapse indicator. QuadClick is called when the mouse up event is handled for the corresponding mouse down event. +

+ + + TControl.QuadClick @@ -22732,7 +22774,9 @@ AToolbar.ButtonHeight := 30; Signals the OnCreateNodeClass event handler (when assigned). - Signals the OnCreateNodeClass event handler (when assigned). +

+ Signals the OnCreateNodeClass event handler (when assigned). +

@@ -22741,13 +22785,15 @@ AToolbar.ButtonHeight := 30; - + Performs actions needed when a drag operation is completed for the control.

- Ensures that the previous drop target is reset, and that the drag scroll timer is disabled. Restores the Tooltips to their previous values. + DoEndDrag is an overridden method used to perform actions needed when a drag operation is completed for the control. DoEndDrag calls the inherited method on entry to signal the OnEndDrag event handler (when assigned). DoEndDrag ensures that the previous drop target is reset, and that the drag scroll timer is disabled. Tooltips are restored to their previous values.

- + + TControl.DoEndDrag + @@ -22874,19 +22920,33 @@ AToolbar.ButtonHeight := 30; Tree node rendered in the method. - - + + Performs actions needed when a drag operation is started for the control. - + + TControl.DoStartDrag + - + TDragObject instance for the drag and drop operation. - - - - + + Performs actions needed when an object is dragged over the tree view control. + +

+ DragOver is an overridden method in TCustomTreeView used to perform actions needed when an object is dragged over the tree view control. DragOver calls the inherited method on entry to get the initial value for the Accept argument and signal the OnDragOver event handler (when assigned). The event handler is used to determine whether a drop can be accepted for the specified object instance. If the event handler has not been aasigned, Accept is set False. +

+

+ DragOver checks for a tree node at the coordinates in X and Y, and checks whether the node is DropTarget for the control. If the node is different than the DropTarget for the control, the DropTarget property in the TTreeNode instance is set to True. +

+ + + + + TControl.DragOver + TControl.OnDragOver + @@ -23029,10 +23089,16 @@ AToolbar.ButtonHeight := 30; - - - - + + Configures the control when its window handle is (re-)initialized. + +

+ InitializeWnd is called after the Handle has been created, and before the missing child handles are created. Calls the inherited method on entry to assign the Handle and and its control flags, and synchronize values in the widgetset class instance. InitializeWnd calls the UpdateDefaultItemHeight method to update property values when tvoAutoItemHeight has been included in the Options for the control. +

+ + + TWinControl.InitializeWnd + @@ -23108,10 +23174,19 @@ AToolbar.ButtonHeight := 30; Shift, Ctrl, Alt modifier for the key code. - - - - + + Performs actions needed when LCL component streaming has been completed. + +

+ Loaded is an overridden method in TCustomTreeView, and calls the inherited method on entry. AT design-time, the FullExpand method is called to expand all of the tree nodes on the control. The UpdateDefaultItemHeight method is called to set property values when tvoAutoItemHeight has been included in the Options for the control. +

+

+ Loaded is called when the control has been loaded from a resource, transfers the loaded property values to the widget. +

+ + + TWinControl.Loaded + @@ -23433,11 +23508,6 @@ AToolbar.ButtonHeight := 30;
Ends scroll bar message handling.
 - - - (?) Using client / item height instead of client / item width. Is that correct? - -