mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-18 01:19:16 +02:00
Docs: LCL/dialogs. Adds or updates content for TCustomTaskDialog topics. Partial.
This commit is contained in:
parent
1a20b44547
commit
dcfaa92e3c
@ -6131,17 +6131,30 @@ State for the verification check box control on the dialog.
|
|||||||
</short>
|
</short>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
<!-- TODO: Needs additional content. -->
|
|
||||||
<element name="TCustomTaskDialog.DoOnHelp">
|
<element name="TCustomTaskDialog.DoOnHelp">
|
||||||
<short>
|
<short>
|
||||||
Signals the OnHelp event handler (when assigned).
|
Signals the OnHelp event handler (when assigned).
|
||||||
</short>
|
</short>
|
||||||
<descr/>
|
<descr>
|
||||||
|
<p>
|
||||||
|
<var>DoOnHelp</var> 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.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
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.
|
||||||
|
</p>
|
||||||
|
</descr>
|
||||||
<version>
|
<version>
|
||||||
Added in LCL version 4.0.
|
Added in LCL version 4.0.
|
||||||
</version>
|
</version>
|
||||||
<seealso>
|
<seealso>
|
||||||
<link id="TCustomTaskDialog.OnHelp"/>
|
<link id="TCustomTaskDialog.OnHelp"/>
|
||||||
|
<link id="TCustomTaskDialog.Buttons"/>
|
||||||
|
<link id="#lcl.taskdlgemulation.TLCLTaskDialog.KeyDown">TLCLTaskDialog.KeyDown</link>
|
||||||
</seealso>
|
</seealso>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
@ -6780,18 +6793,38 @@ Added in LCL version 4.0.
|
|||||||
</seealso>
|
</seealso>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
<!-- TODO: Needs content. -->
|
|
||||||
<element name="TCustomTaskDialog.QueryItemIndex">
|
<element name="TCustomTaskDialog.QueryItemIndex">
|
||||||
<short>
|
<short>
|
||||||
Ordinal position for the value in QueryChoices selected when the task dialog
|
Ordinal position for the value in QueryChoices selected when the task dialog
|
||||||
is executed.
|
is executed.
|
||||||
</short>
|
</short>
|
||||||
<descr/>
|
<descr>
|
||||||
|
<p>
|
||||||
|
<var>QueryItemIndex</var> is an <var>Integer</var> 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.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Use QueryResult to access the string value for the selected item in
|
||||||
|
QueryChoices.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
QueryItem and QueryResult are relevant when tfQuery has been included in the
|
||||||
|
Flags for the task dialog.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Use ModalResult to determine the button or key combination used to complete
|
||||||
|
execution of the dialog form.
|
||||||
|
</p>
|
||||||
|
</descr>
|
||||||
<version>
|
<version>
|
||||||
Added in LCL version 4.0.
|
Added in LCL version 4.0.
|
||||||
</version>
|
</version>
|
||||||
<seealso>
|
<seealso>
|
||||||
<link id="TCustomTaskDialog.QueryChoices"/>
|
<link id="TCustomTaskDialog.QueryChoices"/>
|
||||||
|
<link id="TCustomTaskDialog.QueryResult"/>
|
||||||
<link id="TCustomTaskDialog.Flags"/>
|
<link id="TCustomTaskDialog.Flags"/>
|
||||||
<link id="TCustomTaskDialog.Execute"/>
|
<link id="TCustomTaskDialog.Execute"/>
|
||||||
<link id="TCustomTaskDialog.ModalResult"/>
|
<link id="TCustomTaskDialog.ModalResult"/>
|
||||||
@ -6800,18 +6833,21 @@ Added in LCL version 4.0.
|
|||||||
</seealso>
|
</seealso>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
<!-- TODO: Needs content. -->
|
|
||||||
<element name="TCustomTaskDialog.QueryResult">
|
<element name="TCustomTaskDialog.QueryResult">
|
||||||
<short/>
|
<short>
|
||||||
|
String representation for the value selected in QueryChoices.
|
||||||
|
</short>
|
||||||
<descr/>
|
<descr/>
|
||||||
<version>
|
<version>
|
||||||
Added in LCL version 4.0.
|
Added in LCL version 4.0.
|
||||||
</version>
|
</version>
|
||||||
<seealso>
|
<seealso>
|
||||||
<link id="TCustomTaskDialog.SimpleQuery"/>
|
|
||||||
<link id="TCustomTaskDialog.QueryChoices"/>
|
<link id="TCustomTaskDialog.QueryChoices"/>
|
||||||
|
<link id="TCustomTaskDialog.QueryItemIndex"/>
|
||||||
|
<link id="TCustomTaskDialog.SimpleQuery"/>
|
||||||
<link id="TCustomTaskDialog.Flags"/>
|
<link id="TCustomTaskDialog.Flags"/>
|
||||||
<link id="TCustomTaskDialog.Execute"/>
|
<link id="TCustomTaskDialog.Execute"/>
|
||||||
|
<link id="TCustomTaskDialog.DoExecute"/>
|
||||||
<link id="TCustomTaskDialog.ModalResult"/>
|
<link id="TCustomTaskDialog.ModalResult"/>
|
||||||
<link id="TTaskDialogFlags"/>
|
<link id="TTaskDialogFlags"/>
|
||||||
<link id="TTaskDialogFlag"/>
|
<link id="TTaskDialogFlag"/>
|
||||||
@ -6821,19 +6857,26 @@ Added in LCL version 4.0.
|
|||||||
<element name="TCustomTaskDialog.RadioButton">
|
<element name="TCustomTaskDialog.RadioButton">
|
||||||
<short>The radio button selected on the Task dialog.</short>
|
<short>The radio button selected on the Task dialog.</short>
|
||||||
<descr>
|
<descr>
|
||||||
<!-- TODO: Needs update. -->
|
|
||||||
<p>
|
<p>
|
||||||
<var>RadioButton</var> is a read-only <var>TTaskDialogRadioButtonItem</var>
|
<var>RadioButton</var> is a read-only <var>TTaskDialogRadioButtonItem</var>
|
||||||
property with the radio button selected when the Task dialog was executed.
|
property with the radio button selected when the Task dialog was executed. The
|
||||||
The property value is set when the <var>Execute</var> method calls the
|
property value is set in the Execute method, and contains an entry from the
|
||||||
wrapper in <file>LCLTaskDialog</file>.
|
RadioButtons collection or <b>Nil</b> if a radio button was not selected or
|
||||||
It contains an entry from the <var>RadioButtons</var> collection that was
|
available.
|
||||||
passed as an argument to the <var>TTaskDialog</var> wrapper.
|
</p>
|
||||||
|
<p>
|
||||||
|
Use the Default property in one of the RadioButtons to indicate the selected
|
||||||
|
radio button control when the Execute method is called.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Include tfNoDefaultRadioButton in the Flags property to disable automatic
|
||||||
|
selection of a default radio button on the dialog form.
|
||||||
</p>
|
</p>
|
||||||
</descr>
|
</descr>
|
||||||
<seealso>
|
<seealso>
|
||||||
<link id="TCustomTaskDialog.RadioButtons"/>
|
<link id="TCustomTaskDialog.RadioButtons"/>
|
||||||
<link id="TCustomTaskDialog.Execute"/>
|
<link id="TCustomTaskDialog.Execute"/>
|
||||||
|
<link id="TCustomTaskDialog.Flags"/>
|
||||||
<link id="TCustomTaskDialog.DoExecute"/>
|
<link id="TCustomTaskDialog.DoExecute"/>
|
||||||
<link id="TTaskDialogRadioButtonItem"/>
|
<link id="TTaskDialogRadioButtonItem"/>
|
||||||
</seealso>
|
</seealso>
|
||||||
@ -6871,20 +6914,38 @@ selected on the Task dialog.
|
|||||||
</seealso>
|
</seealso>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
<!-- TODO: Needs content. -->
|
|
||||||
<element name="TCustomTaskDialog.SimpleQuery">
|
<element name="TCustomTaskDialog.SimpleQuery">
|
||||||
<short>
|
<short>
|
||||||
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.
|
dialog.
|
||||||
</short>
|
</short>
|
||||||
<descr/>
|
<descr>
|
||||||
|
<p>
|
||||||
|
<var>SimpleQuery</var> is a <var>String</var> 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.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
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.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Use QueryChoices if predefined choices selected using a combo-box control are
|
||||||
|
needed on the task dialog.
|
||||||
|
</p>
|
||||||
|
</descr>
|
||||||
<version>
|
<version>
|
||||||
Added in LCL version 4.0.
|
Added in LCL version 4.0.
|
||||||
</version>
|
</version>
|
||||||
<seealso/>
|
<seealso>
|
||||||
|
<link id="TCustomTaskDialog.SimpleQueryPasswordChar"/>
|
||||||
|
<link id="TCustomTaskDialog.Flags"/>
|
||||||
|
<link id="TTaskDialogFlags"/>
|
||||||
|
<link id="TTaskDialogFlag"/>
|
||||||
|
</seealso>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
<!-- TODO: Needs content. -->
|
|
||||||
<element name="TCustomTaskDialog.SimpleQueryPasswordChar">
|
<element name="TCustomTaskDialog.SimpleQueryPasswordChar">
|
||||||
<short>
|
<short>
|
||||||
Character value used to obfuscate text in SimpleQuery for the query control.
|
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.
|
|||||||
<descr>
|
<descr>
|
||||||
<p>
|
<p>
|
||||||
The default value for the property is #0 (NULL character) and indicates that
|
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.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
SimpleQueryPasswordChar is used when tfSimpleQuery has been included in the
|
||||||
|
Flags for the task dialog.
|
||||||
</p>
|
</p>
|
||||||
</descr>
|
</descr>
|
||||||
<version>
|
<version>
|
||||||
Added in LCL version 4.0.
|
Added in LCL version 4.0.
|
||||||
</version>
|
</version>
|
||||||
<seealso/>
|
<seealso>
|
||||||
|
<link id="TCustomTaskDialog.SimpleQuery"/>
|
||||||
|
<link id="TCustomTaskDialog.Flags"/>
|
||||||
|
<link id="TTaskDialogFlags"/>
|
||||||
|
<link id="TTaskDialogFlag"/>
|
||||||
|
</seealso>
|
||||||
</element>
|
</element>
|
||||||
|
|
||||||
<element name="TCustomTaskDialog.Text">
|
<element name="TCustomTaskDialog.Text">
|
||||||
@ -6925,7 +6997,6 @@ property editor at design-time.
|
|||||||
Text, ExpandedText, and FooterText allow an HTML-like hyperlinking capability
|
Text, ExpandedText, and FooterText allow an HTML-like hyperlinking capability
|
||||||
using the <a href="linktarget">Link Text</a> notation. The
|
using the <a href="linktarget">Link Text</a> notation. The
|
||||||
feature must be enabled by including tfEnableHyperlinks in the Flags property.
|
feature must be enabled by including tfEnableHyperlinks in the Flags property.
|
||||||
Use tfExpandFooterArea to position the expanded text in the footer area.
|
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
Use ExpandedText to set the content in the collapsible area on the Task
|
Use ExpandedText to set the content in the collapsible area on the Task
|
||||||
@ -7098,7 +7169,7 @@ executed.
|
|||||||
</short>
|
</short>
|
||||||
<descr>
|
<descr>
|
||||||
<p>
|
<p>
|
||||||
OnButtonClicked is signalled after a button is clicked on the Task dialog.
|
OnButtonClicked is signalled when a button is clicked on the Task dialog.
|
||||||
</p>
|
</p>
|
||||||
</descr>
|
</descr>
|
||||||
<seealso/>
|
<seealso/>
|
||||||
@ -7267,7 +7338,9 @@ Added in LCL version 4.0.
|
|||||||
|
|
||||||
<!-- TODO: Needs content. -->
|
<!-- TODO: Needs content. -->
|
||||||
<element name="TCustomTaskDialog.OnHelp">
|
<element name="TCustomTaskDialog.OnHelp">
|
||||||
<short/>
|
<short>
|
||||||
|
Event handler signalled to display help for the task dialog.
|
||||||
|
</short>
|
||||||
<descr/>
|
<descr/>
|
||||||
<version>
|
<version>
|
||||||
Added in LCL version 4.0.
|
Added in LCL version 4.0.
|
||||||
|
Loading…
Reference in New Issue
Block a user