From fb8f4bd664c8b02e92d2a52fcd542a50c93da55e Mon Sep 17 00:00:00 2001 From: dsiders Date: Sat, 18 Jun 2022 01:19:45 +0100 Subject: [PATCH] Docs: LCL/editbtn. Removes extra spaces in topics. Updates tagging for True and False values. --- docs/xml/lcl/editbtn.xml | 95 +++++++++++++++++++++++----------------- 1 file changed, 54 insertions(+), 41 deletions(-) diff --git a/docs/xml/lcl/editbtn.xml b/docs/xml/lcl/editbtn.xml index 45e72d6289..e96717d9b1 100644 --- a/docs/xml/lcl/editbtn.xml +++ b/docs/xml/lcl/editbtn.xml @@ -340,7 +340,7 @@ Performs actions needed when the button for the control is clicked.

- The implementation for ButtonClick is empty in TCustomEditButton; use a descendent class which implements a specific functionality. + The implementation for ButtonClick is empty in TCustomEditButton; use a descendent class which implements a specific functionality.

@@ -399,10 +399,10 @@ Indicates whether the Button for the control should be visible.

- CalcButtonVisible is a Boolean function used to determine whether the Button for the control should be visible. The return value is True when the control is Visible and the Edit has focus, or the control is not configured to display its button only when focused. + CalcButtonVisible is a Boolean function used to determine whether the Button for the control should be visible. The return value is True when the control is Visible and the Edit has focus, or the control is not configured to display its button only when focused.

- The return value is always True at design-time. + The return value is always True at design-time.

CalcButtonVisible is used in the implementation of the CheckButtonVisible method. @@ -439,10 +439,10 @@ Ensures the Button for the control is configured and its visibility is set.

- CheckButtonVisible is a procedure which ensures that the Button in the control is configured and its visibility is set. If Button has not been assigned (contains Nil), no actions are performed in the method. + CheckButtonVisible is a procedure which ensures that the Button in the control is configured and its visibility is set. If Button has not been assigned (contains Nil), no actions are performed in the method.

- Otherwise, the Visible property in Button is set to the value returned by CalcButtonVisible. UpdateSpacing is called to adjust the space between Edit and Button as needed for its visibility and Layout. + Otherwise, the Visible property in Button is set to the value returned by CalcButtonVisible. UpdateSpacing is called to adjust the space between Edit and Button as needed for its visibility and Layout.

@@ -500,7 +500,7 @@ - ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control. + ButtonOnlyWhenFocused - if True, the SpeedButton only appears when focus is given to the EditButton control. @@ -527,7 +527,8 @@ - Flat - if True, SpeedButton appears flat rather than three-dimensional. + When True, the SpeedButton has a flat appearance rather than a three-dimensional one. + @@ -606,11 +607,11 @@ - Create - constructor for TCustomEditButton: calls inherited Create then sets some defaults and initializes some variables. + Constructor for the class instance.

- Create - constructor for TCustomEditButton: calls inherited Create then sets some defaults and initializes some variables. + Create is the constructor for TCustomEditButton. It calls the inherited Create method then sets default values and initializes variables.

Initializes height and width, cursor, glyph, style, checks visibility, event handler for click. @@ -640,7 +641,7 @@

- TEditButton implements a grouped edit control with both an Edit and a Button. TEditButton is derived from the TCustomEditButton class, and sets the visibility for properties declared in the ancestor classes. + TEditButton implements a grouped edit control with both an Edit and a Button. TEditButton is derived from the TCustomEditButton class, and sets the visibility for properties declared in the ancestor classes.

@@ -664,7 +665,7 @@

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

@@ -799,7 +800,9 @@ - True if the item matches the filter implemented in the event handler. + + True if the item matches the filter implemented in the event handler. + Pointer to the data for the item examined in the event handler. @@ -814,7 +817,7 @@

- TFilterItemExEvent is a Boolean object function type that specifies an event handler used to filter data items in TCustomControlFilterEdit. It is similar to TFilterItemEvent, but provides an additional argument with the caption for the data item. + TFilterItemExEvent is a Boolean object function type that specifies an event handler used to filter data items in TCustomControlFilterEdit. It is similar to TFilterItemEvent, but provides an additional argument with the caption for the data item.

The return value is True if an item matches a filter condition implemented in the event handler. Done can be updated to indicate if the item requires additional filtering on the title string in the data item; when it contains True, no additional filtering is needed. @@ -830,7 +833,9 @@ - True if the item matches the filter implemented in the event handler. + + True if the item matches the filter implemented in the event handler. + Caption or display name for the item examined in the event handler. @@ -857,7 +862,7 @@ - True when the item is checked. + True when the item is checked. Object examined in the method. @@ -940,13 +945,13 @@

- The value is True when TextHint contains a value other than the rsFilter resource string. + The value is True when TextHint contains a value other than the rsFilter resource string.

. - True when TextHint is included in the LCL component stream. + True when TextHint is included in the LCL component stream. @@ -998,7 +1003,7 @@ Signals the OnFilterItemEx (preferred) or OnFilterItem (deprecated) event handlers (when assigned) to determine if the item meets the filter condition. Values in ACaption and ItemData are passed as arguments to the event handlers.

- The return value is True when the item meets the filter condition(s) implemented in the event handlers. The DoDefaultFilterItem method is called when the return value is False, or the event handlers are not assigned in the class instance. + The return value is True when the item meets the filter condition(s) implemented in the event handlers. The DoDefaultFilterItem method is called when the return value is False, or the event handlers are not assigned in the class instance.

