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 @@ - + Set type with the parts changed on the status panel. - SetIndex saves the old index value, checks that the supplied value is different and then calls inherited method. + Sets the value for the Index property. - + +

+ SetIndex saves the old index value, checks that the supplied value is different and then calls inherited method. +

+
TCollectionItem.Index
- + New value for the Index property. - Create - constructor for TStatusPanel: sets default width, alignment and bevel, calls inherited Create and loads into StatusBar. + Constructor for the class instance. +

+ 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. +

TCollectionItem.Create @@ -350,31 +357,51 @@ - Destroy - destructor for TStatusPanel: calls inherited Destroy and removes itself from the StatusBar. + Destructor for the class instance. - + +

+ Destroy is the destructor for TStatusPanel and calls the inherited Destroy method. It removes itself from the StatusBar by calling its InvalidatePanel method. +

+
+ + TCollectionItem.Destroy
- Assign copies text, width, alignment, bevel and style properties from Source if it is of correct type, otherwise calls inherited Assign (which will probably raise an exception). + Implements persistence for the class type. - + + Assign copies text, width, alignment, bevel and style properties from Source if it is of correct type, otherwise calls inherited Assign (which will probably raise an exception). + TPersistent.Assign - Class instance with the values stored in the status panel. + + Class instance with the values stored in the status panel. + - The StatusBar that contains this StatusPanel - - + + Gets the status bar which contains the class instance. + + +

+ 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. +

+
+ + + + TCollectionItem.Collection +
Status bar where the panel is displayed. @@ -390,47 +417,89 @@ The type of Bevel for the display. - Only supported on Windows. + +

+ Supported for the Windows platform only. +

+
- Introduces BiDiMode support not present in the ancestor class. + + Introduces BiDiMode support not present in the ancestor class. + - Introduces BiDiMode support not present in the ancestor class. + + Introduces BiDiMode support not present in the ancestor class. + - Style - whether text or something drawn by the owner. + Indicates whether the panel contains text or is owner-drawn. - - + +

+ 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. +

+
+
psText
+
+ Indicates that the panel draws its Text on the panel. Causes the widgetset class to send a message which sets the text for the panel handle. +
+
psOwnerDraw
+
+ Indicates that the panel is drawn using the OnDrawPanel routine assigned to the StatusBar for the panel. Causes an additional drawing flag to be set when the widgetset class updates the panel on its StatusBar. +
+
+

+ 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. +

+
+ + + + + + + + TCollectionItem +
- Text - the string for display in the StatusBar. + Text displayed on 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. +

+
- The Width of this panel on the StatusBar. + + The Width for the panel on the StatusBar. + - TStatusPanels - the collection of Status Panels in this StatusBar. + A collection of panels displayed on a status bar control. @@ -524,32 +593,101 @@ - Provides indexed access to the TStatusPanel items in the collection. - + + Provides indexed access to the TStatusPanel items in the collection. + + +

+ 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: +

+// var AStatusBar: TStatusBar; +AStatusBar.Panels.Items[0]; +AStatusBar.Panels[0]; + +

+ It is also the target member for an enumerator. For example: +

+// var AStatusBar: TStatusBar; +// APanel: TStatusPanel; +for APanel in AStatusBar.Panels do +begin + APanel.Alignment := taCenter; + APanel.Width := 88; +end; + +

+ Use methods like Add, Delete, and Clear to maintain the items in the collection. +

+
+ + + TCollection.Clear + TCollection.Delete TCollection.Items
- Ordinal position for the collection item. + Ordinal position for the status bar panel. - The StatusBar to which this collection of Status Panels belongs. + The StatusBar to which this collection of status panels belongs. - - + +

+ 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. +

+
+ + + + + TCollection +
- TSBCreatePanelClassEvent - generic event handling procedure for creating a Status Bar panel class. + Specifies an event handler signalled to get the class type for a new status bar panel. + +

+ 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. +

+
+ + + + +
+ + Object (TStatusBar) for the event. + + + Class reference for the new panel. - Specified an event handler used to draw a panel in a status bar. + + Specifies an event handler used to draw a panel in a status bar. +

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. + Displays a panel along the bottom of a form with current status information.

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 @@ - DoSetApplicationHint - specifies a hint string and returns True if successful. + DoSetApplicationHint - specifies a hint string and returns True if successful. @@ -762,7 +900,9 @@ Displays the hint for the status bar. - DoHint shows the hint text for the control and returns True when successful. Uses the OnHint event handler. +

+ DoHint shows the hint text for the control and returns True when successful. Uses the OnHint event handler. +

@@ -836,9 +976,13 @@ - Destroy - destructor for TStatusBar: frees canvas and panels, then calls inherited Destroy. + Destructor for the class instance. - + +

+ Destroy is the destructor for TStatusBar. It frees the Canvas and panels, and calls the inherited Destroy method. +

+
TWinControl.Destroy TComponent.Destroy @@ -868,14 +1012,16 @@ - BeginUpdate - starts the update process. + Starts an update process for the status bar. + - EndUpdate - finishes the update process. + Finishes an update process for the status bar. + @@ -898,7 +1044,7 @@ GetPanelIndexAt gets the ordinal position for the panel at the specified coordinates. The return value is -1 when Panels have not been defined in the status bar. No actions are performed in the method when Panels is empty.

- 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.

@@ -909,30 +1055,37 @@
- Horizontal coordinate to locate in the Panels for the status bar. + + Horizontal coordinate to locate in the Panels for the status bar. + - Vertical coordinate to locate in the Panels for the status bar. + + Vertical coordinate to locate in the Panels for the status bar. + - SizeGripEnabled - returns True if the size-grip (an area at the bottom of the statusbar where a mouse can grip to change the size) is enabled. + SizeGripEnabled - returns True if the size-grip (an area at the bottom of the statusbar where a mouse can grip to change the size) is enabled. - UpdatingStatusBar - returns True if the status bar is being updated. + Returns True if the status bar is being updated. + - True if the status bar is being updated. + True if the status bar is being updated. - The Canvas where the Panels for the StatusBar are are Painted. + + The Canvas where the Panels for the StatusBar are painted. + @@ -943,7 +1096,7 @@ Specifies the placement of the control inside its Parent.

- 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.

@@ -959,7 +1112,7 @@

