Debian Codegraph @

doc/scripting/lib.scripting.GtkDialog-class.html

raw
1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6 <title>lib.scripting.GtkDialog</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9 </head>
10
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <th class="navbar" width="100%"></th>
34 </tr>
35 </table>
36 <table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 Package&nbsp;lib ::
41 <a href="lib.scripting-module.html">Module&nbsp;scripting</a> ::
42 Class&nbsp;GtkDialog
43 </span>
44 </td>
45 <td>
46 <table cellpadding="0" cellspacing="0">
47 <!-- hide/show private -->
48 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
49 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
50 <tr><td align="right"><span class="options"
51 >[<a href="frames.html" target="_top">frames</a
52 >]&nbsp;|&nbsp;<a href="lib.scripting.GtkDialog-class.html"
53 target="_top">no&nbsp;frames</a>]</span></td></tr>
54 </table>
55 </td>
56 </tr>
57 </table>
58 <!-- ==================== CLASS DESCRIPTION ==================== -->
59 <h1 class="epydoc">Class GtkDialog</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog">source&nbsp;code</a></span></p>
60 <p>Provides a simple interface for the display of some basic dialogs to
61 collect information from the user.</p>
62 <p>This version uses Zenity to integrate well with GNOME. To pass
63 additional arguments to Zenity that are not specifically handled, use
64 keyword arguments. For example, to pass the --timeout argument to Zenity
65 pass <code>timeout=&quot;15&quot;</code> as one of the parameters. All
66 keyword arguments must be given as strings.</p>
67 <p>A note on exit codes: an exit code of 0 indicates that the user
68 clicked OK.</p>
69
70 <!-- ==================== INSTANCE METHODS ==================== -->
71 <a name="section-InstanceMethods"></a>
72 <table class="summary" border="1" cellpadding="3"
73 cellspacing="0" width="100%" bgcolor="white">
74 <tr bgcolor="#70b0f0" class="table-header">
75 <td colspan="2" class="table-header">
76 <table border="0" cellpadding="0" cellspacing="0" width="100%">
77 <tr valign="top">
78 <td align="left"><span class="table-header">Instance Methods</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-InstanceMethods"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86 </tr>
87 <tr class="private">
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 <table width="100%" cellpadding="0" cellspacing="0" border="0">
92 <tr>
93 <td><span class="summary-sig"><a name="_run_zenity"></a><span class="summary-sig-name">_run_zenity</span>(<span class="summary-sig-arg">self</span>,
94 <span class="summary-sig-arg">title</span>,
95 <span class="summary-sig-arg">args</span>,
96 <span class="summary-sig-arg">kwargs</span>)</span></td>
97 <td align="right" valign="top">
98 <span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog._run_zenity">source&nbsp;code</a></span>
99
100 </td>
101 </tr>
102 </table>
103
104 </td>
105 </tr>
106 <tr>
107 <td width="15%" align="right" valign="top" class="summary">
108 <span class="summary-type"><code>tuple(int, str)</code></span>
109 </td><td class="summary">
110 <table width="100%" cellpadding="0" cellspacing="0" border="0">
111 <tr>
112 <td><span class="summary-sig"><a href="lib.scripting.GtkDialog-class.html#info_dialog" class="summary-sig-name">info_dialog</a>(<span class="summary-sig-arg">self</span>,
113 <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Information</code><code class="variable-quote">'</code></span>,
114 <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
115 <span class="summary-sig-arg">**kwargs</span>)</span><br />
116 Show an information dialog</td>
117 <td align="right" valign="top">
118 <span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.info_dialog">source&nbsp;code</a></span>
119
120 </td>
121 </tr>
122 </table>
123
124 </td>
125 </tr>
126 <tr>
127 <td width="15%" align="right" valign="top" class="summary">
128 <span class="summary-type"><code>tuple(int, str)</code></span>
129 </td><td class="summary">
130 <table width="100%" cellpadding="0" cellspacing="0" border="0">
131 <tr>
132 <td><span class="summary-sig"><a href="lib.scripting.GtkDialog-class.html#input_dialog" class="summary-sig-name">input_dialog</a>(<span class="summary-sig-arg">self</span>,
133 <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter a value</code><code class="variable-quote">'</code></span>,
134 <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter a value</code><code class="variable-quote">'</code></span>,
135 <span class="summary-sig-arg">default</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
136 <span class="summary-sig-arg">**kwargs</span>)</span><br />
137 Show an input dialog</td>
138 <td align="right" valign="top">
139 <span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.input_dialog">source&nbsp;code</a></span>
140
141 </td>
142 </tr>
143 </table>
144
145 </td>
146 </tr>
147 <tr>
148 <td width="15%" align="right" valign="top" class="summary">
149 <span class="summary-type"><code>tuple(int, str)</code></span>
150 </td><td class="summary">
151 <table width="100%" cellpadding="0" cellspacing="0" border="0">
152 <tr>
153 <td><span class="summary-sig"><a href="lib.scripting.GtkDialog-class.html#password_dialog" class="summary-sig-name">password_dialog</a>(<span class="summary-sig-arg">self</span>,
154 <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter password</code><code class="variable-quote">'</code></span>,
155 <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter password</code><code class="variable-quote">'</code></span>,
156 <span class="summary-sig-arg">**kwargs</span>)</span><br />
157 Show a password input dialog</td>
158 <td align="right" valign="top">
159 <span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.password_dialog">source&nbsp;code</a></span>
160
161 </td>
162 </tr>
163 </table>
164
165 </td>
166 </tr>
167 <tr>
168 <td width="15%" align="right" valign="top" class="summary">
169 <span class="summary-type"><code>tuple(int, str)</code></span>
170 </td><td class="summary">
171 <table width="100%" cellpadding="0" cellspacing="0" border="0">
172 <tr>
173 <td><span class="summary-sig"><a href="lib.scripting.GtkDialog-class.html#list_menu" class="summary-sig-name">list_menu</a>(<span class="summary-sig-arg">self</span>,
174 <span class="summary-sig-arg">options</span>,
175 <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a value</code><code class="variable-quote">'</code></span>,
176 <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a value</code><code class="variable-quote">'</code></span>,
177 <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>,
178 <span class="summary-sig-arg">**kwargs</span>)</span><br />
179 Show a single-selection list menu</td>
180 <td align="right" valign="top">
181 <span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.list_menu">source&nbsp;code</a></span>
182
183 </td>
184 </tr>
185 </table>
186
187 </td>
188 </tr>
189 <tr>
190 <td width="15%" align="right" valign="top" class="summary">
191 <span class="summary-type"><code>tuple(int, str)</code></span>
192 </td><td class="summary">
193 <table width="100%" cellpadding="0" cellspacing="0" border="0">
194 <tr>
195 <td><span class="summary-sig"><a href="lib.scripting.GtkDialog-class.html#list_menu_multi" class="summary-sig-name">list_menu_multi</a>(<span class="summary-sig-arg">self</span>,
196 <span class="summary-sig-arg">options</span>,
197 <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose one or more values</code><code class="variable-quote">'</code></span>,
198 <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose one or more values</code><code class="variable-quote">'</code></span>,
199 <span class="summary-sig-arg">defaults</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
200 <span class="summary-sig-arg">**kwargs</span>)</span><br />
201 Show a multiple-selection list menu</td>
202 <td align="right" valign="top">
203 <span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.list_menu_multi">source&nbsp;code</a></span>
204
205 </td>
206 </tr>
207 </table>
208
209 </td>
210 </tr>
211 <tr>
212 <td width="15%" align="right" valign="top" class="summary">
213 <span class="summary-type"><code>tuple(int, str)</code></span>
214 </td><td class="summary">
215 <table width="100%" cellpadding="0" cellspacing="0" border="0">
216 <tr>
217 <td><span class="summary-sig"><a href="lib.scripting.GtkDialog-class.html#open_file" class="summary-sig-name">open_file</a>(<span class="summary-sig-arg">self</span>,
218 <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Open File</code><code class="variable-quote">'</code></span>,
219 <span class="summary-sig-arg">**kwargs</span>)</span><br />
220 Show an Open File dialog</td>
221 <td align="right" valign="top">
222 <span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.open_file">source&nbsp;code</a></span>
223
224 </td>
225 </tr>
226 </table>
227
228 </td>
229 </tr>
230 <tr>
231 <td width="15%" align="right" valign="top" class="summary">
232 <span class="summary-type"><code>tuple(int, str)</code></span>
233 </td><td class="summary">
234 <table width="100%" cellpadding="0" cellspacing="0" border="0">
235 <tr>
236 <td><span class="summary-sig"><a href="lib.scripting.GtkDialog-class.html#save_file" class="summary-sig-name">save_file</a>(<span class="summary-sig-arg">self</span>,
237 <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Save As</code><code class="variable-quote">'</code></span>,
238 <span class="summary-sig-arg">**kwargs</span>)</span><br />
239 Show a Save As dialog</td>
240 <td align="right" valign="top">
241 <span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.save_file">source&nbsp;code</a></span>
242
243 </td>
244 </tr>
245 </table>
246
247 </td>
248 </tr>
249 <tr>
250 <td width="15%" align="right" valign="top" class="summary">
251 <span class="summary-type"><code>tuple(int, str)</code></span>
252 </td><td class="summary">
253 <table width="100%" cellpadding="0" cellspacing="0" border="0">
254 <tr>
255 <td><span class="summary-sig"><a href="lib.scripting.GtkDialog-class.html#choose_directory" class="summary-sig-name">choose_directory</a>(<span class="summary-sig-arg">self</span>,
256 <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Select Directory</code><code class="variable-quote">'</code></span>,
257 <span class="summary-sig-arg">initialDir</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">~</code><code class="variable-quote">'</code></span>,
258 <span class="summary-sig-arg">**kwargs</span>)</span><br />
259 Show a Directory Chooser dialog</td>
260 <td align="right" valign="top">
261 <span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.choose_directory">source&nbsp;code</a></span>
262
263 </td>
264 </tr>
265 </table>
266
267 </td>
268 </tr>
269 <tr>
270 <td width="15%" align="right" valign="top" class="summary">
271 <span class="summary-type"><code>tuple(int, str)</code></span>
272 </td><td class="summary">
273 <table width="100%" cellpadding="0" cellspacing="0" border="0">
274 <tr>
275 <td><span class="summary-sig"><a href="lib.scripting.GtkDialog-class.html#calendar" class="summary-sig-name">calendar</a>(<span class="summary-sig-arg">self</span>,
276 <span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a date</code><code class="variable-quote">'</code></span>,
277 <span class="summary-sig-arg">format</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">%Y-%m-%d</code><code class="variable-quote">'</code></span>,
278 <span class="summary-sig-arg">date</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">today</code><code class="variable-quote">'</code></span>,
279 <span class="summary-sig-arg">**kwargs</span>)</span><br />
280 Show a calendar dialog</td>
281 <td align="right" valign="top">
282 <span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.calendar">source&nbsp;code</a></span>
283
284 </td>
285 </tr>
286 </table>
287
288 </td>
289 </tr>
290 </table>
291 <!-- ==================== METHOD DETAILS ==================== -->
292 <a name="section-MethodDetails"></a>
293 <table class="details" border="1" cellpadding="3"
294 cellspacing="0" width="100%" bgcolor="white">
295 <tr bgcolor="#70b0f0" class="table-header">
296 <td colspan="2" class="table-header">
297 <table border="0" cellpadding="0" cellspacing="0" width="100%">
298 <tr valign="top">
299 <td align="left"><span class="table-header">Method Details</span></td>
300 <td align="right" valign="top"
301 ><span class="options">[<a href="#section-MethodDetails"
302 class="privatelink" onclick="toggle_private();"
303 >hide private</a>]</span></td>
304 </tr>
305 </table>
306 </td>
307 </tr>
308 </table>
309 <a name="info_dialog"></a>
310 <div>
311 <table class="details" border="1" cellpadding="3"
312 cellspacing="0" width="100%" bgcolor="white">
313 <tr><td>
314 <table width="100%" cellpadding="0" cellspacing="0" border="0">
315 <tr valign="top"><td>
316 <h3 class="epydoc"><span class="sig"><span class="sig-name">info_dialog</span>(<span class="sig-arg">self</span>,
317 <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Information</code><code class="variable-quote">'</code></span>,
318 <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
319 <span class="sig-arg">**kwargs</span>)</span>
320 </h3>
321 </td><td align="right" valign="top"
322 ><span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.info_dialog">source&nbsp;code</a></span>&nbsp;
323 </td>
324 </tr></table>
325
326 <p>Show an information dialog</p>
327 <p>Usage: <code>dialog.info_dialog(title=&quot;Information&quot;,
328 message=&quot;&quot;, **kwargs)</code></p>
329 <dl class="fields">
330 <dt>Parameters:</dt>
331 <dd><ul class="nomargin-top">
332 <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
333 <li><strong class="pname"><code>message</code></strong> - message displayed in the dialog</li>
334 </ul></dd>
335 <dt>Returns: <code>tuple(int, str)</code></dt>
336 <dd>a tuple containing the exit code and user input</dd>
337 </dl>
338 </td></tr></table>
339 </div>
340 <a name="input_dialog"></a>
341 <div>
342 <table class="details" border="1" cellpadding="3"
343 cellspacing="0" width="100%" bgcolor="white">
344 <tr><td>
345 <table width="100%" cellpadding="0" cellspacing="0" border="0">
346 <tr valign="top"><td>
347 <h3 class="epydoc"><span class="sig"><span class="sig-name">input_dialog</span>(<span class="sig-arg">self</span>,
348 <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter a value</code><code class="variable-quote">'</code></span>,
349 <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter a value</code><code class="variable-quote">'</code></span>,
350 <span class="sig-arg">default</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
351 <span class="sig-arg">**kwargs</span>)</span>
352 </h3>
353 </td><td align="right" valign="top"
354 ><span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.input_dialog">source&nbsp;code</a></span>&nbsp;
355 </td>
356 </tr></table>
357
358 <p>Show an input dialog</p>
359 <p>Usage: <code>dialog.input_dialog(title=&quot;Enter a value&quot;,
360 message=&quot;Enter a value&quot;, default=&quot;&quot;,
361 **kwargs)</code></p>
362 <dl class="fields">
363 <dt>Parameters:</dt>
364 <dd><ul class="nomargin-top">
365 <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
366 <li><strong class="pname"><code>message</code></strong> - message displayed above the input box</li>
367 <li><strong class="pname"><code>default</code></strong> - default value for the input box</li>
368 </ul></dd>
369 <dt>Returns: <code>tuple(int, str)</code></dt>
370 <dd>a tuple containing the exit code and user input</dd>
371 </dl>
372 </td></tr></table>
373 </div>
374 <a name="password_dialog"></a>
375 <div>
376 <table class="details" border="1" cellpadding="3"
377 cellspacing="0" width="100%" bgcolor="white">
378 <tr><td>
379 <table width="100%" cellpadding="0" cellspacing="0" border="0">
380 <tr valign="top"><td>
381 <h3 class="epydoc"><span class="sig"><span class="sig-name">password_dialog</span>(<span class="sig-arg">self</span>,
382 <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter password</code><code class="variable-quote">'</code></span>,
383 <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Enter password</code><code class="variable-quote">'</code></span>,
384 <span class="sig-arg">**kwargs</span>)</span>
385 </h3>
386 </td><td align="right" valign="top"
387 ><span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.password_dialog">source&nbsp;code</a></span>&nbsp;
388 </td>
389 </tr></table>
390
391 <p>Show a password input dialog</p>
392 <p>Usage: <code>dialog.password_dialog(title=&quot;Enter password&quot;,
393 message=&quot;Enter password&quot;)</code></p>
394 <dl class="fields">
395 <dt>Parameters:</dt>
396 <dd><ul class="nomargin-top">
397 <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
398 <li><strong class="pname"><code>message</code></strong> - message displayed above the password input box</li>
399 </ul></dd>
400 <dt>Returns: <code>tuple(int, str)</code></dt>
401 <dd>a tuple containing the exit code and user input</dd>
402 </dl>
403 </td></tr></table>
404 </div>
405 <a name="list_menu"></a>
406 <div>
407 <table class="details" border="1" cellpadding="3"
408 cellspacing="0" width="100%" bgcolor="white">
409 <tr><td>
410 <table width="100%" cellpadding="0" cellspacing="0" border="0">
411 <tr valign="top"><td>
412 <h3 class="epydoc"><span class="sig"><span class="sig-name">list_menu</span>(<span class="sig-arg">self</span>,
413 <span class="sig-arg">options</span>,
414 <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a value</code><code class="variable-quote">'</code></span>,
415 <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a value</code><code class="variable-quote">'</code></span>,
416 <span class="sig-arg">default</span>=<span class="sig-default">None</span>,
417 <span class="sig-arg">**kwargs</span>)</span>
418 </h3>
419 </td><td align="right" valign="top"
420 ><span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.list_menu">source&nbsp;code</a></span>&nbsp;
421 </td>
422 </tr></table>
423
424 <p>Show a single-selection list menu</p>
425 <p>Usage: <code>dialog.list_menu(options, title=&quot;Choose a
426 value&quot;, message=&quot;Choose a value&quot;, default=None,
427 **kwargs)</code></p>
428 <dl class="fields">
429 <dt>Parameters:</dt>
430 <dd><ul class="nomargin-top">
431 <li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li>
432 <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
433 <li><strong class="pname"><code>message</code></strong> - message displayed above the list</li>
434 <li><strong class="pname"><code>default</code></strong> - default value to be selected</li>
435 </ul></dd>
436 <dt>Returns: <code>tuple(int, str)</code></dt>
437 <dd>a tuple containing the exit code and user choice</dd>
438 </dl>
439 </td></tr></table>
440 </div>
441 <a name="list_menu_multi"></a>
442 <div>
443 <table class="details" border="1" cellpadding="3"
444 cellspacing="0" width="100%" bgcolor="white">
445 <tr><td>
446 <table width="100%" cellpadding="0" cellspacing="0" border="0">
447 <tr valign="top"><td>
448 <h3 class="epydoc"><span class="sig"><span class="sig-name">list_menu_multi</span>(<span class="sig-arg">self</span>,
449 <span class="sig-arg">options</span>,
450 <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose one or more values</code><code class="variable-quote">'</code></span>,
451 <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose one or more values</code><code class="variable-quote">'</code></span>,
452 <span class="sig-arg">defaults</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>,
453 <span class="sig-arg">**kwargs</span>)</span>
454 </h3>
455 </td><td align="right" valign="top"
456 ><span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.list_menu_multi">source&nbsp;code</a></span>&nbsp;
457 </td>
458 </tr></table>
459
460 <p>Show a multiple-selection list menu</p>
461 <p>Usage: <code>dialog.list_menu_multi(options, title=&quot;Choose one or
462 more values&quot;, message=&quot;Choose one or more values&quot;,
463 defaults=[], **kwargs)</code></p>
464 <dl class="fields">
465 <dt>Parameters:</dt>
466 <dd><ul class="nomargin-top">
467 <li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li>
468 <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
469 <li><strong class="pname"><code>message</code></strong> - message displayed above the list</li>
470 <li><strong class="pname"><code>defaults</code></strong> - list of default values to be selected</li>
471 </ul></dd>
472 <dt>Returns: <code>tuple(int, str)</code></dt>
473 <dd>a tuple containing the exit code and user choice</dd>
474 </dl>
475 </td></tr></table>
476 </div>
477 <a name="open_file"></a>
478 <div>
479 <table class="details" border="1" cellpadding="3"
480 cellspacing="0" width="100%" bgcolor="white">
481 <tr><td>
482 <table width="100%" cellpadding="0" cellspacing="0" border="0">
483 <tr valign="top"><td>
484 <h3 class="epydoc"><span class="sig"><span class="sig-name">open_file</span>(<span class="sig-arg">self</span>,
485 <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Open File</code><code class="variable-quote">'</code></span>,
486 <span class="sig-arg">**kwargs</span>)</span>
487 </h3>
488 </td><td align="right" valign="top"
489 ><span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.open_file">source&nbsp;code</a></span>&nbsp;
490 </td>
491 </tr></table>
492
493 <p>Show an Open File dialog</p>
494 <p>Usage: <code>dialog.open_file(title=&quot;Open File&quot;,
495 **kwargs)</code></p>
496 <dl class="fields">
497 <dt>Parameters:</dt>
498 <dd><ul class="nomargin-top">
499 <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
500 </ul></dd>
501 <dt>Returns: <code>tuple(int, str)</code></dt>
502 <dd>a tuple containing the exit code and file path</dd>
503 </dl>
504 </td></tr></table>
505 </div>
506 <a name="save_file"></a>
507 <div>
508 <table class="details" border="1" cellpadding="3"
509 cellspacing="0" width="100%" bgcolor="white">
510 <tr><td>
511 <table width="100%" cellpadding="0" cellspacing="0" border="0">
512 <tr valign="top"><td>
513 <h3 class="epydoc"><span class="sig"><span class="sig-name">save_file</span>(<span class="sig-arg">self</span>,
514 <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Save As</code><code class="variable-quote">'</code></span>,
515 <span class="sig-arg">**kwargs</span>)</span>
516 </h3>
517 </td><td align="right" valign="top"
518 ><span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.save_file">source&nbsp;code</a></span>&nbsp;
519 </td>
520 </tr></table>
521
522 <p>Show a Save As dialog</p>
523 <p>Usage: <code>dialog.save_file(title=&quot;Save As&quot;,
524 **kwargs)</code></p>
525 <dl class="fields">
526 <dt>Parameters:</dt>
527 <dd><ul class="nomargin-top">
528 <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
529 </ul></dd>
530 <dt>Returns: <code>tuple(int, str)</code></dt>
531 <dd>a tuple containing the exit code and file path</dd>
532 </dl>
533 </td></tr></table>
534 </div>
535 <a name="choose_directory"></a>
536 <div>
537 <table class="details" border="1" cellpadding="3"
538 cellspacing="0" width="100%" bgcolor="white">
539 <tr><td>
540 <table width="100%" cellpadding="0" cellspacing="0" border="0">
541 <tr valign="top"><td>
542 <h3 class="epydoc"><span class="sig"><span class="sig-name">choose_directory</span>(<span class="sig-arg">self</span>,
543 <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Select Directory</code><code class="variable-quote">'</code></span>,
544 <span class="sig-arg">initialDir</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">~</code><code class="variable-quote">'</code></span>,
545 <span class="sig-arg">**kwargs</span>)</span>
546 </h3>
547 </td><td align="right" valign="top"
548 ><span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.choose_directory">source&nbsp;code</a></span>&nbsp;
549 </td>
550 </tr></table>
551
552 <p>Show a Directory Chooser dialog</p>
553 <p>Usage: <code>dialog.choose_directory(title=&quot;Select
554 Directory&quot;, **kwargs)</code></p>
555 <dl class="fields">
556 <dt>Parameters:</dt>
557 <dd><ul class="nomargin-top">
558 <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
559 </ul></dd>
560 <dt>Returns: <code>tuple(int, str)</code></dt>
561 <dd>a tuple containing the exit code and path</dd>
562 </dl>
563 </td></tr></table>
564 </div>
565 <a name="calendar"></a>
566 <div>
567 <table class="details" border="1" cellpadding="3"
568 cellspacing="0" width="100%" bgcolor="white">
569 <tr><td>
570 <table width="100%" cellpadding="0" cellspacing="0" border="0">
571 <tr valign="top"><td>
572 <h3 class="epydoc"><span class="sig"><span class="sig-name">calendar</span>(<span class="sig-arg">self</span>,
573 <span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose a date</code><code class="variable-quote">'</code></span>,
574 <span class="sig-arg">format</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">%Y-%m-%d</code><code class="variable-quote">'</code></span>,
575 <span class="sig-arg">date</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">today</code><code class="variable-quote">'</code></span>,
576 <span class="sig-arg">**kwargs</span>)</span>
577 </h3>
578 </td><td align="right" valign="top"
579 ><span class="codelink"><a href="lib.scripting-pysrc.html#GtkDialog.calendar">source&nbsp;code</a></span>&nbsp;
580 </td>
581 </tr></table>
582
583 <p>Show a calendar dialog</p>
584 <p>Usage: <code>dialog.calendar_dialog(title=&quot;Choose a date&quot;,
585 format=&quot;%Y-%m-%d&quot;, date=&quot;YYYY-MM-DD&quot;,
586 **kwargs)</code></p>
587 <dl class="fields">
588 <dt>Parameters:</dt>
589 <dd><ul class="nomargin-top">
590 <li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
591 <li><strong class="pname"><code>format</code></strong> - format of date to be returned</li>
592 <li><strong class="pname"><code>date</code></strong> - initial date as YYYY-MM-DD, otherwise today</li>
593 </ul></dd>
594 <dt>Returns: <code>tuple(int, str)</code></dt>
595 <dd>a tuple containing the exit code and date</dd>
596 </dl>
597 </td></tr></table>
598 </div>
599 <br />
600 <!-- ==================== NAVIGATION BAR ==================== -->
601 <table class="navbar" border="0" width="100%" cellpadding="0"
602 bgcolor="#a0c0ff" cellspacing="0">
603 <tr valign="middle">
604 <!-- Home link -->
605 <th>&nbsp;&nbsp;&nbsp;<a
606 href="lib.scripting-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
607
608 <!-- Tree link -->
609 <th>&nbsp;&nbsp;&nbsp;<a
610 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
611
612 <!-- Index link -->
613 <th>&nbsp;&nbsp;&nbsp;<a
614 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
615
616 <!-- Help link -->
617 <th>&nbsp;&nbsp;&nbsp;<a
618 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
619
620 <th class="navbar" width="100%"></th>
621 </tr>
622 </table>
623 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
624 <tr>
625 <td align="left" class="footer">
626 Generated by Epydoc 3.0.1 on Fri Apr 20 20:26:25 2012
627 </td>
628 <td align="right" class="footer">
629 <a target="mainFrame" href="http://epydoc.sourceforge.net"
630 >http://epydoc.sourceforge.net</a>
631 </td>
632 </tr>
633 </table>
634
635 <script type="text/javascript">
636 <!--
637 // Private objects are initially displayed (because if
638 // javascript is turned off then we want them to be
639 // visible); but by default, we want to hide them. So hide
640 // them unless we have a cookie that says to show them.
641 checkCookie();
642 // -->
643 </script>
644 </body>
645 </html>