From d37d3f099fba01fdd3ee95e8cab037103d7663c7 Mon Sep 17 00:00:00 2001 From: dsiders Date: Wed, 21 Jul 2021 19:30:34 +0000 Subject: [PATCH] Docs: LCL. Fixes content, links for properties re-declared with different default values. git-svn-id: trunk@65481 - --- docs/xml/lcl/buttonpanel.xml | 4 +- docs/xml/lcl/buttons.xml | 52 +++---- docs/xml/lcl/comctrls.xml | 250 +++++++++++++++++++++++++++++---- docs/xml/lcl/dbctrls.xml | 57 +++++++- docs/xml/lcl/dbgrids.xml | 42 +++++- docs/xml/lcl/editbtn.xml | 46 +++++- docs/xml/lcl/extctrls.xml | 156 ++++++++++++++++----- docs/xml/lcl/filectrl.xml | 2 +- docs/xml/lcl/forms.xml | 158 +++++++++++++++++++-- docs/xml/lcl/grids.xml | 66 +++++++-- docs/xml/lcl/helpintfs.xml | 59 +++++--- docs/xml/lcl/pairsplitter.xml | 8 +- docs/xml/lcl/shellctrls.xml | 75 +++++++++- docs/xml/lcl/stdctrls.xml | 255 +++++++++++++++++++++++++++++----- docs/xml/lcl/valedit.xml | 24 +++- 15 files changed, 1061 insertions(+), 193 deletions(-) diff --git a/docs/xml/lcl/buttonpanel.xml b/docs/xml/lcl/buttonpanel.xml index c84f357c08..3a27d865ac 100644 --- a/docs/xml/lcl/buttonpanel.xml +++ b/docs/xml/lcl/buttonpanel.xml @@ -1093,9 +1093,9 @@ AButtonPanel.ShowGlyphs := [pbOk, pbCancel]; - + - + diff --git a/docs/xml/lcl/buttons.xml b/docs/xml/lcl/buttons.xml index 1f239e47ad..b83658227d 100644 --- a/docs/xml/lcl/buttons.xml +++ b/docs/xml/lcl/buttons.xml @@ -2505,7 +2505,26 @@ - + + + The background color for the control. + + +

+ The default value for the property is clBtnFace in TCustomSpeedButton. +

+

+ If the color is clDefault , the result will need to be passed through GetDefaultColor to resolve clDefault to a TColor value. Convenience routines which obtain the color by resolving clDefault and ParentColor are also provided as TControl.GetColorResolvingParent and TControl.GetRGBColorResolvingParent. +

+ + + TControl.Color + TControl.ParentColor + TControl.GetDefaultColor + TControl.GetColorResolvingParent + TControl.GetRGColGetRGBColorResolvingParentarent + + Indicates if the button has been set to the Down state. @@ -2690,39 +2709,14 @@ - - -

Standard properties, which should be supported by all descendants.

-

Reads the value for color, or stores the value, and sets a flag if the color is stored.

-

The default color is the same as the window in which the control is located.

- - - + - - - - -

Standard properties, which should be supported by all descendants.

-

Whether the control is Enabled. If not, it usually appears 'greyed-out'.

-

Reads a flag to see whether the control is enabled, or stores a new value. If stored, sets a flag to say so.

- - - + - - - -

Standard properties, which should be supported by all descendants.

-

Reads a flag to see what font should be used, or sets a flag to store it. If stored, sets a flag to say so.

-

The properties of Font are defined in the parent class TFont. -

- - - + diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index 3115ebc534..bfa97613cf 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -937,23 +937,65 @@ - + + + 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. +

+ + + TControl.Align + + + - AutoHint - if True, a hint is automatically shown when mouse hovers over status bar. Default is False. + Indicates if a hint is automatically shown when the mouse hovers over the status bar. + +

+ The default value for the property is False. +

+ - TStatusBar default is True. + + Indicates if the control is automatically resized to fill the area on its aligned edge. + + +

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

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

+

+ Convenience routines which obtain the color by resolving clDefault and ParentColor are also provided as TControl.GetColorResolvingParent and TControl.GetRGBColorResolvingParent. +

+ + + TControl.Color + + + @@ -1040,7 +1082,21 @@ - + + 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. +