- The default value for the property is False. + The default value for the property is False.

@@ -970,7 +1123,7 @@

- The default value for the property is True in TStatusBar. + The default value for the property is True in TStatusBar.

@@ -986,10 +1139,10 @@ The background color of the control.

- 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.

@@ -1005,7 +1158,9 @@ - Collection with the TStatusPanel instances defined for the control. + + Collection with the TStatusPanel instances defined for the control. +

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. + SimpleText - a character string containing the information to be displayed in the Status Bar. +

- 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.

@@ -1087,14 +1243,16 @@ Indicates if the control is visible.

- 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.

TControl.Visible + TControl.Show + TControl.Hide
@@ -1357,14 +1515,18 @@
- True if message contains an accelerator key handled in the method. + + True if message contains an accelerator key handled in the method. + Message examined in the method. - Performs actions needed when Visible is changed to False. + + Performs actions needed when Visible is changed to False. +

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 @@ - Performs actions needed when Visible is changed to True. + + Performs actions needed when Visible is changed to True. +

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 @@ - Always returns False. + Always returns False. @@ -1485,7 +1649,7 @@ - True when the control is visible. + True when the control is visible. @@ -1506,10 +1670,10 @@ VisibleIndex is an Integer function used to get the ordinal position for the page instance within the list of visible pages for the Parent control.

- 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 @@ Locates a visible page in the tab control.

- 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 @@ - Always returns False in TCustomTabControl. + Always returns False in TCustomTabControl. - Moves the specified page control to the position in NewIndex. + + Moves the specified page control to the position in NewIndex. + @@ -2563,7 +2729,9 @@ - Ensures that the current page has its Visible property set to True. + + Ensures that the current page has its Visible property set to True. +

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 @@ - True if the accelerator was handled in the active page. + + True if the accelerator was handled in the active page. + Message with the accelerator key examined in the method. @@ -2907,7 +3077,7 @@

- 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.

@@ -3038,7 +3208,7 @@
- Always returns True. + Always returns True. @@ -3435,7 +3605,7 @@ - ShowTabs - if True (default condition), show the tabs for each page. + Shows the tabs for each page when set to True (default). @@ -3612,13 +3782,13 @@ Indicates if the tab is visible in the Parent control.

- 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. +

@@ -4105,7 +4279,7 @@

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

@@ -4242,7 +4416,7 @@ - IsUpdating - returns True if in the process of updating. + IsUpdating - returns True if in the process of updating. @@ -4283,7 +4457,7 @@ - MultiLine - if True, multiple lines may be used in Tab strings. + MultiLine - if True, multiple lines may be used in Tab strings. @@ -4291,7 +4465,7 @@ - MultiSelect - if True, multiple tabs can be selected, for example by holding down Shift or Ctrl keys while selecting. + MultiSelect - if True, multiple tabs can be selected, for example by holding down Shift or Ctrl keys while selecting. @@ -4299,14 +4473,14 @@ - OwnerDraw - if True, Owner object (or calling routine) can specify drawing methods. + OwnerDraw - if True, Owner object (or calling routine) can specify drawing methods. - RaggedRight - if True, strings are un-justified or un-aligned with ragged right margin. + RaggedRight - if True, strings are un-justified or un-aligned with ragged right margin. @@ -4314,7 +4488,7 @@ - ScrollOpposite - if True, scrolling proceeds in opposite direction to usual. + ScrollOpposite - if True, scrolling proceeds in opposite direction to usual. @@ -4747,7 +4921,7 @@ - SetUpdateState - if Updating is True, calls BeginUpdate; otherwise calls EndUpdate. + SetUpdateState - if Updating is True, calls BeginUpdate; otherwise calls EndUpdate. @@ -5133,7 +5307,7 @@ SetTabHeight is used to set the height for the tabs displayed on the control to the value in AValue. SetTabHeight calls GetCapabilities to determine if the value nbcTabsSizeable is included in the capabilities for the control. No actions are performed in the method when nbcTabsSizeable is not present in the controls capabilities list.

- 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.

@@ -5226,7 +5400,7 @@ Indicates whether the tab control can update its Tabs property.

- 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.

@@ -5235,18 +5409,20 @@
- True if the Tabs for the control can be modified. + + True if the Tabs for the control can be modified. + Indicates if the control can show the tab at the specified position. -

Always returns True in TTabControl.

+

Always returns True in TTabControl.

- Always returns True in TTabControl. + Always returns True in TTabControl. Ordinal position for the requested tab. @@ -5878,16 +6054,16 @@
- The list item has its Cut property set to True. + The list item has its Cut property set to True. - The list item has its DropTarget property set to True. + The list item has its DropTarget property set to True. - The list item has its Focused property set to True. + The list item has its Focused property set to True. - The list item has its Selected property set to True. + The list item has its Selected property set to True. @@ -6132,7 +6308,7 @@ Indicates whether icons in a list view can be automatically arranged.

- 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 @@ Indicates if the caption for a list item can wrap into multiple lines.

- 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 @@ - True when the list items have the same content. + True when the list items have the same content. List item compared to the current class instance. @@ -6532,11 +6708,15 @@ - True if the list item has an owner with a valid handle. + + True if the list item has an owner with a valid handle. + - True if the member variable for the Checked property contains True. + + True if the member variable for the Checked property contains True. +

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.

@@ -6642,7 +6822,9 @@
- True is the list item can be partially visible in the control. + + True is the list item can be partially visible in the control. + @@ -6699,7 +6881,9 @@
- True if the control is not ReadOnly and the editor is valid, otherwise False. + + True if the control is not ReadOnly and the editor is valid, otherwise False. + @@ -6725,7 +6909,7 @@ - Checked - if True, a check mark is present beside the item implying it has been selected. + Checked - if True, a check mark is present beside the item implying it has been selected. @@ -6743,14 +6927,14 @@ - DropTarget - returns True if this is a valid target on the list for dropping. + DropTarget - returns True if this is a valid target on the list for dropping. - Property is true if this item has Focus. + Property is True if this item has Focus. @@ -6797,10 +6981,10 @@

- 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.

@@ -6920,7 +7104,7 @@ - True if the owner for the list item has been assigned and can be updated in the widgetset class. + True if the owner for the list item has been assigned and can be updated in the widgetset class. @@ -6930,7 +7114,7 @@ - Sets the internal index position for the virutal item. + Sets the internal index position for the virtual item. @@ -7783,7 +7967,7 @@ The Changed method is called to signal a change in the values for the collection item.

