« back to all changes in this revision
Viewing changes to doc/lib.scripting.Dialog-class.html
- browse files at revision 4
- compare with another revision
- download diff
- download tarball
- view history from revision 4
- Committer: Bazaar Package Importer
- Author(s): Luke Faraone
- Date: 2009-09-27 15:08:28 UTC
- mfrom: (1.1.2 upstream) (2.1.2 squeeze)
- Revision ID: james.westby@ubuntu.com-20090927150828-6sded0d8od2mqsvp
Tags: 0.60.5-1
* New upstream version (closes: 548531)
* Change to using pickle instead of cPickle due to a bug in the latter
* Bring in changes to common modules needed for GTK version
* Fix design flaw in pickle error trapping code
* Fix <enter> not being sent at the end of unicode char entry
* Fix service crashing when undoing an expansion with backspace
* Use Phrase instead of Script in some nogui functions
* Change to using pickle instead of cPickle due to a bug in the latter
* Bring in changes to common modules needed for GTK version
* Fix design flaw in pickle error trapping code
* Fix <enter> not being sent at the end of unicode char entry
* Fix service crashing when undoing an expansion with backspace
* Use Phrase instead of Script in some nogui functions
- files added:
- doc/nogui
- doc/scripting
- files removed:
- doc/api-objects.txt
- files modified:
- PKG-INFO
added
removed
doc/lib.scripting.Dialog-class.html
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.Dialog</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> <a
19
href="lib.scripting-module.html">Home</a> </th>
20
21
<!-- Tree link -->
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
24
25
<!-- Index link -->
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
28
29
<!-- Help link -->
30
<th> <a
31
href="help.html">Help</a> </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 lib ::
41
<a href="lib.scripting-module.html">Module scripting</a> ::
42
Class Dialog
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 private</a>]</span></td></tr>
50
<tr><td align="right"><span class="options"
51
>[<a href="frames.html" target="_top">frames</a
52
>] | <a href="lib.scripting.Dialog-class.html"
53
target="_top">no frames</a>]</span></td></tr>
54
</table>
55
</td>
56
</tr>
57
</table>
58
<!-- ==================== CLASS DESCRIPTION ==================== -->
59
<h1 class="epydoc">Class Dialog</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#Dialog">source 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
63
<!-- ==================== INSTANCE METHODS ==================== -->
64
<a name="section-InstanceMethods"></a>
65
<table class="summary" border="1" cellpadding="3"
66
cellspacing="0" width="100%" bgcolor="white">
67
<tr bgcolor="#70b0f0" class="table-header">
68
<td colspan="2" class="table-header">
69
<table border="0" cellpadding="0" cellspacing="0" width="100%">
70
<tr valign="top">
71
<td align="left"><span class="table-header">Instance Methods</span></td>
72
<td align="right" valign="top"
73
><span class="options">[<a href="#section-InstanceMethods"
74
class="privatelink" onclick="toggle_private();"
75
>hide private</a>]</span></td>
76
</tr>
77
</table>
78
</td>
79
</tr>
80
<tr class="private">
81
<td width="15%" align="right" valign="top" class="summary">
82
<span class="summary-type"> </span>
83
</td><td class="summary">
84
<table width="100%" cellpadding="0" cellspacing="0" border="0">
85
<tr>
86
<td><span class="summary-sig"><a name="__runKdialog"></a><span class="summary-sig-name">__runKdialog</span>(<span class="summary-sig-arg">self</span>,
87
<span class="summary-sig-arg">title</span>,
88
<span class="summary-sig-arg">args</span>)</span></td>
89
<td align="right" valign="top">
90
<span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.__runKdialog">source code</a></span>
91
92
</td>
93
</tr>
94
</table>
95
96
</td>
97
</tr>
98
<tr>
99
<td width="15%" align="right" valign="top" class="summary">
100
<span class="summary-type"> </span>
101
</td><td class="summary">
102
<table width="100%" cellpadding="0" cellspacing="0" border="0">
103
<tr>
104
<td><span class="summary-sig"><a href="lib.scripting.Dialog-class.html#input_dialog" class="summary-sig-name">input_dialog</a>(<span class="summary-sig-arg">self</span>,
105
<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>,
106
<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>,
107
<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>)</span><br />
108
Show an input dialog</td>
109
<td align="right" valign="top">
110
<span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.input_dialog">source code</a></span>
111
112
</td>
113
</tr>
114
</table>
115
116
</td>
117
</tr>
118
<tr>
119
<td width="15%" align="right" valign="top" class="summary">
120
<span class="summary-type"> </span>
121
</td><td class="summary">
122
<table width="100%" cellpadding="0" cellspacing="0" border="0">
123
<tr>
124
<td><span class="summary-sig"><a href="lib.scripting.Dialog-class.html#password_dialog" class="summary-sig-name">password_dialog</a>(<span class="summary-sig-arg">self</span>,
125
<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>,
126
<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>)</span><br />
127
Show a password input dialog</td>
128
<td align="right" valign="top">
129
<span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.password_dialog">source code</a></span>
130
131
</td>
132
</tr>
133
</table>
134
135
</td>
136
</tr>
137
<tr>
138
<td width="15%" align="right" valign="top" class="summary">
139
<span class="summary-type"> </span>
140
</td><td class="summary">
141
<table width="100%" cellpadding="0" cellspacing="0" border="0">
142
<tr>
143
<td><span class="summary-sig"><a href="lib.scripting.Dialog-class.html#combo_menu" class="summary-sig-name">combo_menu</a>(<span class="summary-sig-arg">self</span>,
144
<span class="summary-sig-arg">options</span>,
145
<span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose an option</code><code class="variable-quote">'</code></span>,
146
<span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose an option</code><code class="variable-quote">'</code></span>)</span><br />
147
Show a combobox menu</td>
148
<td align="right" valign="top">
149
<span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.combo_menu">source code</a></span>
150
151
</td>
152
</tr>
153
</table>
154
155
</td>
156
</tr>
157
<tr>
158
<td width="15%" align="right" valign="top" class="summary">
159
<span class="summary-type"> </span>
160
</td><td class="summary">
161
<table width="100%" cellpadding="0" cellspacing="0" border="0">
162
<tr>
163
<td><span class="summary-sig"><a href="lib.scripting.Dialog-class.html#list_menu" class="summary-sig-name">list_menu</a>(<span class="summary-sig-arg">self</span>,
164
<span class="summary-sig-arg">options</span>,
165
<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>,
166
<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>,
167
<span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>)</span><br />
168
Show a single-selection list menu</td>
169
<td align="right" valign="top">
170
<span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.list_menu">source code</a></span>
171
172
</td>
173
</tr>
174
</table>
175
176
</td>
177
</tr>
178
<tr>
179
<td width="15%" align="right" valign="top" class="summary">
180
<span class="summary-type"> </span>
181
</td><td class="summary">
182
<table width="100%" cellpadding="0" cellspacing="0" border="0">
183
<tr>
184
<td><span class="summary-sig"><a href="lib.scripting.Dialog-class.html#list_menu_multi" class="summary-sig-name">list_menu_multi</a>(<span class="summary-sig-arg">self</span>,
185
<span class="summary-sig-arg">options</span>,
186
<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>,
187
<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>,
188
<span class="summary-sig-arg">defaults</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span><br />
189
Show a multiple-selection list menu</td>
190
<td align="right" valign="top">
191
<span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.list_menu_multi">source code</a></span>
192
193
</td>
194
</tr>
195
</table>
196
197
</td>
198
</tr>
199
<tr>
200
<td width="15%" align="right" valign="top" class="summary">
201
<span class="summary-type"> </span>
202
</td><td class="summary">
203
<table width="100%" cellpadding="0" cellspacing="0" border="0">
204
<tr>
205
<td><span class="summary-sig"><a href="lib.scripting.Dialog-class.html#open_file" class="summary-sig-name">open_file</a>(<span class="summary-sig-arg">self</span>,
206
<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>,
207
<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>,
208
<span class="summary-sig-arg">fileTypes</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">*|All Files</code><code class="variable-quote">'</code></span>,
209
<span class="summary-sig-arg">rememberAs</span>=<span class="summary-sig-default">None</span>)</span><br />
210
Show an Open File dialog</td>
211
<td align="right" valign="top">
212
<span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.open_file">source code</a></span>
213
214
</td>
215
</tr>
216
</table>
217
218
</td>
219
</tr>
220
<tr>
221
<td width="15%" align="right" valign="top" class="summary">
222
<span class="summary-type"> </span>
223
</td><td class="summary">
224
<table width="100%" cellpadding="0" cellspacing="0" border="0">
225
<tr>
226
<td><span class="summary-sig"><a href="lib.scripting.Dialog-class.html#save_file" class="summary-sig-name">save_file</a>(<span class="summary-sig-arg">self</span>,
227
<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>,
228
<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>,
229
<span class="summary-sig-arg">fileTypes</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">*|All Files</code><code class="variable-quote">'</code></span>,
230
<span class="summary-sig-arg">rememberAs</span>=<span class="summary-sig-default">None</span>)</span><br />
231
Show a Save As dialog</td>
232
<td align="right" valign="top">
233
<span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.save_file">source code</a></span>
234
235
</td>
236
</tr>
237
</table>
238
239
</td>
240
</tr>
241
<tr>
242
<td width="15%" align="right" valign="top" class="summary">
243
<span class="summary-type"> </span>
244
</td><td class="summary">
245
<table width="100%" cellpadding="0" cellspacing="0" border="0">
246
<tr>
247
<td><span class="summary-sig"><a href="lib.scripting.Dialog-class.html#choose_directory" class="summary-sig-name">choose_directory</a>(<span class="summary-sig-arg">self</span>,
248
<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>,
249
<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>,
250
<span class="summary-sig-arg">rememberAs</span>=<span class="summary-sig-default">None</span>)</span><br />
251
Show a Directory Chooser dialog</td>
252
<td align="right" valign="top">
253
<span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.choose_directory">source code</a></span>
254
255
</td>
256
</tr>
257
</table>
258
259
</td>
260
</tr>
261
<tr>
262
<td width="15%" align="right" valign="top" class="summary">
263
<span class="summary-type"> </span>
264
</td><td class="summary">
265
<table width="100%" cellpadding="0" cellspacing="0" border="0">
266
<tr>
267
<td><span class="summary-sig"><a href="lib.scripting.Dialog-class.html#choose_colour" class="summary-sig-name">choose_colour</a>(<span class="summary-sig-arg">self</span>,
268
<span class="summary-sig-arg">title</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">Select Colour</code><code class="variable-quote">'</code></span>)</span><br />
269
Show a Colour Chooser dialog</td>
270
<td align="right" valign="top">
271
<span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.choose_colour">source code</a></span>
272
273
</td>
274
</tr>
275
</table>
276
277
</td>
278
</tr>
279
</table>
280
<!-- ==================== METHOD DETAILS ==================== -->
281
<a name="section-MethodDetails"></a>
282
<table class="details" border="1" cellpadding="3"
283
cellspacing="0" width="100%" bgcolor="white">
284
<tr bgcolor="#70b0f0" class="table-header">
285
<td colspan="2" class="table-header">
286
<table border="0" cellpadding="0" cellspacing="0" width="100%">
287
<tr valign="top">
288
<td align="left"><span class="table-header">Method Details</span></td>
289
<td align="right" valign="top"
290
><span class="options">[<a href="#section-MethodDetails"
291
class="privatelink" onclick="toggle_private();"
292
>hide private</a>]</span></td>
293
</tr>
294
</table>
295
</td>
296
</tr>
297
</table>
298
<a name="input_dialog"></a>
299
<div>
300
<table class="details" border="1" cellpadding="3"
301
cellspacing="0" width="100%" bgcolor="white">
302
<tr><td>
303
<table width="100%" cellpadding="0" cellspacing="0" border="0">
304
<tr valign="top"><td>
305
<h3 class="epydoc"><span class="sig"><span class="sig-name">input_dialog</span>(<span class="sig-arg">self</span>,
306
<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>,
307
<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>,
308
<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>)</span>
309
</h3>
310
</td><td align="right" valign="top"
311
><span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.input_dialog">source code</a></span>
312
</td>
313
</tr></table>
314
315
<p>Show an input dialog</p>
316
<p>Usage: <code>dialog.input_dialog(title="Enter a value",
317
message="Enter a value", default="")</code></p>
318
<dl class="fields">
319
<dt>Parameters:</dt>
320
<dd><ul class="nomargin-top">
321
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
322
<li><strong class="pname"><code>message</code></strong> - message displayed above the input box</li>
323
<li><strong class="pname"><code>default</code></strong> - default value for the input box</li>
324
</ul></dd>
325
</dl>
326
</td></tr></table>
327
</div>
328
<a name="password_dialog"></a>
329
<div>
330
<table class="details" border="1" cellpadding="3"
331
cellspacing="0" width="100%" bgcolor="white">
332
<tr><td>
333
<table width="100%" cellpadding="0" cellspacing="0" border="0">
334
<tr valign="top"><td>
335
<h3 class="epydoc"><span class="sig"><span class="sig-name">password_dialog</span>(<span class="sig-arg">self</span>,
336
<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>,
337
<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>)</span>
338
</h3>
339
</td><td align="right" valign="top"
340
><span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.password_dialog">source code</a></span>
341
</td>
342
</tr></table>
343
344
<p>Show a password input dialog</p>
345
<p>Usage: <code>dialog.password_dialog(title="Enter password",
346
message="Enter password")</code></p>
347
<dl class="fields">
348
<dt>Parameters:</dt>
349
<dd><ul class="nomargin-top">
350
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
351
<li><strong class="pname"><code>message</code></strong> - message displayed above the password input box</li>
352
</ul></dd>
353
</dl>
354
</td></tr></table>
355
</div>
356
<a name="combo_menu"></a>
357
<div>
358
<table class="details" border="1" cellpadding="3"
359
cellspacing="0" width="100%" bgcolor="white">
360
<tr><td>
361
<table width="100%" cellpadding="0" cellspacing="0" border="0">
362
<tr valign="top"><td>
363
<h3 class="epydoc"><span class="sig"><span class="sig-name">combo_menu</span>(<span class="sig-arg">self</span>,
364
<span class="sig-arg">options</span>,
365
<span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose an option</code><code class="variable-quote">'</code></span>,
366
<span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Choose an option</code><code class="variable-quote">'</code></span>)</span>
367
</h3>
368
</td><td align="right" valign="top"
369
><span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.combo_menu">source code</a></span>
370
</td>
371
</tr></table>
372
373
<p>Show a combobox menu</p>
374
<p>Usage: <code>dialog.combo_menu(options, title="Choose an
375
option", message="Choose an option")</code></p>
376
<dl class="fields">
377
<dt>Parameters:</dt>
378
<dd><ul class="nomargin-top">
379
<li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li>
380
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
381
<li><strong class="pname"><code>message</code></strong> - message displayed above the combobox</li>
382
</ul></dd>
383
</dl>
384
</td></tr></table>
385
</div>
386
<a name="list_menu"></a>
387
<div>
388
<table class="details" border="1" cellpadding="3"
389
cellspacing="0" width="100%" bgcolor="white">
390
<tr><td>
391
<table width="100%" cellpadding="0" cellspacing="0" border="0">
392
<tr valign="top"><td>
393
<h3 class="epydoc"><span class="sig"><span class="sig-name">list_menu</span>(<span class="sig-arg">self</span>,
394
<span class="sig-arg">options</span>,
395
<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>,
396
<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>,
397
<span class="sig-arg">default</span>=<span class="sig-default">None</span>)</span>
398
</h3>
399
</td><td align="right" valign="top"
400
><span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.list_menu">source code</a></span>
401
</td>
402
</tr></table>
403
404
<p>Show a single-selection list menu</p>
405
<p>Usage: <code>dialog.list_menu(options, title="Choose a
406
value", message="Choose a value", default=None)</code></p>
407
<dl class="fields">
408
<dt>Parameters:</dt>
409
<dd><ul class="nomargin-top">
410
<li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li>
411
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
412
<li><strong class="pname"><code>message</code></strong> - message displayed above the list</li>
413
<li><strong class="pname"><code>default</code></strong> - default value to be selected</li>
414
</ul></dd>
415
</dl>
416
</td></tr></table>
417
</div>
418
<a name="list_menu_multi"></a>
419
<div>
420
<table class="details" border="1" cellpadding="3"
421
cellspacing="0" width="100%" bgcolor="white">
422
<tr><td>
423
<table width="100%" cellpadding="0" cellspacing="0" border="0">
424
<tr valign="top"><td>
425
<h3 class="epydoc"><span class="sig"><span class="sig-name">list_menu_multi</span>(<span class="sig-arg">self</span>,
426
<span class="sig-arg">options</span>,
427
<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>,
428
<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>,
429
<span class="sig-arg">defaults</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span>
430
</h3>
431
</td><td align="right" valign="top"
432
><span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.list_menu_multi">source code</a></span>
433
</td>
434
</tr></table>
435
436
<p>Show a multiple-selection list menu</p>
437
<p>Usage: <code>dialog.list_menu_multi(options, title="Choose one or
438
more values", message="Choose one or more values",
439
defaults=[])</code></p>
440
<dl class="fields">
441
<dt>Parameters:</dt>
442
<dd><ul class="nomargin-top">
443
<li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li>
444
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
445
<li><strong class="pname"><code>message</code></strong> - message displayed above the list</li>
446
<li><strong class="pname"><code>defaults</code></strong> - list of default values to be selected</li>
447
</ul></dd>
448
</dl>
449
</td></tr></table>
450
</div>
451
<a name="open_file"></a>
452
<div>
453
<table class="details" border="1" cellpadding="3"
454
cellspacing="0" width="100%" bgcolor="white">
455
<tr><td>
456
<table width="100%" cellpadding="0" cellspacing="0" border="0">
457
<tr valign="top"><td>
458
<h3 class="epydoc"><span class="sig"><span class="sig-name">open_file</span>(<span class="sig-arg">self</span>,
459
<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>,
460
<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>,
461
<span class="sig-arg">fileTypes</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">*|All Files</code><code class="variable-quote">'</code></span>,
462
<span class="sig-arg">rememberAs</span>=<span class="sig-default">None</span>)</span>
463
</h3>
464
</td><td align="right" valign="top"
465
><span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.open_file">source code</a></span>
466
</td>
467
</tr></table>
468
469
<p>Show an Open File dialog</p>
470
<p>Usage: <code>dialog.open_file(title="Open File",
471
initialDir="~", fileTypes="*|All Files",
472
rememberAs=None)</code></p>
473
<dl class="fields">
474
<dt>Parameters:</dt>
475
<dd><ul class="nomargin-top">
476
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
477
<li><strong class="pname"><code>initialDir</code></strong> - starting directory for the file dialog</li>
478
<li><strong class="pname"><code>fileTypes</code></strong> - file type filter expression</li>
479
<li><strong class="pname"><code>rememberAs</code></strong> - gives an ID to this file dialog, allowing it to open at the last
480
used path next time</li>
481
</ul></dd>
482
</dl>
483
</td></tr></table>
484
</div>
485
<a name="save_file"></a>
486
<div>
487
<table class="details" border="1" cellpadding="3"
488
cellspacing="0" width="100%" bgcolor="white">
489
<tr><td>
490
<table width="100%" cellpadding="0" cellspacing="0" border="0">
491
<tr valign="top"><td>
492
<h3 class="epydoc"><span class="sig"><span class="sig-name">save_file</span>(<span class="sig-arg">self</span>,
493
<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>,
494
<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>,
495
<span class="sig-arg">fileTypes</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">*|All Files</code><code class="variable-quote">'</code></span>,
496
<span class="sig-arg">rememberAs</span>=<span class="sig-default">None</span>)</span>
497
</h3>
498
</td><td align="right" valign="top"
499
><span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.save_file">source code</a></span>
500
</td>
501
</tr></table>
502
503
<p>Show a Save As dialog</p>
504
<p>Usage: <code>dialog.save_file(title="Save As",
505
initialDir="~", fileTypes="*|All Files",
506
rememberAs=None)</code></p>
507
<dl class="fields">
508
<dt>Parameters:</dt>
509
<dd><ul class="nomargin-top">
510
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
511
<li><strong class="pname"><code>initialDir</code></strong> - starting directory for the file dialog</li>
512
<li><strong class="pname"><code>fileTypes</code></strong> - file type filter expression</li>
513
<li><strong class="pname"><code>rememberAs</code></strong> - gives an ID to this file dialog, allowing it to open at the last
514
used path next time</li>
515
</ul></dd>
516
</dl>
517
</td></tr></table>
518
</div>
519
<a name="choose_directory"></a>
520
<div>
521
<table class="details" border="1" cellpadding="3"
522
cellspacing="0" width="100%" bgcolor="white">
523
<tr><td>
524
<table width="100%" cellpadding="0" cellspacing="0" border="0">
525
<tr valign="top"><td>
526
<h3 class="epydoc"><span class="sig"><span class="sig-name">choose_directory</span>(<span class="sig-arg">self</span>,
527
<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>,
528
<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>,
529
<span class="sig-arg">rememberAs</span>=<span class="sig-default">None</span>)</span>
530
</h3>
531
</td><td align="right" valign="top"
532
><span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.choose_directory">source code</a></span>
533
</td>
534
</tr></table>
535
536
<p>Show a Directory Chooser dialog</p>
537
<p>Usage: <code>dialog.choose_directory(title="Select
538
Directory", initialDir="~", rememberAs=None)</code></p>
539
<dl class="fields">
540
<dt>Parameters:</dt>
541
<dd><ul class="nomargin-top">
542
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
543
<li><strong class="pname"><code>initialDir</code></strong> - starting directory for the directory chooser dialog</li>
544
<li><strong class="pname"><code>rememberAs</code></strong> - gives an ID to this file dialog, allowing it to open at the last
545
used path next time</li>
546
</ul></dd>
547
</dl>
548
</td></tr></table>
549
</div>
550
<a name="choose_colour"></a>
551
<div>
552
<table class="details" border="1" cellpadding="3"
553
cellspacing="0" width="100%" bgcolor="white">
554
<tr><td>
555
<table width="100%" cellpadding="0" cellspacing="0" border="0">
556
<tr valign="top"><td>
557
<h3 class="epydoc"><span class="sig"><span class="sig-name">choose_colour</span>(<span class="sig-arg">self</span>,
558
<span class="sig-arg">title</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">Select Colour</code><code class="variable-quote">'</code></span>)</span>
559
</h3>
560
</td><td align="right" valign="top"
561
><span class="codelink"><a href="lib.scripting-pysrc.html#Dialog.choose_colour">source code</a></span>
562
</td>
563
</tr></table>
564
565
<p>Show a Colour Chooser dialog</p>
566
<p>Usage: <code>dialog.choose_colour(title="Select
567
Colour")</code></p>
568
<dl class="fields">
569
<dt>Parameters:</dt>
570
<dd><ul class="nomargin-top">
571
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li>
572
</ul></dd>
573
</dl>
574
</td></tr></table>
575
</div>
576
<br />
577
<!-- ==================== NAVIGATION BAR ==================== -->
578
<table class="navbar" border="0" width="100%" cellpadding="0"
579
bgcolor="#a0c0ff" cellspacing="0">
580
<tr valign="middle">
581
<!-- Home link -->
582
<th> <a
583
href="lib.scripting-module.html">Home</a> </th>
584
585
<!-- Tree link -->
586
<th> <a
587
href="module-tree.html">Trees</a> </th>
588
589
<!-- Index link -->
590
<th> <a
591
href="identifier-index.html">Indices</a> </th>
592
593
<!-- Help link -->
594
<th> <a
595
href="help.html">Help</a> </th>
596
597
<th class="navbar" width="100%"></th>
598
</tr>
599
</table>
600
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
601
<tr>
602
<td align="left" class="footer">
603
Generated by Epydoc 3.0.1 on Thu Aug 13 13:17:08 2009
604
</td>
605
<td align="right" class="footer">
606
<a target="mainFrame" href="http://epydoc.sourceforge.net"
607
>http://epydoc.sourceforge.net</a>
608
</td>
609
</tr>
610
</table>
611
612
<script type="text/javascript">
613
<!--
614
// Private objects are initially displayed (because if
615
// javascript is turned off then we want them to be
616
// visible); but by default, we want to hide them. So hide
617
// them unless we have a cookie that says to show them.
618
checkCookie();
619
// -->
620
</script>
621
</body>
622
</html>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1