+

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

+ + + TControl.Visible + + + @@ -3412,13 +3468,16 @@ - + + Enables or disables navigation using the Tab key.

The default value for the property is True in TCustomTabControl.

- + + TWinControl.TabStop + @@ -3545,7 +3604,28 @@ - + + + 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 proprty 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. +

+

+ Use IsControlVisible to determine if the page is currently the active page displayed in the Parent tab control. +

+ + + TCustomPage.TabVisible + + + @@ -5519,7 +5599,7 @@ - + @@ -10599,7 +10679,17 @@ - + + Line style drawn as a border around the control. + +

+ The default value for the property is bsSingle in TCustomListView. +

+ + + TWinControl.BorderStyle + + TCanvas instance used to draw the control. @@ -10865,10 +10955,18 @@ - - - - + + + Allows the user to navigate to this control, by pressing the Tab key. + + +

+ The default value for the property is True in TCustomListView, +

+ + + TWinControl.TabStop + @@ -10926,7 +11024,7 @@ - + @@ -10947,7 +11045,28 @@ - + + + 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. +

+

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

+ + + TControl.ParentColor + TControl.Color + TControl.GetColorResolvingParent + TControl.GetRGBColorResolvingParent + + + @@ -14533,7 +14652,18 @@ AToolbar.ButtonHeight := 30; - + + 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 alTop in TToolBar. +

+ + + TControl.Align + + + @@ -17150,10 +17280,16 @@ AToolbar.ButtonHeight := 30; - - - - + + Enables or disables navigatiopn using the Tab key. + +

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

+ + + TWinControl.TabStop + @@ -17281,7 +17417,7 @@ AToolbar.ButtonHeight := 30; - + @@ -22605,7 +22741,17 @@ AToolbar.ButtonHeight := 30; - + + Line style used to draw the border for the control. + +

+ The default value for the property is bsSingle in TCustomTreeView. +

+ + + TWinControl.BorderStyle + + @@ -23640,7 +23786,17 @@ AToolbar.ButtonHeight := 30; - + + Width of the line drawn as a border around the control. + +

+ The default value for the property is 0 in TCustomTreeView. +

+ + + TWinControl.BorderWidth + + Last visible tree node starting at the TopItem in the control. @@ -23649,13 +23805,15 @@ AToolbar.ButtonHeight := 30; - Color used for the control display area. + Color used for the background in the control display area.

The default value for the property is clWindow. Contains the same value as the BackgroundColor property.

- + + TControl.Color + @@ -24031,7 +24189,17 @@ AText := ATreeView.Items.Item[0].Text; // caption for the first tree node - + + Enables or diables navigation using the Tab key. + +

+ The default value for the property is True in TCustomTreeView. +

+ + + TWinControl.TabStop + + @@ -24075,7 +24243,19 @@ AText := ATreeView.Items.Item[0].Text; // caption for the first tree node - + + + + +

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

+ + + TControl.ParentColor + + + @@ -24095,7 +24275,19 @@ 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. +

+ + + TWinControl.TabStop + + + diff --git a/docs/xml/lcl/dbctrls.xml b/docs/xml/lcl/dbctrls.xml index a0a9310ef1..e8fb083740 100644 --- a/docs/xml/lcl/dbctrls.xml +++ b/docs/xml/lcl/dbctrls.xml @@ -4873,7 +4873,24 @@ - + + + + The maximum length for text entered in the edit box for the control. + + +

+ MaxLength is an Integer property which contains the maximum length for a value entered in the Text for the control. It controls the number of characters allowed in the edit box, but does not limit the length of the value that can be directly assigned to Text. MaxLength is passed to and read from the widgetset class when a handle has been assigned for the control. +

+

+ The default value for the property is -1 in TDBComboBox, and forces the widgetset class to update its value for the property. Setting the value for the property does not alter the existing value in Text. +

+ + + TCustomComboBox.MaxLength + + + @@ -8100,7 +8117,7 @@ - + @@ -8116,7 +8133,27 @@ - + + + Contains the background color for the control. + +

+ Color is a TColor property with the background color for the control. + The default value for the property is clBackground in TDBNavigator. +

+