- 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).

@@ -8258,23 +8442,37 @@ - TLVColumnClickEvent - generic event handler method for a click on a List View column. + Specifies an event handler signalled for a mouse click on a list view column. - - + +

+ 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. +

+
+ + + +
- + Object (TCustomListView) for the event. - + TListColumn instance for the event. - TLVColumnRClickEvent - generic event handler method for a right click on a List View column. + Specifies an event handler signalled for a right mouse click on a list view column. - + +

+ Not used in the current LCL version. +

+
@@ -8692,7 +8890,7 @@ TListViewProperties is a set type used to store zero or more values from the TListViewProperty enumeration.

- 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 @@ -9395,7 +9594,7 @@ - True when the list item can be partially visible in the control; False requires the item to be fully visible to be displayed. + True when the list item can be partially visible in the control; False requires the item to be fully visible to be displayed. @@ -9551,8 +9750,7 @@ Toggles the Boolean value in the ShowEditorQueued property, and calls the ShowEditor method.

- 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.

@@ -9657,7 +9855,7 @@ Clears the current selection for the control.

- 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 @@ - ItemInserted - the specified item is inserted into the list. + Performs actions when a list item has been inserted in the Items collection. - - + +

+ 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. +

+
+ + + + + + +
- + List item for the insert notification. @@ -9793,7 +10001,7 @@ Gets the default size for new instances of the class.

- 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.

@@ -9806,7 +10014,7 @@ - InitializeWnd - calls inherited method, then sets various local properties. + Calls the inherited method, and sets default values in properties. InitializeWnd - calls inherited method, then sets style, adds columns, sets imagelists and item depending properties (scroll bars, sorting etc), adds items and sets other miscellaneous properties (default item height, hot track styles, hover time etc) @@ -9819,7 +10027,9 @@ Frees the window handle and other resources for the control. - FinalizeWnd retrieves the cached origin for the list view and finalizes the items and columns for the control. +

+ FinalizeWnd retrieves the cached origin for the list view and finalizes the items and columns for the control. +

TWinControl.FinalizeWnd @@ -9833,39 +10043,76 @@ Signals the OnCreateItemClass event handler to get the class type used for new list items, and creates a new list item. - - + +

+ 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. +

+
+ + + + + + + +
List item created in the method. - Creates a new TListItems instance. - - + + Creates a new TListItems instance used in the Items property. + + + CreateListItems allocates the container used for the Items property when OwnerData is set to False. It creates and returns a new TListItems instance using the list view control as the Owner of the items in the container. A TOwnerDataListItems instance is allocated for use in Items when OwnerData is changed to True. + + + + + + + TListItems instance created in the method. - Determines if the specified Item can be edited in the control. + + Determines if the specified list Item can be edited in the control. +

- 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.

- + + + + + + + +
- True if the editor can be displayed and activated for the specified item. + + True if the editor can be displayed and activated for the specified list item. + List item to examine in the method. @@ -9900,13 +10147,13 @@ ColClick ensures that the Editor for the control is hidden when it has been assigned and displayed for 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 @@ - Item with the values inserted into the Items for the control. + + Item with the values inserted into the Items for the control. + @@ -10042,12 +10291,14 @@ - True if the list item is selected. + True if the list item is selected. - Adjusts the layout for the list view using the specified arguments. + + Adjusts the layout for the list view using the specified arguments. +

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 @@ - Performs actions when editing has been completed for an item in the control. + Performs actions when editing has been completed for a list item.

@@ -10126,10 +10377,20 @@ - ImageChanged - procedure to signal that an image has changed. + Implements the event handler signalled when an image on the control is changed. - - + +

+ 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. +

+
+ + + TChangeLink.OnChange +
Object for the event notification. @@ -10155,7 +10416,7 @@

- 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.

@@ -10169,7 +10430,7 @@ - IsCustomDrawn - returns True if a target has been custom drawn. + Returns True if a target has been custom drawn.

@@ -10190,31 +10451,53 @@ - Performs custom drawing in the given rectangle and returns True if successful. + Performs custom drawing in the specified rectangle and returns True on success.

- 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.

+ + + + + + +
- + + True if the control was drawn using the assigned event handlers. + - + + Bounds rectangle for the drawing operation. + - + + Drawing stage for the control. Affects the OnCustomDraw event handler. + - Custom draws the specified item and returns True if successful. + Custom draws the specified item and returns True on success.

- 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).

@@ -10234,11 +10517,11 @@ - Custom draws the specified subitem returning True if successful. + Custom draws the specified subitem and returns True on success.

- 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).

@@ -10323,7 +10606,7 @@ - Performs actions to get list item data when OwnerData is True. + Performs actions to get list item data when OwnerData is True.

@@ -10333,11 +10616,13 @@ - + List item updated in the method. - Signals the OnDataHint event handler (when assigned). + + Signals the OnDataHint event handler (when assigned). + @@ -10352,7 +10637,9 @@ - Signals the OnDataStateChange event handler (when assigned). + + Signals the OnDataStateChange event handler (when assigned). + @@ -10372,7 +10659,7 @@ - + Member used to store the multi-selection list in the class instance. @@ -10399,7 +10686,7 @@ - The first TListItem instance with its Selected property set to True. + The first TListItem instance with its Selected property set to True. @@ -10424,7 +10711,7 @@ - True if the internal multi-selection list needs to be initialized. False when MultiSelect is not enabled and the list is not required. + True if the internal multi-selection list needs to be initialized. False when MultiSelect is not enabled and the list is not required. @@ -10469,7 +10756,7 @@ Performs actions needed when the control is double clicked.

- 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.

@@ -10601,7 +10888,7 @@ Columns is a TListColumns property which contains the column definitions for the list view control. The TListItem instances in the collection contain information about the caption for the column header, column width, image, and sort indicator value. Assigning a new collection to the property causes the designer for the parent form to be updated at design-time.

- 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.

- The Windows API documentation recommends setting HideSelection to False if the application uses Accessiblity roles and descriptions. + The Windows API documentation recommends setting HideSelection to False if the application uses Accessiblity roles and descriptions.
@@ -10672,7 +10959,7 @@

