/Doc/alert_funcs.html

https://bitbucket.org/alsh/pygui-mirror · HTML · 117 lines · 115 code · 2 blank · 0 comment · 0 complexity · 3753d959eea01c54c63068bf211071af MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
    2. 

  2. <html><head><title>Alert Functions</title>
    3. 

  3.   
    4. 

  4.                 <meta name="GENERATOR" content="Mozilla/3.01Gold (X11; I; SunOS 5.6 sun4u) [Netscape]"></head>
    5. 

  5. <body>
    6. 

  6.    <h1>Alert Functions</h1>
    7. 

  7.  These functions display various  commonly-used types of modal dialog containing 
    8. 

  8. a textual message.<br>
    9. 

  9.  <h2>Alert kinds</h2>
    10. 

  10.  The <tt>kind</tt> parameter in the following functions determines the appearance 
    11. 

  11. of the dialog. It may take the following values:<br>
    12. 

  12.  <blockquote>     <dl>
    13. 

  13.     <dt><tt>'stop'</tt></dt>
    14. 

  14.     <dd>Used for displaying an error message or other condition which prevents 
    15. 

  15. an operation from being completed.</dd>
    16. 

  16.   </dl>
    17. 

  17.      <dl>
    18. 

  18.     <dt><tt>'caution'</tt></dt>
    19. 

  19.     <dd>Used for warning the user when an operation could cause loss of data 
    20. 

  20. or other undesirable effects.</dd>
    21. 

  21.   </dl>
    22. 

  22.      <dl>
    23. 

  23.     <dt><tt>'note'</tt></dt>
    24. 

  24.     <dd>Used for presenting an informational message to the user.</dd>
    25. 

  25.   </dl>
    26. 

  26.      <dl>
    27. 

  27.     <dt><tt>'query'</tt></dt>
    28. 

  28.     <dd>Used for requesting information from the user.</dd>
    29. 

  29.   </dl>
    30. 

  30.  </blockquote>
    31. 

  31.  Some platforms may not display all of these in a unique way.<br>
    32. 

  32.  <h2>Low-level alert functions</h2>
    33. 

  33.  <dl>
    34. 

  34.   <dl>
    35. 

  35.     <dt><tt>alert(kind, message, ok_label = "OK")</tt></dt>
    36. 

  36.     <dd>Displays an alert box with one button, which is the default button.
    37. 

  37. Does not return a value.</dd>
    38. 

  38.   </dl>
    39. 

  39. </dl>
    40. 

  40.  <dl>
    41. 

  41.   <dl>
    42. 

  42.     <dt><tt>alert2(kind,&nbsp;</tt><tt>message</tt><tt>, yes_label = "Yes", 
    43. 

  43. no_label = "No",</tt></dt>
    44. 

  44.     <dt><tt>&nbsp; &nbsp; &nbsp; &nbsp;default = 1, cancel = 0)</tt></dt>
    45. 

  45.     <dd>Displays an alert box with two buttons. Returns 1 if the "yes" button 
    46. 

  46. is pressed, 0 if the "no" button is pressed.  The <tt>default</tt> and <tt>cancel</tt>&nbsp;parameters&nbsp;specify
    47. 

  47. which buttons, if any, are activated by the standard keyboard equivalents,
    48. 

  48. and take the values <tt>1</tt>, <tt>0</tt> or <tt>None</tt>.</dd>
    49. 

  49.   </dl>
    50. 

  50. </dl>
    51. 

  51.  <dl>
    52. 

  52.   <dl>
    53. 

  53.     <dt><tt>alert3(kind, message, yes_label = "Yes", no_label = "No", <br>
    54. 

  54.  &nbsp; &nbsp; &nbsp; &nbsp;other_label = "Cancel", </tt><tt>default = 1,
    55. 

  55. cancel = -1</tt><tt>)</tt></dt>
    56. 

  56.     <dd>Displays an alert box with three buttons. Returns 1 if the "yes" button
    57. 

  57. is pressed, 0 if the "no" button is pressed, and -1 if the "other" button
    58. 

  58. is pressed.&nbsp;  The <tt>default</tt> and <tt>cancel</tt> parameters specify
    59. 

  59. which buttons, if any, are activated by the standard keyboard equivalents,
    60. 

  60. and take the values <tt>1</tt>, <tt>0</tt>, <tt>-1</tt> or <tt>None</tt>.</dd>
    61. 

  61.   </dl>
    62. 

  62. </dl>
    63. 

  63. In addition to the parameters listed above, these functions also accept the
    64. 

  64. following optional parameters:<br>
    65. 

  65. <blockquote>
    66. 

  66.   <dl>
    67. 

  67.     <dt><tt>width</tt></dt>
    68. 

  68.     <dd>The overall width of the alert box.</dd>
    69. 

  69.   </dl>
    70. 

  70.   <dl>
    71. 

  71.     <dt><tt>lines</tt></dt>
    72. 

  72.     <dd>The number of lines to allow for in the text area of the alert box.</dd>
    73. 

  73.   </dl>
    74. 

  74. </blockquote>
    75. 

  75.  These parameters are hints only; platforms are free to
    76. 

  76. ignore them and calculate the size of the alert box from the text
    77. 

  77. provided.<br>
    78. 

  78. <h2>High-level alert functions</h2>
    79. 

  79. 

  80.  The following functions provide shorthands for calling the above functions
    81. 

  81. with certain common combinations of parameters.<br>
    82. 

  82.  <dl>
    83. 

  83.   <dl>
    84. 

  84.     <dt><tt>note_alert(message,</tt> ...<tt>)</tt></dt>
    85. 

  85.     <dd>Equivalent to <tt>alert('note', message,</tt> ...<tt>)</tt>.</dd>
    86. 

  86.   </dl>
    87. 

  87. </dl>
    88. 

  88.    <blockquote>     <dl>
    89. 

  89.     <dt><tt>stop_alert(message,</tt> ...<tt>)</tt></dt>
    90. 

  90.     <dd>Equivalent to <tt>alert('stop', message,</tt> ...<tt>)</tt>.</dd>
    91. 

  91.   </dl>
    92. 

  92.  </blockquote>
    93. 

  93.  <dl>
    94. 

  94.   <dl>
    95. 

  95.     <dt><tt>ask(message,</tt> ...<tt>)</tt></dt>
    96. 

  96.     <dd>Equivalent to <tt>alert2('query', message,</tt> ...<tt>)</tt>.</dd>
    97. 

  97.   </dl>
    98. 

  98. </dl>
    99. 

  99.  <blockquote>     <dl>
    100. 

  100.     <dt><tt>confirm(message,</tt> ...<tt>)</tt></dt>
    101. 

  101.     <dd>Equivalent to <tt>alert2('caution', message,</tt> ...<tt>)</tt>.</dd>
    102. 

  102.   </dl>
    103. 

  103.  </blockquote>
    104. 

  104.  <blockquote>     <dl>
    105. 

  105.     <dt><tt>ask_or_cancel(message,</tt> ...<tt>)</tt></dt>
    106. 

  106.     <dd>Equivalent to <tt>alert3('query', message,</tt> ...<tt>)</tt>.</dd>
    107. 

  107.   </dl>
    108. 

  108.  </blockquote>
    109. 

  109.  <dl>
    110. 

  110.   <dl>
    111. 

  111.     <dt><tt>confirm_or_cancel(message,</tt> ...<tt>)</tt></dt>
    112. 

  112.     <dd>Equivalent to <tt>alert3('caution', message,</tt> ...<tt>)</tt>.</dd>
    113. 

  113.   </dl>
    114. 

  114. </dl>
    115. 

  115.    ---<br>
    116. 

  116.  <br>
    117. 

  117. </body></html>
    118.