+ If the color is clDefault, the value will need to be resolved using the GetDefaultColor method. Convenience routines which obtain the color by resolving clDefault and ParentColor are also provided in TControl.GetColorResolvingParent and TControl.GetRGBColorResolvingParent. +

+ + + TCustomPanel.Color + TControl.ParentColor + TControl.GetDefaultColor + TControl.GetColorResolvingParent + TControl.GetRGBColorResolvingParent + + + @@ -8157,7 +8194,19 @@ - + + + Enables or disables navigation using the Tab key. + +

+ The default value for the property is False in TDBNavigator. +

+ + + TCustomPanel.TabStop + + + diff --git a/docs/xml/lcl/dbgrids.xml b/docs/xml/lcl/dbgrids.xml index 43b08c5df9..fbba163583 100644 --- a/docs/xml/lcl/dbgrids.xml +++ b/docs/xml/lcl/dbgrids.xml @@ -5887,12 +5887,50 @@ - + + + + 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 TDBGrid. +

+

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

+ + + TControl.ParentColor + TControl.Color + TControl.GetColorResolvingParent + TControl.GetRGBCGetRGBColorResolvingParentParent + + + - + + + Scrollbars displayed for the grid control. + +

+ ScrollBars is a TScrollStyle property which indicates the scrollbars displayed for the grid control. The default value for the property is ssBoth in TDBGrid, and causes vertical and horizontal scrollbars to be displayed. +

+

+ See TScrollStyle for more information about values in the enumeration and their meanings. +

+ + + TCustomGrid.ScrollBars + TScrollStyle + + Controls whether the Hint is displayed for the control. diff --git a/docs/xml/lcl/editbtn.xml b/docs/xml/lcl/editbtn.xml index 0c4ab3a3bf..0e74c9ba59 100644 --- a/docs/xml/lcl/editbtn.xml +++ b/docs/xml/lcl/editbtn.xml @@ -581,10 +581,14 @@ - Specifies the amount of space reserved between the Edit and Button controls when Button is visible. + Specifies the number of pixels reserved between the Edit and Button controls when Button is visible. - - + +

+ The default value for the property is 4 in TCustomEditButton. +

+ + @@ -645,7 +649,21 @@ - + + + + Enables automatic adjustment of the size for the control, according to its content. + + +

+ AutoSize is a Boolean property which allows the control to automatically adjustment its size to the content in the control. The default value for the property is True in TEditButton. +

+ + + TCustomAbstractGroupedEdit.AutoSize + + + @@ -669,7 +687,7 @@ - + @@ -1300,7 +1318,23 @@ - + + + Controls case conversion performed for a value entered in the control. + + +

+ CharCase is a TEditCharCase property that controls the case conversion used (if any) for a value entered in the control. The default value for the property is ecLowerCase in TCustomControlFilterEdit, and indicates that charcters are converted to lower case. +

+

+ See TEditCharCase for more information about the enumeration values supported for the type. +

+ + + TCustomAbstractGroupedEdit.CharCase + TEditCharCase + + diff --git a/docs/xml/lcl/extctrls.xml b/docs/xml/lcl/extctrls.xml index 17ef1dd617..13a9911551 100644 --- a/docs/xml/lcl/extctrls.xml +++ b/docs/xml/lcl/extctrls.xml @@ -1932,14 +1932,16 @@ Current position for the splitter. - - + + Specifies the placement of the control inside its Parent.

- The default value for the property is alLeft. + Align is a TAlign property which specifies how the control is aligned to its parent control. The default value for the property is alLeft in TCustomSplitter.

- + + TControl.Align + @@ -1959,14 +1961,18 @@ - - + + + The shape for the mouse pointer when the control is dragged. +

- The default value for the property is crHSplit. + The default value for the property is crHSplit in TCustomSplitter.

- + + TControl.Cursor + @@ -2033,7 +2039,7 @@ - + @@ -2709,21 +2715,13 @@ - -

- The default value for the property is False. -

- + - -

- The default value for the property is False. -

- + @@ -5264,7 +5262,17 @@ - + + Enables or disables navigation using the Tab key. + +

+ The default value for the property is False in TCustomPanel. +