- 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 @@ The event handler is not signalled in the current LCL 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. + 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.

@@ -11383,7 +11670,7 @@ Locates the list item closest to the specified position.

- 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.

@@ -11519,7 +11806,7 @@

- 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.

@@ -11597,7 +11884,7 @@ FlatScrollBars is a Boolean property which indicates if scroll bars are drawn using a "flat" display style. Flat scroll bars are not drawn using raised 3-D relief with shadowing normally used for borders or edges on the control. It also applies color inversion when elements in the control are hovered under the mouse pointer.

- 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.

@@ -11615,7 +11902,7 @@ Enables or disables grid lines between rows and columns on the control.

- 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.

@@ -11703,13 +11990,13 @@ ItemIndex is an Integer property which contains the ordinal position for the selected item on the list view 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. + 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.

Click
-
Toggles the selected state for the list item under the mouse pointer.
+
+ Toggles the selected state for the list item under the mouse pointer. +
Shift+Click
Toggles the selected state for a contiguous block of list items from the mouse pointer to the previous item selection. @@ -11766,7 +12055,7 @@ Use SelCount to get the number of selected items when MultiSelect is enabled. Use Items to access the list items to check the values in their Selected properties.

- 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 @@ - Disables editing of list items on the control when set to True. + Disables editing of list items on the control when set to True.

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,

@@ -11963,7 +12252,7 @@ The important information is held in Items, a string-list that can be created using the string-list editor obtained by right-clicking on the ListView in the Form Editor or by clicking on the ellipsis (...) next to the Items entry in the Object Inspector.

- 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 @@ + TCustomImageList @@ -12010,10 +12300,10 @@ Uses the Color from the Parent control, when enabled.

- 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 @@ - True when the mouse pointer in within the bounds for the control. + + True when the mouse pointer in within the bounds for the control. + @@ -12826,7 +13118,9 @@ - True when the mouse pointer is not in the client rectangle for the control. + + True when the mouse pointer is not in the client rectangle for the control. + @@ -13001,7 +13295,7 @@ - True when the position value is being incremented. False when being decremented. + True when the position is being incremented. False when being decremented. @@ -13009,7 +13303,7 @@

- 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.

Introduced in LCL version 2.1.0. @@ -13231,7 +13525,7 @@ - CanChange - if True, control can be changed. + CanChange - if True, control can be changed. @@ -13279,7 +13573,7 @@ - ArrowKeys - if True, the control can be operated by the keyboard's arrow keys which would simulate a click on the Next or Previous button. + ArrowKeys - if True, the control can be operated by the keyboard's arrow keys which would simulate a click on the Next or Previous button. @@ -13370,7 +13664,7 @@ - If True, multiply all displayed values and the Increment by 1000. + If True, multiply all displayed values and the Increment by 1000. @@ -13385,7 +13679,7 @@ - If True, displayed control or value starts again from minimum or maximum value if clicking a button would cause incrementing or decrementing beyond the extreme value. + If True, displayed control or value starts again from minimum or maximum value if clicking a button would cause incrementing or decrementing beyond the extreme value. @@ -13592,7 +13886,7 @@ - SetChecked - stores the Checked status (True or False). + SetChecked - stores the Checked status (True or False). @@ -13853,7 +14147,7 @@ The Sender argument is the new TCustomAction instance assigned to the Action property for the tool button.

- 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 @@ - New action for the control, or Nil. + New action for the control, or Nil. Indicates if the property in the action must be assigned (not empty). @@ -13973,7 +14267,7 @@ If the mouse event is over the drop-down indicator, the DropDownMenu when its AutoPopUp property is enabled. This requires sending a LM_LBUTTONUP message to ensure that the feature works for all widgetsets.

- 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 @@ - Handles a message sent when the mouse lesaves a control. + Handles a message sent when the mouse leaves a control. TControl.MouseLeave @@ -14217,10 +14511,10 @@

- 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.

- Change the Grouped property to False on a separator or divider to force the preceding or subsequent check-box buttons to be treated as a different group. + Change the Grouped property to False on a separator or divider to force the preceding or subsequent check-box buttons to be treated as a different group.
@@ -14232,7 +14526,7 @@
- True when the AllowAllUp property is set for any of the adjacent grouped check-box buttons on the tool bar. + True when the AllowAllUp property is set for any of the adjacent grouped check-box buttons on the tool bar. @@ -14254,7 +14548,7 @@
- True If the message was handled as an accelerator key for the tool bar button. + True If the message was handled as an accelerator key for the tool bar button. @@ -14329,7 +14623,7 @@
- True if the drop-down menu for the button was successfully displayed and executed. + True if the drop-down menu for the button was successfully displayed and executed. @@ -14364,7 +14658,7 @@ GetCurrentIcon is a method used to get information for the icon drawn on the tool button. It returns values in the variable parameters with the scaled image list for the icon, its position in the image list, and the drawing effect for the image.

- 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 @@ - True when the coordinates are within the arrow for the drop-down. + + True when the coordinates are within the arrow for the drop-down. + Horizontal coordinate examined in the method. @@ -14472,11 +14768,11 @@ - Indicates if all buttons in a group can have their Down property set to False. + Indicates if all buttons in a group can have their Down property set to False.

- 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.

@@ -14493,7 +14789,7 @@ The action performed depends on the control type. For example, a label or button can become bigger or smaller to accommodate a longer or shorter caption.

- 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 @@ - Is this button Down (i.e. has it been selected)? Default false. + Is this button Down (i.e. has it been selected)? Default False.

@@ -14557,7 +14853,7 @@ - Indicates if the tool button is a member of a group. The default value is False. + Indicates if the tool button is a member of a group. The default value is False.

Is this button a member of a group?

@@ -14625,7 +14921,7 @@ Indicates if the tool button is marked.

- 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 @@

