From dcfaa92e3cd5eddf0a41137c2be678bac99d7874 Mon Sep 17 00:00:00 2001 From: dsiders Date: Wed, 9 Aug 2023 04:59:25 +0100 Subject: [PATCH] Docs: LCL/dialogs. Adds or updates content for TCustomTaskDialog topics. Partial. --- docs/xml/lcl/dialogs.xml | 119 +++++++++++++++++++++++++++++++-------- 1 file changed, 96 insertions(+), 23 deletions(-) diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index dcdf1df0ad..5aafbfbd20 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -6131,17 +6131,30 @@ State for the verification check box control on the dialog. - Signals the OnHelp event handler (when assigned). - + +

+DoOnHelp is a method called to perform actions needed when the Help +command is executed for the task dialog. It signals the OnHelp event handler +(when assigned) to respond to the help request. +

+

+DoOnHelp is called when the widgetset handles a TDN_HELP task dialog +notification message which occurs when the Help button is clicked. For +platforms where an emulated task dialog form is used, it is called from the +KeyDown method in the TLCLTaskDialog instance when the F1 key is pressed. +

+ Added in LCL version 4.0. + +TLCLTaskDialog.KeyDown @@ -6780,18 +6793,38 @@ Added in LCL version 4.0. - Ordinal position for the value in QueryChoices selected when the task dialog is executed. - + +

+QueryItemIndex is an Integer property which contains the +ordinal position for the selected value in the QueryChoices on the dialog. It +contains the initial item in QueryChoices selected when the Execute method is +called. It is updated with the option selected during execution of the dialog +form. +

+

+Use QueryResult to access the string value for the selected item in +QueryChoices. +

+

+QueryItem and QueryResult are relevant when tfQuery has been included in the +Flags for the task dialog. +

+

+Use ModalResult to determine the button or key combination used to complete +execution of the dialog form. +

+ Added in LCL version 4.0. + @@ -6800,18 +6833,21 @@ Added in LCL version 4.0. - - + +String representation for the value selected in QueryChoices. + Added in LCL version 4.0. - + + + @@ -6821,19 +6857,26 @@ Added in LCL version 4.0. The radio button selected on the Task dialog. -

RadioButton is a read-only TTaskDialogRadioButtonItem -property with the radio button selected when the Task dialog was executed. -The property value is set when the Execute method calls the -wrapper in LCLTaskDialog. -It contains an entry from the RadioButtons collection that was -passed as an argument to the TTaskDialog wrapper. +property with the radio button selected when the Task dialog was executed. The +property value is set in the Execute method, and contains an entry from the +RadioButtons collection or Nil if a radio button was not selected or +available. +

+

+Use the Default property in one of the RadioButtons to indicate the selected +radio button control when the Execute method is called. +

+

+Include tfNoDefaultRadioButton in the Flags property to disable automatic +selection of a default radio button on the dialog form.

+ @@ -6871,20 +6914,38 @@ selected on the Task dialog. - -Contains the text displayed and editined using the query control on the task +Contains the text displayed and edited using the query control on the task dialog. - + +

+SimpleQuery is a String property which contains free-form +text maintained using the query control for the task dialog. A single-line edit +control is used to display and edit the value for the property. +

+

+SimpleQuery is displayed on the dialog when tfSimpleQuery has been included in +the Flags property. Please note that tfQuery and tfSimpleQuery flag values are +mutually exclusive with tfQuery taking precedence. +

+

+Use QueryChoices if predefined choices selected using a combo-box control are +needed on the task dialog. +

+ Added in LCL version 4.0. - + + + + + + - Character value used to obfuscate text in SimpleQuery for the query control. @@ -6892,13 +6953,24 @@ Character value used to obfuscate text in SimpleQuery for the query control.

The default value for the property is #0 (NULL character) and indicates that -obfuscation is not enabled for the simple query control. +obfuscation is not enabled for the simple query control. Another character +stored in the property is used to obfuscate the characters entered in the +SimpleQuery property. +

+

+SimpleQueryPasswordChar is used when tfSimpleQuery has been included in the +Flags for the task dialog.

Added in LCL version 4.0. - + + + + + + @@ -6925,7 +6997,6 @@ property editor at design-time. Text, ExpandedText, and FooterText allow an HTML-like hyperlinking capability using the <a href="linktarget">Link Text</a> notation. The feature must be enabled by including tfEnableHyperlinks in the Flags property. -Use tfExpandFooterArea to position the expanded text in the footer area.

Use ExpandedText to set the content in the collapsible area on the Task @@ -7098,7 +7169,7 @@ executed.

-OnButtonClicked is signalled after a button is clicked on the Task dialog. +OnButtonClicked is signalled when a button is clicked on the Task dialog.

@@ -7267,7 +7338,9 @@ Added in LCL version 4.0. - + +Event handler signalled to display help for the task dialog. + Added in LCL version 4.0.