+ + + TWinControl.TabStop + + @@ -5280,7 +5288,7 @@ - + @@ -5296,7 +5304,7 @@ - + @@ -5308,15 +5316,30 @@ - + - - + + + + Determines whether a DockManager is used for this DockSite. + +

+ The default value for the property is True in TPanel. +

+

+ When UseDockManager is set to True, and DockSite is also set to True, a DockManager is created automatically. When set to False, an existing DockManager is ignored. If you want to use a special DockManager, install it before setting UseDockManager to True. +

+ + + TWinControl.UseDockManager + + + @@ -5879,6 +5902,11 @@ Determines if controls in TCustomFlowPanel are wrapped. + +

+ The default value for the property is True in TFlowPanel. +

+ @@ -5913,7 +5941,21 @@ - + + + + Determines if child controls are automatically wrapped when needed. + + +

+ The default value for the property is True in TFlowPanel. +

+ + + + + + @@ -5925,7 +5967,22 @@ - + + + Determines whether a DockManager is used for this DockSite. + +

+ The default value for the property is True in TFlowPanel. +

+

+ When UseDockManager is set to True, and DockSite is also set to True, a DockManager is created automatically. When set to False, an existing DockManager is ignored. If you want to use a special DockManager, install it before setting UseDockManager to True. +

+ + + TWinControl.UseDockManager + + + @@ -7857,7 +7914,19 @@ - + + + Allows drag-docking of controls onto this control. + + +

+ A DockSite reacts on controls dragged over this control, signals acceptance and where a dragged control would be dropped. The default value for the property is True in TCustomControlBar. +

+ + + TWinControl.DockSite + + Fill style used for bands on the control bar. @@ -8019,19 +8088,42 @@ - + - - + + + Drawing style for the inner bevel on the control. + +

+ The default value for the property is bvRaised in TControlBar. +

+ + + TCustomPanel.BevelInner + + + + + Drawing style for the outer bevel on the control. + +

+ The default value for the property is bvLowered in TControlBar. +

+ + + TCustomPanel.BevelOuter + + + - + diff --git a/docs/xml/lcl/filectrl.xml b/docs/xml/lcl/filectrl.xml index cd1c8af327..5a6d362322 100644 --- a/docs/xml/lcl/filectrl.xml +++ b/docs/xml/lcl/filectrl.xml @@ -644,7 +644,7 @@ - + diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index c379606212..835a6b4500 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -1418,10 +1418,42 @@ - + + + + Indicates whether scroll bars are automatically displayed or hidden when needed. + + +

+ AutoScroll is a Boolean property which indicates if scroll bars are automatically displayed or hidden on the control as needed. The default value for the property is True in TScrollBox. +

+

+ Changing the value for the property causes the Visible property in both HorzScrollBar and VertScrollBar to be updated (if needed). When set to True, the UpdateScrollBars method is called to calculate the page, range, and visibiity for the scroll bars. When set to False , the HideScrollbars method is called to reset and hide the scroll bars (when assigned). +

+ + + TScrollingWinControl.AutoScroll + TScrollingWinControl.UpdateScrollbars + TScrollingWinControl.HorzScrollBar + TScrollingWinControl.VertScrollBar + + + - + + + Line style used to draw the border around the control. + +

+ The default value for the property is bsSingle in TScrollBox. +

+ + + TWinControl.BorderStyle + + + @@ -1433,7 +1465,28 @@ - + + + + Indicates if the control uses the background from its Parent control. + + +

+ ParentBackground is a Boolean property which indicates if the background for the Parent control is drawn as the background for the current control instance. The default value in TScrollBox is False. +

+

+ ParentBackground is True when csParentBackground is included in the ControlStyle property. Setting the value in ParentBackground causes ControlStyle to be updated to include or exclude the csParentBackground enumeration value; it is included when True. +

+ + + TWinControl.ParentBackground + TControl.ControlStyle + TControl.Parent + TControlStyle + TControlStyleType + + + @@ -1907,7 +1960,7 @@ - + Indicates if the control uses the background from the parent.

@@ -4963,7 +5016,7 @@ - + The background color for the form. Color is a TColor property with the background color used for the form. Color is re-declared in TCustomForm to use either clDefault or clBtnFace as the default value for the property. clDefault is used when the UseCLDefault compiler define exists, and indicates that the color is resolved to the value in a Parent control (when assigned). @@ -5529,12 +5582,18 @@ - - + + + Uses the font from the Parent when enabled. +

