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

Docs: LCL/interfacebase. Updates the TDialogButton.ModalResult topic for changes in 0f522e8d81.

Browse Source
This commit is contained in:
dsiders 2023-07-12 18:51:59 +01:00
parent 2d96b678f3
commit 67d388063b
1 changed files with 42 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/xml/lcl/interfacebase.xml
View File

@ -576,7 +576,7 @@ Use <var>Cancel</var> to control whether the button is used as the Cancel
button in the dialog. button in the dialog.
</p> </p>
<p> <p>
Use <var>ModalResult</var> to set the value returned when the button is Use <var>ModalResult</var> to get or set the value returned when the button is
clicked. clicked.
</p> </p>
</descr> </descr>
@ -591,17 +591,52 @@ clicked.
<short>The modal result value returned when the button is clicked.</short> <short>The modal result value returned when the button is clicked.</short>
<descr> <descr>
<p> <p>
<var>ModalResult</var> is a <var>LongInt</var> property which contains the <var>ModalResult</var> is a <var>LongInt</var> property which contains the modal result value returned when the button is clicked in the dialog.
modal result value returned when the button is clicked in the dialog.
</p> </p>
<p> <p>
ModalResult values correspond to the values in the <var>TModalResult</var> ModalResult can contain a value defined the <var>TModalResult</var> range type
enumeration, but use the native data type expected in <var>TWidgetSet</var> found in the RTL <file>system.uitypes.pp</file> unit. Applications will
methods. normally want to use the descriptive modal result constants when reading or
writing the value, like:
</p>
<ul>
<li>mrNone</li>
<li>mrOK</li>
<li>mrCancel</li>
<li>mrAbort</li>
<li>mrRetry</li>
<li>mrIgnore</li>
<li>mrYes</li>
<li>mrNo</li>
<li>mrAll</li>
<li>mrNoToAll</li>
<li>mrYesToAll</li>
<li>mrClose</li>
</ul>
<p>
The default value for the property is set to 0 (mrNone) in the Create
constructor.
</p> </p>
</descr> </descr>
<seealso> <seealso>
<link id="#lazutils.uitypes.TModalResult">TModalResult</link> <link id="TDialogButton.Create"/>
<!--
TODO: Uncomment when system.uitypes exists in RTL.CHM.
<link id="#rtl.system.uitypes.TModalResult">TModalResult</link>
<link id="#rtl.system.uitypes.mrNone">mrNone</link>
<link id="#rtl.system.uitypes.mrOK">mrOK</link>
<link id="#rtl.system.uitypes.mrCancel">mrCancel</link>
<link id="#rtl.system.uitypes.mrAbort">mrAbort</link>
<link id="#rtl.system.uitypes.mrRetry">mrRetry</link>
<link id="#rtl.system.uitypes.mrIgnore">mrIgnore</link>
<link id="#rtl.system.uitypes.mrYes">mrYes</link>
<link id="#rtl.system.uitypes.mrNo">mrNo</link>
<link id="#rtl.system.uitypes.mrAll">mrAll</link>
<link id="#rtl.system.uitypes.mrNoToAll">mrNoToAll</link>
<link id="#rtl.system.uitypes.mrYesToAll">mrYesToAll</link>
<link id="#rtl.system.uitypes.mrClose">mrClose</link>
-->
</seealso> </seealso>
</element> </element>