<?xml version="1.0" encoding="UTF-8"?>
<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>
          This 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 -->
      <element name="System.UITypes"/>

      <element name="mtWarning">
        <short>Alias to TMsgDlgType.mtWarning in the System.UITypes unit for the FPC RTL.</short>
        <seealso>
          <!-- link id="#rtl.system.uitypes.TMsgDlgType.mtWarning"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgType.mtError"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgType.mtInformation"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgType.mtConfirmation"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgType.mtCustom"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbYes"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbNo"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbOK"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbCancel"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbAbort"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbRetry"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbIgnore"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbAll"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbNoToAll"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbYesToAll"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbHelp"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.TMsgDlgBtn.mbClose"/ -->
        </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="#rtl.system.uitypes.TMsgDlgType"/ -->
          <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>
        </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="#rtl.system.uitypes.TMsgDlgBtn"/ -->
          <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>
        </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="#rtl.system.uitypes.TMsgDlgButtons"/ -->
          <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>
        </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="#rtl.system.uitypes.TModalResult"/ -->
          <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>
        </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>
          <!-- link id="#rtl.system.uitypes.PModalResult"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrNone"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrOK"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrCancel"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrAbort"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrRetry"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrIgnore"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrYes"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrNo"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrAll"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrNoToAll"/ -->
        </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>
          link id="#rtl.system.uitypes.mrYesToAll"/
        </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>
          <!-- link id="#rtl.system.uitypes.mrClose"/ -->
        </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>
          <!-- link id="#rtl.system.uitypes.mrLast"/ -->
        </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>