@@ -1008,7 +1013,7 @@ - True when the item meets the filter condition. + True when the item meets the filter condition. Caption for the item passed to DoDefaultFilterItem. @@ -1023,7 +1028,7 @@ - Returns True when the item meets the filter criterion. + Returns True when the item meets the filter criterion. Caption for the item. @@ -1079,7 +1084,7 @@ Filters the data and updates the container.

- Does its job at once when Immediately is set to True. Otherwise, it connects the OnIdle event handler which applies the filter when the Application is idle. + Does its job at once when Immediately is set to True. Otherwise, it connects the OnIdle event handler which applies the filter when the Application is idle.

@@ -1173,7 +1178,9 @@ - True if OnKeyPress is assigned and handles the VK_RETURN key code. + + True if OnKeyPress is assigned and handles the VK_RETURN key code. + @@ -1195,11 +1202,11 @@
CharCase
Set to ecLowerCase
Button.Enabled
-
Set to False
+
Set to False
FilterOptions
Set to an empty set
FIsFirstUpdate, fIsFirstSetFormActivate
-
Set to True
+
Set to True
TextHint
Set to rsFilter
@@ -1370,7 +1377,7 @@ - An event handler to give extra conditions for filtering, in addition to the default behavior. Returns True if the passes the filter. + An event handler to give extra conditions for filtering, in addition to the default behavior. Returns True if the passes the filter. This feature has, for example, enabled filtering the Options windows in Lazarus IDE based on captions for all controls on the options pages. Deprecated. Use OnFilterItemEx with a caption parameter instead. @@ -1477,7 +1484,7 @@

- TDialogKind is an enumerated type representing the dialog styles available for use in TFileNameEdit. Values in the enumeration influence the common dialog type created for a control which displays a dialog when its button is clicked. + TDialogKind is an enumerated type representing the dialog styles available for use in TFileNameEdit. Values in the enumeration influence the common dialog type created for a control which displays a dialog when its button is clicked.

TDialogKind is the type used to implement the DialogKind property in TFileNameEdit. @@ -1541,7 +1548,7 @@ Gets the default glyph name used for the Button on the control.

- The return value contains the resource ID in the ResBtnFileOpen constant. The value is used in the LoadDefaultGlyph method defined in TCustomEditButton. + The return value contains the resource ID in the ResBtnFileOpen constant. The value is used in the LoadDefaultGlyph method defined in TCustomEditButton.

@@ -1604,7 +1611,7 @@

- SaveDialogResult is a procedure used to capture the results from the dialog when it has finished execution. The values are stored in the corresponding properties in the class instance, and depending on the DialogKind, may include: + SaveDialogResult is a procedure used to capture the results from the dialog when it has finished execution. The values are stored in the corresponding properties in the class instance, and depending on the DialogKind, may include:

  • FilterIndex
    • @@ -1642,7 +1649,9 @@ - Performs actions needed when the value for the control has been changed. + + Performs actions needed when the value for the control has been changed. + @@ -1745,7 +1754,7 @@

    - DialogKind is a TDialogKind property that indicates the type of dialog executed when the Button for the control is clicked. The default value for the property is dkOpen, as assigned in the constructor. Use one of the other TDialogKind enumeration values to perform its corresponding action. + DialogKind is a TDialogKind property that indicates the type of dialog executed when the Button for the control is clicked. The default value for the property is dkOpen, as assigned in the constructor. Use one of the other TDialogKind enumeration values to perform its corresponding action.

    @@ -1762,7 +1771,7 @@

    - DialogTitle is a String property that contains the title displayed on the dialog executed by clicking on Button. The value in DialogTitle is assigned to the TCommonDialog descendant created in the CreateDialog method. + DialogTitle is a String property that contains the title displayed on the dialog executed by clicking on Button. The value in DialogTitle is assigned to the TCommonDialog descendant created in the CreateDialog method.

    @@ -1816,7 +1825,7 @@ Hide directory name from edit.

    - If HideDirectories is set to true, the file name editor displays only a file name, without path. + If HideDirectories is set to True, the file name editor displays only a file name, without path.

    This may be useful if application allows user to select files from a fixed directory with a long path. @@ -2157,11 +2166,11 @@ - ShowHidden - if True, display names of hidden directories. + ShowHidden - if True, display names of hidden directories.

    - ShowHidden - if True, display names of hidden directories. In Windows etc, show directories under 'Windows' and branches; in Linux etc show directories with preceding dot e.g. '.Lazarus'. + When ShowHidden is True, the names for hidden directories are displayed. In Windows, this show directories under 'Windows' and branches; in Linux, show directories with preceding dot e.g. '.Lazarus'.

    @@ -2182,7 +2191,9 @@     - Hint displayed when the mouse hovers over the button for the control. + + Hint displayed when the mouse hovers over the button for the control. + @@ -2282,7 +2293,7 @@ TDateTime value examined in the method. - Indicates if the Date/Time can be accepted when True. + Indicates if the Date/Time can be accepted when True. @@ -2664,7 +2675,7 @@ - Indicates the dialog for control is visible when True. + Indicates the dialog for control is visible when True. @@ -2701,10 +2712,12 @@ - DefaultToday - if True, the current date is offered as the default date (value is False by default). + When True, the current date is offered as the default date (value is False by default). - Default value for the property is False. +

    + The default value for the property is False. +

    @@ -2724,7 +2737,7 @@ DateFormat is a String property which contains the format used when converting the Date value to and from text. DateFormat is relevant when DateOrder contains the value doNone; when another TDateOrder value is used, the fixed format needed for the date order is automatically used.

    - DateFormat is used in the implementation of the TextToDate and DateToText methods. + DateFormat is used in the implementation of the TextToDate and DateToText methods.

    @@ -2821,7 +2834,7 @@ Time value examined in the method. - Indicates the time value is accepted when True. + Indicates the time value is accepted when True.