+ If true, the Font will be the same as the one from the Parent. The default value for the property is False in TCustomForm.

+

+ While ParentFont is True, all changes to the font of the parent will also be applied to the font for the control. This synchronizes them, keeping them set to the same value. If the Font for the control is changed by the application, then ParentFont will automatically be set to False. +

TControl.ParentFont @@ -5832,7 +5891,7 @@ - + @@ -5892,7 +5951,7 @@ - + @@ -6006,9 +6065,57 @@ Owner for the class instance. - - - + + + Indicates if the form can automatically show or hide scroll bars. + + +

+ AutoScroll is a Boolean property which indicates if the form can automatically show or hide its scroll bars. The default valule for the property is False in TCustomDockForm. +

+

+ AutoScroll can only be True when the BorderStyle for the form is bsSizeable or bsSizeToolWin , and may be changed to False at run-time when BorderStyle is changed to another value. +

+ + + TCustomDockForm.BorderStyle + TCustomForm.AutoScroll + + + + + + The border style affects the title bar, border and resize behavior of the form. + + +

+ Use BorderStyle to get or set the appearance of the form's border. The default value in TCustomDockForm is bsSizeToolWin. +

+

+ This property is slightly different (has a different base type) from the TCustomControl.BorderStyle property. When the form is put into another control the window borders depend on the widgetset. There are no borders under GTK. +

+ + + TCustomForm.BorderStyle + TFormBorderStyle + + + + + + Indicates the style for the form. + + +

+ The default value in TCustomDockForm is fsStayOnTop. +

+ + + TCustomForm.FormStyle + TFormStyle + + + @@ -10412,6 +10519,33 @@ + + + Displays the Help Table of Contents using the Help Manager for the application. + + +

+ HelpShowTableOfContents is a method used to display the Help Table of Contents for the application. It uses the global HelpManager variable (when assigned) to call its ShowTableOfContents method. This method must be re-implemented in a descendent class; the default implementation simply returns the shrHelpNotFound result. +

+

+ The return value is True when the HelpManager successfully displays the Table of Contents, and returns the shrSuccess result code. If HelpManager has not been assigned, the return value is always False. +

+ + + HelpManager + THelpManager.ShowTableOfContents + TShowHelpResult + + + Added in LCL version 2.2.0. This method is Delphi compatible. + + + + + True if the Help Table of Contents was successfully displayed by the application. + + + When Sender is a TControl, invoke its ShowHelp method. diff --git a/docs/xml/lcl/grids.xml b/docs/xml/lcl/grids.xml index 00f2789f2c..88efb193bb 100644 --- a/docs/xml/lcl/grids.xml +++ b/docs/xml/lcl/grids.xml @@ -9989,7 +9989,7 @@ - + TScrollStyle @@ -11557,7 +11557,7 @@

- + TScrollStyle @@ -12612,12 +12612,16 @@ - - + + Allows the user to navigate to this control, by pressing the Tab key. - The default value for TabStop is True in TCustomGrid. +

+ The default value for TabStop is True in TCustomGrid. +

- + + TWinControl.TabStop + @@ -13926,7 +13930,30 @@ - + + + + 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 TDrawGrid. +

+

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

+ + + TControl.ParentColor + TControl.Color + TControl.GetColorResolvingParent + TControl.GetRGBColorResolvingParent + + + @@ -15187,7 +15214,30 @@ - + + + + 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 TStringGrid. +

+

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

+ + + TControl.ParentColor + TControl.Color + TControl.GetColorResolvingParent + TControl.GetRGBColorResolvingParent + + + diff --git a/docs/xml/lcl/helpintfs.xml b/docs/xml/lcl/helpintfs.xml index 0d2bc973f7..e0fc44ad3b 100644 --- a/docs/xml/lcl/helpintfs.xml +++ b/docs/xml/lcl/helpintfs.xml @@ -286,21 +286,24 @@
Message
The message text without other parsed items.
- 
-  Example:
-
-    Message written by FPC:
-      unit1.pas(21,3) Warning: unit buttons not used
-
-    Results in:
-      Stage=FPC
-      Type=Warning
-      Line=21
-      Column=3
-      Message=unit buttons not used
-
+

