From d9d99ef620b24903edd9c70b143c3579e8e3f228 Mon Sep 17 00:00:00 2001 From: dsiders Date: Thu, 8 Sep 2022 00:27:18 +0100 Subject: [PATCH] Docs: LCL/editbtn. Updates topic content and See Also links. * Adds missing short descriptions. * Removes unused tagging in linked topics. * Fixes grammar and spelling errors. --- docs/xml/lcl/editbtn.xml | 277 +++++++++++++++++++++++++++++---------- 1 file changed, 211 insertions(+), 66 deletions(-) diff --git a/docs/xml/lcl/editbtn.xml b/docs/xml/lcl/editbtn.xml index 7e8b74f9fc..864f96536d 100644 --- a/docs/xml/lcl/editbtn.xml +++ b/docs/xml/lcl/editbtn.xml @@ -77,7 +77,7 @@ The value was modified in LCL version 2.4. Added in LCL version 2.4. - + @@ -388,12 +388,14 @@ 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 ButtonClick it a virtual method in +TCustomEditButton, and the implementation is empty; use a +descendent class which re-implements the method with the functionality needed +for the control.

- + + @@ -496,19 +498,53 @@ CalcButtonVisible is used in the implementation of the - + +True if the control is visible and has focus, or is configured to +always shows its editor button. + -GetDefaultGlyphName finds the name of the default glyph used for -the Button. +Gets the name of the default glyph resource used for the Button on the +control. - - + +

+GetDefaultGlyphName is String function used to get the default +resource name with the glyph image for the Button on the control. It is used +in the LoadDefaultGlyph method to assign the LCLGlyphName for the +TButtonGlyph instance used in the control. +

+

+GetDefaultGlyphName is a virtual method in TCustomEditButton, and does not +provide an actual value (other than an empty string). It must be +re-implemented in a descendant class to return the name for its glyph +resource. Descendants include: +

+
    +
  • TCustomControlFilterEdit
    • +
  • TFileNameEdit
    • +
  • TDirectoryEdit
    • +
  • TDateEdit
    • +
  • TTimeEdit
    • +
  • TCalcEdit
    • +
+ + + + + + + + +TButtonGlyph.LCLGlyphName + - + +Default resource name for the glyph image on the Button in the control. + @@ -1124,6 +1160,7 @@ does not have focus, it displays the greyed value "(filter)". New value for the property. + Event handler signalled to apply a filter when an Application becomes idle. @@ -1158,20 +1195,20 @@ OnIdle signals the OnAfterFilter event handler (when assigned). Object for the event notification. - +Not used or updated in TCustomControlFilterEdit. - -Indicates if the value in TextHint is stored in the LCL component streaming -mechanism - +Indicates if the value in TextHint is stored in the LCL component streaming +mechanism. + +

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

. - +

+ @@ -1384,12 +1421,16 @@ is a virtual abstract method, and must be implemented in a derived classes. Moves to the next value matching the filter for the control. +

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

 - + +True if the value should be selected following the move operation. + @@ -1404,18 +1445,24 @@ Abstract virtual method that must be implemented in a descendent class. - + +True if the value should be selected following the move operation. + Moves one page of previous values matching the filter. +

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

 - + +True if the value should be selected following the move operation. + @@ -1428,7 +1475,9 @@ Abstract virtual method that must be implemented in a descendent class. - + +True if the value should be selected following the move operation. + @@ -1441,7 +1490,9 @@ Abstract virtual method that must be implemented in a descendent class. - + +True if the value should be selected following the move operation. + @@ -1454,7 +1505,9 @@ Abstract virtual method that must be implemented in a descendent class. - + +True if the value should be selected following the move operation. + @@ -2043,10 +2096,15 @@ Performs actions needed when the value for the control has been changed. Signals the OnFolderChange event handler (when assigned). - + + + + - + +Object instance (TFileNameEdit) for the event notification. + @@ -2080,9 +2138,23 @@ calls the inherited constructor. Create allocates resource needed for the -RunDialog executes the dialog for the control. +Executes an Open or Save dialog for the DialogKind specified in the control. - + +