alLeft, alRight
-
The return value is True.
+
The return value is True.
alNone, alClient, alCustom
-
The return value is True when Height is larger than Width.
+
The return value is True when Height is larger than Width.

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 @@ - True when the buttons on the control are displayed vertically. + + True when the buttons on the control are displayed vertically. + @@ -15096,7 +15394,7 @@ - True when ButtonHeight is 0 or larger. + True when ButtonHeight is 0 or larger. @@ -15105,7 +15403,7 @@ - True when ButtonWidth is 0 or larger. + True when ButtonWidth is 0 or larger. @@ -15114,7 +15412,7 @@ - True when DropDownWidth is 0 or larger. + True when DropDownWidth is 0 or larger. @@ -15159,7 +15457,7 @@ - True if the menu item for the button was checked (clicked) in the method. + True if the menu item for the button was checked (clicked) in the method. Tool button examined in the method. @@ -15235,10 +15533,14 @@ - Tool button using the specified shortcut, or Nil when not found. + + Tool button using the specified shortcut, or Nil when not found. + - Shortcut or accelerator key to locate in the tool bar buttons. + + Shortcut or accelerator key to locate in the tool bar buttons. + @@ -15276,7 +15578,7 @@

- 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.

@@ -15532,7 +15834,7 @@ AToolbar.ButtonHeight := 30; - Always returns False for TToolBar. + Always returns False for TToolBar.

The tool bar cannot be given focus, but its buttons or controls can. @@ -15543,7 +15845,7 @@ AToolbar.ButtonHeight := 30; - Always returns False for TToolBar. + Always returns False for TToolBar. @@ -15869,7 +16171,7 @@ AToolbar.ButtonHeight := 30; List is a Boolean property which indicates if the buttons on the tool bar are displayed using a list style.

- 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; Indicates whether captions are displayed on tool bar buttons.