+ Example: +

+

+ Message written by FPC: +

+ unit1.pas(21,3) Warning: unit buttons not used +

+ Results in: +

+ +Stage=FPC +Type=Warning +Line=21 +Column=3 +Message=unit buttons not used + - @@ -388,34 +391,44 @@ - - - + Performs actions when help is not available in the help manager. + +

+ DoHelpNotFound is a TShowHelpResult class function used to perform actions when help cannot be displayed using the help manager instance. It sets the help result and error message when the help file, query, or context is not available (or implemented) in the help manager. The default implementation sets the return value to shrHelpNotFound, and sets ErrMsg to 'Help not found'. +

+

+ DoHelpNotFound is called from help manager methods which display a given help type. +

+ - + Error message displayed when help is not available in the help manager. - + Displays the Help Table of Contents for the help manager. - + Help display result code. - + Error message displayed when the return value is not shrSuccess. - - + Not implemented in THelpManager. + +

+ Abstract virtual method which must be implemented in a descendent class. +

+ diff --git a/docs/xml/lcl/pairsplitter.xml b/docs/xml/lcl/pairsplitter.xml index 08e4edbb0e..0b03cfcfce 100644 --- a/docs/xml/lcl/pairsplitter.xml +++ b/docs/xml/lcl/pairsplitter.xml @@ -419,9 +419,13 @@ True if the class has a specific ancestor. - + Cursor displayed when the control is resized. - + +

+ The default value for the property is crHSplit in TCustomPairSplitter. +

+ TControl.Cursor diff --git a/docs/xml/lcl/shellctrls.xml b/docs/xml/lcl/shellctrls.xml index a388759cc7..5f48228ee3 100644 --- a/docs/xml/lcl/shellctrls.xml +++ b/docs/xml/lcl/shellctrls.xml @@ -814,7 +814,24 @@ - + + + + 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 TShellTreeView. +

+

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

+ + + + + + @@ -829,10 +846,21 @@ - + + + Enables navigation using the Tab key. + +

+ The default value for the properly is True in TShellTreeView. +

+ + + TWinControl.TabStop + + + - Tag value for the component. @@ -1418,9 +1446,24 @@ - + - + + + The background color for the control. + +

+ The default value for the properly is clWindow in TShellListView. +

+

+ If Color is set to clDefault, it needs to be passed through GetDefaultColor to resolve clDefault to a TColor value. Convenience routines which obtain the color by resolving clDefault and ParentColor are also provided as TControl.GetColorResolvingParent and TControl.GetRGBColorResolvingParent. +

+ + + TControl.Color + + + @@ -1432,7 +1475,25 @@ - + + + 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 TShellListView. +

+

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

+ + + TControl.ParentColor + + + @@ -1446,7 +1507,7 @@ - + diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml index a3024734e0..27b3cfef6a 100644 --- a/docs/xml/lcl/stdctrls.xml +++ b/docs/xml/lcl/stdctrls.xml @@ -646,7 +646,18 @@ - + + Enables navigation using the Tab key. + +

+ Allows the user to navigate to this control, by pressing the Tab key. + The default value for the property is True in TCustomScrollBar. +

+ + + TWinControl.TabStop + + Event handler signalled when the value in Position, Min, Max, or PageSize is changed. @@ -768,7 +779,7 @@ - + @@ -2553,7 +2564,20 @@ - + + 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 TCustomComboBox. +

+

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

+ + + TControl.ParentColor + + Determines whether the list entries are sorted in alphanumeric order. @@ -3145,7 +3169,17 @@ - + + Enables or disables navigation using the Tab key. + +

+ Allows the user to navigate to this control, by pressing the Tab key. The default value for the property is True in TCustomComboBox. +

+ + + TWinControl.TabStop + + The value in the edit box for the control. @@ -3263,7 +3297,7 @@ - + @@ -3273,7 +3307,7 @@ - + @@ -4368,7 +4402,18 @@ - + + + Line style used for the border on the control. + +

+ Indicates the line style drawn as a border around the control. The default value for the property is bsSingle in TCustomListBox. +

