Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Tools.TRPreviewer.html
Documentation/Source/eric5.Tools.TRPreviewer.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Tools.TRPreviewer</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Tools.TRPreviewer</h1> | |
| 12 <p> | |
| 13 Module implementing the TR Previewer main window. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>noTranslationName</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#TRPreviewer">TRPreviewer</a></td> | |
| 23 <td>Class implementing the UI Previewer main window.</td> | |
| 24 </tr><tr> | |
| 25 <td><a href="#Translation">Translation</a></td> | |
| 26 <td>Class to store the properties of a translation</td> | |
| 27 </tr><tr> | |
| 28 <td><a href="#TranslationsDict">TranslationsDict</a></td> | |
| 29 <td>Class to store all loaded translations.</td> | |
| 30 </tr><tr> | |
| 31 <td><a href="#WidgetView">WidgetView</a></td> | |
| 32 <td>Class to show a dynamically loaded widget (or dialog).</td> | |
| 33 </tr><tr> | |
| 34 <td><a href="#WidgetWorkspace">WidgetWorkspace</a></td> | |
| 35 <td>Specialized workspace to show the loaded widgets.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="TRPreviewer" ID="TRPreviewer"></a> | |
| 44 <h2>TRPreviewer</h2> | |
| 45 <p> | |
| 46 Class implementing the UI Previewer main window. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QMainWindow | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#TRPreviewer.__init__">TRPreviewer</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#TRPreviewer.__about">__about</a></td> | |
| 61 <td>Private slot to show the about information.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#TRPreviewer.__aboutQt">__aboutQt</a></td> | |
| 64 <td>Private slot to show info about Qt.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#TRPreviewer.__initActions">__initActions</a></td> | |
| 67 <td>Private method to define the user interface actions.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#TRPreviewer.__initMenus">__initMenus</a></td> | |
| 70 <td>Private method to create the menus.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#TRPreviewer.__initToolbars">__initToolbars</a></td> | |
| 73 <td>Private method to create the toolbars.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#TRPreviewer.__openTranslation">__openTranslation</a></td> | |
| 76 <td>Private slot to handle the Open Translation action.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#TRPreviewer.__openWidget">__openWidget</a></td> | |
| 79 <td>Private slot to handle the Open Dialog action.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#TRPreviewer.__showWindowMenu">__showWindowMenu</a></td> | |
| 82 <td>Private slot to handle the aboutToShow signal of the window menu.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#TRPreviewer.__updateActions">__updateActions</a></td> | |
| 85 <td>Private slot to update the actions state.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#TRPreviewer.__whatsThis">__whatsThis</a></td> | |
| 88 <td>Private slot called in to enter Whats This mode.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#TRPreviewer.closeEvent">closeEvent</a></td> | |
| 91 <td>Private event handler for the close event.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#TRPreviewer.reloadTranslations">reloadTranslations</a></td> | |
| 94 <td>Public slot to reload all translations.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#TRPreviewer.setTranslation">setTranslation</a></td> | |
| 97 <td>Public slot to activate a translation.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#TRPreviewer.show">show</a></td> | |
| 100 <td>Public slot to show this dialog.</td> | |
| 101 </tr> | |
| 102 </table> | |
| 103 <a NAME="TRPreviewer.__init__" ID="TRPreviewer.__init__"></a> | |
| 104 <h4>TRPreviewer (Constructor)</h4> | |
| 105 <b>TRPreviewer</b>(<i>filenames = [], parent = None, name = None</i>) | |
| 106 <p> | |
| 107 Constructor | |
| 108 </p><dl> | |
| 109 <dt><i>filenames</i></dt> | |
| 110 <dd> | |
| 111 filenames of form and/or translation files to load | |
| 112 </dd><dt><i>parent</i></dt> | |
| 113 <dd> | |
| 114 parent widget of this window (QWidget) | |
| 115 </dd><dt><i>name</i></dt> | |
| 116 <dd> | |
| 117 name of this window (string) | |
| 118 </dd> | |
| 119 </dl><a NAME="TRPreviewer.__about" ID="TRPreviewer.__about"></a> | |
| 120 <h4>TRPreviewer.__about</h4> | |
| 121 <b>__about</b>(<i></i>) | |
| 122 <p> | |
| 123 Private slot to show the about information. | |
| 124 </p><a NAME="TRPreviewer.__aboutQt" ID="TRPreviewer.__aboutQt"></a> | |
| 125 <h4>TRPreviewer.__aboutQt</h4> | |
| 126 <b>__aboutQt</b>(<i></i>) | |
| 127 <p> | |
| 128 Private slot to show info about Qt. | |
| 129 </p><a NAME="TRPreviewer.__initActions" ID="TRPreviewer.__initActions"></a> | |
| 130 <h4>TRPreviewer.__initActions</h4> | |
| 131 <b>__initActions</b>(<i></i>) | |
| 132 <p> | |
| 133 Private method to define the user interface actions. | |
| 134 </p><a NAME="TRPreviewer.__initMenus" ID="TRPreviewer.__initMenus"></a> | |
| 135 <h4>TRPreviewer.__initMenus</h4> | |
| 136 <b>__initMenus</b>(<i></i>) | |
| 137 <p> | |
| 138 Private method to create the menus. | |
| 139 </p><a NAME="TRPreviewer.__initToolbars" ID="TRPreviewer.__initToolbars"></a> | |
| 140 <h4>TRPreviewer.__initToolbars</h4> | |
| 141 <b>__initToolbars</b>(<i></i>) | |
| 142 <p> | |
| 143 Private method to create the toolbars. | |
| 144 </p><a NAME="TRPreviewer.__openTranslation" ID="TRPreviewer.__openTranslation"></a> | |
| 145 <h4>TRPreviewer.__openTranslation</h4> | |
| 146 <b>__openTranslation</b>(<i></i>) | |
| 147 <p> | |
| 148 Private slot to handle the Open Translation action. | |
| 149 </p><a NAME="TRPreviewer.__openWidget" ID="TRPreviewer.__openWidget"></a> | |
| 150 <h4>TRPreviewer.__openWidget</h4> | |
| 151 <b>__openWidget</b>(<i></i>) | |
| 152 <p> | |
| 153 Private slot to handle the Open Dialog action. | |
| 154 </p><a NAME="TRPreviewer.__showWindowMenu" ID="TRPreviewer.__showWindowMenu"></a> | |
| 155 <h4>TRPreviewer.__showWindowMenu</h4> | |
| 156 <b>__showWindowMenu</b>(<i></i>) | |
| 157 <p> | |
| 158 Private slot to handle the aboutToShow signal of the window menu. | |
| 159 </p><a NAME="TRPreviewer.__updateActions" ID="TRPreviewer.__updateActions"></a> | |
| 160 <h4>TRPreviewer.__updateActions</h4> | |
| 161 <b>__updateActions</b>(<i></i>) | |
| 162 <p> | |
| 163 Private slot to update the actions state. | |
| 164 </p><a NAME="TRPreviewer.__whatsThis" ID="TRPreviewer.__whatsThis"></a> | |
| 165 <h4>TRPreviewer.__whatsThis</h4> | |
| 166 <b>__whatsThis</b>(<i></i>) | |
| 167 <p> | |
| 168 Private slot called in to enter Whats This mode. | |
| 169 </p><a NAME="TRPreviewer.closeEvent" ID="TRPreviewer.closeEvent"></a> | |
| 170 <h4>TRPreviewer.closeEvent</h4> | |
| 171 <b>closeEvent</b>(<i>event</i>) | |
| 172 <p> | |
| 173 Private event handler for the close event. | |
| 174 </p><dl> | |
| 175 <dt><i>event</i></dt> | |
| 176 <dd> | |
| 177 close event (QCloseEvent) | |
| 178 </dd> | |
| 179 </dl><a NAME="TRPreviewer.reloadTranslations" ID="TRPreviewer.reloadTranslations"></a> | |
| 180 <h4>TRPreviewer.reloadTranslations</h4> | |
| 181 <b>reloadTranslations</b>(<i></i>) | |
| 182 <p> | |
| 183 Public slot to reload all translations. | |
| 184 </p><a NAME="TRPreviewer.setTranslation" ID="TRPreviewer.setTranslation"></a> | |
| 185 <h4>TRPreviewer.setTranslation</h4> | |
| 186 <b>setTranslation</b>(<i>name</i>) | |
| 187 <p> | |
| 188 Public slot to activate a translation. | |
| 189 </p><dl> | |
| 190 <dt><i>name</i></dt> | |
| 191 <dd> | |
| 192 name (language) of the translation (string or QString) | |
| 193 </dd> | |
| 194 </dl><a NAME="TRPreviewer.show" ID="TRPreviewer.show"></a> | |
| 195 <h4>TRPreviewer.show</h4> | |
| 196 <b>show</b>(<i></i>) | |
| 197 <p> | |
| 198 Public slot to show this dialog. | |
| 199 </p><p> | |
| 200 This overloaded slot loads a UI file to be previewed after | |
| 201 the main window has been shown. This way, previewing a dialog | |
| 202 doesn't interfere with showing the main window. | |
| 203 </p> | |
| 204 <div align="right"><a href="#top">Up</a></div> | |
| 205 <hr /><hr /> | |
| 206 <a NAME="Translation" ID="Translation"></a> | |
| 207 <h2>Translation</h2> | |
| 208 <p> | |
| 209 Class to store the properties of a translation | |
| 210 </p> | |
| 211 <h3>Derived from</h3> | |
| 212 object | |
| 213 <h3>Class Attributes</h3> | |
| 214 <table> | |
| 215 <tr><td>None</td></tr> | |
| 216 </table> | |
| 217 <h3>Methods</h3> | |
| 218 <table> | |
| 219 <tr> | |
| 220 <td><a href="#Translation.__init__">Translation</a></td> | |
| 221 <td>Constructor</td> | |
| 222 </tr> | |
| 223 </table> | |
| 224 <a NAME="Translation.__init__" ID="Translation.__init__"></a> | |
| 225 <h4>Translation (Constructor)</h4> | |
| 226 <b>Translation</b>(<i></i>) | |
| 227 <p> | |
| 228 Constructor | |
| 229 </p> | |
| 230 <div align="right"><a href="#top">Up</a></div> | |
| 231 <hr /><hr /> | |
| 232 <a NAME="TranslationsDict" ID="TranslationsDict"></a> | |
| 233 <h2>TranslationsDict</h2> | |
| 234 <p> | |
| 235 Class to store all loaded translations. | |
| 236 </p><h4>Signals</h4> | |
| 237 <dl> | |
| 238 <dt>translationChanged()</dt> | |
| 239 <dd> | |
| 240 emit after a translator was set | |
| 241 </dd> | |
| 242 </dl> | |
| 243 <h3>Derived from</h3> | |
| 244 QObject | |
| 245 <h3>Class Attributes</h3> | |
| 246 <table> | |
| 247 <tr><td>None</td></tr> | |
| 248 </table> | |
| 249 <h3>Methods</h3> | |
| 250 <table> | |
| 251 <tr> | |
| 252 <td><a href="#TranslationsDict.__init__">TranslationsDict</a></td> | |
| 253 <td>Constructor</td> | |
| 254 </tr><tr> | |
| 255 <td><a href="#TranslationsDict.__del">__del</a></td> | |
| 256 <td>Private method to delete a translator from the list of available translators.</td> | |
| 257 </tr><tr> | |
| 258 <td><a href="#TranslationsDict.__findFileName">__findFileName</a></td> | |
| 259 <td>Private method to find a translation by file name.</td> | |
| 260 </tr><tr> | |
| 261 <td><a href="#TranslationsDict.__findName">__findName</a></td> | |
| 262 <td>Private method to find a translation by name.</td> | |
| 263 </tr><tr> | |
| 264 <td><a href="#TranslationsDict.__haveFileName">__haveFileName</a></td> | |
| 265 <td>Private method to check for the presence of a translation.</td> | |
| 266 </tr><tr> | |
| 267 <td><a href="#TranslationsDict.__haveName">__haveName</a></td> | |
| 268 <td>Private method to check for the presence of a named translation.</td> | |
| 269 </tr><tr> | |
| 270 <td><a href="#TranslationsDict.__uniqueName">__uniqueName</a></td> | |
| 271 <td>Private method to generate a unique name.</td> | |
| 272 </tr><tr> | |
| 273 <td><a href="#TranslationsDict.add">add</a></td> | |
| 274 <td>Public method to add a translation to the list.</td> | |
| 275 </tr><tr> | |
| 276 <td><a href="#TranslationsDict.hasTranslations">hasTranslations</a></td> | |
| 277 <td>Public method to check for loaded translations.</td> | |
| 278 </tr><tr> | |
| 279 <td><a href="#TranslationsDict.loadTransFile">loadTransFile</a></td> | |
| 280 <td>Public slot to load a translation file.</td> | |
| 281 </tr><tr> | |
| 282 <td><a href="#TranslationsDict.reload">reload</a></td> | |
| 283 <td>Public method to reload all translators.</td> | |
| 284 </tr><tr> | |
| 285 <td><a href="#TranslationsDict.set">set</a></td> | |
| 286 <td>Public slot to set a translator by name.</td> | |
| 287 </tr> | |
| 288 </table> | |
| 289 <a NAME="TranslationsDict.__init__" ID="TranslationsDict.__init__"></a> | |
| 290 <h4>TranslationsDict (Constructor)</h4> | |
| 291 <b>TranslationsDict</b>(<i>selector, parent</i>) | |
| 292 <p> | |
| 293 Constructor | |
| 294 </p><dl> | |
| 295 <dt><i>selector</i></dt> | |
| 296 <dd> | |
| 297 reference to the QComboBox used to show the | |
| 298 available languages (QComboBox) | |
| 299 </dd><dt><i>parent</i></dt> | |
| 300 <dd> | |
| 301 parent widget (QWidget) | |
| 302 </dd> | |
| 303 </dl><a NAME="TranslationsDict.__del" ID="TranslationsDict.__del"></a> | |
| 304 <h4>TranslationsDict.__del</h4> | |
| 305 <b>__del</b>(<i>name</i>) | |
| 306 <p> | |
| 307 Private method to delete a translator from the list of available translators. | |
| 308 </p><dl> | |
| 309 <dt><i>name</i></dt> | |
| 310 <dd> | |
| 311 name of the translator to delete (string or QString) | |
| 312 </dd> | |
| 313 </dl><a NAME="TranslationsDict.__findFileName" ID="TranslationsDict.__findFileName"></a> | |
| 314 <h4>TranslationsDict.__findFileName</h4> | |
| 315 <b>__findFileName</b>(<i>transFileName</i>) | |
| 316 <p> | |
| 317 Private method to find a translation by file name. | |
| 318 </p><dl> | |
| 319 <dt><i>transFileName</i></dt> | |
| 320 <dd> | |
| 321 file name of the translation file (string) | |
| 322 </dd> | |
| 323 </dl><dl> | |
| 324 <dt>Returns:</dt> | |
| 325 <dd> | |
| 326 reference to a translation object or None | |
| 327 </dd> | |
| 328 </dl><a NAME="TranslationsDict.__findName" ID="TranslationsDict.__findName"></a> | |
| 329 <h4>TranslationsDict.__findName</h4> | |
| 330 <b>__findName</b>(<i>name</i>) | |
| 331 <p> | |
| 332 Private method to find a translation by name. | |
| 333 </p><dl> | |
| 334 <dt><i>name</i></dt> | |
| 335 <dd> | |
| 336 name (language) of the translation (string) | |
| 337 </dd> | |
| 338 </dl><dl> | |
| 339 <dt>Returns:</dt> | |
| 340 <dd> | |
| 341 reference to a translation object or None | |
| 342 </dd> | |
| 343 </dl><a NAME="TranslationsDict.__haveFileName" ID="TranslationsDict.__haveFileName"></a> | |
| 344 <h4>TranslationsDict.__haveFileName</h4> | |
| 345 <b>__haveFileName</b>(<i>transFileName</i>) | |
| 346 <p> | |
| 347 Private method to check for the presence of a translation. | |
| 348 </p><dl> | |
| 349 <dt><i>transFileName</i></dt> | |
| 350 <dd> | |
| 351 file name of the translation file (string) | |
| 352 </dd> | |
| 353 </dl><dl> | |
| 354 <dt>Returns:</dt> | |
| 355 <dd> | |
| 356 flag indicating the presence of the translation (boolean) | |
| 357 </dd> | |
| 358 </dl><a NAME="TranslationsDict.__haveName" ID="TranslationsDict.__haveName"></a> | |
| 359 <h4>TranslationsDict.__haveName</h4> | |
| 360 <b>__haveName</b>(<i>name</i>) | |
| 361 <p> | |
| 362 Private method to check for the presence of a named translation. | |
| 363 </p><dl> | |
| 364 <dt><i>name</i></dt> | |
| 365 <dd> | |
| 366 name (language) of the translation (string) | |
| 367 </dd> | |
| 368 </dl><dl> | |
| 369 <dt>Returns:</dt> | |
| 370 <dd> | |
| 371 flag indicating the presence of the translation (boolean) | |
| 372 </dd> | |
| 373 </dl><a NAME="TranslationsDict.__uniqueName" ID="TranslationsDict.__uniqueName"></a> | |
| 374 <h4>TranslationsDict.__uniqueName</h4> | |
| 375 <b>__uniqueName</b>(<i>transFileName</i>) | |
| 376 <p> | |
| 377 Private method to generate a unique name. | |
| 378 </p><dl> | |
| 379 <dt><i>transFileName</i></dt> | |
| 380 <dd> | |
| 381 file name of the translation file (string) | |
| 382 </dd> | |
| 383 </dl><dl> | |
| 384 <dt>Returns:</dt> | |
| 385 <dd> | |
| 386 unique name (string or None) | |
| 387 </dd> | |
| 388 </dl><a NAME="TranslationsDict.add" ID="TranslationsDict.add"></a> | |
| 389 <h4>TranslationsDict.add</h4> | |
| 390 <b>add</b>(<i>fileName, setTranslation = True</i>) | |
| 391 <p> | |
| 392 Public method to add a translation to the list. | |
| 393 </p><p> | |
| 394 If the translation file (*.qm) has not been loaded yet, it will | |
| 395 be loaded automatically. | |
| 396 </p><dl> | |
| 397 <dt><i>fileName</i></dt> | |
| 398 <dd> | |
| 399 name of the translation file to be added (string) | |
| 400 </dd><dt><i>setTranslation</i></dt> | |
| 401 <dd> | |
| 402 flag indicating, if this should be set as the active | |
| 403 translation (boolean) | |
| 404 </dd> | |
| 405 </dl><a NAME="TranslationsDict.hasTranslations" ID="TranslationsDict.hasTranslations"></a> | |
| 406 <h4>TranslationsDict.hasTranslations</h4> | |
| 407 <b>hasTranslations</b>(<i></i>) | |
| 408 <p> | |
| 409 Public method to check for loaded translations. | |
| 410 </p><dl> | |
| 411 <dt>Returns:</dt> | |
| 412 <dd> | |
| 413 flag signaling if any translation was loaded (boolean) | |
| 414 </dd> | |
| 415 </dl><a NAME="TranslationsDict.loadTransFile" ID="TranslationsDict.loadTransFile"></a> | |
| 416 <h4>TranslationsDict.loadTransFile</h4> | |
| 417 <b>loadTransFile</b>(<i>transFileName</i>) | |
| 418 <p> | |
| 419 Public slot to load a translation file. | |
| 420 </p><dl> | |
| 421 <dt><i>transFileName</i></dt> | |
| 422 <dd> | |
| 423 file name of the translation file (string) | |
| 424 </dd> | |
| 425 </dl><dl> | |
| 426 <dt>Returns:</dt> | |
| 427 <dd> | |
| 428 reference to the new translator object (QTranslator) | |
| 429 </dd> | |
| 430 </dl><a NAME="TranslationsDict.reload" ID="TranslationsDict.reload"></a> | |
| 431 <h4>TranslationsDict.reload</h4> | |
| 432 <b>reload</b>(<i></i>) | |
| 433 <p> | |
| 434 Public method to reload all translators. | |
| 435 </p><a NAME="TranslationsDict.set" ID="TranslationsDict.set"></a> | |
| 436 <h4>TranslationsDict.set</h4> | |
| 437 <b>set</b>(<i>name</i>) | |
| 438 <p> | |
| 439 Public slot to set a translator by name. | |
| 440 </p><dl> | |
| 441 <dt><i>name</i></dt> | |
| 442 <dd> | |
| 443 name (language) of the translator to set (string) | |
| 444 </dd> | |
| 445 </dl> | |
| 446 <div align="right"><a href="#top">Up</a></div> | |
| 447 <hr /><hr /> | |
| 448 <a NAME="WidgetView" ID="WidgetView"></a> | |
| 449 <h2>WidgetView</h2> | |
| 450 <p> | |
| 451 Class to show a dynamically loaded widget (or dialog). | |
| 452 </p> | |
| 453 <h3>Derived from</h3> | |
| 454 QWidget | |
| 455 <h3>Class Attributes</h3> | |
| 456 <table> | |
| 457 <tr><td>None</td></tr> | |
| 458 </table> | |
| 459 <h3>Methods</h3> | |
| 460 <table> | |
| 461 <tr> | |
| 462 <td><a href="#WidgetView.__init__">WidgetView</a></td> | |
| 463 <td>Constructor</td> | |
| 464 </tr><tr> | |
| 465 <td><a href="#WidgetView.__rebuildWidget">__rebuildWidget</a></td> | |
| 466 <td>Private method to schedule a rebuild of the widget.</td> | |
| 467 </tr><tr> | |
| 468 <td><a href="#WidgetView.buildWidget">buildWidget</a></td> | |
| 469 <td>Public slot to load a UI file.</td> | |
| 470 </tr><tr> | |
| 471 <td><a href="#WidgetView.isValid">isValid</a></td> | |
| 472 <td>Public method to return the validity of this widget view.</td> | |
| 473 </tr><tr> | |
| 474 <td><a href="#WidgetView.uiFileName">uiFileName</a></td> | |
| 475 <td>Public method to retrieve the name of the UI file.</td> | |
| 476 </tr> | |
| 477 </table> | |
| 478 <a NAME="WidgetView.__init__" ID="WidgetView.__init__"></a> | |
| 479 <h4>WidgetView (Constructor)</h4> | |
| 480 <b>WidgetView</b>(<i>uiFileName, parent = None, name = None</i>) | |
| 481 <p> | |
| 482 Constructor | |
| 483 </p><dl> | |
| 484 <dt><i>uiFileName</i></dt> | |
| 485 <dd> | |
| 486 name of the UI file to load (string) | |
| 487 </dd><dt><i>parent</i></dt> | |
| 488 <dd> | |
| 489 parent widget (QWidget) | |
| 490 </dd><dt><i>name</i></dt> | |
| 491 <dd> | |
| 492 name of this widget (string) | |
| 493 </dd> | |
| 494 </dl><a NAME="WidgetView.__rebuildWidget" ID="WidgetView.__rebuildWidget"></a> | |
| 495 <h4>WidgetView.__rebuildWidget</h4> | |
| 496 <b>__rebuildWidget</b>(<i></i>) | |
| 497 <p> | |
| 498 Private method to schedule a rebuild of the widget. | |
| 499 </p><a NAME="WidgetView.buildWidget" ID="WidgetView.buildWidget"></a> | |
| 500 <h4>WidgetView.buildWidget</h4> | |
| 501 <b>buildWidget</b>(<i></i>) | |
| 502 <p> | |
| 503 Public slot to load a UI file. | |
| 504 </p><a NAME="WidgetView.isValid" ID="WidgetView.isValid"></a> | |
| 505 <h4>WidgetView.isValid</h4> | |
| 506 <b>isValid</b>(<i></i>) | |
| 507 <p> | |
| 508 Public method to return the validity of this widget view. | |
| 509 </p><dl> | |
| 510 <dt>Returns:</dt> | |
| 511 <dd> | |
| 512 flag indicating the validity (boolean) | |
| 513 </dd> | |
| 514 </dl><a NAME="WidgetView.uiFileName" ID="WidgetView.uiFileName"></a> | |
| 515 <h4>WidgetView.uiFileName</h4> | |
| 516 <b>uiFileName</b>(<i></i>) | |
| 517 <p> | |
| 518 Public method to retrieve the name of the UI file. | |
| 519 </p><dl> | |
| 520 <dt>Returns:</dt> | |
| 521 <dd> | |
| 522 filename of the loaded UI file (string) | |
| 523 </dd> | |
| 524 </dl> | |
| 525 <div align="right"><a href="#top">Up</a></div> | |
| 526 <hr /><hr /> | |
| 527 <a NAME="WidgetWorkspace" ID="WidgetWorkspace"></a> | |
| 528 <h2>WidgetWorkspace</h2> | |
| 529 <p> | |
| 530 Specialized workspace to show the loaded widgets. | |
| 531 </p><h4>Signals</h4> | |
| 532 <dl> | |
| 533 <dt>lastWidgetClosed()</dt> | |
| 534 <dd> | |
| 535 emitted after last widget was closed | |
| 536 </dd> | |
| 537 </dl> | |
| 538 <h3>Derived from</h3> | |
| 539 QWorkspace | |
| 540 <h3>Class Attributes</h3> | |
| 541 <table> | |
| 542 <tr><td>None</td></tr> | |
| 543 </table> | |
| 544 <h3>Methods</h3> | |
| 545 <table> | |
| 546 <tr> | |
| 547 <td><a href="#WidgetWorkspace.__init__">WidgetWorkspace</a></td> | |
| 548 <td>Constructor</td> | |
| 549 </tr><tr> | |
| 550 <td><a href="#WidgetWorkspace.__findWidget">__findWidget</a></td> | |
| 551 <td>Private method to find a specific widget view.</td> | |
| 552 </tr><tr> | |
| 553 <td><a href="#WidgetWorkspace.__toggleWidget">__toggleWidget</a></td> | |
| 554 <td>Private method to toggle a workspace window.</td> | |
| 555 </tr><tr> | |
| 556 <td><a href="#WidgetWorkspace.closeAllWidgets">closeAllWidgets</a></td> | |
| 557 <td>Public slot to close all windows.</td> | |
| 558 </tr><tr> | |
| 559 <td><a href="#WidgetWorkspace.closeWidget">closeWidget</a></td> | |
| 560 <td>Public slot to close the active window.</td> | |
| 561 </tr><tr> | |
| 562 <td><a href="#WidgetWorkspace.eventFilter">eventFilter</a></td> | |
| 563 <td>Protected method called to filter an event.</td> | |
| 564 </tr><tr> | |
| 565 <td><a href="#WidgetWorkspace.hasWidgets">hasWidgets</a></td> | |
| 566 <td>Public method to check for loaded widgets.</td> | |
| 567 </tr><tr> | |
| 568 <td><a href="#WidgetWorkspace.loadWidget">loadWidget</a></td> | |
| 569 <td>Public slot to load a UI file.</td> | |
| 570 </tr><tr> | |
| 571 <td><a href="#WidgetWorkspace.showWindowMenu">showWindowMenu</a></td> | |
| 572 <td>Public method to set up the widgets part of the Window menu.</td> | |
| 573 </tr><tr> | |
| 574 <td><a href="#WidgetWorkspace.toggleSelectedWidget">toggleSelectedWidget</a></td> | |
| 575 <td>Public method to handle the toggle of a window.</td> | |
| 576 </tr> | |
| 577 </table> | |
| 578 <a NAME="WidgetWorkspace.__init__" ID="WidgetWorkspace.__init__"></a> | |
| 579 <h4>WidgetWorkspace (Constructor)</h4> | |
| 580 <b>WidgetWorkspace</b>(<i>parent = None</i>) | |
| 581 <p> | |
| 582 Constructor | |
| 583 </p><dl> | |
| 584 <dt><i>parent</i></dt> | |
| 585 <dd> | |
| 586 parent widget (QWidget) | |
| 587 </dd> | |
| 588 </dl><a NAME="WidgetWorkspace.__findWidget" ID="WidgetWorkspace.__findWidget"></a> | |
| 589 <h4>WidgetWorkspace.__findWidget</h4> | |
| 590 <b>__findWidget</b>(<i>uiFileName</i>) | |
| 591 <p> | |
| 592 Private method to find a specific widget view. | |
| 593 </p><dl> | |
| 594 <dt><i>uiFileName</i></dt> | |
| 595 <dd> | |
| 596 filename of the loaded UI file (string) | |
| 597 </dd> | |
| 598 </dl><dl> | |
| 599 <dt>Returns:</dt> | |
| 600 <dd> | |
| 601 reference to the widget (WidgetView) or None | |
| 602 </dd> | |
| 603 </dl><a NAME="WidgetWorkspace.__toggleWidget" ID="WidgetWorkspace.__toggleWidget"></a> | |
| 604 <h4>WidgetWorkspace.__toggleWidget</h4> | |
| 605 <b>__toggleWidget</b>(<i>w</i>) | |
| 606 <p> | |
| 607 Private method to toggle a workspace window. | |
| 608 </p><dl> | |
| 609 <dt><i>w</i></dt> | |
| 610 <dd> | |
| 611 window to be toggled | |
| 612 </dd> | |
| 613 </dl><a NAME="WidgetWorkspace.closeAllWidgets" ID="WidgetWorkspace.closeAllWidgets"></a> | |
| 614 <h4>WidgetWorkspace.closeAllWidgets</h4> | |
| 615 <b>closeAllWidgets</b>(<i></i>) | |
| 616 <p> | |
| 617 Public slot to close all windows. | |
| 618 </p><a NAME="WidgetWorkspace.closeWidget" ID="WidgetWorkspace.closeWidget"></a> | |
| 619 <h4>WidgetWorkspace.closeWidget</h4> | |
| 620 <b>closeWidget</b>(<i></i>) | |
| 621 <p> | |
| 622 Public slot to close the active window. | |
| 623 </p><a NAME="WidgetWorkspace.eventFilter" ID="WidgetWorkspace.eventFilter"></a> | |
| 624 <h4>WidgetWorkspace.eventFilter</h4> | |
| 625 <b>eventFilter</b>(<i>obj, ev</i>) | |
| 626 <p> | |
| 627 Protected method called to filter an event. | |
| 628 </p><dl> | |
| 629 <dt><i>object</i></dt> | |
| 630 <dd> | |
| 631 object, that generated the event (QObject) | |
| 632 </dd><dt><i>event</i></dt> | |
| 633 <dd> | |
| 634 the event, that was generated by object (QEvent) | |
| 635 </dd> | |
| 636 </dl><dl> | |
| 637 <dt>Returns:</dt> | |
| 638 <dd> | |
| 639 flag indicating if event was filtered out | |
| 640 </dd> | |
| 641 </dl><a NAME="WidgetWorkspace.hasWidgets" ID="WidgetWorkspace.hasWidgets"></a> | |
| 642 <h4>WidgetWorkspace.hasWidgets</h4> | |
| 643 <b>hasWidgets</b>(<i></i>) | |
| 644 <p> | |
| 645 Public method to check for loaded widgets. | |
| 646 </p><dl> | |
| 647 <dt>Returns:</dt> | |
| 648 <dd> | |
| 649 flag signaling if any widget was loaded (boolean) | |
| 650 </dd> | |
| 651 </dl><a NAME="WidgetWorkspace.loadWidget" ID="WidgetWorkspace.loadWidget"></a> | |
| 652 <h4>WidgetWorkspace.loadWidget</h4> | |
| 653 <b>loadWidget</b>(<i>uiFileName</i>) | |
| 654 <p> | |
| 655 Public slot to load a UI file. | |
| 656 </p><dl> | |
| 657 <dt><i>uiFileName</i></dt> | |
| 658 <dd> | |
| 659 name of the UI file to load (string) | |
| 660 </dd> | |
| 661 </dl><a NAME="WidgetWorkspace.showWindowMenu" ID="WidgetWorkspace.showWindowMenu"></a> | |
| 662 <h4>WidgetWorkspace.showWindowMenu</h4> | |
| 663 <b>showWindowMenu</b>(<i>windowMenu</i>) | |
| 664 <p> | |
| 665 Public method to set up the widgets part of the Window menu. | |
| 666 </p><dl> | |
| 667 <dt><i>windowMenu</i></dt> | |
| 668 <dd> | |
| 669 reference to the window menu | |
| 670 </dd> | |
| 671 </dl><a NAME="WidgetWorkspace.toggleSelectedWidget" ID="WidgetWorkspace.toggleSelectedWidget"></a> | |
| 672 <h4>WidgetWorkspace.toggleSelectedWidget</h4> | |
| 673 <b>toggleSelectedWidget</b>(<i>act</i>) | |
| 674 <p> | |
| 675 Public method to handle the toggle of a window. | |
| 676 </p><dl> | |
| 677 <dt><i>act</i></dt> | |
| 678 <dd> | |
| 679 reference to the action that triggered (QAction) | |
| 680 </dd> | |
| 681 </dl> | |
| 682 <div align="right"><a href="#top">Up</a></div> | |
| 683 <hr /> | |
| 684 </body></html> |
