diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml
index 053ead378a..4cdc19242c 100644
--- a/docs/xml/lcl/comctrls.xml
+++ b/docs/xml/lcl/comctrls.xml
@@ -318,27 +318,34 @@
+ SetIndex saves the old index value, checks that the supplied value is different and then calls inherited method.
+
+ Create is the constructor for TStatusPanel. It sets default values for the width, alignment and bevel, calls the inherited Create method, and loads the class instance into StatusBar.
+
+ Destroy is the destructor for TStatusPanel and calls the inherited Destroy method. It removes itself from the StatusBar by calling its InvalidatePanel method.
+
+ StatusBar is a TStatusBar function used to retrieve the status bar where the class instance is displayed. It uses the Collection which owns the item to access its StatusBar property. If the Collection is not derived from TStatusPanels, the return value is Nil.
+
+ Supported for the Windows platform only.
+
+ Style is a TStatusPanelStyle property which indicates whether the panel is drawn as text, or uses an owner-draw routine to render the status panel.
+
+ The default value for the property is psText. Changing the value for the property causes the Changed method to be called to update the collection item in its owner. PanelChanged is also called to invalidate the border for the status bar panel.
+
+ Text is a TCaption property with the text displayed for the status bar panel. Changing the value for the property causes the Changed method to be called to update the collection item in its owner. PanelChanged is also called to invalidate the text area for the status bar panel.
+
+ Text is used when the Style property contains psText. Set Style to psOwnerDraw to use the OnDrawPanel event handler in the StatusBar to render the panel.
+
+ Items is a TStatusPanel property which allows access to a status bar panel by an ordinal position specified in Index. Values in the Index argument must be in the range 0..Count-1.
+
+ Items is the default property for the class instance, and allows access using either of the following:
+
+ It is also the target member for an enumerator. For example:
+
+ Use methods like Add, Delete, and Clear to maintain the items in the collection.
+
+ StatusBar is a read-only TStatusBar property and contains the status bar that is the owner of the items in the collection. It provides access to the properties and methods in the status bar from methods in the collection. Its primary purpose is to notify the status bar when panel(s) in the collection have been added or modified.
+
+ The property value is assigned in the Create constructor, and uses the value passed as an argument to the method.
+
+ TSBCreatePanelClassEvent is an object procedure type and specifies an event handler used to get the class type needed for a new status bar panel instance.
+
+ Sender is the status bar where the panel will be created. It must be cast to TStatusBar to access properties and method specific to the class type.
+
+ PanelClass is a variable argument with the class type used to create the new panel instance. It can be updated in the event handler to use the value from the GetPanelClass method in the status bar, or another class type if desired.
+
+ TSBCreatePanelClassEvent is the type used for the OnCreatePanelClass event handler in TStatusBar.
+
TDrawPanelEvent is the type used to implement the OnDrawPanel property in TStatusBar.
@@ -571,14 +709,14 @@
TStatusBar - a strip along the bottom of a form for displaying information on current status. The bar may consist of a single SimplePanel in which case the displayed text is contained in SimpleText.
- However if SimplePanel is false, then there can be multiple panels or sub-sections of the status bar whose properties are described in Panels.
+ However if SimplePanel is False, then there can be multiple panels or sub-sections of the status bar whose properties are described in Panels.
The property SimpleText can be assigned in code to display the value of some variable, such as the position of the Splitter in the example.
@@ -753,7 +891,7 @@
+ DoHint shows the hint text for the control and returns True when successful. Uses the OnHint event handler.
+
+ Destroy is the destructor for TStatusBar. It frees the Canvas and panels, and calls the inherited Destroy method.
+
- GetPanelIndexAt uses the display rectangle for the control to determine in the specified coordinates are within one of the Panels defined for the control. When True, each of the items in the Panels collection are examined to determine if the point is within a specific panel. The ordinal position for the panel is assigned as the return value.
+ GetPanelIndexAt uses the display rectangle for the control to determine in the specified coordinates are within one of the Panels defined for the control. When True, each of the items in the Panels collection are examined to determine if the point is within a specific panel. The ordinal position for the panel is assigned as the return value.
- Align is a TAlign property which specifies how the control is aligned to its parent control. The default value for the property is alBottom in TStatusBar.
+ Align is a TAlign property which specifies how the control is aligned to its parent control. The default value for the property is alBottom in TStatusBar.
- The default value for the property is False.
+ The default value for the property is False.
- The default value for the property is True in TStatusBar.
+ The default value for the property is True in TStatusBar.
- The default value for the property is clDefault or clBtnFace (depending on the UseCLDefault compiler define).If the color is clDefault , the result will need to be passed through GetDefaultColor to resolve clDefault to an actual TColor value.
+ The default value for the property is clDefault or clBtnFace (depending on the UseCLDefault compiler define). If the color is clDefault , the result will need to be passed through GetDefaultColor to resolve clDefault to an actual TColor value.
- Convenience routines which obtain the color by resolving clDefault and ParentColor are also provided as TControl.GetColorResolvingParent and TControl.GetRGBColorResolvingParent.
+ Convenience routines which obtain the color by resolving clDefault and ParentColor are provided in the TControl.GetColorResolvingParent and TControl.GetRGBColorResolvingParent methods.
Panels is a collection used to store TStatusPanel class instances added to the status bar. Panels are significant when the SimplePanel property is set to False; when SimplePanel contains True, the status bar displays the value in SimpleText across the entire width for the status bar.
@@ -1025,10 +1180,11 @@
- SimpleText - a character string containing the information to be displayed in the Status Bar. This is displayed if SimplePanel is true; otherwise the information in Panels is displayed.
+ SimpleText - a character string containing the information to be displayed in the Status Bar. This is displayed if SimplePanel is True; otherwise the information in Panels is displayed.
- Allows the control, and all of its children, to be displayed or hidden. Visible is set to True by Show , or to False by Hide. Calling these methods is equivalent to setting the Visible property.
+ Allows the control, and all of its children, to be displayed or hidden. Visible is set to True in the Show method, and to False in the Hide method. Calling these methods is equivalent to setting the value in the Visible property.
- The default value for the property is True in TStatusBar.
+ The default value for the property is True in TStatusBar.
DoHide is a method used to perform actions needed when the Visible property is changed to False. DoHide signals the OnHide event handler (when assigned).
@@ -1381,7 +1543,9 @@
DoShow is a method used to perform actions needed when Visible property is changed to True. DoShow signals the OnShow event handler (when assigned).
@@ -1459,7 +1623,7 @@
+
+ // var AStatusBar: TStatusBar;
+AStatusBar.Panels.Items[0];
+AStatusBar.Panels[0];
+
+ // var AStatusBar: TStatusBar;
+// APanel: TStatusPanel;
+for APanel in AStatusBar.Panels do
+begin
+ APanel.Alignment := taCenter;
+ APanel.Width := 88;
+end;
+
+
- When Parent is a TCustomTabControl descendant, its TCustomPage instances are examined to find the current class instance. At run-time, only pages with the TabVisible property set to True are considered in the method. At design-time, all pages are examined. + When Parent is a TCustomTabControl descendant, its TCustomPage instances are examined to find the current class instance. At run-time, only pages with the TabVisible property set to True are considered in the method. At design-time, all pages are examined.
- The return value is the relative position in the list of visible pages where the current class instance was found. The return value is -1 if the current page was not found in the Parent control, or when none of the pages in the Parent control are visible. + The return value is the relative position in the list of visible pages where the current class instance was found. The return value is -1 if the current page was not found in the Parent control, or when none of the pages in the Parent control are visible.
When Parent is not derived from TCustomTabControl, the return value is always -1.
@@ -2361,7 +2525,7 @@
- FindVisiblePage is used to locate a Page in the tab control with its TabVisible property set to True.
+ FindVisiblePage is used to locate a Page in the tab control with its TabVisible property set to True.
Index specifies the ordinal position in Pages property that is the search locus. FindVisiblePage searches the Page collection in ascending order starting at the position in Index. If a visible page is not found, Page is searched in descending order starting at Index -1.
@@ -2391,11 +2555,13 @@
ShowCurrentPage checks the value in PageIndex to determine if a valid page index has been specified. No actions are performed in the method when PageIndex is less than 0 or greater than PageCount - 1.
@@ -2806,7 +2974,9 @@
- Notification is overridden in TCustomTabControl to ensure that resources allocated for the Images property are Nil'd when the component is removed.
+ Notification is overridden in TCustomTabControl to ensure that resources allocated for the Images property are Nil'd when the component is removed.
- TabVisible indicates if the Tab is visible in the Parent control. The default value for the property is True in TTabSheet.
+ TabVisible indicates if the Tab is visible in the Parent control. The default value for the property is True in TTabSheet.
Changing the value in the property cause the Parent control to be updated to reflect the new value. No actions are performed in the method at design-time, or when the property value is not different than the stored value.
- When the Parent control has been assigned and has a handle allocated, the TCustomTabControl in Parent is updated to reflect the new value for the property. When True, the active page in the Parent control is changed to the current page instance if one has not already been assigned in the Parent. The page and its handle are removed from the Tab control when the property value is False.
+ When the Parent control has been assigned and has a handle allocated, the TCustomTabControl in Parent is updated to reflect the new value for the property. When True, the active page in the Parent control is changed to the current page instance if one has not already been assigned in the Parent. The page and its handle are removed from the Tab control when the property value is False.
Use IsControlVisible to determine if the page is currently the active page displayed in the Parent tab control.
@@ -3844,9 +4014,13 @@
SelectNextPage - checking that its tab is visible.
If GoForward is True, goes to next (higher index) page; if False, goes to previous (lower index) If CheckTabVisible is True, will only move if the tab is visible
+ If GoForward is True, goes to next (higher index) page.
+ If False, goes to previous (lower index)
+
+ If CheckTabVisible is True, will only move if the tab is Visible.
+ Among the defaults set are:
- HotTrack, Multiline, MultiSelect, OwnerDraw, RaggedRight, ScrollOpposite - all False; Tab height and width to zero
+ HotTrack, Multiline, MultiSelect, OwnerDraw, RaggedRight, ScrollOpposite - all False; Tab height and width to zero
- SetTabHeight propogates the new tab height to the Notebook which contains the Tabs in the control. + SetTabHeight propagates the new tab height to the Notebook which contains the Tabs in the control.
- Signals the OnChanging event handler (when assigned) to get the return value for the method. The default return value is True when OnChanging has not been assigned. + Signals the OnChanging event handler (when assigned) to get the return value for the method. The default return value is True when OnChanging has not been assigned.
Always returns True in TTabControl.
+Always returns True in TTabControl.
- AutoArrange is a Boolean property which indicates if icons in a list view control can be automatically arranged when items are added to the control. The default value for the property is False. + AutoArrange is a Boolean property which indicates if icons in a list view control can be automatically arranged when items are added to the control. The default value for the property is False.
AutoArrange is used when the list view uses the vsIcon or vsSmallIcon view styles.
@@ -6148,7 +6324,7 @@
- WrapText is a Boolean property which indicates if the Caption for a list view item can be wrapped into multiple lines. The default value for the property is True.
+ WrapText is a Boolean property which indicates if the Caption for a list view item can be wrapped into multiple lines. The default value for the property is True.
The Caption for the item is wrapped when its length exceeds the width for the icon in the list item.
@@ -6514,7 +6690,7 @@
Used in methods in the widgetset class. @@ -6619,7 +6799,7 @@ Destroy sets the internal flag that marks the list item for destruction in the Owner. When the Owner is assigned, its ItemDestroying method is called to signal destruction of the list item in the container.
- Destroy free and Nils resources allocated for the SubItems property, and calls the inherited destructor prior to exit. + Destroy free and Nils resources allocated for the SubItems property, and calls the inherited destructor prior to exit.
- Selected is a Boolean property which indicates if the list item has been selected. The property value is determined by examining the internal TListItemStates set for the class instance. When lisSelected has been included in the state values, the property is True. Otherwise, the property is False. + Selected is a Boolean property which indicates if the list item has been selected. The property value is determined by examining the internal TListItemStates set for the class instance. When lisSelected has been included in the state values, the property is True. Otherwise, the property is False.
- Setting a new value for the property causes the value lisSelected to be included in or removed from the internal set. AIsSet indicates whether the state value is set. When True, the state value is included in the set. Otherwise, the state value is excluded. + Setting a new value for the property causes the value lisSelected to be included in or removed from the internal set. AIsSet indicates whether the state value is set. When True, the state value is included in the set. Otherwise, the state value is excluded.
- If ASource is not derived from TListColumn, the inherited method is called using ASource as an argument. An EConvertError exception is raised if ASource has not been assigned (contains Nil). + If ASource is not derived from TListColumn, the inherited method is called using ASource as an argument. An EConvertError exception is raised if ASource has not been assigned (contains Nil).
+ TLVColumnClickEvent is the type used to implement the OnColumnClick property in TCustomListView. TLVColumnClickEvent allows an application to perform actions needed when a click event is handled for a column on the list view control. +
++ Use Sender (cast to a TCustomListView type) to access properties and methods in the list view control. Use Column to access properties and methods in the TListColumn instance for the event. +
++ Not used in the current LCL version. +
+- The set represents Boolean property values found in TCustomListView / TListView. When a value is included in the set, the corresponding property in TCustomListView has been set to True. The value is excluded from the set when the corresponding property in TCustomListView is set to False. + The set represents Boolean property values found in TCustomListView / TListView. When a value is included in the set, the corresponding property in TCustomListView has been set to True. The value is excluded from the set when the corresponding property in TCustomListView is set to False.
TListViewProperties is the type used to implement the internal FProperties member in TCustomListView. @@ -9312,6 +9510,7 @@ + TCustomImageList
- QueuedShowEditor is called when the ShowEditorQueued property is set to True. - Application.QueueAsyncCall is used to asynchronously execute the method. + QueuedShowEditor is called when the ShowEditorQueued property is set to True. Application.QueueAsyncCall is used to asynchronously execute the method.
- InvalidateSelected is a method used to clear the current selection for the control. It sets the value in the Selected property to Nil, and resets the internal memeber used to track the selected item in OwnerData mode. It also updates the control flags to remove the value lffSelectedValid. + InvalidateSelected is a method used to clear the current selection for the control. It sets the value in the Selected property to Nil, and resets the internal member used to track the selected item in OwnerData mode. It also updates the control flags to remove the value lffSelectedValid.
InvalidateSelected is called when a list item is deleted which is the current value in Selected, or when all list items are deleted for the control. It is also called when a new value is assigned to Selected. @@ -9764,7 +9962,7 @@ ItemDeleted is a method called when the specified list item is removed from the Items for the control.
- ItemDeleted ensures that the list item in AItem is not referenced as a selected or focused item on the control. If AItem is the value in Selected, Selected is set to Nil and the control flags are updated to removed the valid selection flag (ffSelectedValid). If AItem is the focused list item on the control, the focus reference is set to Nil. + ItemDeleted ensures that the list item in AItem is not referenced as a selected or focused item on the control. If AItem is the value in Selected, Selected is set to Nil and the control flags are updated to removed the valid selection flag (ffSelectedValid). If AItem is the focused list item on the control, the focus reference is set to Nil.
ItemDeleted is called when the TListItem instance in AItem is freed from the container in Items. ItemDeleted calls DoDeletion to execute the Delete method in TCustomListView (when not overridden) or signal the OnDeletion event handler (when assigned).
@@ -9778,13 +9976,23 @@
+ Calls the DoInsert method to execute an overridden InsertItem method, or to signal the OnInsert event handler for the list item in AItem. Called from the InsertItem method in TListItems.
+
- GetControlClassDefaultSize is an overridden TSize class function used to get the default size for new instances of the class type. In TCustomListView, the default dimensions are 250 pixels wide by 150 pixels high.
+ GetControlClassDefaultSize is an overridden TSize class function used to get the default size for new instances of the class type. In TCustomListView, the default dimensions are 250 pixels wide by 150 pixels high.
+ FinalizeWnd retrieves the cached origin for the list view and finalizes the items and columns for the control.
+
+ TListItemClass is the default class reference used to create the list item in the method. Use the OnCreateItemClass event handler to provide an alternate class type used for list Items in the control.
+
+ Items is assigned as the owner for the list item instance created in the method.
+
+ CreateListItem is called from the Add method in TListItems when an Owner has been assigned for the container.
+
- CanEdit is a Boolean function used to determine if the editor can be displayed and activated for the specified Item. The return value defaults to True.
+ CanEdit is a Boolean function used to determine if the editor can be displayed and activated for the specified list Item. The default return value is True.
- CanEdit signals the OnEditing event handler (when assigned), where the return value can be modified. Use values in Item or the list view control to determine the return value (including their respective ReadOnly properties).
+ CanEdit signals the OnEditing event handler (when assigned) where the return value can be modified. The event handler can examine values in the Item argument, the list view instance, or use other user-specified criteria to determine the return value.
- CanEdit is called from the ShowEditor method, and occurs before the Editor in the control is configured and displayed.
+ CanEdit is called from the ShowEditor method, and occurs before the Editor in the control is configured and displayed. Use the Readonly property to prevent ShowEditor from being called when keyboard (F2) and mouse click events are handled in the control.
- AColumn is the TListColumn instance representing the column header clicked on the control. The OnColumnClick event handler is signalled (when assigned) if ColumnClick is set to True. The event handler can be used to adjust property values in the column argument or the list view control as needed. + AColumn is the TListColumn instance representing the column header clicked on the control. The OnColumnClick event handler is signalled (when assigned) if ColumnClick is set to True. The event handler can be used to adjust property values in the column argument or the list view control as needed.
- ColClick uses the value in AutoSort to determine if the control is updated to reflect a change to the sort column or its order indicator. No additional actions are performed when AutoSort is False or SortType is stNone. + ColClick uses the value in AutoSort to determine if the control is updated to reflect a change to the sort column or its order indicator. No additional actions are performed when AutoSort is False or SortType is stNone.
- When AutoSort is set to True, the Index in AColumn is used to set the value for the SortColumn property, When AutoSortIndicator is enabled, the Columns for the control are updated to clear any previous sort indicators when a new sort column has been clicked. The sort indicator in the AColumn argument is also updated. If AColumn was already the SortColumn for the control, the value in SortDirection is toggled between it ascending and descending values. + When AutoSort is set to True, the Index in AColumn is used to set the value for the SortColumn property. When AutoSortIndicator is enabled, the Columns for the control are updated to clear any previous sort indicators when a new sort column has been clicked. The sort indicator in the AColumn argument is also updated. If AColumn was already the SortColumn for the control, the value in SortDirection is toggled between it ascending and descending values.
ColClick is called when the LVN_COLUMNCLICK control notification message is handled for the list view control. @@ -9924,13 +10171,13 @@ Delete is a method used to delete the list item specified in AItem.
- In Delphi, Delete is called when Items.Delete is executed. The OnDeletion event handler is signalled each time the method is called, even when list items are freed from the Items container. + In Delphi, Delete is called when Items.Delete is executed. The OnDeletion event handler is signalled each time the method is called, even when list items are freed from the Items container.
The Lazarus implementation differs. It uses a flag value in AItem to determine if the method has been called when the list item is freed, or when the Delete method in the list item has been called explicitly.
- Delete is called from the DoDeletion method if an overridden Delete method has been implemented. The OnDeletion event handler is signalled when Delete has been explicitly called, and when the Delete method has not been overridden. + Delete is called from the DoDeletion method if an overridden Delete method has been implemented. The OnDeletion event handler is signalled when Delete has been explicitly called, and when the Delete method has not been overridden.
While not 100% Delphi compatible, it is more compatible than previous LCL versions. @@ -10012,7 +10259,9 @@
DoAutoAdjustLayout is an overridden procedure used to adjust the layout for the list view using the specified arguments. DoAutoAdjustLayout calls the inherited method.
@@ -10097,7 +10348,7 @@
@@ -10126,10 +10377,20 @@
+ Assigned in the constructor as the OnChange event handler in TChangeLink instances used for the control.
+
+ Please note that the current implementation is empty. This needs to be moved to the LCL interface since image changes can occur there.
+
- Ensures that members for the LargeImages, SmallImages, and StateImages are set to Nil when the corresponding image list is removed.
+ Ensures that members for the LargeImages, SmallImages, and StateImages are set to Nil when the corresponding image list is removed.
@@ -10190,31 +10451,53 @@
- CustomDraw draws the control using the OnCustomDraw or OnAdvancedCustomDraw event handlers (when assigned).
+ CustomDraw draws the list view control using the OnCustomDraw or OnAdvancedCustomDraw event handlers. OnCustomDraw is signalled (when assigned) if the drawing stage in AStage is cdPrePaint. OnAdvancedCustomDraw is signalled (when assigned).
+
+ The default return value is True, but may be modified in the event handlers if it is not able to render the control in the handler routine.
+
+ Use OnDrawItem and OnAdvancedCustomDrawItem to draw an individual list item on the control.
+
+ CustomDraw is called from the IntfCustomDraw method and occurs when the widgetset class instance redraws the LCL control.
- CustomDrawItem draws an item in the control using the OnCustomDrawItem or OnAdvancedCustomDrawItem event handlers (when assigned).
+ CustomDrawItem draws an item on the list view control using the OnCustomDrawItem or OnAdvancedCustomDrawItem event handlers (when assigned).
- CustomDrawSubItem draws a sub-item in the control using the OnCustomDrawSubItem and OnAdvancedCustomDrawSubItem event handlers (when assigned).
+ CustomDrawSubItem draws a sub-item on the list view control using the OnCustomDrawSubItem and OnAdvancedCustomDrawSubItem event handlers (when assigned).
@@ -10333,11 +10616,13 @@
- Calls the inherited DblClick method. Ensures that ShowEditorQueued is set to True when the control has an assigned editor and is not marked as read-only.
+ Calls the inherited DblClick method. Ensures that ShowEditorQueued is set to True when the control has an assigned editor and is not marked as read-only.
- Column is significant when the ViewStyle for the control is set to vsReport. Report view is the only style where the columns are used or displayed. Set the value in ShowColumnHeaders to True to display the column header defined in the collection.
+ Column is significant when the ViewStyle for the control is set to vsReport. Report view is the only style where the columns are used or displayed. Set the value in ShowColumnHeaders to True to display the column header defined in the collection.
Columns are used at run-time to handle column click notifications and changes to the sort indicator. Use AutoSort, AutoSortIndicator, SortColumn, SortType, and SortDirection to access or maintain values for items in the collection.
@@ -10642,13 +10929,13 @@
- HideSelection is a Boolean property which indicates if the selected item(s) for the list view are highlighted when the control loses focus. When set to True, the selected item(s) are redrawn to remove the selection highlighting. When set to False, the selection hightlighting is retained when the control loses focus.
+ HideSelection is a Boolean property which indicates if the selected item(s) for the list view are highlighted when the control loses focus. When set to True, the selected item(s) are redrawn to remove the selection highlighting. When set to False, the selection hightlighting is retained when the control loses focus.
- The default value for the property is True. Changing the value for the property causes the widgetset class to be updated with the new value.
+ The default value for the property is True. Changing the value for the property causes the widgetset class to be updated with the new value.
- A typical application might have two ImageLists: one of LargeImages and one of SmallImages containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.
+ A typical application might have two ImageLists: one of LargeImages and one of SmallImages containing two versions of the same collection of images, in large and small format; the index positions in the first image list should correspond to those in the second image list.
SmallImages could be displayed beside the text strings in the list view and the programmer would supply code to ensure that when an item with its associated SmallImage was selected, the corresponding LargeImage would be displayed in another window.
@@ -11060,7 +11347,7 @@
- OnDataHint is not used in the current LCL implementation. In virtual mode (OwnerData = True), only the most recently accessed virtual list item exists in the list view control. The data hinting, or pre-fetch caching, feature is not used in the current implementation.
+ OnDataHint is not used in the current LCL implementation. In virtual mode (OwnerData = True), only the most recently accessed virtual list item exists in the list view control. The data hinting, or pre-fetch caching, feature is not used in the current implementation.
- GetNearestItem is used to locate a list item from a position specified in pixel coordinates relative to the top left corner of the list view. It starts looking at the position specified by the Point parameter, and moves in the direction indicated by the Direction parameter until it locates a list item.If no item is found Nil is returned.
+ GetNearestItem is used to locate a list item from a position specified in pixel coordinates relative to the top left corner of the list view. It starts looking at the position specified by the Point parameter, and moves in the direction indicated by the Direction parameter until it locates a list item.If no item is found Nil is returned.
- Checkboxes is a Boolean property which indicates if check boxes are displayed next to list items on the control. The default value for the property is False. Changing the value for the property causes the widgetset class to be updated.
+ Checkboxes is a Boolean property which indicates if check boxes are displayed next to list items on the control. The default value for the property is False. Changing the value for the property causes the widgetset class to be updated.
Use the OnItemChecked event handler to perform actions needed when the check state for a list item has been changed.
@@ -11528,7 +11815,7 @@
CheckBoxes is used when a LVN_ITEMCHANGED notification message is handled for the control with a LVIF_STATE change flag.
- The value in CheckBoxes is ignored when OwnerData is set to True. Check box display cannot be enabled for virtual mode.
+ The value in CheckBoxes is ignored when OwnerData is set to True. Check box display cannot be enabled for virtual mode.
- The default value for the property is False. Changing the value for the property causes the widgetset class to be updated.
+ The default value for the property is False. Changing the value for the property causes the widgetset class to be updated.
- GridLines is a Boolean property used to enable or disable drawing of a 1-pixel grid line between rows and columns on the control. The default value for the property is False, and hides the grid lines. Changing the value for the property causes the widgetset class to be updated.
+ GridLines is a Boolean property used to enable or disable drawing of a 1-pixel grid line between rows and columns on the control. The default value for the property is False, and hides the grid lines. Changing the value for the property causes the widgetset class to be updated.
- When OwnerData is False, the property value contains the value received from the widgetset class when the LVN_ITEMCHANGED notification message is handled for the control. If OwnerData is True, an internal member is locally maintained to track the selected item. In OwnerData (virtual) mode, only the most recently accessed item is stored for the control.
+ When OwnerData is False, the property value contains the value received from the widgetset class when the LVN_ITEMCHANGED notification message is handled for the control. If OwnerData is True, an internal member is locally maintained to track the selected item. In OwnerData (virtual) mode, only the most recently accessed item is stored for the control.
- Setting a new value for the property causes the Selected property to be updated. In OwnerData mode, this causes the internal member to be updated and the virtual item is retrieved to set its Selected property to True. If Virtual mode is not enabled, the Selected property is set to corresponding value in Items.
+ Setting a new value for the property causes the Selected property to be updated. In OwnerData mode, this causes the internal member to be updated and the virtual item is retrieved to set its Selected property to True. If Virtual mode is not enabled, the Selected property is set to corresponding value in Items.
- If the new property value is -1, the value in Selected is set to Nil. Setting a new property value when MultiSelect is enabled also causes Selected to be set to Nil.
+ If the new property value is -1, the value in Selected is set to Nil. Setting a new property value when MultiSelect is enabled also causes Selected to be set to Nil.
An Exception is raised if the new property value is not a value index position in Items, or -1.
@@ -11741,14 +12028,16 @@
- MultiSelect is a Boolean property which indicates if multiple simultaneous item selections are allows in the list view control. The default value for the property is False, and allows a single selection as reflected in the Selected property.
+ MultiSelect is a Boolean property which indicates if multiple simultaneous item selections are allows in the list view control. The default value for the property is False, and allows a single selection as reflected in the Selected property.
- When set to True, multiple entries in the Items property can bemarked as Selected. This can be achieved in program code by iterating over the TListItem instances in Items, and setting the Selected property for the appropriate items. At run-time, the mouse can be use toggle the selected state for one or more of the list items.
+ When set to True, multiple entries in the Items property can be marked as Selected. This can be achieved in program code by iterating over the TListItem instances in Items, and setting the Selected property for the appropriate items. At run-time, the mouse can be use toggle the selected state for one or more of the list items.
- Use SelectAll to set the selected state to True for all of the Items on the control.
+ Use SelectAll to set the selected state to True for all of the Items on the control.
Use ClearSelection to clear the selected state for all of the Items on the control.
@@ -11810,7 +12099,7 @@
ReadOnly is a Boolean property used to enable or disable editing of captions for list items at run-time. When ReadOnly is set to True, the editor for the control cannot be activated using a mouse double Click or by pressing the F2 function key.
@@ -11837,7 +12126,7 @@
SelCount is a read-only Integer property with the number selected entries in Items. SelCount is relevant when MultiSelect is set to True; otherwise, the single selected item is found in the Selected property.
- If the Handle has been allocated for the widgetset class, the value from the GetSelCount method is used as the property value. Otherwise, the property value is calculated by counting the number of TListItem instances in Items that have their Selected property set to True. The return value is 0 when none of the Items have a selected property set to True.
+ If the Handle has been allocated for the widgetset class, the value from the GetSelCount method is used as the property value. Otherwise, the property value is calculated by counting the number of TListItem instances in Items that have their Selected property set to True. The return value is 0 when none of the Items have a selected property set to True.
Use GetNextItem with the lisSelected item state to retrieve a multi-selected item that is adjacent to another selected item.
@@ -11918,7 +12207,7 @@
- The default value for the property is True in TCustomListView,
+ The default value for the property is True in TCustomListView,
- A typical application might have two ImageLists: one of LargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.
+ A typical application might have two image lists: LargeImages and SmallImages. They contain large and small sizes for the same collection of images. The index positions in the first list would correspond with those in the second list.
SmallImages (if assigned to a string-list) can be displayed beside the text strings in the list view and the programmer would supply code to ensure that when an item with its associated Small Image was selected, the corresponding Large Image would be displayed in another window.
@@ -11974,6 +12263,7 @@
- ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is False in TListView.
+ ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is False in TListView.
- When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
+ When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
Using ParentColor when the Color value is clDefault can cause problems in resolving the actual color value. To obtain the Color property of a control while taking into account clDefault and ParentColor, use the GetColorResolvingParent method. This method might return a non-RGB color, but will never return clDefault. To obtain a purely RGB result use the GetRGBColorResolvingParent method.
@@ -12817,7 +13107,9 @@
- InitializeWnd is an overridden method used to initialize the widgetset class for the control. InitializeWnd calls the inherited method. When the FUseWS member contains False, no additional actions are performed in the method. When it contains True, methods in its widgetset class are called to synchronize values in the Min, Max, Position, Increment, Wrap, Orientation, and UseArrowKeys properties.
+ InitializeWnd is an overridden method used to initialize the widgetset class for the control. InitializeWnd calls the inherited method. When the FUseWS member contains False, no additional actions are performed in the method. When it contains True, methods in its widgetset class are called to synchronize values in the Min, Max, Position, Increment, Wrap, Orientation, and UseArrowKeys properties.
- CheckDefaults indicates when values from the action are copied into the control. When set to True, the values in the Action are applied only when its property value has been assigned.
+ CheckDefaults indicates when values from the action are copied into the control. When set to True, the values in the Action are applied only when its property value has been assigned.
ActionChange calls the inherited method on entry to copy properties from Sender to the control. It provides support for translating the Checked property in the action to the Down property used in the tool button. It also changes the value in ImageIndex only when a valid image index has been assigned in the Action.
@@ -13867,7 +14161,7 @@
- If the mouse event is over the button, the Down property is set to True. + If the mouse event is over the button, the Down property is set to True.
MouseDown is called from window message handlers for the control. @@ -14029,7 +14323,7 @@
- Adjacent check box-style buttons (and their separators / dividers) with their Grouped property set to True are considered to be in the same group. GroupAllUpAllowed examines the adjacent tool buttons on the Parent tool bar to determine whether any of the grouped buttons have the AllowAllUp property set to True. When one grouped check-box button has AllowAllUp set, the remaining buttons in the group are treated in the same manner. + Adjacent check box-style buttons (and their separators / dividers) with their Grouped property set to True are considered to be in the same group. GroupAllUpAllowed examines the adjacent tool buttons on the Parent tool bar to determine whether any of the grouped buttons have the AllowAllUp property set to True. When one grouped check-box button has AllowAllUp set, the remaining buttons in the group are treated in the same manner.
- ImageList is the scaled image list with the images from the parent tool bar. It is re-created in the method and uses the image size from the parent tool bar scaled to the run-time display density (PPI). The images in the list are retrieved from the Images, HotImages, or DisabledImages properties in the parent tool bar and reflect the values in the Enabled property and the tool button flags. The default value is Nil (unassigned). + ImageList is the scaled image list with the images from the parent tool bar. It is re-created in the method and uses the image size from the parent tool bar scaled to the run-time display density (PPI). The images in the list are retrieved from the Images, HotImages, or DisabledImages properties in the parent tool bar and reflect the values in the Enabled property and the tool button flags. The default value is Nil (unassigned).
TheIndex is the position in the image list for the icon image. It defaults to the value in the ImageIndex property. @@ -14413,7 +14707,7 @@ Called during AutoSize calculations. Only positive values are valid. Negative or 0 are treated as undefined, and the LCL uses other sizes instead.
- When WithThemeSpace is True, additional space is reserved for stacking. + When WithThemeSpace is True, additional space is reserved for stacking.
Calls the inherited method on entry. Values from the ButtonWidth and ButtonHeight properties in the parent tool bar may be used in the PreferredWidth and PreferredHeight arguments, depending on the orientation for the tool bar. No additional actions are performed in the method if the parent tool bar has not been assigned.
@@ -14459,7 +14753,9 @@
- AllowAllUp, when True, indicates that all buttons in a group are allowed to be 'Up' at the same time. The default value for the property is False, and indicates that one of the grouped buttons must have its Down property set to True.
+ AllowAllUp, when True, indicates that all buttons in a group are allowed to be 'Up' at the same time. The default value for the property is False, and indicates that one of the grouped buttons must have its Down property set to True.
- Default value for the property is False, and disables auto-sizing for the control instance. + Default value for the property is False, and disables auto-sizing for the control instance.
The write access specifier is overridden in TToolButton to resize and align the tool button and its parent tool bar when needed.
@@ -14509,7 +14805,7 @@
@@ -14557,7 +14853,7 @@
Is this button a member of a group?
- Marked is a Boolean property which indicates if the tool button is marked. The default value for the property is False.
+ Marked is a Boolean property which indicates if the tool button is marked. The default value for the property is False.
Marked is provided for Delphi code compatibility; it is not used in the implementation of TToolButton or TToolBar.
@@ -15037,9 +15333,9 @@
If the tool bar is parented by a TCoolBar control, the value in its Vertical property is used as the return value.
@@ -15048,7 +15344,9 @@
- Calls the inherited method on entry. Ensures that the DisabledImages, HotImages, and Images properties are Nil'd if their image list is removed from the control.
+ Calls the inherited method on entry. Ensures that the DisabledImages, HotImages, and Images properties are Nil'd if their image list is removed from the control.
The tool bar cannot be given focus, but its buttons or controls can.
@@ -15543,7 +15845,7 @@ AToolbar.ButtonHeight := 30;
- When List is set to True, the icon for a tool button is displayed on the left edge of the button immediately before the Caption text (when enabled). When set to False, the icon is centered in the button width and above the Caption text for the button.
+ When List is set to True, the icon for a tool button is displayed on the left edge of the button immediately before the Caption text (when enabled). When set to False, the icon is centered in the button width and above the Caption text for the button.
The default value for the property is False. Changing the value for the property causes the tool bar to be resized and redrawn.
@@ -15890,7 +16192,7 @@ AToolbar.ButtonHeight := 30;
- ShowCaptions is a Boolean property which indicates whether caption text is displayed on tool bar buttons. The default value for the property is False. Changing the value for the property causes the tool bar to be redrawn.
+ ShowCaptions is a Boolean property which indicates whether caption text is displayed on tool bar buttons. The default value for the property is False. Changing the value for the property causes the tool bar to be redrawn.
ShowCaptions is used in the Paint method for the tool buttons on the control. When set to True, the caption text for a button is centered aligned at the bottom edge of the button. The icon for a button is drawn center aligned at the top edge of the button.
@@ -16101,7 +16403,7 @@ AToolbar.ButtonHeight := 30;
- The default value for the property is clDefault. Please note that the default value for ParentColor is True, and causes the color defined for the TCoolBar control to be used.
+ The default value for the property is clDefault. Please note that the default value for ParentColor is True, and causes the color defined for the TCoolBar control to be used.
- Setting a new value for the property causes the Collection for the class to be updated. The existing control on the band is Nil'd and the new value is assigned. The Parent property in the control is set to the TCoolBar instance.
+ Setting a new value for the property causes the Collection for the class to be updated. The existing control on the band is Nil'd and the new value is assigned. The Parent property in the control is set to the TCoolBar instance.
- IsFirstAtRow uses values from Vertical and IsRightToLeft to determine the orientation and order for the bands. The return value is True when the band at the specified position is the first one visually displayed on a given row. + IsFirstAtRow uses values from Vertical and IsRightToLeft to determine the orientation and order for the bands. The return value is True when the band at the specified position is the first one visually displayed on a given row.
IsFirstAtRow is used in MouseDown and MouseMove when handling drag messages to order the bands in the control.
@@ -17293,7 +17597,7 @@ AToolbar.ButtonHeight := 30;
- ABand is an Integer output parameter with the position for the band under the mouse pointer. It can contain an ordinal position in the visible bands for the control, and can be in the range 0..Bands.Count-1. The upper limit may be smaller if any of the bands have their Visible property set to False. + ABand is an Integer output parameter with the position for the band under the mouse pointer. It can contain an ordinal position in the visible bands for the control, and can be in the range 0..Bands.Count-1. The upper limit may be smaller if any of the bands have their Visible property set to False.
ABand may contain a negative value, defined in the cNewRowAbove and cNewRowBelow constants, that represent the unused space above or below the bands on the control.
@@ -18132,10 +18436,10 @@ AToolbar.ButtonHeight := 30;
- The default value for the property is True in TCustomTrackBar.
+ The default value for the property is True in TCustomTrackBar.
- Child nodes are removed by setting HasChildren to False. Child nodes in Items are freed, and its storage is set to Nil. + Child nodes are removed by setting HasChildren to False. Child nodes in Items are freed, and its storage is set to Nil.
- The Pointer in the Data property is set to Nil. + The Pointer in the Data property is set to Nil.
Destroy calls the inherited method prior to exit.
@@ -19462,7 +19766,7 @@ AToolbar.ButtonHeight := 30;
- The child nodes (but not the grand-children) are sorted. If SortProc is Nil the method DefaultTreeViewSort is used. The default implementation always returns True.
+ The child nodes (but not the grand-children) are sorted. If SortProc is Nil the method DefaultTreeViewSort is used. The default implementation always returns True.
- Delete is a method used to remove the tree node from the TTreeNodes container. Delete calls Free to destroy the object instance if the Deleting property is not set to True. No actions are performed when Deleting is True.
+ Delete is a method used to remove the tree node from the TTreeNodes container. Delete calls Free to destroy the object instance if the Deleting property is not set to True. No actions are performed when Deleting is True.
- Cut is a Boolean property which indicates if the tree node has been cut from the tree structure. The property value is True when nsCut has been included in the States property for the tree node. Changing the value for the property causes the States property to be updated to include or exclude the node state value.
+ Cut is a Boolean property which indicates if the tree node has been cut from the tree structure. The property value is True when nsCut has been included in the States property for the tree node. Changing the value for the property causes the States property to be updated to include or exclude the node state value.
@@ -20372,14 +20692,14 @@ AToolbar.ButtonHeight := 30;
DropTarget is a Boolean property which indicates if the node is a drop target in a drag and drop operation. The value for the property is True when nsDropHilited has been included in the States property.
- Setting a new value for the property causes States to be updated to reflect the new value. When set to True, nsDropHilited is included in State and the internal last drop target is updated in the associated TreeView control. When set to False, nsDropHilited is excluded from States and the last drop target is set to Nil in the TreeView control.
+ Setting a new value for the property causes States to be updated to reflect the new value. When set to True, nsDropHilited is included in State and the internal last drop target is updated in the associated TreeView control. When set to False, nsDropHilited is excluded from States and the last drop target is set to Nil in the TreeView control.
@@ -20402,7 +20722,7 @@ AToolbar.ButtonHeight := 30;
@@ -20436,10 +20756,10 @@ AToolbar.ButtonHeight := 30;
HasChildren is a Boolean property which indicates whether the tree node has child nodes.
- The property value is True when States includes the value nsHasChildren. Items is not used to determine the property value.
+ The property value is True when States includes the value nsHasChildren. Items is not used to determine the property value.
- Setting a new value for the property causes States to be updated to include or exclude nsHasChildren to reflect the new value. When the value is False, child nodes in the Items property are freed.
+ Setting a new value for the property causes States to be updated to include or exclude nsHasChildren to reflect the new value. When the value is False, child nodes in the Items property are freed.
The Update method is called to refresh the associated TreeView control (when assigned).
@@ -20500,7 +20820,7 @@ AToolbar.ButtonHeight := 30;
@@ -20518,7 +20838,7 @@ AToolbar.ButtonHeight := 30;
@@ -20570,7 +20890,7 @@ AToolbar.ButtonHeight := 30;
@@ -20787,7 +21107,7 @@ AToolbar.ButtonHeight := 30;
@@ -20807,7 +21127,7 @@ AToolbar.ButtonHeight := 30;
- Enabled is a Boolean property which indicates if the tree node can be selected in a tree control. The Selected and MultiSelected properties cannot be set to True when Enabled is False. A mouse click used to select the node is also ignored when Enabled is False. The default value for the property is True.
+ Enabled is a Boolean property which indicates if the tree node can be selected in a tree control. The Selected and MultiSelected properties cannot be set to True when Enabled is False. A mouse click used to select the node is also ignored when Enabled is False. The default value for the property is True.
Read and write access to the property value are redirected to the States property. Enabled is True when nsEnabled is included in the States property. It is False if the value is omitted from States.
@@ -20894,7 +21214,9 @@ AToolbar.ButtonHeight := 30;
- Returns the TTreeNode instance found which matches the text ancestry in TextPath, or Nil if a tree node is not found matching the specified values.
+ Returns the TTreeNode instance found which matches the text ancestry in TextPath, or Nil if a tree node is not found matching the specified values.
TextPath contains the delimited text values used to locate a tree node. The '/' (Slash) character is used as the delimiter between text values in TextPath. An initial slash character representing the root node is not needed or allowed. The search always starts at the top-level tree nodes in the container. The FindNode method is used to locate subsequent delimited text values in TextPath.
@@ -21368,7 +21692,7 @@ AToolbar.ButtonHeight := 30;
If a different node is being edited in the control, the EndEditing method is called.
@@ -22552,7 +22882,7 @@ AToolbar.ButtonHeight := 30;
@@ -22573,7 +22903,7 @@ AToolbar.ButtonHeight := 30;
CanCollapse is a Boolean function used to determine if the tree node in Node can be collapsed. CanCollapse signals the OnCollapsing event handler (when assigned) to determine if the tree node can be collapsed.
- The return value is updated in the event handler, and can be set to True when the node has child nodes and is currently expanded. The return value should be set to False if the node does not have any child nodes.
+ The return value is updated in the event handler, and can be set to True when the node has child nodes and is currently expanded. The return value should be set to False if the node does not have any child nodes.
The return value is always True if the OnCollapsing event handler has not been assigned, or when the component is being freed.
@@ -22596,33 +22926,37 @@ AToolbar.ButtonHeight := 30;
CanEdit is a Boolean function used to determine if the tree node in Node can be edited. CanEdit signals the OnEditing event handler (when assigned) to determine if the TTreeNode instance can be modified.
- The return value is updated in the event handler, and can be set to True if the tree view control is not configured to be read-only and the tree node is eligible for modification. Use the Options property in the tree view control to check for the read-only setting. The return value is always True if the OnEditing event handler has not been assigned.
+ The return value is updated in the event handler, and can be set to True if the tree view control is not configured to be read-only and the tree node is eligible for modification. Use the Options property in the tree view control to check for the read-only setting. The return value is always True if the OnEditing event handler has not been assigned.
CanExpand is a Boolean function used to determine if the tree node specified in Node can be expanded. CanExpand signals the OnExpanding event handler (when assigned) to get the return value for the method.
@@ -22634,7 +22968,7 @@ AToolbar.ButtonHeight := 30;
- CustomDraw - returns True if Custom Drawing is proceeding in the specified Rectangle.
+ CustomDraw - returns True if Custom Drawing is proceeding in the specified Rectangle.
Stage indicates whether PrePaint, PostPaint, PreErase or PostErase.
@@ -22692,17 +23026,17 @@ AToolbar.ButtonHeight := 30;
- CustomDrawItem - returns True if Custom Image drawing is proceeding at the specified TreeNode.
+ CustomDrawItem - returns True if Custom Image drawing is proceeding at the specified TreeNode.
State denotes one of Selected, Grayed, Disabled, Checked, Focused, Default, Hot, Marked or Indeterminate.
Stage indicates whether PrePaint, PostPaint, PreErase or PostErase. If PaintImages is True, Images should be painted as well as text. If PaintImages is True, Images should be painted as well as text.
- 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 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 assigned, 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.
+ 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.
- MouseDown ensures that both Left and Right mouse button events are handled (when needed). When RightClickSelect is True, the Selection can be changed using the Right mouse button. Otherwise, it is ignored. Multi-selection is handled when the Shift modifier is set for the mouse event.
+ MouseDown ensures that both Left and Right mouse button events are handled (when needed). When RightClickSelect is True, the Selection can be changed using the Right mouse button. Otherwise, it is ignored. Multi-selection is handled when the Shift modifier is set for the mouse event.
- A mouse event on an unused space in the control causes ClearSelection to be called when RowSelect is True. Selected is set to Nil if RowSelect is False.
+ A mouse event on an unused space in the control causes ClearSelection to be called when RowSelect is True. Selected is set to Nil if RowSelect is False.
- When MultiSelect has not been enabled, the selected tree node is assigned to the Selected property. When it has been enabled, the MultiSelect method in Items is used to include the selected tree node in the Selections property. ClearSelection is called if the tree node was de-selected by the mouse event. Selected is set to Nil if the tree node was de-selected by the mouse event.
+ When MultiSelect has not been enabled, the selected tree node is assigned to the Selected property. When it has been enabled, the MultiSelect method in Items is used to include the selected tree node in the Selections property. ClearSelection is called if the tree node was de-selected by the mouse event. Selected is set to Nil if the tree node was de-selected by the mouse event.
The control is Focused (when needed and allowed) by calling the SetFocus method.
@@ -23711,7 +24055,7 @@ AToolbar.ButtonHeight := 30;
MultiSelect is a Boolean property used to enable or disable selection of multiple nodes in the tree view control. The default value for the property is False, and allows a single selected node indicated in the Selection property.
- When set to True, multiple nodes can be selected and stored in the Selections property. Use Ctrl+Click add or remove a node in the Selections property. Use Shift+Click to add or remove a range of nodes in the Selections property.
+ When set to True, multiple nodes can be selected and stored in the Selections property. Use Ctrl+Click to add or remove a node in the Selections property. Use Shift+Click and Ctrl+Shift+Click to add or remove a range of nodes in the Selections property.
Changing the value for the property causes existing nodes in both Selection and Selections to be cleared.
@@ -24482,7 +24830,7 @@ AToolbar.ButtonHeight := 30;
- KeepPrimary indicates whether the first tree node in a multi-selection is retained. When set to False, all selected nodes are removed from the Selections property. Otherwise, the tree node in Selected is retained.
+ KeepPrimary indicates whether the first tree node in a multi-selection is retained. When set to False, all selected nodes are removed from the Selections property. Otherwise, the tree node in Selected is retained.
- If MultiSelect has not been enabled, the value in the Selected property is set to Nil to clear the single node selection.
+ If MultiSelect has not been enabled, the value in the Selected property is set to Nil to clear the single node selection.
- No actions are performed in the method when MultiSelect is False and KeepPrimary is True.
+ No actions are performed in the method when MultiSelect is False and KeepPrimary is True.
ClearSelections is called from methods that handle mouse or keyboard selection, like KeyDown and MouseDown. It is also called when a new value is assigned to the MultiSelect property.
@@ -24510,7 +24858,9 @@ AToolbar.ButtonHeight := 30;
@@ -24562,7 +24912,7 @@ AToolbar.ButtonHeight := 30;
No actions are performed in the method when the number of tree nodes in Items is 0 (zero).
- The return value is always False.
+ The return value is always False.
CustomSort calls BeginUpdate to minimize updates during the sorting process. EndUpdates is called when the sorting process is completed.
@@ -24577,7 +24927,7 @@ AToolbar.ButtonHeight := 30;
- No actions are performed in the method when SelectionVisible returns True.
+ No actions are performed in the method when SelectionVisible returns True.
- If MultiSelect has been enabled in the Options for the control, the ClearMultiSelection method in Items is called to clear the values in the Selections property. Otherwise the Selected property for the TTreeNode instance in Selected is set to False (which makes the Selected property unassigned).
+ If MultiSelect has been enabled in the Options for the control, the ClearMultiSelection method in Items is called to clear the values in the Selections property. Otherwise the Selected property for the TTreeNode instance in Selected is set to False (which makes the Selected property unassigned).
No action are performed if MultiSelect has not been enabled and Selected has not been assigned.
@@ -25005,10 +25359,14 @@ AToolbar.ButtonHeight := 30;
- ScrollBars is a TScrollStyle property with the scrollbars displayed for the tree view control. The default value for the property is ssBoth, and indicates both horizontal and vertical scrollbars are always visible. See TScrollStyle for more information about values in the enumeration and their meanings.
+ ScrollBars is a TScrollStyle property with the scroll bars displayed for the tree view control. The default value for the property is ssBoth, and indicates both horizontal and vertical scroll bars are always visible. See TScrollStyle for more information about values in the enumeration and their meanings.
- Changing the value for the property causes the States property to be update, and the scollbars are redrawn for the control.
+ Changing the value for the property causes the States property to be updated, and the scroll bars are redrawn for the control.
- TabStop is a Boolean property which enables or disables keyboard navigation for the control. When set to True, the control can be entered and exited using the Tab and Shift+Tab keys. When set to False, the control does not respond to these keystrokes, and cannot be entered or exited using the keyboard to navigate the tab order for controls on a form.
+ TabStop is a Boolean property which enables or disables keyboard navigation for the control. When set to True, the control can be entered and exited using the Tab and Shift+Tab keys. When set to False, the control does not respond to these keystrokes, and cannot be entered or exited using the keyboard to navigate the tab order for controls on a form.
- The default value for the property is True in TCustomTreeView.
+ The default value for the property is True in TCustomTreeView.
- The default value for the property is False in TTreeView.
+ The default value for the property is False in TTreeView.
- The default value for the property is True in TTreeView.
+ The default value for the property is True in TTreeView.
- Update is an overridden method used to update the section in the header control. When Item is assigned, the UpdateSection method in the THeaderControl instance is called. If Item is unassigned (contains Nil), the UpdateSections method in the THeaderControl instance is called update all sections in the collection.
+ Update is an overridden method used to update the section in the header control. When Item is assigned, the UpdateSection method in the THeaderControl instance is called. If Item is unassigned (contains Nil), the UpdateSections method in the THeaderControl instance is called update all sections in the collection.
- Register is a procedure used to register components in the Common Controls Tab
+
+ Common Controls Tab
-