- 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; - True when ParentBitmap is not set. + True when ParentBitmap is not set. @@ -16110,7 +16412,7 @@ AToolbar.ButtonHeight := 30; - True when ParentColor is not set. + True when ParentColor is not set. @@ -16411,7 +16713,7 @@ AToolbar.ButtonHeight := 30;

  • Break (True)
  • Color (clDefault)
  • -
  • Control (set to Nil)
  • +
  • Control (set to Nil)
  • FixedBackground (True)
  • ImageIndex (-1)
  • MinHeight (cDefMinHeight)
  • @@ -16564,7 +16866,7 @@ AToolbar.ButtonHeight := 30; Color for the band.

    - 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.

    @@ -16574,7 +16876,7 @@ AToolbar.ButtonHeight := 30; Control displayed on the band.

    - 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.

    @@ -16796,7 +17098,7 @@ AToolbar.ButtonHeight := 30; - TCoolBand instance with the specified control, or Nil when not found. + TCoolBand instance with the specified control, or Nil when not found. @@ -17179,7 +17481,9 @@ AToolbar.ButtonHeight := 30; - True to reserve additional space for theme elements. + + True to reserve additional space for theme elements. + @@ -17210,10 +17514,10 @@ AToolbar.ButtonHeight := 30; - True is a band is under the mouse pointer. + True is a band is under the mouse pointer. - True is the grabber is under the mouse pointer. + True is the grabber is under the mouse pointer. @@ -17283,7 +17587,7 @@ AToolbar.ButtonHeight := 30; ABand is the ordinal position for the requested band in the visible bands for the control. It represents an element in the internal array of visible TCoolBand instances populated in the CalculateAndAlign method.

    - 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; - True is the requested band is the left edge of the visible display area for the control. + True is the requested band is the left edge of the visible display area for the control. @@ -17535,7 +17839,7 @@ AToolbar.ButtonHeight := 30; MouseToBandPos is a method used to get the position for the band under the specified mouse coordinates.

    - 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; - True if the value in Width should be resized. + True if the value in Width should be resized. - True if the value in Height should be resized. + True if the value in Height should be resized. @@ -18219,7 +18523,7 @@ AToolbar.ButtonHeight := 30; - True if the values are displayed in ascending order from right-to-left. + True if the values are displayed in ascending order from right-to-left. @@ -18258,7 +18562,7 @@ AToolbar.ButtonHeight := 30; Enables or disables navigatiopn using the Tab key.

    - The default value for the property is True in TCustomTrackBar. + The default value for the property is True in TCustomTrackBar.

    @@ -18442,7 +18746,7 @@ AToolbar.ButtonHeight := 30; Visible has been set in the TTreeNode.
    - Enabled has been set to True for the TTreeNode. + Enabled has been set to True for the TTreeNode. The tree node is bound to a tree (has a Parent) or is a top-level node. @@ -18728,7 +19032,7 @@ AToolbar.ButtonHeight := 30; - TTVEditingEvent - generic event handling method for editing a specified node if AllowEdit is True. + TTVEditingEvent - generic event handling method for editing a specified node if AllowEdit is True. @@ -18779,7 +19083,7 @@ AToolbar.ButtonHeight := 30; - TTVExpandingEvent - generic event handling method for expanding a tree node if AllowExpansion is True. + TTVExpandingEvent - generic event handling method for expanding a tree node if AllowExpansion is True. @@ -18796,7 +19100,7 @@ AToolbar.ButtonHeight := 30; - TTVCollapsingEvent - generic event handling method for collapsing a Tree Node if AllowCollapse is True. + TTVCollapsingEvent - generic event handling method for collapsing a Tree Node if AllowCollapse is True. @@ -18990,7 +19294,7 @@ AToolbar.ButtonHeight := 30; - True if the specified node has child nodes. + True if the specified node has child nodes. Object (TCustomTreeView ) for the event notification. @@ -19128,7 +19432,7 @@ AToolbar.ButtonHeight := 30; - True if the node is expanded to show its child nodes, or False when it is collapsed. + True if the node is expanded to show its child nodes, or False when it is collapsed. @@ -19430,10 +19734,10 @@ AToolbar.ButtonHeight := 30; It notifies the owner ( the TTreeNodes container) that the tree node and its accessibility object are being deleted. The Unbind method is called to remove any references to the node in the parent and sibling nodes, or as a selection in TreeNodes.

    - 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; - True on success. + True on success. @@ -19502,17 +19806,17 @@ AToolbar.ButtonHeight := 30; CustomSort - Sorts the child nodes using SortProc.

    - 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.

    - Always returns True. + Always returns True. - Sorting algorithm executed in the method, or Nil to use the default procedure. + Sorting algorithm executed in the method, or Nil to use the default procedure. @@ -19597,7 +19901,7 @@ AToolbar.ButtonHeight := 30; - DisplayRect - returns the coordinates of the rectangle containing the current entry; if TextOnly is True, returns the coordinates for the text. + DisplayRect - returns the coordinates of the rectangle containing the current entry; if TextOnly is True, returns the coordinates for the text. @@ -19660,7 +19964,9 @@ AToolbar.ButtonHeight := 30; - True if editing was enabled for the tree node in the method. + + True if editing was enabled for the tree node in the method. + @@ -19686,7 +19992,7 @@ AToolbar.ButtonHeight := 30; - The TTreeNode instance in Items with the specified value, or Nil if not found. + The TTreeNode instance in Items with the specified value, or Nil if not found. @@ -19709,7 +20015,9 @@ AToolbar.ButtonHeight := 30; - First tree node in the Items property, or Nil when Items is empty. + + First tree node in the Items property, or Nil when Items is empty. + @@ -19817,7 +20125,7 @@ AToolbar.ButtonHeight := 30; - Gets the last child node in Items with its Visible property set to True. + Gets the last child node in Items with its Visible property set to True. @@ -19904,7 +20212,7 @@ AToolbar.ButtonHeight := 30; - Gets the next sibling node for the current tree node, or Nil when a sibling does not exist. + Gets the next sibling node for the current tree node, or Nil when a sibling does not exist. @@ -19931,16 +20239,22 @@ AToolbar.ButtonHeight := 30; - Next node in the tree node navigation order, or Nil. + + Next node in the tree node navigation order, or Nil. + - Gets the next child or sibling for the current node that is visible and enabled. + + Gets the next child or sibling for the current node that is visible and enabled. + - Child or sibling tree node, or Nil when not enabled and visible. + + Child or sibling tree node, or Nil when not enabled and visible. + @@ -20000,7 +20314,9 @@ AToolbar.ButtonHeight := 30; Node which is the previous child node. - Node which is the previous sibling for the specified child, or Nil. + + Node which is the previous sibling for the specified child, or Nil. + @@ -20080,7 +20396,9 @@ AToolbar.ButtonHeight := 30; - The located tree node, or Nil if none of the sibling nodes are both visible and enabled. + + The located tree node, or Nil if none of the sibling nodes are both visible and enabled. + @@ -20093,7 +20411,7 @@ AToolbar.ButtonHeight := 30; - Returns True if the specified node is a parent for the current node. + Returns True if the specified node is a parent for the current node. @@ -20160,7 +20478,9 @@ AToolbar.ButtonHeight := 30; - True to collapses all descendent nodes in the subtree. + + True to collapses all descendent nodes in the subtree. + @@ -20173,11 +20493,11 @@ AToolbar.ButtonHeight := 30; - Frees the current tree node when the Deleting property is not True. + Frees the current tree node when the Deleting property is not 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.

    @@ -20201,7 +20521,7 @@ AToolbar.ButtonHeight := 30;
    - True if the edited value for Text is discarded. + True if the edited value for Text is discarded. @@ -20216,7 +20536,7 @@ AToolbar.ButtonHeight := 30; - True to expand all descendent nodes. + True to expand all descendent nodes. @@ -20298,7 +20618,7 @@ AToolbar.ButtonHeight := 30; - WriteDebugReport - for debugging. If Recurse is True, report for all descendants as well. + WriteDebugReport - for debugging. If Recurse is True, report for all descendants as well. @@ -20334,7 +20654,7 @@ AToolbar.ButtonHeight := 30;

    - 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.

    @@ -20360,7 +20680,7 @@ AToolbar.ButtonHeight := 30; - True if the node has been marked for deletion in the associated tree view control. + True if the node has been marked for deletion in the associated tree view control.

    @@ -20372,14 +20692,14 @@ AToolbar.ButtonHeight := 30; - True if the node is a drop target in a drag and drop operation. + True if the node is a drop target in a drag and drop operation.

    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.

    @@ -20387,7 +20707,7 @@ AToolbar.ButtonHeight := 30; - True if the node has been expanded, False when collapsed. + True if the node has been expanded, False when collapsed.

    @@ -20402,7 +20722,7 @@ AToolbar.ButtonHeight := 30; - True if the node has focus in the TreeView control. + True if the node has focus in the TreeView control.

    @@ -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; - True if the entire node is visible in the display area for the associated TreeView control. + True if the entire node is visible in the display area for the associated TreeView control.

    @@ -20518,7 +20838,7 @@ AToolbar.ButtonHeight := 30; - True if the node is visible. + True if the node is visible.

    @@ -20570,7 +20890,7 @@ AToolbar.ButtonHeight := 30; - MultiSelected - if True, several nodes have been selected simultaneously (e.g. using the Shift or Ctrl key while selecting). + MultiSelected - if True, several nodes have been selected simultaneously (e.g. using the Shift or Ctrl key while selecting). @@ -20623,7 +20943,7 @@ AToolbar.ButtonHeight := 30; - True if the current node is selected in the tree view control. + True if the current node is selected in the tree view control.

    @@ -20787,7 +21107,7 @@ AToolbar.ButtonHeight := 30; - True if the tree node is visible in the associated TreeView control. + True if the tree node is visible in the associated TreeView control.

    @@ -20807,7 +21127,7 @@ AToolbar.ButtonHeight := 30; Controls whether the tree node can be selected, and its visual appearance.

    - 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; - True when more tree nodes are available in the internal container. + + True when more tree nodes are available in the internal container. + @@ -21041,7 +21363,9 @@ AToolbar.ButtonHeight := 30; TTreeNode instance created or updated in the method. - An existing tree node to update, or Nil to create a new tree node. + + An existing tree node to update, or Nil to create a new tree node. + Text for the tree node. @@ -21345,7 +21669,7 @@ 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; - Tree node with the specified text, or Nil. + Tree node with the specified text, or Nil. Text to locate in the top-level siblings. @@ -21398,7 +21722,7 @@ AToolbar.ButtonHeight := 30; - Gets the first top-level tree node with its Visible property set to True. + Gets the first top-level tree node with its Visible property set to True. @@ -21451,7 +21775,7 @@ AToolbar.ButtonHeight := 30; - Gets the last top-level tree node with its Visible property set to True. + Gets the last top-level tree node with its Visible property set to True. @@ -21466,7 +21790,9 @@ AToolbar.ButtonHeight := 30; - The tree node, or Nil when a top-level sibling is not visible and enabled. + + The tree node, or Nil when a top-level sibling is not visible and enabled. + @@ -21563,14 +21889,14 @@ AToolbar.ButtonHeight := 30; - True if the node is part of a multi-selection in the internal selection list. + True if the node is part of a multi-selection in the internal selection list. - True if the node is part of a multi-selection in the internal selection list. + True if the node is part of a multi-selection in the internal selection list. @@ -21658,7 +21984,7 @@ AToolbar.ButtonHeight := 30; - True to add the node, False to remove the node in the selection list. + True to add the node, False to remove the node in the selection list. @@ -21710,7 +22036,7 @@ AToolbar.ButtonHeight := 30; - True to remove all existing nodes in the selection list, False to remove the most recent node. + True to remove all existing nodes in the selection list, False to remove the most recent node. @@ -21756,7 +22082,7 @@ AToolbar.ButtonHeight := 30; - KeepCollapsedNodes - if True, preserves the nodes that have been collapsed. + KeepCollapsedNodes - if True, preserves the nodes that have been collapsed. @@ -21907,12 +22233,12 @@ AToolbar.ButtonHeight := 30; - Allows selection of several tree-items, e.g. using Ctrl+click and Shift+click. Has the same affect as setting the MultiSelect property to True. + Allows selection of several tree-items, e.g. using Ctrl+click and Shift+click. Has the same affect as setting the MultiSelect property to True. - Automatically expands child nodes for a tree-item when user clicks it, or the item is activated by code. Has the same affect as setting the AutoExpand property to True. + Automatically expands child nodes for a tree-item when user clicks it, or the item is activated by code. Has the same affect as setting the AutoExpand property to True. @@ -22517,10 +22843,14 @@ AToolbar.ButtonHeight := 30; No actions are performed in the method for any of the following conditions:

      -
    • ANode has not been assigned (contains Nil).
    • +
    • ANode has not been assigned (contains Nilb>).
    • ANode is not visible.
    • -
    • BeginEditing has been called and EndEditing has not yet been called.
    • -
    • CanEdit (and the OnEditing event handler) returns False.
    • +
    • + BeginEditing has been called and EndEditing has not yet been called. +
    • +
    • + CanEdit (and the OnEditing event handler) returns False. +

    If a different node is being edited in the control, the EndEditing method is called. @@ -22552,7 +22882,7 @@ AToolbar.ButtonHeight := 30; - True if the specified tree node can be used in the Selected or Selections properties. + True if the specified tree node can be used in the Selected or Selections properties.

    @@ -22573,7 +22903,7 @@ AToolbar.ButtonHeight := 30; - True if the specified tree node can be used in the Selected or Selections properties. + True if the specified tree node can be used in the Selected or Selections properties. @@ -22581,13 +22911,13 @@ AToolbar.ButtonHeight := 30; - Returns True if a given TreeNode can be collapsed. + Returns True if a given TreeNode can be collapsed.

    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; - True if the specified node can be collapsed. + + True if the specified node can be collapsed. + Tree node examined in the method. - Returns True if the specified tree node can be edited. + Returns True if the specified tree node can be edited.

    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.

    - True if the specified tree node can modify its property values. + + True if the specified tree node can modify its property values. + Tree node examined in the method. - True if the specified tree node can be expanded. + True if the specified tree node can be expanded.

    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; - True if the specified node can be expanded. + True if the specified node can be expanded. Tree node examined in the method. @@ -22666,11 +23000,11 @@ 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.

    - 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.

    - 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.

    @@ -22728,11 +23062,15 @@ AToolbar.ButtonHeight := 30;
    - True when tvoAutoItemHeight in not in the Options for the control. + + True when tvoAutoItemHeight in not in the Options for the control. + - Applies a layout adjustment policy using the specified scaling factors. + + Applies a layout adjustment policy using the specified scaling factors. + TControl.DoAutoAdjustLayout @@ -22754,7 +23092,9 @@ AToolbar.ButtonHeight := 30; - True when ExpandSignSize has a value other than the default (-1). + + True when ExpandSignSize has a value other than the default (-1). + @@ -22867,7 +23207,9 @@ AToolbar.ButtonHeight := 30; - The expanded tree node found at the vertical coordinate, or Nil when a node is not found. + + The expanded tree node found at the vertical coordinate, or Nil when a node is not found. + @@ -22904,12 +23246,14 @@ AToolbar.ButtonHeight := 30; - True when Indent has a value other than the default value (-1). + + True when Indent has a value other than the default value (-1). + - IsCustomDrawn - returns True if the specified target is custom drawn. + IsCustomDrawn - returns True if the specified target is custom drawn. @@ -22921,7 +23265,7 @@ AToolbar.ButtonHeight := 30; - True when event handlers have been assigned for the specified target and stage. + True when event handlers have been assigned for the specified target and stage. @@ -22933,14 +23277,14 @@ AToolbar.ButtonHeight := 30; - Returns True if the specified tree node and its parent nodes are visible and expanded. + Returns True if the specified tree node and its parent nodes are visible and expanded. - True if the specified tree node and its parent nodes are visible and expanded. + True if the specified tree node and its parent nodes are visible and expanded. @@ -22949,7 +23293,7 @@ AToolbar.ButtonHeight := 30; - IsNodeHeightFullVisible - returns True if the full height of the specified node is visible in the current view. + IsNodeHeightFullVisible - returns True if the full height of the specified node is visible in the current view. @@ -22963,7 +23307,7 @@ AToolbar.ButtonHeight := 30; - IsInsertMarkVisible - returns True if an Insert mark is visible. + IsInsertMarkVisible - returns True if an Insert mark is visible. @@ -22995,7 +23339,7 @@ AToolbar.ButtonHeight := 30; - True to include the tree node in Selections (when enabled), False to select only the specified node. + True to include the tree node in Selections (when enabled), False to select only the specified node. @@ -23313,10 +23657,10 @@ AToolbar.ButtonHeight := 30; 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 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.

    @@ -23591,13 +23935,13 @@ AToolbar.ButtonHeight := 30; The tree node for the mouse event is retrieved using GetNodeAt for the mouse coordinates. The Selected state for the tree node is saved so the selection can be restored prior to exit.

    - 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; - True if the node has child nodes. False if OnHasChildren has not been assigned. + True if the node has child nodes. False if OnHasChildren has not been assigned. @@ -23991,7 +24335,9 @@ AToolbar.ButtonHeight := 30; - True if the node data was successfully added to the accessibility object. + + True if the node data was successfully added to the accessibility object. + @@ -24089,13 +24435,15 @@ AToolbar.ButtonHeight := 30; - Enables or disables selection of several tree-items at one time. + + Enables or disables selection of multiple tree nodes at the same time. +

    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; - Always returns False (because CustomSort returns False). + Always returns False (because CustomSort returns False). @@ -24495,13 +24843,13 @@ AToolbar.ButtonHeight := 30; If MultiSelect has been enabled in the Options for the control, the ClearMultiSelection method is called to clear the selected nodes.

    - 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; - True if the first node in a multi-selection is kept. + + True if the first node in a multi-selection is kept. + @@ -24531,7 +24881,7 @@ AToolbar.ButtonHeight := 30;

    FMaxRight member
    Raises the exception if FMaxRight has a negative value.
    IsEditing / Selected
    -
    Raises the exception if IsEditing is True and Selected is unassigned.
    +
    Raises the exception if IsEditing is True and Selected is unassigned.
    Selected
    Raises the exception if the node in Selected is not visible.
    Items
    @@ -24552,7 +24902,7 @@ AToolbar.ButtonHeight := 30; - If True, the external method specified in SortProc is used for sorting. + If True, the external method specified in SortProc is used for sorting.

    @@ -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; - Always returns False. + Always returns False. Routine used to implement the sort procedure in the method. @@ -24644,7 +24994,9 @@ AToolbar.ButtonHeight := 30; - Visible tree node at the specified position, or Nil when not found. + + Visible tree node at the specified position, or Nil when not found. + Horizontal coordinate for the the node or row. @@ -24763,7 +25115,9 @@ AToolbar.ButtonHeight := 30; - True if the tvsIsEditing flag is present in States. + + True if the tvsIsEditing flag is present in States. + @@ -24951,7 +25305,7 @@ AToolbar.ButtonHeight := 30; - True when a selected tree node on the control is visible. + True when a selected tree node on the control is visible. @@ -24964,7 +25318,7 @@ AToolbar.ButtonHeight := 30; MakeSelectionVisible allows the control to display a selected node on the tree view control. It forces the tree node to become visible in the display area for the control. The node made visible is either the value in Selected or the first multi-selected node in Selections. The MakeVisible method for the TTreeNode instance is called to update the parent nodes and the associated tree view control.

    - No actions are performed in the method when SelectionVisible returns True. + No actions are performed in the method when SelectionVisible returns True.

    @@ -24979,7 +25333,7 @@ AToolbar.ButtonHeight := 30; Clears selected tree node(s) in the control if they are not visible.

    - 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; - TStringList with the text for nodes selected in the method. + + TStringList with the text for nodes selected in the method. + - True if the TStringList instance is freed in the method. + + True if the TStringList instance is freed in the method. + @@ -25019,7 +25377,9 @@ AToolbar.ButtonHeight := 30; - True if the next node becomes selected in the control. + + True if the next node becomes selected in the control. + @@ -25030,7 +25390,9 @@ AToolbar.ButtonHeight := 30; - True if the previous node becomes selected in the control. + + True if the previous node becomes selected in the control. + @@ -25041,7 +25403,9 @@ AToolbar.ButtonHeight := 30; - True if the node becomes selected in the control. + + True if the node becomes selected in the control. + @@ -25052,7 +25416,7 @@ AToolbar.ButtonHeight := 30; - True if the node becomes selected in the control. + True if the node becomes selected in the control. @@ -25061,7 +25425,7 @@ AToolbar.ButtonHeight := 30; - True if the node is selected in the control. + True if the node is selected in the control. @@ -25070,7 +25434,7 @@ AToolbar.ButtonHeight := 30; - True if the node is selected in the control. + True if the node is selected in the control. @@ -25377,7 +25741,7 @@ AText := ATreeView.Items.Item[0].Text; // caption for the first tree node - KeepCollapsedNodes - if True, the collapsed nodes are to be retained. + KeepCollapsedNodes - if True, the collapsed nodes are to be retained. @@ -25410,10 +25774,10 @@ AText := ATreeView.Items.Item[0].Text; // caption for the first tree node Specifies the scroll bars displayed for the tree view control.

    - 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.

    @@ -25619,10 +25983,10 @@ AText := ATreeView.Items.Item[0].Text; // caption for the first tree node Enables or disables navigation using the Tab key.

    - 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.

    @@ -25677,7 +26041,7 @@ AText := ATreeView.Items.Item[0].Text; // caption for the first tree node

    - The default value for the property is False in TTreeView. + The default value for the property is False in TTreeView.

    @@ -25709,7 +26073,7 @@ AText := ATreeView.Items.Item[0].Text; // caption for the first tree node Enables or disables navigation using the Tab key.

    - The default value for the property is True in TTreeView. + The default value for the property is True in TTreeView.

    @@ -25898,7 +26262,7 @@ OldExpanded.Free; Tree view with nodes examined in the method.
    - Collapses previously expanded child nodes when True. + Collapses previously expanded child nodes when True. @@ -26241,10 +26605,12 @@ OldExpanded.Free; - Performs actions needed when a collection item has been changed. + + Performs actions needed when a collection item has been changed. +

    - 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.

    Update does not call the inherited method which notifies observers of the change. @@ -26296,17 +26662,25 @@ OldExpanded.Free;
    - Header section created (optional) and stored in the method. + + Header section created (optional) and stored in the method. + - Header section to add in the method, or Nil to create a new one. + + Header section to add in the method, or Nil to create a new one. + - Ordinal position in the collection where the header section is stored. + + Ordinal position in the collection where the header section is stored. + - Inserts a new collection item at the specified position in the collection. + + Inserts a new collection item at the specified position in the collection. + TCollection.Insert @@ -27100,9 +27474,10 @@ OldExpanded.Free; Registers components in the Lazarus IDE.

    - Register is a procedure used to register components in the comctrls.pp unit in the Lazarus IDE. Register adds the following components: + Register is a procedure used to register components in the comctrls.pp unit in the Lazarus IDE. Register adds the following components to the Component palette:

    -

    Common Controls Tab +

    + Common Controls Tab

    • TTrackbar