+RunDialog is a virtual method used to create, display, and execute +a dialog when the button for the control is clicked. It calls the +CreateDialog method to create a TDialogKind instance for the type indicated +in the DialogKind property. The Execute method for the dialog is called to +display the dialog form. If Execute returns True, the SaveDialogResult +method is called to perform the Open or Save action(s) needed for the +DialogKind. +

+

+RunDialog is called from the ButtonClick method which occurs when the Button +for the control has been clicked. +

+ @@ -2379,10 +2451,33 @@ attached SpeedButton that summons a Directory Open dialog. New value for the property. - - - - + + +Gets the name of the default glyph resource used for the Button on the +control. + + +

+GetDefaultGlyphName is an overridden String function used to get +the default resource name with the glyph image for the Button on the control. +It is used in the LoadDefaultGlyph method to assign the LCLGlyphName for the +TButtonGlyph instance used in the control. +

+

+In TDirectoryEdit, the return value is set to the ResBtnSelDir +constant. +

+ + + + +TButtonGlyph.LCLGlyphName + + + + +Default resource name for the glyph used on the button in the control. + @@ -3107,7 +3202,6 @@ DateToText is used in the implementation of the SetDate, - Registers the class reference used to create new instances of the class. @@ -3116,21 +3210,30 @@ Registers the class reference used to create new instances of the class. -Gets the default glyph name displayed on the Button for the control. +Gets the name of the default glyph resource used for the Button on the +control.

-GetDefaultGlyphName is overridden in TDateEdit to -return the resource name specified in the ResBtnCalendar constant. +GetDefaultGlyphName is an overridden String function used to get +the default resource name with the glyph image for the Button on the control. +It is used in the LoadDefaultGlyph method to assign the LCLGlyphName for the +TButtonGlyph instance used in the control. +

+

+In TDateEdit, the return value is set to the ResBtnCalendar +constant.

+ +TButtonGlyph.LCLGlyphName -Resource name for the default glyph. +Default resource name for the glyph image on the control. @@ -4094,30 +4197,55 @@ Used in the implementation of the OpenTimePopup and EditEditingDone methods. - - - + +Tries to parse and convert the specified string to a time value. + + + - + +True if the text was successfully converted to a TDateTime value. + - + +String with the time to convert in the method. + - + +Returns the TDateTime with the time value converted in the method. + -Gets the resource name for the default glyph displayed on the Button for the +Gets the name of the default glyph resource used for the Button on the control. - - + +

+GetDefaultGlyphName is an overridden String function used to get +the default resource name with the glyph image for the Button on the control. +It is used in the LoadDefaultGlyph method to assign the LCLGlyphName for the +TButtonGlyph instance used in the control. +

+

+In TTimeEdit, the return value is set to the ResBtnTime +constant. +

+ + + + +TButtonGlyph.LCLGlyphName + -Resource name for the glyph. + +Default resource name for the glyph used on the button in the control. + @@ -4125,7 +4253,10 @@ control. Performs actions needed when the Button for the control is clicked. - + + +ShowTimePopup + @@ -4289,20 +4420,37 @@ by 5 columns using 5 minute time intervals is used. -TAcceptValueEvent - generic event handling method for accepting a -value from a (calculator) dialog. +Specifies an event handler signalled when a calculator dialog has been used +to accept or reject a value. - - + +

+TAcceptValueEvent is the type used for the OnAcceptValue property +in TCalcEdit. Implement and assign a routine using the signature for the +event handler to respond to selection of a value using a calculator dialog. +Use the AValue and Accept variable arguments to determine the value and +action returned from the dialog instance. +

+ + + + - + +Object instance (TCalcEdit) for the event notification. + - + +Double type with the value returned from the dialog for a calculator dialog. + - - + + +Returns True if the OK button was used to accept the value on the +dialog. Otherwise, the return value is False. + @@ -4316,11 +4464,13 @@ dialog. implements a numeric edit control with a button to display a calculator dialog. It contains properties to configure the button and the calculator dialog. Other properties are provided to access the numeric value as an -Integer or a floating point (Double) data type. Use the RunDIalog method to +Integer or a floating point (Double) data type. Use the RunDialog method to display the calculator dialog and get its return value.

- + + + @@ -4330,6 +4480,7 @@ display the calculator dialog and get its return value. + Gets the value for the AsFloat property. @@ -4374,14 +4525,8 @@ display the calculator dialog and get its return value. New value for the property. - - - - - - - - + +