Docs: LCL/dialogs. Adds topic skeletons for refactoring changes in 05c9e4aa76.

(cherry picked from commit 28dc68de66)
This commit is contained in:
dsiders 2023-08-01 06:23:01 +01:00
parent b9563b47ee
commit 2ac376db28

View File

@ -5212,11 +5212,12 @@ TTaskDialogBaseButtonItem is the ancestor class for
</seealso>
</element>
<!-- private -->
<element name="TTaskDialogBaseButtonItem.FCaption"/>
<element name="TTaskDialogBaseButtonItem.FClient"/>
<element name="TTaskDialogBaseButtonItem.FCommandLinkHint"/>
<element name="TTaskDialogBaseButtonItem.FModalResult"/>
<!-- private -->
<element name="TTaskDialogBaseButtonItem.GetDefault"/>
<element name="TTaskDialogBaseButtonItem.GetDefault.Result"/>
<element name="TTaskDialogBaseButtonItem.SetCaption"/>
@ -5321,6 +5322,28 @@ property in the TCustomTaskDialog instance.
</seealso>
</element>
<element name="TTaskDialogBaseButtonItem.CommandLinkHint">
<short>
Provides additional information about the button when command links are
enabled in a task dialog.
</short>
<descr>
<p>
CommandLinkHint is a TTranslateString property which contains additional
information about the button. The translatable content is used as second line
of text for the button when command links are enabled in a native TTaskDialog
instance. The value is not displayed as an additional line on platforms where
an emulated task dialog is used; this includes all platforms other Windows
(Vista or later).
</p>
</descr>
<version>
Added in LCL version 4.0.
</version>
<seealso/>
</element>
<element name="TTaskDialogBaseButtonItem.Caption">
<short>Caption text displayed on the button surface.</short>
<descr>
@ -5402,6 +5425,8 @@ also used as the <var>DisplayName</var> for the collection item when assigned.
<short>Collection which owns the button item.</short>
</element>
<element name="TTaskDialogButtonItem.CommandLinkHint" link="#lcl.dialogs.TTaskDialogBaseButtonItem.CommandLinkHint"/>
<element name="TTaskDialogButtonItem.ModalResult" link="#lcl.dialogs.TTaskDialogBaseButtonItem.ModalResult"/>
<element name="TTaskDialogRadioButtonItem">
@ -5702,6 +5727,10 @@ For other platforms, or Windows versions which do not support the TaskDialog API
<element name="TCustomTaskDialog.FFooterText"/>
<element name="TCustomTaskDialog.FMainIcon"/>
<element name="TCustomTaskDialog.FModalResult"/>
<element name="TCustomTaskDialog.FOnDialogConstructed"/>
<element name="TCustomTaskDialog.FOnDialogCreated"/>
<element name="TCustomTaskDialog.FOnDialogDestroyed"/>
<element name="TCustomTaskDialog.FOnVerificationClicked"/>
<element name="TCustomTaskDialog.FQueryChoices"/>
<element name="TCustomTaskDialog.FQueryResult"/>
<element name="TCustomTaskDialog.FQueryItemIndex"/>
@ -6453,6 +6482,46 @@ OnButtonClicked is signalled after a button is clicked on the Task dialog.
<seealso/>
</element>
<!-- TODO: Needs content. -->
<element name="TCustomTaskDialog.OnDialogConstructed">
<short/>
<descr/>
<version>
Added in LCL version 4.0.
</version>
<seealso/>
</element>
<!-- TODO: Needs content. -->
<element name="TCustomTaskDialog.OnDialogCreated">
<short/>
<descr/>
<version>
Added in LCL version 4.0.
</version>
<seealso/>
</element>
<!-- TODO: Needs content. -->
<element name="TCustomTaskDialog.OnDialogDestroyed">
<short/>
<descr/>
<version>
Added in LCL version 4.0.
</version>
<seealso/>
</element>
<!-- TODO: Needs content. -->
<element name="TCustomTaskDialog.OnVerificationClicked">
<short/>
<descr/>
<version>
Added in LCL version 4.0.
</version>
<seealso/>
</element>
<!-- TODO: Needs update after refactoring. -->
<element name="TTaskDialog">
<short>Creates a configurable, modal task dialog at run-time.</short>
@ -6526,9 +6595,13 @@ end;
<element name="TTaskDialog.SimpleQueryPasswordChar" link="#lcl.dialogs.TCustomTaskDialog.SimpleQueryPasswordChar"/>
<element name="TTaskDialog.Text" link="#lcl.dialogs.TCustomTaskDialog.Text"/>
<element name="TTaskDialog.Title" link="#lcl.dialogs.TCustomTaskDialog.Title"/>
<element name="TTaskDialog.Width" link="#lcl.dialogs.TCustomTaskDialog.Width"/>
<element name="TTaskDialog.VerificationText" link="#lcl.dialogs.TCustomTaskDialog.VerificationText"/>
<element name="TTaskDialog.Width" link="#lcl.dialogs.TCustomTaskDialog.Width"/>
<element name="TTaskDialog.OnButtonClicked" link="#lcl.dialogs.TCustomTaskDialog.OnButtonClicked"/>
<element name="TTaskDialog.OnDialogConstructed" link="#lcl.dialogs.TCustomTaskDialog.OnDialogConstructed"/>
<element name="TTaskDialog.OnDialogCreated" link="#lcl.dialogs.TCustomTaskDialog.OnDialogCreated"/>
<element name="TTaskDialog.OnDialogDestroyed" link="#lcl.dialogs.TCustomTaskDialog.OnDialogDestroyed"/>
<element name="TTaskDialog.OnVerificationClicked" link="#lcl.dialogs.TCustomTaskDialog.OnVerificationClicked"/>
<!-- TODO: Needs content. -->
<element name="TaskDialogFirstButtonIndex">