/Doc/ModalDialog.html

https://bitbucket.org/alsh/pygui-mirror · HTML · 40 lines · 39 code · 1 blank · 0 comment · 0 complexity · 7d8335f49d314c794644d5694ff8e64d MD5 · raw file 

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><title>PyGUI - ModalDialog class</title>
    3. 

  3.   
    4. 

  4.         <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"></head>
    5. 

  5. <body>
    6. 

  6.  <h1>class <tt>ModalDialog(Dialog)</tt></h1>
    7. 

  7.  The ModalDialog class is a subclass of <a href="Dialog.html">Dialog</a>
    8. 

  8. designed for modal dialogs. It has a default style of <tt>'modal_dialog'</tt>
    9. 

  9. and provides facilities for presenting the dialog modally.<br>
    10. 

  10.  <br>
    11. 

  11.  While a ModalDialog is active, interaction with other parts of the application 
    12. 

  12. is prevented. Other windows cannot be activated, application-wide menu commands 
    13. 

  13. other than those used by the dialog itself are not enabled, and unhandled 
    14. 

  14. events and messages are not forwarded to the application.<br>
    15. 

  15.  <h2>Constructor</h2>
    16. 

  16.  <blockquote>        <dl>
    17. 

  17.     <dt><tt>ModalDialog(style</tt> <tt>=</tt> <tt>'modal_dialog',</tt></dt>
    18. 

  18.     <dt><tt>&nbsp; &nbsp; </tt><tt>closable</tt>       <tt>=</tt> <tt>False,</tt>       <tt>resizable</tt> <tt>=</tt> <tt>False,</tt> <tt>zoomable</tt> = <tt>False</tt><tt>,</tt></dt>
    19. 

  19.     <dt><tt>&nbsp; &nbsp; movable</tt> <tt>=</tt> <i>default</i><tt>,</tt> <tt>hidable</tt> =&nbsp;<i>default</i><tt>)</tt></dt>
    20. 

  20.     <dd><br>Constructs a ModalDialog with the specified options. The default values
    21. 

  21. for the <tt>movable</tt> and <tt>hidable</tt> options are platform-dependent.</dd>
    22. 

  22.   </dl>
    23. 

  23.   </blockquote>
    24. 

  24.  <h2>Methods</h2>
    25. 

  25.  <blockquote>     <dl>
    26. 

  26.     <dt><tt>present()</tt></dt>
    27. 

  27.     <dd>Present the dialog modally. The dialog is shown and a nested event 
    28. 

  28. loop is entered which prevents interaction with any other part of the application. 
    29. 

  29. This method retains control until the dialog's <tt>dismiss()</tt> method is
    30. 

  30. called. The dialog is then hidden and the <span style="font-family: monospace;">present()</span> method returns with the value passed to <tt>dismiss()</tt>.<br>
    31. 

  31.  </dd>
    32. 

  32.   </dl>
    33. 

  33. </blockquote>
    34. 

  34.  <blockquote>     <dl>
    35. 

  35.     <dt><tt>dismiss(result</tt> <tt>=</tt> <tt>0)</tt></dt>
    36. 

  36.     <dd>Hides the dialog and, if the dialog is being presented modally, causes the <tt>present()</tt> method to return with the given result as its return value.<br><br></dd><dt style="font-family: monospace;">ok()</dt><dd>Dismisses the dialog with the value <span style="font-family: monospace;">True</span>. By default, this method is called in response to pressing a <a href="Button.html#DefaultButton">DefaultButton</a> or&nbsp;a Return/Enter key event.<br><br></dd><dt style="font-family: monospace;">cancel()</dt><dd>Dismisses the dialog with the value <span style="font-family: monospace;">False</span>. By default, this method is called in response to pressing a&nbsp;<a href="Button.html#CancelButton">CancelButton</a> or&nbsp;an Escape key event.</dd>
    37. 

  37.   </dl>
    38. 

  38.  </blockquote>
    39. 

  39.  --- 
    40. 

  40. </body></html>
    41.