1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
Documentation for LCL (Lazarus Component Library) and LazUtils (Lazarus
Utilities) are published under the Creative Commons Attribution-ShareAlike 4.0
International public license.
https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt
https://gitlab.com/freepascal.org/lazarus/lazarus/-/blob/main/docs/cc-by-sa-4-0.txt
Copyright (c) 1997-2025, by the Lazarus Development Team.
-->
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
UITypes
====================================================================
-->
<module name="UITypes">
<short>
Contains types and constants used in modal dialogs.
</short>
<descr>
<p>
<file>uitypes.pas</file> contains types and constants used in modal dialogs.
</p>
<p>
<file>uitypes.pas</file> is part of the <file>lazutils</file> package.
</p>
<remark>
The <file>UITypes</file> unit has been marked as deprecated in versions after
2.0.12. Use the <file>System.UITypes</file> unit from the FPC 3.2.0 (or
higher) Run-time Library (RTL).
</remark>
</descr>
<!-- unresolved external references -->
<!-- used for FPC 3.X type aliases -->
<element name="System.UITypes"/>
<element name="mtWarning">
<short>
Alias to TMsgDlgType.mtWarning in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mtWarning">mtWarning</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mtError">
<short>
Alias to TMsgDlgType.mtError in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgType">TMsgDlgType</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mtInformation">
<short>
Alias to TMsgDlgType.mtInformation in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgType">TMsgDlgType</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mtConfirmation">
<short>
Alias to TMsgDlgType.mtConfirmation in the System.UITypes unit for the FPC
RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgType">TMsgDlgType</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mtCustom">
<short>
Alias to TMsgDlgType.mtCustom in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgType">TMsgDlgType</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbYes">
<short>
Alias to TMsgDlgBtn.mbYes in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbNo">
<short>
Alias to TMsgDlgBtn.mbNo in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbOK">
<short>
Alias to TMsgDlgBtn.mbOK in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbCancel">
<short>
Alias to TMsgDlgBtn.mbCancel in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbAbort">
<short>
Alias to TMsgDlgBtn.mbAbort in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbRetry">
<short>
Alias to TMsgDlgBtn.mbRetry in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbIgnore">
<short>
Alias to TMsgDlgBtn.mbIgnore in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbAll">
<short>
Alias to TMsgDlgBtn.mbAll in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbNoToAll">
<short>
Alias to TMsgDlgBtn.mbNoToAll in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbYesToAll">
<short>
Alias to TMsgDlgBtn.mbYesToAll in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbHelp">
<short>
Alias to TMsgDlgBtn.mbHelp in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="mbClose">
<short>
Alias to TMsgDlgBtn.mbClose in the System.UITypes unit for the FPC RTL.
</short>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
<version>
Available in FPC 3.2.0 and Lazarus versions after 2.0.12.
</version>
</element>
<element name="TMsgDlgType">
<short>
Alias to the TMsgDlgType type in the FPC RTL.
</short>
<descr>
<p>
<var>TMsgDlgType</var> is an enumeration type that defines the type of dialog
implemented in a message box. Values in the enumeration determine the
caption, icon, string literals, and buttons displayed in various dialog types.
</p>
<p>
TMsgDlgType is used in several routines, such as: <var>MessageDlg</var>,
<var>MessageDlgPos</var>,<var> MessageDlgPosHelp</var>,
<var>CreateMessageDialog</var>, <var>QuestionDlg</var>, and
<var>LazMessageDlg</var>.
</p>
<remark>
TMsgDlgType has been deprecated in the UITypes unit for Lazarus versions
after 2.0.12. Use the TMsgDlgType type from the System.UITypes unit in the
FPC 3.2.0 RTL instead.
</remark>
</descr>
<seealso>
<link id="#lcl.dialogs.MessageDlg">MessageDlg</link>
<link id="#lcl.dialogs.MessageDlgPos">MessageDlgPos</link>
<link id="#lcl.dialogs.CreateMessageDialog">CreateMessageDialog</link>
<link id="#lcl.dialogs.QuestionDlg">QuestionDlg</link>
<link id="#lcl.lazdialogs.LazMessageDlg">LazMessageDlg</link>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgType">TMsgDlgType</link>
-->
</seealso>
</element>
<element name="TMsgDlgType.mtWarning">
<short>
Warning message box with an Exclamation mark icon.
</short>
</element>
<element name="TMsgDlgType.mtError">
<short>
Error message box with Stop sign icon.
</short>
</element>
<element name="TMsgDlgType.mtInformation">
<short>
Information message box with an Info icon.
</short>
</element>
<element name="TMsgDlgType.mtConfirmation">
<short>
Confirmation message box with a Question mark icon.
</short>
</element>
<element name="TMsgDlgType.mtCustom">
<short>
Custom message box; No icon is displayed, and the caption contains the value
in ApplicationName.
</short>
</element>
<element name="TMsgDlgBtn">
<short>
Alias to the TMsgDlgBtn type in the FPC RTL.
</short>
<descr>
<p>
<var>TMsgDlgBtn</var> is an enumeration type with values that define the
buttons that can be displayed in a message dialog. TMsgDlgBtn values also
determine the modal result returned from the dialog when the corresponding
button is clicked.
</p>
<p>
Values in the enumeration are used in various routines, such as:
<var>MessageDlg</var>, <var>MessageDlgPos</var>,
<var>MessageDlgPosHelp</var>, <var>CreateMessageDialog</var>,
<var>QuestionDlg</var>, and <var>LazMessageDlg</var>.
</p>
<remark>
TMsgDlgBtn has been deprecated in the UITypes unit for Lazarus versions after
2.0.12. Use the TMsgDlgBtn type from the System.UITypes unit in the FPC 3.2.0
RTL instead.
</remark>
</descr>
<seealso>
<link id="#lcl.dialogs.MessageDlg">MessageDlg</link>
<link id="#lcl.dialogs.MessageDlgPos">MessageDlgPos</link>
<link id="#lcl.dialogs.MessageDlgPosHelp">MessageDlgPosHep</link>
<link id="#lcl.dialogs.CreateMessageDialog">CreateMessageDialog</link>
<link id="#lcl.dialogs.QuestionDlg">QuestionDlg</link>
<link id="#lcl.lazdialogs.LazMessageDlg">LazMessageDlg</link>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgBtn">TMsgDlgBtn</link>
-->
</seealso>
</element>
<element name="TMsgDlgBtn.mbYes">
<short>
Displays a 'Yes' button.
</short>
</element>
<element name="TMsgDlgBtn.mbNo">
<short>
Displays a 'No' button.
</short>
</element>
<element name="TMsgDlgBtn.mbOK">
<short>
Displays an 'OK' button.
</short>
</element>
<element name="TMsgDlgBtn.mbCancel">
<short>
Displays a 'Cancel' button.
</short>
</element>
<element name="TMsgDlgBtn.mbAbort">
<short>
Displays an 'Abort' button.
</short>
</element>
<element name="TMsgDlgBtn.mbRetry">
<short>
Displays a 'Retry' button.
</short>
</element>
<element name="TMsgDlgBtn.mbIgnore">
<short>
Displays an 'Ignore' button.
</short>
</element>
<element name="TMsgDlgBtn.mbAll">
<short>
Displays an 'All' button.
</short>
</element>
<element name="TMsgDlgBtn.mbNoToAll">
<short>
Displays a 'No to All' button.
</short>
</element>
<element name="TMsgDlgBtn.mbYesToAll">
<short>
Displays a 'Yes to All' button.
</short>
</element>
<element name="TMsgDlgBtn.mbHelp">
<short>
Displays a 'Help' button.
</short>
</element>
<element name="TMsgDlgBtn.mbClose">
<short>
Displays a 'Close' button.
</short>
</element>
<element name="TMsgDlgButtons">
<short>
Alias to the TMsgDlgButtons type in the FPC RTL.
</short>
<descr>
<p>
<var>TMsgDlgButtons</var> is a set type used to store zero or more values
from the TMsgDlgBtn enumeration. TMsgDlgButtons is passed as an argument to
routines like: <var>MessageDlg</var>, <var>MessageDlgPos</var>,
<var>MessageDlgPosHelp</var>, <var>CreateMessageDialog</var>,
<var>QuestionDlg</var>, and <var>LazMessageDlg</var>.
</p>
<remark>
TMsgDlgButtons has been deprecated in the UITypes unit for Lazarus versions
after 2.0.12. Use the TMsgDlgButtons type from the System.UITypes unit in the
FPC 3.2.0 RTL instead.
</remark>
</descr>
<seealso>
<link id="#lcl.dialogs.MessageDlg">MessageDlg</link>
<link id="#lcl.dialogs.MessageDlgPos">MessageDlgPos</link>
<link id="#lcl.dialogs.MessageDlgPosHelp">MessageDlgPosHelp</link>
<link id="#lcl.dialogs.CreateMessageDialog">CreateMessageDialog</link>
<link id="#lcl.dialogs.QuestionDlg">QuestionDlg</link>
<link id="#lcl.lazdialogs.LazMessageDlg">LazMessageDlg</link>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TMsgDlgButtons">TMsgDlgButtons</link>
-->
</seealso>
</element>
<element name="TModalResult">
<short>
Alias to the TModalResult type in the FPC RTL.
</short>
<descr>
<p>
<var>TModalResult</var> is an Integer type with a value in the range
<b>low(Integer)..high(Integer)</b>. TModalResult is the type returned by
routines that display modal dialog boxes, such as: <var>MessageDlg</var>,
<var>MessageDlgPos</var>, <var>MessageDlgPosHelp</var>,
<var>QuestionDlg</var>, and <var>LazMessageDlg</var>.
</p>
<p>
The value in TModalResult indicates the button clicked to close the modal
dialog, and contains one of the constant values:
</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>
<li>mrLast</li>
</ul>
<remark>
TModalResult has been deprecated in the UITypes unit for Lazarus versions
after 2.0.12. Use the TMsgDlgType type from the System.UITypes unit in the
FPC 3.2.0 RTL instead.
</remark>
</descr>
<seealso>
<link id="#lcl.dialogs.MessageDlg">MessageDlg</link>
<link id="#lcl.dialogs.MessageDlgPos">MessageDlgPos</link>
<link id="#lcl.dialogs.MessageDlgPosHelp">MessageDlgPosHelp</link>
<link id="#lcl.dialogs.CreateMessageDialog">CreateMessageDialog</link>
<link id="#lcl.dialogs.QuestionDlg">QuestionDlg</link>
<link id="#lcl.lazdialogs.LazMessageDlg">LazMessageDlg</link>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.TModalResult">TModalResult</link>
-->
</seealso>
</element>
<element name="PModalResult">
<short>
Alias to the PModalResult type in the FPC RTL.
</short>
<descr>
<p>
<var>PModalResult</var> is a pointer type to a <var>TModalResult</var> value.
</p>
<remark>
PModalResult has been deprecated in the UITypes unit for Lazarus versions
after 2.0.12. Use the TMsgDlgType type from the System.UITypes unit in the
FPC 3.2.0 RTL instead.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.PModalResult">PModalResult</link>
-->
</seealso>
</element>
<element name="mrNone">
<short>Dialog was closed without pressing a button.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrNone constant from
the System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrNone">mrNone</link>
-->
</seealso>
</element>
<element name="mrOK">
<short>OK button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrOK constant from the
System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrOk">mrOk</link>
-->
</seealso>
</element>
<element name="mrCancel">
<short>Cancel button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrCancel constant from
the System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrCancel">mrCancel</link>
-->
</seealso>
</element>
<element name="mrAbort">
<short>Abort button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrAbort constant from
the System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrAbort">mrAbort</link>
-->
</seealso>
</element>
<element name="mrRetry">
<short>Retry button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrRetry constant from
the System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrRetry">mrRetry</link>
-->
</seealso>
</element>
<element name="mrIgnore">
<short>Ignore button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrIgnore constant from
the System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrIgnore">mrIgnore</link>
-->
</seealso>
</element>
<element name="mrYes">
<short>Yes button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrYes constant from the
System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrYes">mrYes</link>
-->
</seealso>
</element>
<element name="mrNo">
<short>No button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrNo constant from the
System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrNo">mrNo</link>
-->
</seealso>
</element>
<element name="mrAll">
<short>All button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrAll constant from the
System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrAll">mrAll</link>
-->
</seealso>
</element>
<element name="mrNoToAll">
<short>No to All button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrNoToAll constant from
the System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrNoToAll">mrNoToAll</link>
-->
</seealso>
</element>
<element name="mrYesToAll">
<short>Yes to All button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrYesToAll constant
from the System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrYesToAll">mrYesToAll</link>
-->
</seealso>
</element>
<element name="mrClose">
<short>Close button was clicked.</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrClose constant from
the System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrClose">mrClose</link>
-->
</seealso>
</element>
<element name="mrLast">
<short>Last modal result value (same as mrClose).</short>
<descr>
<remark>
Deprecated for Lazarus versions after 2.0.12. Use the mrLast constant from
the System.UITypes unit in the FPC 3.2.0 RTL.
</remark>
</descr>
<seealso>
<!--
Uncomment when RTL documentation contains the topic.
<link id="#rtl.system.uitypes.mrLast">mrLast</link>
-->
</seealso>
</element>
<element name="ModalResultStr">
<short>
String representations for modal result values.
</short>
<descr>
<p>
<var>ModalResultStr</var> is an array of <var>ShortString</var> values that
contains the string representations for the values in
<var>TModalResult</var>. ModalResultStr values can be accessed using the
corresponding numeric modal result value. For example:
</p>
<code>
sResult := ModalResultStr[mrNone]; // returns 'mrNone'
</code>
<p>
ModalResultStr contains the following values:
</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>
ModalResultStr is used in the implementation of the
<var>GetModalResultStr</var> routine in the <file>controls.pp</file> unit.
</p>
</descr>
<seealso>
<link id="#lcl.controls.GetModalResultStr">GetModalResultStr</link>
</seealso>
</element>
</module>
<!-- UITypes -->
</package>
</fpdoc-descriptions>
|