Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Tools.TRPreviewer.html

Documentation/Source/eric4.Tools.TRPreviewer.html

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

Mercurial Repository: eric

eric ide

mercurial