/Doc/Dialog.html
HTML | 44 lines | 43 code | 1 blank | 0 comment | 0 complexity | bcb1b1f73cd8cad1e6a95de344663cfe MD5 | raw file
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head>
3
4 <title>Dialog</title><meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"></head>
5<body>
6<h1>class <tt>Dialog(<a href="Window.html">Window</a>)</tt></h1>
7<br>
8The Dialog class is a subclass of <a href="Window.html">Window</a> designed
9for use as a dialog box. It provides facilities for defining default and
10cancel buttons that are activated by keyboard equivalents.<br>
11<br>
12A Dialog differs from a Window in having a default style of <tt>'nonmodal_dialog'</tt>,
13and by default (if possible on the platform) not being closable, zoomable
14or resizable. These options can be overridden in the constructor call. <br>
15<br>
16On platforms which display a menu bar at the top of each window, a Dialog
17does not normally have a menu bar. Enabled menu items are still available by their
18keyboard equivalents while the Dialog is active, however.<br>
19<h2>Constructor</h2>
20<blockquote>
21 <dl>
22 <dt><tt>Dialog(style</tt> <tt>=</tt> <tt>'nonmodal_dialog',</tt></dt>
23 <dt><tt> </tt><tt>closable</tt> <tt>=</tt> <tt>False,</tt>
24 <tt>resizable</tt> <tt>=</tt> <tt>False,</tt> <tt>zoomable</tt> = <tt>False</tt><tt>,</tt></dt>
25 <dt><tt> movable</tt> <tt>=</tt> <i>platform_default</i><tt>,</tt> <tt>hidable</tt>
26= <i>platform_default</i><tt>)<br></tt></dt>
27 <dd>Constructs a Dialog with the specified options. The default values
28for the movable and hidable options are platform-dependent.</dd>
29 </dl>
30</blockquote>
31<h2>Action Properties</h2>
32<blockquote>
33 <dl>
34 <dt><tt>default_action</tt></dt>
35 <dd><span style="font-family: monospace;"></span>Action
36to perform in response to a Return or Enter key event. This action is
37also typically invoked by activating a default button or pressing
38Return or Enter in a text field. The default is <span style="font-family: monospace;">'ok'</span>, which is implemented by <a href="ModalDialog.html">ModalDialog</a> to dismiss the dialog with the value <span style="font-family: monospace;">True</span>. You can create a button which invokes this action using <a href="Button.html#DefaultButton">DefaultButton</a>.</dd></dl><dl><dt><tt>cancel_action</tt></dt>
39 <dd>Action to perform in response to an Escape key event. This action is also typically invoked by activating a cancel button or pressing Escape in a text field. The default is <span style="font-family: monospace;">'cancel'</span>, which is implemented by <a href="ModalDialog.html">ModalDialog</a> to dismiss the dialog with the value <span style="font-family: monospace;">False</span>. You can create a button which invokes this action using <a href="Button.html#CancelButton">CancelButton</a>.</dd>
40 </dl>
41</blockquote>
42<br>
43<br>
44</body></html>