+ + + TWinControl.BorderStyle + + Drawing surface where the control is drawn. @@ -4611,7 +4656,21 @@ - + + Use 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 TCustomListBox. +

+

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

+ + + TControl.ParentColor + + + @@ -4738,7 +4797,19 @@ - + + + Enables navigation using the Tab key. + +

+ Allows the user to navigate to this control, by pressing the Tab key. + The default value for the property is True in TCustomListBox. +

+ + + + + Index of the first visible (or top-most) item. @@ -4797,7 +4868,7 @@ - + @@ -4857,7 +4928,6 @@ - @@ -4868,7 +4938,7 @@ - + @@ -4878,7 +4948,7 @@ - + @@ -5950,8 +6020,31 @@ - - + + + Allows automatic adjustment of the size for the control, according to its content. + + +

+ 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. The default value for the property is True in TCustomEdit. and enables auto-sizing the control instance to its content. +

+ + + TControl.AutoSize + + + + + Indicates the line style drawn as a border around the control. + +

+ The default value for the property is bsSingle in TCustomEdit. +

+ + + TWinControl.BorderStyle + + Indicates whether the last change can be reverted in the control. @@ -6258,7 +6351,19 @@ - + + + Enables navigation using the Tab key. + +

+ Allows the user to navigate to this control, by pressing the Tab key. + The default value for the property is True in TCustomEdit. +

+ + + TWinControl.TabStop + + The text displayed and edited for the control. @@ -6979,10 +7084,10 @@ end; - + - + @@ -7030,7 +7135,7 @@ end; - + @@ -7122,7 +7227,7 @@ end; - + @@ -7172,7 +7277,7 @@ end; - + @@ -8316,7 +8421,18 @@ end; - + + Enables navigation using the Tab key. + +

+ Allows the user to navigate to this control, by pressing the Tab key. + The default value for the property is True in TCustomButton. +

+ + + + + Implements a push button control. @@ -8360,7 +8476,7 @@ end; - + @@ -8399,7 +8515,7 @@ end; - + @@ -8805,7 +8921,21 @@ end; - + + + + Allows automatic adjustment of the size for the control, according to its content. + + +

+ 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. The default value for the property is True in TCheckBox, and enables auto-sizing for the control instance. +

+ + + TControl.AutoSize + + + @@ -8852,7 +8982,20 @@ end; - + + + Enables navigation using the Tab key. + +

+ Allows the user to navigate to this control, by pressing the Tab key. + The default value for the property is True in TCheckBox. +

+ + + TWinControl.TabStop + + + @@ -8943,7 +9086,20 @@ end; - + + + Enables navigation using the Tab key. + +

+ Allows the user to navigate to this control, by pressing the Tab key. + The default value for the property is True in TToggleBox. +

+ + + TWinControl.TabStop + + + @@ -9088,8 +9244,8 @@ end; - - + + Enables or disables auto-sizing the control to its content.

The default value for the property is True in TRadioButton. @@ -9143,7 +9299,20 @@ end; - + + + Enables navigation using the Tab key. + +

+ Allows the user to navigate to this control, by pressing the Tab key. + The default value for the property is True in TRadioButton. +

+ + + TWinControl.TabStop + + + @@ -9774,8 +9943,11 @@ end; - Enables or disables auto-sizing for the control. + Enables or disables auto-sizing for the control to its content. +

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

The default value for the property is True in TCustomLabel.

@@ -9922,7 +10094,20 @@ end; - + + 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 is False in TCustomLabel. +

+

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

+ + + TControl.ParentColor + + Control used to display static text, possibly in multiple lines. @@ -9943,11 +10128,11 @@ end; - + - + @@ -9978,7 +10163,7 @@ end; - + diff --git a/docs/xml/lcl/valedit.xml b/docs/xml/lcl/valedit.xml index b38c371a34..debdb8c041 100644 --- a/docs/xml/lcl/valedit.xml +++ b/docs/xml/lcl/valedit.xml @@ -2506,7 +2506,29 @@ - + + + + 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 TValueListEditor. +

+

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

+ + + TControl.ParentColor + TControl.GetColorResolvingParent + TControl.GetRGBColorResolvingParent + + +