| 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.QtDialog</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 QtDialog |
| 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.QtDialog-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 QtDialog</h1><p class="nomargin-top"><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog">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 |
<p>This version uses KDialog to integrate well with KDE. To pass |
| 63 |
additional arguments to KDialog that are not specifically handled, use |
| 64 |
keyword arguments. For example, to pass the --geometry argument to |
| 65 |
KDialog to specify the desired size of the dialog, pass |
| 66 |
<code>geometry="700x400"</code> as one of the parameters. All |
| 67 |
keyword arguments must be given as strings.</p> |
| 68 |
<p>A note on exit codes: an exit code of 0 indicates that the user |
| 69 |
clicked OK.</p> |
| 70 |
|
| 71 |
<!-- ==================== INSTANCE METHODS ==================== --> |
| 72 |
<a name="section-InstanceMethods"></a> |
| 73 |
<table class="summary" border="1" cellpadding="3" |
| 74 |
cellspacing="0" width="100%" bgcolor="white"> |
| 75 |
<tr bgcolor="#70b0f0" class="table-header"> |
| 76 |
<td colspan="2" class="table-header"> |
| 77 |
<table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 78 |
<tr valign="top"> |
| 79 |
<td align="left"><span class="table-header">Instance Methods</span></td> |
| 80 |
<td align="right" valign="top" |
| 81 |
><span class="options">[<a href="#section-InstanceMethods" |
| 82 |
class="privatelink" onclick="toggle_private();" |
| 83 |
>hide private</a>]</span></td> |
| 84 |
</tr> |
| 85 |
</table> |
| 86 |
</td> |
| 87 |
</tr> |
| 88 |
<tr class="private"> |
| 89 |
<td width="15%" align="right" valign="top" class="summary"> |
| 90 |
<span class="summary-type"> </span> |
| 91 |
</td><td class="summary"> |
| 92 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 93 |
<tr> |
| 94 |
<td><span class="summary-sig"><a name="_run_kdialog"></a><span class="summary-sig-name">_run_kdialog</span>(<span class="summary-sig-arg">self</span>, |
| 95 |
<span class="summary-sig-arg">title</span>, |
| 96 |
<span class="summary-sig-arg">args</span>, |
| 97 |
<span class="summary-sig-arg">kwargs</span>)</span></td> |
| 98 |
<td align="right" valign="top"> |
| 99 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog._run_kdialog">source code</a></span> |
| 100 |
|
| 101 |
</td> |
| 102 |
</tr> |
| 103 |
</table> |
| 104 |
|
| 105 |
</td> |
| 106 |
</tr> |
| 107 |
<tr> |
| 108 |
<td width="15%" align="right" valign="top" class="summary"> |
| 109 |
<span class="summary-type"><code>tuple(int, str)</code></span> |
| 110 |
</td><td class="summary"> |
| 111 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 112 |
<tr> |
| 113 |
<td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#info_dialog" class="summary-sig-name">info_dialog</a>(<span class="summary-sig-arg">self</span>, |
| 114 |
<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>, |
| 115 |
<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>, |
| 116 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 117 |
Show an information dialog</td> |
| 118 |
<td align="right" valign="top"> |
| 119 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.info_dialog">source code</a></span> |
| 120 |
|
| 121 |
</td> |
| 122 |
</tr> |
| 123 |
</table> |
| 124 |
|
| 125 |
</td> |
| 126 |
</tr> |
| 127 |
<tr> |
| 128 |
<td width="15%" align="right" valign="top" class="summary"> |
| 129 |
<span class="summary-type"><code>tuple(int, str)</code></span> |
| 130 |
</td><td class="summary"> |
| 131 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 132 |
<tr> |
| 133 |
<td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#input_dialog" class="summary-sig-name">input_dialog</a>(<span class="summary-sig-arg">self</span>, |
| 134 |
<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>, |
| 135 |
<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>, |
| 136 |
<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>, |
| 137 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 138 |
Show an input dialog</td> |
| 139 |
<td align="right" valign="top"> |
| 140 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.input_dialog">source code</a></span> |
| 141 |
|
| 142 |
</td> |
| 143 |
</tr> |
| 144 |
</table> |
| 145 |
|
| 146 |
</td> |
| 147 |
</tr> |
| 148 |
<tr> |
| 149 |
<td width="15%" align="right" valign="top" class="summary"> |
| 150 |
<span class="summary-type"><code>tuple(int, str)</code></span> |
| 151 |
</td><td class="summary"> |
| 152 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 153 |
<tr> |
| 154 |
<td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#password_dialog" class="summary-sig-name">password_dialog</a>(<span class="summary-sig-arg">self</span>, |
| 155 |
<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>, |
| 156 |
<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>, |
| 157 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 158 |
Show a password input dialog</td> |
| 159 |
<td align="right" valign="top"> |
| 160 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.password_dialog">source code</a></span> |
| 161 |
|
| 162 |
</td> |
| 163 |
</tr> |
| 164 |
</table> |
| 165 |
|
| 166 |
</td> |
| 167 |
</tr> |
| 168 |
<tr> |
| 169 |
<td width="15%" align="right" valign="top" class="summary"> |
| 170 |
<span class="summary-type"><code>tuple(int, str)</code></span> |
| 171 |
</td><td class="summary"> |
| 172 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 173 |
<tr> |
| 174 |
<td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#combo_menu" class="summary-sig-name">combo_menu</a>(<span class="summary-sig-arg">self</span>, |
| 175 |
<span class="summary-sig-arg">options</span>, |
| 176 |
<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>, |
| 177 |
<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>, |
| 178 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 179 |
Show a combobox menu</td> |
| 180 |
<td align="right" valign="top"> |
| 181 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.combo_menu">source 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.QtDialog-class.html#list_menu" class="summary-sig-name">list_menu</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 a value</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 a value</code><code class="variable-quote">'</code></span>, |
| 199 |
<span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>, |
| 200 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 201 |
Show a single-selection list menu</td> |
| 202 |
<td align="right" valign="top"> |
| 203 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.list_menu">source 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.QtDialog-class.html#list_menu_multi" class="summary-sig-name">list_menu_multi</a>(<span class="summary-sig-arg">self</span>, |
| 218 |
<span class="summary-sig-arg">options</span>, |
| 219 |
<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>, |
| 220 |
<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>, |
| 221 |
<span class="summary-sig-arg">defaults</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>, |
| 222 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 223 |
Show a multiple-selection list menu</td> |
| 224 |
<td align="right" valign="top"> |
| 225 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.list_menu_multi">source code</a></span> |
| 226 |
|
| 227 |
</td> |
| 228 |
</tr> |
| 229 |
</table> |
| 230 |
|
| 231 |
</td> |
| 232 |
</tr> |
| 233 |
<tr> |
| 234 |
<td width="15%" align="right" valign="top" class="summary"> |
| 235 |
<span class="summary-type"><code>tuple(int, str)</code></span> |
| 236 |
</td><td class="summary"> |
| 237 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 238 |
<tr> |
| 239 |
<td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#open_file" class="summary-sig-name">open_file</a>(<span class="summary-sig-arg">self</span>, |
| 240 |
<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>, |
| 241 |
<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>, |
| 242 |
<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>, |
| 243 |
<span class="summary-sig-arg">rememberAs</span>=<span class="summary-sig-default">None</span>, |
| 244 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 245 |
Show an Open File dialog</td> |
| 246 |
<td align="right" valign="top"> |
| 247 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.open_file">source code</a></span> |
| 248 |
|
| 249 |
</td> |
| 250 |
</tr> |
| 251 |
</table> |
| 252 |
|
| 253 |
</td> |
| 254 |
</tr> |
| 255 |
<tr> |
| 256 |
<td width="15%" align="right" valign="top" class="summary"> |
| 257 |
<span class="summary-type"><code>tuple(int, str)</code></span> |
| 258 |
</td><td class="summary"> |
| 259 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 260 |
<tr> |
| 261 |
<td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#save_file" class="summary-sig-name">save_file</a>(<span class="summary-sig-arg">self</span>, |
| 262 |
<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>, |
| 263 |
<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>, |
| 264 |
<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>, |
| 265 |
<span class="summary-sig-arg">rememberAs</span>=<span class="summary-sig-default">None</span>, |
| 266 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 267 |
Show a Save As dialog</td> |
| 268 |
<td align="right" valign="top"> |
| 269 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.save_file">source code</a></span> |
| 270 |
|
| 271 |
</td> |
| 272 |
</tr> |
| 273 |
</table> |
| 274 |
|
| 275 |
</td> |
| 276 |
</tr> |
| 277 |
<tr> |
| 278 |
<td width="15%" align="right" valign="top" class="summary"> |
| 279 |
<span class="summary-type"><code>tuple(int, str)</code></span> |
| 280 |
</td><td class="summary"> |
| 281 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 282 |
<tr> |
| 283 |
<td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#choose_directory" class="summary-sig-name">choose_directory</a>(<span class="summary-sig-arg">self</span>, |
| 284 |
<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>, |
| 285 |
<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>, |
| 286 |
<span class="summary-sig-arg">rememberAs</span>=<span class="summary-sig-default">None</span>, |
| 287 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 288 |
Show a Directory Chooser dialog</td> |
| 289 |
<td align="right" valign="top"> |
| 290 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.choose_directory">source code</a></span> |
| 291 |
|
| 292 |
</td> |
| 293 |
</tr> |
| 294 |
</table> |
| 295 |
|
| 296 |
</td> |
| 297 |
</tr> |
| 298 |
<tr> |
| 299 |
<td width="15%" align="right" valign="top" class="summary"> |
| 300 |
<span class="summary-type"><code>tuple(int, str)</code></span> |
| 301 |
</td><td class="summary"> |
| 302 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 303 |
<tr> |
| 304 |
<td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#choose_colour" class="summary-sig-name">choose_colour</a>(<span class="summary-sig-arg">self</span>, |
| 305 |
<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>, |
| 306 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 307 |
Show a Colour Chooser dialog</td> |
| 308 |
<td align="right" valign="top"> |
| 309 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.choose_colour">source code</a></span> |
| 310 |
|
| 311 |
</td> |
| 312 |
</tr> |
| 313 |
</table> |
| 314 |
|
| 315 |
</td> |
| 316 |
</tr> |
| 317 |
<tr> |
| 318 |
<td width="15%" align="right" valign="top" class="summary"> |
| 319 |
<span class="summary-type"><code>tuple(int, str)</code></span> |
| 320 |
</td><td class="summary"> |
| 321 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 322 |
<tr> |
| 323 |
<td><span class="summary-sig"><a href="lib.scripting.QtDialog-class.html#calendar" class="summary-sig-name">calendar</a>(<span class="summary-sig-arg">self</span>, |
| 324 |
<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>, |
| 325 |
<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>, |
| 326 |
<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>, |
| 327 |
<span class="summary-sig-arg">**kwargs</span>)</span><br /> |
| 328 |
Show a calendar dialog</td> |
| 329 |
<td align="right" valign="top"> |
| 330 |
<span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.calendar">source code</a></span> |
| 331 |
|
| 332 |
</td> |
| 333 |
</tr> |
| 334 |
</table> |
| 335 |
|
| 336 |
</td> |
| 337 |
</tr> |
| 338 |
</table> |
| 339 |
<!-- ==================== METHOD DETAILS ==================== --> |
| 340 |
<a name="section-MethodDetails"></a> |
| 341 |
<table class="details" border="1" cellpadding="3" |
| 342 |
cellspacing="0" width="100%" bgcolor="white"> |
| 343 |
<tr bgcolor="#70b0f0" class="table-header"> |
| 344 |
<td colspan="2" class="table-header"> |
| 345 |
<table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| 346 |
<tr valign="top"> |
| 347 |
<td align="left"><span class="table-header">Method Details</span></td> |
| 348 |
<td align="right" valign="top" |
| 349 |
><span class="options">[<a href="#section-MethodDetails" |
| 350 |
class="privatelink" onclick="toggle_private();" |
| 351 |
>hide private</a>]</span></td> |
| 352 |
</tr> |
| 353 |
</table> |
| 354 |
</td> |
| 355 |
</tr> |
| 356 |
</table> |
| 357 |
<a name="info_dialog"></a> |
| 358 |
<div> |
| 359 |
<table class="details" border="1" cellpadding="3" |
| 360 |
cellspacing="0" width="100%" bgcolor="white"> |
| 361 |
<tr><td> |
| 362 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 363 |
<tr valign="top"><td> |
| 364 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">info_dialog</span>(<span class="sig-arg">self</span>, |
| 365 |
<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>, |
| 366 |
<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>, |
| 367 |
<span class="sig-arg">**kwargs</span>)</span> |
| 368 |
</h3> |
| 369 |
</td><td align="right" valign="top" |
| 370 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.info_dialog">source code</a></span> |
| 371 |
</td> |
| 372 |
</tr></table> |
| 373 |
|
| 374 |
<p>Show an information dialog</p> |
| 375 |
<p>Usage: <code>dialog.info_dialog(title="Information", |
| 376 |
message="", **kwargs)</code></p> |
| 377 |
<dl class="fields"> |
| 378 |
<dt>Parameters:</dt> |
| 379 |
<dd><ul class="nomargin-top"> |
| 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 in the dialog</li> |
| 382 |
</ul></dd> |
| 383 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 384 |
<dd>a tuple containing the exit code and user input</dd> |
| 385 |
</dl> |
| 386 |
</td></tr></table> |
| 387 |
</div> |
| 388 |
<a name="input_dialog"></a> |
| 389 |
<div> |
| 390 |
<table class="details" border="1" cellpadding="3" |
| 391 |
cellspacing="0" width="100%" bgcolor="white"> |
| 392 |
<tr><td> |
| 393 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 394 |
<tr valign="top"><td> |
| 395 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">input_dialog</span>(<span class="sig-arg">self</span>, |
| 396 |
<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>, |
| 397 |
<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>, |
| 398 |
<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>, |
| 399 |
<span class="sig-arg">**kwargs</span>)</span> |
| 400 |
</h3> |
| 401 |
</td><td align="right" valign="top" |
| 402 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.input_dialog">source code</a></span> |
| 403 |
</td> |
| 404 |
</tr></table> |
| 405 |
|
| 406 |
<p>Show an input dialog</p> |
| 407 |
<p>Usage: <code>dialog.input_dialog(title="Enter a value", |
| 408 |
message="Enter a value", default="", |
| 409 |
**kwargs)</code></p> |
| 410 |
<dl class="fields"> |
| 411 |
<dt>Parameters:</dt> |
| 412 |
<dd><ul class="nomargin-top"> |
| 413 |
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li> |
| 414 |
<li><strong class="pname"><code>message</code></strong> - message displayed above the input box</li> |
| 415 |
<li><strong class="pname"><code>default</code></strong> - default value for the input box</li> |
| 416 |
</ul></dd> |
| 417 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 418 |
<dd>a tuple containing the exit code and user input</dd> |
| 419 |
</dl> |
| 420 |
</td></tr></table> |
| 421 |
</div> |
| 422 |
<a name="password_dialog"></a> |
| 423 |
<div> |
| 424 |
<table class="details" border="1" cellpadding="3" |
| 425 |
cellspacing="0" width="100%" bgcolor="white"> |
| 426 |
<tr><td> |
| 427 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 428 |
<tr valign="top"><td> |
| 429 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">password_dialog</span>(<span class="sig-arg">self</span>, |
| 430 |
<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>, |
| 431 |
<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>, |
| 432 |
<span class="sig-arg">**kwargs</span>)</span> |
| 433 |
</h3> |
| 434 |
</td><td align="right" valign="top" |
| 435 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.password_dialog">source code</a></span> |
| 436 |
</td> |
| 437 |
</tr></table> |
| 438 |
|
| 439 |
<p>Show a password input dialog</p> |
| 440 |
<p>Usage: <code>dialog.password_dialog(title="Enter password", |
| 441 |
message="Enter password", **kwargs)</code></p> |
| 442 |
<dl class="fields"> |
| 443 |
<dt>Parameters:</dt> |
| 444 |
<dd><ul class="nomargin-top"> |
| 445 |
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li> |
| 446 |
<li><strong class="pname"><code>message</code></strong> - message displayed above the password input box</li> |
| 447 |
</ul></dd> |
| 448 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 449 |
<dd>a tuple containing the exit code and user input</dd> |
| 450 |
</dl> |
| 451 |
</td></tr></table> |
| 452 |
</div> |
| 453 |
<a name="combo_menu"></a> |
| 454 |
<div> |
| 455 |
<table class="details" border="1" cellpadding="3" |
| 456 |
cellspacing="0" width="100%" bgcolor="white"> |
| 457 |
<tr><td> |
| 458 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 459 |
<tr valign="top"><td> |
| 460 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">combo_menu</span>(<span class="sig-arg">self</span>, |
| 461 |
<span class="sig-arg">options</span>, |
| 462 |
<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>, |
| 463 |
<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>, |
| 464 |
<span class="sig-arg">**kwargs</span>)</span> |
| 465 |
</h3> |
| 466 |
</td><td align="right" valign="top" |
| 467 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.combo_menu">source code</a></span> |
| 468 |
</td> |
| 469 |
</tr></table> |
| 470 |
|
| 471 |
<p>Show a combobox menu</p> |
| 472 |
<p>Usage: <code>dialog.combo_menu(options, title="Choose an |
| 473 |
option", message="Choose an option", **kwargs)</code></p> |
| 474 |
<dl class="fields"> |
| 475 |
<dt>Parameters:</dt> |
| 476 |
<dd><ul class="nomargin-top"> |
| 477 |
<li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li> |
| 478 |
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li> |
| 479 |
<li><strong class="pname"><code>message</code></strong> - message displayed above the combobox</li> |
| 480 |
</ul></dd> |
| 481 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 482 |
<dd>a tuple containing the exit code and user choice</dd> |
| 483 |
</dl> |
| 484 |
</td></tr></table> |
| 485 |
</div> |
| 486 |
<a name="list_menu"></a> |
| 487 |
<div> |
| 488 |
<table class="details" border="1" cellpadding="3" |
| 489 |
cellspacing="0" width="100%" bgcolor="white"> |
| 490 |
<tr><td> |
| 491 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 492 |
<tr valign="top"><td> |
| 493 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">list_menu</span>(<span class="sig-arg">self</span>, |
| 494 |
<span class="sig-arg">options</span>, |
| 495 |
<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>, |
| 496 |
<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>, |
| 497 |
<span class="sig-arg">default</span>=<span class="sig-default">None</span>, |
| 498 |
<span class="sig-arg">**kwargs</span>)</span> |
| 499 |
</h3> |
| 500 |
</td><td align="right" valign="top" |
| 501 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.list_menu">source code</a></span> |
| 502 |
</td> |
| 503 |
</tr></table> |
| 504 |
|
| 505 |
<p>Show a single-selection list menu</p> |
| 506 |
<p>Usage: <code>dialog.list_menu(options, title="Choose a |
| 507 |
value", message="Choose a value", default=None, |
| 508 |
**kwargs)</code></p> |
| 509 |
<dl class="fields"> |
| 510 |
<dt>Parameters:</dt> |
| 511 |
<dd><ul class="nomargin-top"> |
| 512 |
<li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li> |
| 513 |
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li> |
| 514 |
<li><strong class="pname"><code>message</code></strong> - message displayed above the list</li> |
| 515 |
<li><strong class="pname"><code>default</code></strong> - default value to be selected</li> |
| 516 |
</ul></dd> |
| 517 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 518 |
<dd>a tuple containing the exit code and user choice</dd> |
| 519 |
</dl> |
| 520 |
</td></tr></table> |
| 521 |
</div> |
| 522 |
<a name="list_menu_multi"></a> |
| 523 |
<div> |
| 524 |
<table class="details" border="1" cellpadding="3" |
| 525 |
cellspacing="0" width="100%" bgcolor="white"> |
| 526 |
<tr><td> |
| 527 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 528 |
<tr valign="top"><td> |
| 529 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">list_menu_multi</span>(<span class="sig-arg">self</span>, |
| 530 |
<span class="sig-arg">options</span>, |
| 531 |
<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>, |
| 532 |
<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>, |
| 533 |
<span class="sig-arg">defaults</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>, |
| 534 |
<span class="sig-arg">**kwargs</span>)</span> |
| 535 |
</h3> |
| 536 |
</td><td align="right" valign="top" |
| 537 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.list_menu_multi">source code</a></span> |
| 538 |
</td> |
| 539 |
</tr></table> |
| 540 |
|
| 541 |
<p>Show a multiple-selection list menu</p> |
| 542 |
<p>Usage: <code>dialog.list_menu_multi(options, title="Choose one or |
| 543 |
more values", message="Choose one or more values", |
| 544 |
defaults=[], **kwargs)</code></p> |
| 545 |
<dl class="fields"> |
| 546 |
<dt>Parameters:</dt> |
| 547 |
<dd><ul class="nomargin-top"> |
| 548 |
<li><strong class="pname"><code>options</code></strong> - list of options (strings) for the dialog</li> |
| 549 |
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li> |
| 550 |
<li><strong class="pname"><code>message</code></strong> - message displayed above the list</li> |
| 551 |
<li><strong class="pname"><code>defaults</code></strong> - list of default values to be selected</li> |
| 552 |
</ul></dd> |
| 553 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 554 |
<dd>a tuple containing the exit code and user choice</dd> |
| 555 |
</dl> |
| 556 |
</td></tr></table> |
| 557 |
</div> |
| 558 |
<a name="open_file"></a> |
| 559 |
<div> |
| 560 |
<table class="details" border="1" cellpadding="3" |
| 561 |
cellspacing="0" width="100%" bgcolor="white"> |
| 562 |
<tr><td> |
| 563 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 564 |
<tr valign="top"><td> |
| 565 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">open_file</span>(<span class="sig-arg">self</span>, |
| 566 |
<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>, |
| 567 |
<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>, |
| 568 |
<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>, |
| 569 |
<span class="sig-arg">rememberAs</span>=<span class="sig-default">None</span>, |
| 570 |
<span class="sig-arg">**kwargs</span>)</span> |
| 571 |
</h3> |
| 572 |
</td><td align="right" valign="top" |
| 573 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.open_file">source code</a></span> |
| 574 |
</td> |
| 575 |
</tr></table> |
| 576 |
|
| 577 |
<p>Show an Open File dialog</p> |
| 578 |
<p>Usage: <code>dialog.open_file(title="Open File", |
| 579 |
initialDir="~", fileTypes="*|All Files", |
| 580 |
rememberAs=None, **kwargs)</code></p> |
| 581 |
<dl class="fields"> |
| 582 |
<dt>Parameters:</dt> |
| 583 |
<dd><ul class="nomargin-top"> |
| 584 |
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li> |
| 585 |
<li><strong class="pname"><code>initialDir</code></strong> - starting directory for the file dialog</li> |
| 586 |
<li><strong class="pname"><code>fileTypes</code></strong> - file type filter expression</li> |
| 587 |
<li><strong class="pname"><code>rememberAs</code></strong> - gives an ID to this file dialog, allowing it to open at the last |
| 588 |
used path next time</li> |
| 589 |
</ul></dd> |
| 590 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 591 |
<dd>a tuple containing the exit code and file path</dd> |
| 592 |
</dl> |
| 593 |
</td></tr></table> |
| 594 |
</div> |
| 595 |
<a name="save_file"></a> |
| 596 |
<div> |
| 597 |
<table class="details" border="1" cellpadding="3" |
| 598 |
cellspacing="0" width="100%" bgcolor="white"> |
| 599 |
<tr><td> |
| 600 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 601 |
<tr valign="top"><td> |
| 602 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">save_file</span>(<span class="sig-arg">self</span>, |
| 603 |
<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>, |
| 604 |
<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>, |
| 605 |
<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>, |
| 606 |
<span class="sig-arg">rememberAs</span>=<span class="sig-default">None</span>, |
| 607 |
<span class="sig-arg">**kwargs</span>)</span> |
| 608 |
</h3> |
| 609 |
</td><td align="right" valign="top" |
| 610 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.save_file">source code</a></span> |
| 611 |
</td> |
| 612 |
</tr></table> |
| 613 |
|
| 614 |
<p>Show a Save As dialog</p> |
| 615 |
<p>Usage: <code>dialog.save_file(title="Save As", |
| 616 |
initialDir="~", fileTypes="*|All Files", |
| 617 |
rememberAs=None, **kwargs)</code></p> |
| 618 |
<dl class="fields"> |
| 619 |
<dt>Parameters:</dt> |
| 620 |
<dd><ul class="nomargin-top"> |
| 621 |
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li> |
| 622 |
<li><strong class="pname"><code>initialDir</code></strong> - starting directory for the file dialog</li> |
| 623 |
<li><strong class="pname"><code>fileTypes</code></strong> - file type filter expression</li> |
| 624 |
<li><strong class="pname"><code>rememberAs</code></strong> - gives an ID to this file dialog, allowing it to open at the last |
| 625 |
used path next time</li> |
| 626 |
</ul></dd> |
| 627 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 628 |
<dd>a tuple containing the exit code and file path</dd> |
| 629 |
</dl> |
| 630 |
</td></tr></table> |
| 631 |
</div> |
| 632 |
<a name="choose_directory"></a> |
| 633 |
<div> |
| 634 |
<table class="details" border="1" cellpadding="3" |
| 635 |
cellspacing="0" width="100%" bgcolor="white"> |
| 636 |
<tr><td> |
| 637 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 638 |
<tr valign="top"><td> |
| 639 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">choose_directory</span>(<span class="sig-arg">self</span>, |
| 640 |
<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>, |
| 641 |
<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>, |
| 642 |
<span class="sig-arg">rememberAs</span>=<span class="sig-default">None</span>, |
| 643 |
<span class="sig-arg">**kwargs</span>)</span> |
| 644 |
</h3> |
| 645 |
</td><td align="right" valign="top" |
| 646 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.choose_directory">source code</a></span> |
| 647 |
</td> |
| 648 |
</tr></table> |
| 649 |
|
| 650 |
<p>Show a Directory Chooser dialog</p> |
| 651 |
<p>Usage: <code>dialog.choose_directory(title="Select |
| 652 |
Directory", initialDir="~", rememberAs=None, |
| 653 |
**kwargs)</code></p> |
| 654 |
<dl class="fields"> |
| 655 |
<dt>Parameters:</dt> |
| 656 |
<dd><ul class="nomargin-top"> |
| 657 |
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li> |
| 658 |
<li><strong class="pname"><code>initialDir</code></strong> - starting directory for the directory chooser dialog</li> |
| 659 |
<li><strong class="pname"><code>rememberAs</code></strong> - gives an ID to this file dialog, allowing it to open at the last |
| 660 |
used path next time</li> |
| 661 |
</ul></dd> |
| 662 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 663 |
<dd>a tuple containing the exit code and chosen path</dd> |
| 664 |
</dl> |
| 665 |
</td></tr></table> |
| 666 |
</div> |
| 667 |
<a name="choose_colour"></a> |
| 668 |
<div> |
| 669 |
<table class="details" border="1" cellpadding="3" |
| 670 |
cellspacing="0" width="100%" bgcolor="white"> |
| 671 |
<tr><td> |
| 672 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 673 |
<tr valign="top"><td> |
| 674 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">choose_colour</span>(<span class="sig-arg">self</span>, |
| 675 |
<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>, |
| 676 |
<span class="sig-arg">**kwargs</span>)</span> |
| 677 |
</h3> |
| 678 |
</td><td align="right" valign="top" |
| 679 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.choose_colour">source code</a></span> |
| 680 |
</td> |
| 681 |
</tr></table> |
| 682 |
|
| 683 |
<p>Show a Colour Chooser dialog</p> |
| 684 |
<p>Usage: <code>dialog.choose_colour(title="Select |
| 685 |
Colour")</code></p> |
| 686 |
<dl class="fields"> |
| 687 |
<dt>Parameters:</dt> |
| 688 |
<dd><ul class="nomargin-top"> |
| 689 |
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li> |
| 690 |
</ul></dd> |
| 691 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 692 |
<dd>a tuple containing the exit code and colour</dd> |
| 693 |
</dl> |
| 694 |
</td></tr></table> |
| 695 |
</div> |
| 696 |
<a name="calendar"></a> |
| 697 |
<div> |
| 698 |
<table class="details" border="1" cellpadding="3" |
| 699 |
cellspacing="0" width="100%" bgcolor="white"> |
| 700 |
<tr><td> |
| 701 |
<table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| 702 |
<tr valign="top"><td> |
| 703 |
<h3 class="epydoc"><span class="sig"><span class="sig-name">calendar</span>(<span class="sig-arg">self</span>, |
| 704 |
<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>, |
| 705 |
<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>, |
| 706 |
<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>, |
| 707 |
<span class="sig-arg">**kwargs</span>)</span> |
| 708 |
</h3> |
| 709 |
</td><td align="right" valign="top" |
| 710 |
><span class="codelink"><a href="lib.scripting-pysrc.html#QtDialog.calendar">source code</a></span> |
| 711 |
</td> |
| 712 |
</tr></table> |
| 713 |
|
| 714 |
<p>Show a calendar dialog</p> |
| 715 |
<p>Usage: <code>dialog.calendar_dialog(title="Choose a date", |
| 716 |
format="%Y-%m-%d", date="YYYY-MM-DD", |
| 717 |
**kwargs)</code></p> |
| 718 |
<p>Note: the format and date parameters are not currently used</p> |
| 719 |
<dl class="fields"> |
| 720 |
<dt>Parameters:</dt> |
| 721 |
<dd><ul class="nomargin-top"> |
| 722 |
<li><strong class="pname"><code>title</code></strong> - window title for the dialog</li> |
| 723 |
<li><strong class="pname"><code>format</code></strong> - format of date to be returned</li> |
| 724 |
<li><strong class="pname"><code>date</code></strong> - initial date as YYYY-MM-DD, otherwise today</li> |
| 725 |
</ul></dd> |
| 726 |
<dt>Returns: <code>tuple(int, str)</code></dt> |
| 727 |
<dd>a tuple containing the exit code and date</dd> |
| 728 |
</dl> |
| 729 |
</td></tr></table> |
| 730 |
</div> |
| 731 |
<br /> |
| 732 |
<!-- ==================== NAVIGATION BAR ==================== --> |
| 733 |
<table class="navbar" border="0" width="100%" cellpadding="0" |
| 734 |
bgcolor="#a0c0ff" cellspacing="0"> |
| 735 |
<tr valign="middle"> |
| 736 |
<!-- Home link --> |
| 737 |
<th> <a |
| 738 |
href="lib.scripting-module.html">Home</a> </th> |
| 739 |
|
| 740 |
<!-- Tree link --> |
| 741 |
<th> <a |
| 742 |
href="module-tree.html">Trees</a> </th> |
| 743 |
|
| 744 |
<!-- Index link --> |
| 745 |
<th> <a |
| 746 |
href="identifier-index.html">Indices</a> </th> |
| 747 |
|
| 748 |
<!-- Help link --> |
| 749 |
<th> <a |
| 750 |
href="help.html">Help</a> </th> |
| 751 |
|
| 752 |
<th class="navbar" width="100%"></th> |
| 753 |
</tr> |
| 754 |
</table> |
| 755 |
<table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| 756 |
<tr> |
| 757 |
<td align="left" class="footer"> |
| 758 |
Generated by Epydoc 3.0.1 on Fri Apr 20 20:26:25 2012 |
| 759 |
</td> |
| 760 |
<td align="right" class="footer"> |
| 761 |
<a target="mainFrame" href="http://epydoc.sourceforge.net" |
| 762 |
>http://epydoc.sourceforge.net</a> |
| 763 |
</td> |
| 764 |
</tr> |
| 765 |
</table> |
| 766 |
|
| 767 |
<script type="text/javascript"> |
| 768 |
<!-- |
| 769 |
// Private objects are initially displayed (because if |
| 770 |
// javascript is turned off then we want them to be |
| 771 |
// visible); but by default, we want to hide them. So hide |
| 772 |
// them unless we have a cookie that says to show them. |
| 773 |
checkCookie(); |
| 774 |
// --> |
| 775 |
</script> |
| 776 |
</body> |
| 777 |
</html> |