paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-09 15:28:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/dialogs. Adds TaskDlg topics for changes in 5779cff4.

Browse Source
This commit is contained in:
dsiders 2024-03-21 16:12:24 +01:00
parent 3472aa12bd
commit f45a7a1900
1 changed files with 137 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

137
docs/xml/lcl/dialogs.xml
View File

@ -9676,6 +9676,143 @@ Initial directory displayed in the dialog.
</short>
</element>
<element name="TaskDlg">
<short>
Provides a wrapper function used to configure and execute a TTaskDialog
instance.
</short>
<descr>
<p>
<var>TaskDlg</var> is an overloaded function which implements a wrapper used to
execute a TTaskDialog with the specified parameter values. The overloaded
variants allow different features / behaviors to be enabled when the task
dialog is executed.
</p>
<p>
The parameter values are copied to the corresponding properties in the
TTaskDialog instance created (and freed after execution) in the routine. The
Execute method in the dialog is called to display the dialog form and to
capture the result.
</p>
<p>
The return value is the <var>TModalResult</var> enumeration value returned in
the ModalResult property for the TTaskdialog instance. The default value is
<var>mrCancel</var>.
</p>
<p>
TaskDlg is a convenience routine that allows a task dialog to be used in a
manner similar to the MessageDlg routine.
</p>
<p>
Please note that TaskDlg does not provide access to the progress bar
functionality in TTaskDialog. You must use a TTaskDialog instance to configure
and enable that feature.
</p>
<p>
See TTaskDialog for more information about the features and behaviors supported
in the dialog type.
</p>
</descr>
<version>
Added in LCL version 4.0.
</version>
<seealso>
<link id="TTaskDialog"/>
<link id="TTaskDialogIcon"/>
<link id="TMsgDlgButtons"/>
<link id="TMsgDlgBtn"/>
<link id="TTaskDialogFlags"/>
<link id="TTaskDialogFlag"/>
<link id="MessageDlg"/>
<link id="#lcl.forms.TModalResult">TModalResult</link>
</seealso>
</element>
<element name="TaskDlg.Result">
<short>
TModalResult value returned when the task dialog is executed. The default value is mrCancel.
</short>
</element>
<element name="TaskDlg.aCaption">
<short>
Text displayed as the caption on the task dialog form.
</short>
</element>
<element name="TaskDlg.aMsg">
<short>
</short>
Text displayed as the title on the task dialog.
</element>
<element name="TaskDlg.aInfo">
<short>
Text displayed in the main content area on the task dialog.
</short>
</element>
<element name="TaskDlg.DlgIcon">
<short>
Indicates the icon displayed on the task dialog.
</short>
</element>
<element name="TaskDlg.AButtons">
<short>
Set with the common buttons displayed on the task dialog.
</short>
</element>
<element name="TaskDlg.aFooter">
<short>
Text displayed in the footer area on the task dialog.
</short>
</element>
<element name="TaskDlg.aDetails">
<short>
Text displayed in the expandable text areas on the task dialog.
</short>
</element>
<element name="TaskDlg.AFlags">
<short>
Set of features or behaviors enabled in task dialog. The default value is
[tfAllowDialogCancellation] and allows the task dialog to be cancelled.
</short>
</element>
<element name="TaskDlg.ADefaultButton">
<short>
Indicates the default button on the task dialog.
</short>
</element>
<element name="TaskDlg.ARadioButtons">
<short>
Array of string values used as the captions for radio buttons displayed on the
task dialog.
</short>
</element>
<element name="TaskDlg.RadioIndex">
<short>
Output parameter used to return the ordinal position for the radio button
selected on the task dialog during execution.
</short>
</element>
<element name="TaskDlg.ADefaultRadio">
<short>
Ordinal position for the default radio button selected when the task dialog is
executed. The default value is -1 and indicated that no radio button is pre-selected.
</short>
</element>
<element name="TaskDlg.ACheckBoxText">
<short>
Text displayed as the verification text on the task dialog.
</short>
</element>
<element name="TaskDlg.Checked">
<short>
Output parameter used to return the checked state for the verification check
box on the task dialog.
</short>
</element>
<element name="TaskDlg.ACustomButtons">
<short>
Array of string values with the captions for custom buttons displayed on the task dialog.
</short>
</element>
<element name="TCustomCopyToClipboardDialog">
<short>
Base class for a dialog form used during copy to clipboard operations.