1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html>
<head>
<title>API docs for “kiwi.ui.dialogs”</title>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
<link href="apidocs.css" type="text/css" rel="stylesheet" />
</head>
<body>
<h1 class="module">Module k.u.dialogs</h1>
<p>
<span id="part">Part of <a href="kiwi.html">kiwi</a>.<a href="kiwi.ui.html">ui</a></span>
</p>
<div>
</div>
<div class="undocumented">No module docstring</div>
<div id="splitTables">
<table class="children sortable" id="id301">
<tr class="class">
<td>Class</td>
<td><a href="kiwi.ui.dialogs.HIGAlertDialog.html">HIGAlertDialog</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.ui.dialogs.BaseDialog.html">BaseDialog</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#messagedialog">messagedialog</a></td>
<td><span>Create and show a MessageDialog.
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#_simple">_simple</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#error">error</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#info">info</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#warning">warning</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#yesno">yesno</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#open">open</a></td>
<td><span>Displays an open dialog.
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#selectfolder">selectfolder</a></td>
<td><span>Displays a select folder dialog.
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#ask_overwrite">ask_overwrite</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#save">save</a></td>
<td><span>Displays a save dialog.
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#password">password</a></td>
<td><span>Shows a password dialog and returns the password entered in the
dialog
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.ui.dialogs.html#_test">_test</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
</div>
<div class="function">
<a name="kiwi.ui.dialogs.messagedialog"></a>
<a name="messagedialog"></a>
<div class="functionHeader">
def messagedialog(dialog_type, short, long=None, parent=None, buttons=gtk.BUTTONS_OK, default=-1):
</div>
<div class="functionBody">
<div>Create and show a MessageDialog.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">dialog_type</td><td>one of constants
<ul>
<li>
gtk.MESSAGE_INFO
</li>
<li>
gtk.MESSAGE_WARNING
</li>
<li>
gtk.MESSAGE_QUESTION
</li>
<li>
gtk.MESSAGE_ERROR
</li>
</ul>
</td></tr><tr><td></td><td class="fieldArg">short</td><td>A header text to be inserted in the dialog.
</td></tr><tr><td></td><td class="fieldArg">long</td><td>A long description of message.
</td></tr><tr><td></td><td class="fieldArg">parent</td><td>The parent widget of this dialog
(type: a gtk.Window subclass
)</td></tr><tr><td></td><td class="fieldArg">buttons</td><td>The button type that the dialog will be display, one of the
constants:
<ul>
<li>
gtk.BUTTONS_NONE
</li>
<li>
gtk.BUTTONS_OK
</li>
<li>
gtk.BUTTONS_CLOSE
</li>
<li>
gtk.BUTTONS_CANCEL
</li>
<li>
gtk.BUTTONS_YES_NO
</li>
<li>
gtk.BUTTONS_OK_CANCEL
</li>
</ul>
or a tuple or 2-sized tuples representing label and response. If label
is a stock-id a stock icon will be displayed.
</td></tr><tr><td></td><td class="fieldArg">default</td><td>optional default response id
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs._simple"></a>
<a name="_simple"></a>
<div class="functionHeader">
def _simple(type, short, long=None, parent=None, buttons=gtk.BUTTONS_OK, default=-1):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs.error"></a>
<a name="error"></a>
<div class="functionHeader">
def error(short, long=None, parent=None, buttons=gtk.BUTTONS_OK, default=-1):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs.info"></a>
<a name="info"></a>
<div class="functionHeader">
def info(short, long=None, parent=None, buttons=gtk.BUTTONS_OK, default=-1):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs.warning"></a>
<a name="warning"></a>
<div class="functionHeader">
def warning(short, long=None, parent=None, buttons=gtk.BUTTONS_OK, default=-1):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs.yesno"></a>
<a name="yesno"></a>
<div class="functionHeader">
def yesno(text, parent=None, default=gtk.RESPONSE_YES, buttons=gtk.BUTTONS_YES_NO):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs.open"></a>
<a name="open"></a>
<div class="functionHeader">
def open(title='', parent=None, patterns=None, folder=None, filter=None):
</div>
<div class="functionBody">
<div>Displays an open dialog.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">title</td><td>the title of the folder, defaults to 'Select folder'
</td></tr><tr><td></td><td class="fieldArg">parent</td><td>parent gtk.Window or None
</td></tr><tr><td></td><td class="fieldArg">patterns</td><td>a list of pattern strings ['*.py', '*.pl'] or None
</td></tr><tr><td></td><td class="fieldArg">folder</td><td>initial folder or None
</td></tr><tr><td></td><td class="fieldArg">filter</td><td>a filter to use or None, is incompatible with patterns
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs.selectfolder"></a>
<a name="selectfolder"></a>
<div class="functionHeader">
def selectfolder(title='', parent=None, folder=None):
</div>
<div class="functionBody">
<div>Displays a select folder dialog.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">title</td><td>the title of the folder, defaults to 'Select folder'
</td></tr><tr><td></td><td class="fieldArg">parent</td><td>parent gtk.Window or None
</td></tr><tr><td></td><td class="fieldArg">folder</td><td>initial folder or None
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs.ask_overwrite"></a>
<a name="ask_overwrite"></a>
<div class="functionHeader">
def ask_overwrite(filename, parent=None):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs.save"></a>
<a name="save"></a>
<div class="functionHeader">
def save(title='', parent=None, current_name='', folder=None):
</div>
<div class="functionBody">
<div>Displays a save dialog.
<table class="fieldTable"></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs.password"></a>
<a name="password"></a>
<div class="functionHeader">
def password(primary='', secondary='', parent=None):
</div>
<div class="functionBody">
<div>Shows a password dialog and returns the password entered in the
dialog
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">primary</td><td>primary text
</td></tr><tr><td></td><td class="fieldArg">secondary</td><td>secondary text
</td></tr><tr><td></td><td class="fieldArg">parent</td><td>a gtk.Window subclass or None
</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">the password or None if none specified
(type: string or None
)</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.dialogs._test"></a>
<a name="_test"></a>
<div class="functionHeader">
def _test():
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div>
<address>
<a href="index.html">API Documentation</a> for Kiwi, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2008-05-29 16:06:17.
</address>
</body>
</html>
|
