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

Docs: LCL/taskdlgemulation. Adds and updates topics for changes in d1ac727ad0.

Browse Source
This commit is contained in:
dsiders 2023-08-08 21:23:15 +01:00
parent e369a9397e
commit d961ef5cc6
1 changed files with 69 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
docs/xml/lcl/taskdlgemulation.xml
View File

@ -94,6 +94,7 @@ The task dialog structure which created the form.
</element>
<element name="TLCLTaskDialog.FVerifyChecked"/>
<element name="TLCLTaskDialog.FExpanded"/>
<element name="TLCLTaskDialog.Timer"/>
<element name="TLCLTaskDialog.TimerStartTime"/>
<element name="TLCLTaskDialog.RadioButtonArray"/>
@ -133,6 +134,12 @@ Check-box control used for optional Task Dialog verification.
</short>
</element>
<element name="TLCLTaskDialog.ExpandBtn">
<short>
The expand/collapse button (expando control) for the Task dialog.
</short>
</element>
<!-- private -->
<element name="TLCLTaskDialog.AddIcon"/>
<element name="TLCLTaskDialog.AddIcon.IconBorder"/>
@ -218,6 +225,10 @@ Check-box control used for optional Task Dialog verification.
<element name="TLCLTaskDialog.ResetTimer"/>
<element name="TLCLTaskDialog.ExpandDialog"/>
<element name="TLCLTaskDialog.CollapseDialog"/>
<element name="TLCLTaskDialog.DoDialogConstructed"/>
<element name="TLCLTaskDialog.DoDialogCreated"/>
@ -253,6 +264,54 @@ Naming schemes... choose one.
<element name="TLCLTaskDialog.OnTimer"/>
<element name="TLCLTaskDialog.OnTimer.Sender"/>
<element name="TLCLTaskDialog.OnExpandButtonClicked">
<short>
Implements the event handler signalled when the expand/collapse button (expando
control) has been clicked on the task dialog.
</short>
<descr>
<p>
<var>OnExpandButtonClicked</var> is a method method used to perform actions
needed when the expand/collapse button for the task dialog has been clicked. It
is assigned during form set-up to the OnClick event handler for the TButton
instance used on the form.
</p>
<p>
OnExpandButtonClicked ensures that the correct private method is called for the
button click; the current value in the expanded state is used to determine
whether expandable text is changed from expanded to collapsed, or vice versa.
It also sets the new value for the private expanded state member.
</p>
<p>
The DoOnExpandButtonClicked in the TTaskDialog instance for the dialog form is
called with the new value for the Expanded property.
</p>
</descr>
<version>
Added in LCL version 4.0.
</version>
<seealso>
<link id="#lcl.dialogs.TTaskDialog.Expanded">TTaskDialog.Expanded</link>
<link id="#lcl.dialogs.TTaskDialog.ExpandedText">TTaskDialog.ExpandedText</link>
<link id="#lcl.dialogs.TTaskDialog.DoOnExpandButtonClicked">TTaskDialog.DoOnExpandButtonClicked</link>
</seealso>
</element>
<element name="TLCLTaskDialog.OnExpandButtonClicked.Sender">
<short>
Not used in the method.
</short>
</element>
<!-- TODO: Needs content. -->
<element name="TLCLTaskDialog.DoOnHelp">
<short/>
<descr/>
<version>
Added in LCL version 4.0.
</version>
<seealso/>
</element>
<!-- protected -->
<element name="TLCLTaskDialog.SetupControls">
<short>
@ -286,6 +345,9 @@ value has not been assigned.
Values in the text, expanded text, and footer text properties.
</li>
<li>
Value for the expand / collapse button on the dialog.
</li>
<li>
Content in the Verification text.
</li>
<li>
@ -340,8 +402,8 @@ Implements the OnKeyDown event handler for the task dialog.
<p>
<var>KeyDown</var> is an overridden method in <var>TLCLTaskDialog</var> which
implements the handler routine for OnKeyDown events in the dialog form.
KeyDown ensures that Esc and Alt+F4 key down events are applied properly for
the emulated task dialog.
KeyDown ensures that Esc, Alt+F4, and F1 key down events are applied properly
for the emulated task dialog.
</p>
<p>
When BorderIcons indicates that the dialog form can be closed (contains
@ -355,6 +417,11 @@ is digested (set to 0). The native task dialog blocks Alt+F4 to close the
dialog, so it is blocked in the emulated task dialog as well.
</p>
<p>
When Key indicates that F1 was pressed, the DoOnHelp method in the TTaskDialog
instance is called to signal an assigned OnHelp event handler in the task
dialog. The value in Key is set to 0 to consume the key event.
</p>
<p>
KeyDown calls the inherited method prior to exit.
</p>
</descr>