Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Plugins.ViewManagerPlugins.Listspace.Listspace.html

Documentation/Source/eric6.Plugins.ViewManagerPlugins.Listspace.Listspace.html

changeset 3673
e26d7d0c1088
child 4026
10f27c323bcd
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.ViewManagerPlugins.Listspace.Listspace</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.ViewManagerPlugins.Listspace.Listspace</h1>
23 <p>
24 Module implementing the listspace viewmanager class.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#Listspace">Listspace</a></td>
34 <td>Class implementing the listspace viewmanager class.</td>
35 </tr><tr>
36 <td><a href="#StackedWidget">StackedWidget</a></td>
37 <td>Class implementing a custimized StackedWidget.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="Listspace" ID="Listspace"></a>
46 <h2>Listspace</h2>
47 <p>
48 Class implementing the listspace viewmanager class.
49 </p><h3>Signals</h3>
50 <dl>
51 <dt>bookmarkToggled(Editor)</dt>
52 <dd>
53 emitted when a bookmark is toggled.
54 </dd><dt>breakpointToggled(Editor)</dt>
55 <dd>
56 emitted when a breakpoint is toggled.
57 </dd><dt>changeCaption(str)</dt>
58 <dd>
59 emitted if a change of the caption is necessary
60 </dd><dt>checkActions(Editor)</dt>
61 <dd>
62 emitted when some actions should be checked
63 for their status
64 </dd><dt>cursorChanged(Editor)</dt>
65 <dd>
66 emitted after the cursor position of the
67 active window has changed
68 </dd><dt>editorChanged(str)</dt>
69 <dd>
70 emitted when the current editor has changed
71 </dd><dt>editorChangedEd(Editor)</dt>
72 <dd>
73 emitted when the current editor has changed
74 </dd><dt>editorClosed(str)</dt>
75 <dd>
76 emitted just before an editor window gets closed
77 </dd><dt>editorClosedEd(Editor)</dt>
78 <dd>
79 emitted just before an editor window gets
80 closed
81 </dd><dt>editorLanguageChanged(Editor)</dt>
82 <dd>
83 emitted to signal a change of an
84 editors language
85 </dd><dt>editorLineChanged(str,int)</dt>
86 <dd>
87 emitted to signal a change of an
88 editor's current line (line is given one based)
89 </dd><dt>editorOpened(str)</dt>
90 <dd>
91 emitted after an editor window was opened
92 </dd><dt>editorOpenedEd(Editor)</dt>
93 <dd>
94 emitted after an editor window was opened
95 </dd><dt>editorSaved(str)</dt>
96 <dd>
97 emitted after an editor window was saved
98 </dd><dt>editorTextChanged(Editor)</dt>
99 <dd>
100 emitted to signal a change of an
101 editor's text
102 </dd><dt>lastEditorClosed()</dt>
103 <dd>
104 emitted after the last editor window was closed
105 </dd><dt>previewStateChanged(bool)</dt>
106 <dd>
107 emitted to signal a change in the
108 preview state
109 </dd><dt>syntaxerrorToggled(Editor)</dt>
110 <dd>
111 emitted when a syntax error is toggled.
112 </dd>
113 </dl>
114 <h3>Derived from</h3>
115 QSplitter, ViewManager
116 <h3>Class Attributes</h3>
117 <table>
118 <tr><td>None</td></tr>
119 </table>
120 <h3>Class Methods</h3>
121 <table>
122 <tr><td>None</td></tr>
123 </table>
124 <h3>Methods</h3>
125 <table>
126 <tr>
127 <td><a href="#Listspace.__init__">Listspace</a></td>
128 <td>Constructor</td>
129 </tr><tr>
130 <td><a href="#Listspace.__captionChange">__captionChange</a></td>
131 <td>Private method to handle caption change signals from the editor.</td>
132 </tr><tr>
133 <td><a href="#Listspace.__contextMenuClose">__contextMenuClose</a></td>
134 <td>Private method to close the selected editor.</td>
135 </tr><tr>
136 <td><a href="#Listspace.__contextMenuCloseAll">__contextMenuCloseAll</a></td>
137 <td>Private method to close all editors.</td>
138 </tr><tr>
139 <td><a href="#Listspace.__contextMenuCloseOthers">__contextMenuCloseOthers</a></td>
140 <td>Private method to close the other editors.</td>
141 </tr><tr>
142 <td><a href="#Listspace.__contextMenuCopyPathToClipboard">__contextMenuCopyPathToClipboard</a></td>
143 <td>Private method to copy the file name of the selected editor to the clipboard.</td>
144 </tr><tr>
145 <td><a href="#Listspace.__contextMenuOpenRejections">__contextMenuOpenRejections</a></td>
146 <td>Private slot to open a rejections file associated with the selected editor.</td>
147 </tr><tr>
148 <td><a href="#Listspace.__contextMenuPrintFile">__contextMenuPrintFile</a></td>
149 <td>Private method to print the selected editor.</td>
150 </tr><tr>
151 <td><a href="#Listspace.__contextMenuSave">__contextMenuSave</a></td>
152 <td>Private method to save the selected editor.</td>
153 </tr><tr>
154 <td><a href="#Listspace.__contextMenuSaveAll">__contextMenuSaveAll</a></td>
155 <td>Private method to save all editors.</td>
156 </tr><tr>
157 <td><a href="#Listspace.__contextMenuSaveAs">__contextMenuSaveAs</a></td>
158 <td>Private method to save the selected editor to a new file.</td>
159 </tr><tr>
160 <td><a href="#Listspace.__currentChanged">__currentChanged</a></td>
161 <td>Private slot to handle the currentChanged signal.</td>
162 </tr><tr>
163 <td><a href="#Listspace.__cursorLineChanged">__cursorLineChanged</a></td>
164 <td>Private slot to handle a change of the current editor's cursor line.</td>
165 </tr><tr>
166 <td><a href="#Listspace.__initMenu">__initMenu</a></td>
167 <td>Private method to initialize the viewlist context menu.</td>
168 </tr><tr>
169 <td><a href="#Listspace.__showMenu">__showMenu</a></td>
170 <td>Private slot to handle the customContextMenuRequested signal of the viewlist.</td>
171 </tr><tr>
172 <td><a href="#Listspace.__showSelectedView">__showSelectedView</a></td>
173 <td>Private slot called to show a view selected in the list.</td>
174 </tr><tr>
175 <td><a href="#Listspace._addView">_addView</a></td>
176 <td>Protected method to add a view (i.e.</td>
177 </tr><tr>
178 <td><a href="#Listspace._initWindowActions">_initWindowActions</a></td>
179 <td>Protected method to define the user interface actions for window handling.</td>
180 </tr><tr>
181 <td><a href="#Listspace._modificationStatusChanged">_modificationStatusChanged</a></td>
182 <td>Protected slot to handle the modificationStatusChanged signal.</td>
183 </tr><tr>
184 <td><a href="#Listspace._removeAllViews">_removeAllViews</a></td>
185 <td>Protected method to remove all views (i.e.</td>
186 </tr><tr>
187 <td><a href="#Listspace._removeView">_removeView</a></td>
188 <td>Protected method to remove a view (i.e.</td>
189 </tr><tr>
190 <td><a href="#Listspace._showView">_showView</a></td>
191 <td>Protected method to show a view (i.e.</td>
192 </tr><tr>
193 <td><a href="#Listspace._syntaxErrorToggled">_syntaxErrorToggled</a></td>
194 <td>Protected slot to handle the syntaxerrorToggled signal.</td>
195 </tr><tr>
196 <td><a href="#Listspace.activeWindow">activeWindow</a></td>
197 <td>Public method to return the active (i.e.</td>
198 </tr><tr>
199 <td><a href="#Listspace.addSplit">addSplit</a></td>
200 <td>Public method used to split the current view.</td>
201 </tr><tr>
202 <td><a href="#Listspace.canCascade">canCascade</a></td>
203 <td>Public method to signal if cascading of managed windows is available.</td>
204 </tr><tr>
205 <td><a href="#Listspace.canSplit">canSplit</a></td>
206 <td>public method to signal if splitting of the view is available.</td>
207 </tr><tr>
208 <td><a href="#Listspace.canTile">canTile</a></td>
209 <td>Public method to signal if tiling of managed windows is available.</td>
210 </tr><tr>
211 <td><a href="#Listspace.cascade">cascade</a></td>
212 <td>Public method to cascade the managed windows.</td>
213 </tr><tr>
214 <td><a href="#Listspace.eventFilter">eventFilter</a></td>
215 <td>Public method called to filter the event queue.</td>
216 </tr><tr>
217 <td><a href="#Listspace.getSplitOrientation">getSplitOrientation</a></td>
218 <td>Public method to get the orientation of the split view.</td>
219 </tr><tr>
220 <td><a href="#Listspace.nextSplit">nextSplit</a></td>
221 <td>Public slot used to move to the next split.</td>
222 </tr><tr>
223 <td><a href="#Listspace.prevSplit">prevSplit</a></td>
224 <td>Public slot used to move to the previous split.</td>
225 </tr><tr>
226 <td><a href="#Listspace.removeSplit">removeSplit</a></td>
227 <td>Public method used to remove the current split view.</td>
228 </tr><tr>
229 <td><a href="#Listspace.setEditorName">setEditorName</a></td>
230 <td>Public method to change the displayed name of the editor.</td>
231 </tr><tr>
232 <td><a href="#Listspace.setSplitOrientation">setSplitOrientation</a></td>
233 <td>Public method used to set the orientation of the split view.</td>
234 </tr><tr>
235 <td><a href="#Listspace.showWindowMenu">showWindowMenu</a></td>
236 <td>Public method to set up the viewmanager part of the Window menu.</td>
237 </tr><tr>
238 <td><a href="#Listspace.tile">tile</a></td>
239 <td>Public method to tile the managed windows.</td>
240 </tr>
241 </table>
242 <h3>Static Methods</h3>
243 <table>
244 <tr><td>None</td></tr>
245 </table>
246 <a NAME="Listspace.__init__" ID="Listspace.__init__"></a>
247 <h4>Listspace (Constructor)</h4>
248 <b>Listspace</b>(<i>parent</i>)
249 <p>
250 Constructor
251 </p><dl>
252 <dt><i>parent</i></dt>
253 <dd>
254 parent widget (QWidget)
255 </dd>
256 </dl><a NAME="Listspace.__captionChange" ID="Listspace.__captionChange"></a>
257 <h4>Listspace.__captionChange</h4>
258 <b>__captionChange</b>(<i>cap, editor</i>)
259 <p>
260 Private method to handle caption change signals from the editor.
261 </p><p>
262 Updates the listwidget text to reflect the new caption information.
263 </p><dl>
264 <dt><i>cap</i></dt>
265 <dd>
266 Caption for the editor (string)
267 </dd><dt><i>editor</i></dt>
268 <dd>
269 Editor to update the caption for
270 </dd>
271 </dl><a NAME="Listspace.__contextMenuClose" ID="Listspace.__contextMenuClose"></a>
272 <h4>Listspace.__contextMenuClose</h4>
273 <b>__contextMenuClose</b>(<i></i>)
274 <p>
275 Private method to close the selected editor.
276 </p><a NAME="Listspace.__contextMenuCloseAll" ID="Listspace.__contextMenuCloseAll"></a>
277 <h4>Listspace.__contextMenuCloseAll</h4>
278 <b>__contextMenuCloseAll</b>(<i></i>)
279 <p>
280 Private method to close all editors.
281 </p><a NAME="Listspace.__contextMenuCloseOthers" ID="Listspace.__contextMenuCloseOthers"></a>
282 <h4>Listspace.__contextMenuCloseOthers</h4>
283 <b>__contextMenuCloseOthers</b>(<i></i>)
284 <p>
285 Private method to close the other editors.
286 </p><a NAME="Listspace.__contextMenuCopyPathToClipboard" ID="Listspace.__contextMenuCopyPathToClipboard"></a>
287 <h4>Listspace.__contextMenuCopyPathToClipboard</h4>
288 <b>__contextMenuCopyPathToClipboard</b>(<i></i>)
289 <p>
290 Private method to copy the file name of the selected editor to the
291 clipboard.
292 </p><a NAME="Listspace.__contextMenuOpenRejections" ID="Listspace.__contextMenuOpenRejections"></a>
293 <h4>Listspace.__contextMenuOpenRejections</h4>
294 <b>__contextMenuOpenRejections</b>(<i></i>)
295 <p>
296 Private slot to open a rejections file associated with the selected
297 editor.
298 </p><a NAME="Listspace.__contextMenuPrintFile" ID="Listspace.__contextMenuPrintFile"></a>
299 <h4>Listspace.__contextMenuPrintFile</h4>
300 <b>__contextMenuPrintFile</b>(<i></i>)
301 <p>
302 Private method to print the selected editor.
303 </p><a NAME="Listspace.__contextMenuSave" ID="Listspace.__contextMenuSave"></a>
304 <h4>Listspace.__contextMenuSave</h4>
305 <b>__contextMenuSave</b>(<i></i>)
306 <p>
307 Private method to save the selected editor.
308 </p><a NAME="Listspace.__contextMenuSaveAll" ID="Listspace.__contextMenuSaveAll"></a>
309 <h4>Listspace.__contextMenuSaveAll</h4>
310 <b>__contextMenuSaveAll</b>(<i></i>)
311 <p>
312 Private method to save all editors.
313 </p><a NAME="Listspace.__contextMenuSaveAs" ID="Listspace.__contextMenuSaveAs"></a>
314 <h4>Listspace.__contextMenuSaveAs</h4>
315 <b>__contextMenuSaveAs</b>(<i></i>)
316 <p>
317 Private method to save the selected editor to a new file.
318 </p><a NAME="Listspace.__currentChanged" ID="Listspace.__currentChanged"></a>
319 <h4>Listspace.__currentChanged</h4>
320 <b>__currentChanged</b>(<i>index</i>)
321 <p>
322 Private slot to handle the currentChanged signal.
323 </p><dl>
324 <dt><i>index</i></dt>
325 <dd>
326 index of the current editor
327 </dd>
328 </dl><a NAME="Listspace.__cursorLineChanged" ID="Listspace.__cursorLineChanged"></a>
329 <h4>Listspace.__cursorLineChanged</h4>
330 <b>__cursorLineChanged</b>(<i>lineno</i>)
331 <p>
332 Private slot to handle a change of the current editor's cursor line.
333 </p><dl>
334 <dt><i>lineno</i></dt>
335 <dd>
336 line number of the current editor's cursor (zero based)
337 </dd>
338 </dl><a NAME="Listspace.__initMenu" ID="Listspace.__initMenu"></a>
339 <h4>Listspace.__initMenu</h4>
340 <b>__initMenu</b>(<i></i>)
341 <p>
342 Private method to initialize the viewlist context menu.
343 </p><a NAME="Listspace.__showMenu" ID="Listspace.__showMenu"></a>
344 <h4>Listspace.__showMenu</h4>
345 <b>__showMenu</b>(<i>point</i>)
346 <p>
347 Private slot to handle the customContextMenuRequested signal of
348 the viewlist.
349 </p><dl>
350 <dt><i>point</i></dt>
351 <dd>
352 position to open the menu at (QPoint)
353 </dd>
354 </dl><a NAME="Listspace.__showSelectedView" ID="Listspace.__showSelectedView"></a>
355 <h4>Listspace.__showSelectedView</h4>
356 <b>__showSelectedView</b>(<i>row</i>)
357 <p>
358 Private slot called to show a view selected in the list.
359 </p><dl>
360 <dt><i>row</i></dt>
361 <dd>
362 row number of the item clicked on (integer)
363 </dd>
364 </dl><a NAME="Listspace._addView" ID="Listspace._addView"></a>
365 <h4>Listspace._addView</h4>
366 <b>_addView</b>(<i>win, fn=None, noName=""</i>)
367 <p>
368 Protected method to add a view (i.e. window).
369 </p><dl>
370 <dt><i>win</i></dt>
371 <dd>
372 editor assembly to be added
373 </dd><dt><i>fn</i></dt>
374 <dd>
375 filename of this editor (string)
376 </dd><dt><i>noName</i></dt>
377 <dd>
378 name to be used for an unnamed editor (string)
379 </dd>
380 </dl><a NAME="Listspace._initWindowActions" ID="Listspace._initWindowActions"></a>
381 <h4>Listspace._initWindowActions</h4>
382 <b>_initWindowActions</b>(<i></i>)
383 <p>
384 Protected method to define the user interface actions for window
385 handling.
386 </p><a NAME="Listspace._modificationStatusChanged" ID="Listspace._modificationStatusChanged"></a>
387 <h4>Listspace._modificationStatusChanged</h4>
388 <b>_modificationStatusChanged</b>(<i>m, editor</i>)
389 <p>
390 Protected slot to handle the modificationStatusChanged signal.
391 </p><dl>
392 <dt><i>m</i></dt>
393 <dd>
394 flag indicating the modification status (boolean)
395 </dd><dt><i>editor</i></dt>
396 <dd>
397 editor window changed
398 </dd>
399 </dl><a NAME="Listspace._removeAllViews" ID="Listspace._removeAllViews"></a>
400 <h4>Listspace._removeAllViews</h4>
401 <b>_removeAllViews</b>(<i></i>)
402 <p>
403 Protected method to remove all views (i.e. windows).
404 </p><a NAME="Listspace._removeView" ID="Listspace._removeView"></a>
405 <h4>Listspace._removeView</h4>
406 <b>_removeView</b>(<i>win</i>)
407 <p>
408 Protected method to remove a view (i.e. window).
409 </p><dl>
410 <dt><i>win</i></dt>
411 <dd>
412 editor window to be removed
413 </dd>
414 </dl><a NAME="Listspace._showView" ID="Listspace._showView"></a>
415 <h4>Listspace._showView</h4>
416 <b>_showView</b>(<i>win, fn=None</i>)
417 <p>
418 Protected method to show a view (i.e. window).
419 </p><dl>
420 <dt><i>win</i></dt>
421 <dd>
422 editor assembly to be shown
423 </dd><dt><i>fn</i></dt>
424 <dd>
425 filename of this editor (string)
426 </dd>
427 </dl><a NAME="Listspace._syntaxErrorToggled" ID="Listspace._syntaxErrorToggled"></a>
428 <h4>Listspace._syntaxErrorToggled</h4>
429 <b>_syntaxErrorToggled</b>(<i>editor</i>)
430 <p>
431 Protected slot to handle the syntaxerrorToggled signal.
432 </p><dl>
433 <dt><i>editor</i></dt>
434 <dd>
435 editor that sent the signal
436 </dd>
437 </dl><a NAME="Listspace.activeWindow" ID="Listspace.activeWindow"></a>
438 <h4>Listspace.activeWindow</h4>
439 <b>activeWindow</b>(<i></i>)
440 <p>
441 Public method to return the active (i.e. current) window.
442 </p><dl>
443 <dt>Returns:</dt>
444 <dd>
445 reference to the active editor
446 </dd>
447 </dl><a NAME="Listspace.addSplit" ID="Listspace.addSplit"></a>
448 <h4>Listspace.addSplit</h4>
449 <b>addSplit</b>(<i></i>)
450 <p>
451 Public method used to split the current view.
452 </p><a NAME="Listspace.canCascade" ID="Listspace.canCascade"></a>
453 <h4>Listspace.canCascade</h4>
454 <b>canCascade</b>(<i></i>)
455 <p>
456 Public method to signal if cascading of managed windows is available.
457 </p><dl>
458 <dt>Returns:</dt>
459 <dd>
460 flag indicating cascading of windows is available
461 </dd>
462 </dl><a NAME="Listspace.canSplit" ID="Listspace.canSplit"></a>
463 <h4>Listspace.canSplit</h4>
464 <b>canSplit</b>(<i></i>)
465 <p>
466 public method to signal if splitting of the view is available.
467 </p><dl>
468 <dt>Returns:</dt>
469 <dd>
470 flag indicating splitting of the view is available.
471 </dd>
472 </dl><a NAME="Listspace.canTile" ID="Listspace.canTile"></a>
473 <h4>Listspace.canTile</h4>
474 <b>canTile</b>(<i></i>)
475 <p>
476 Public method to signal if tiling of managed windows is available.
477 </p><dl>
478 <dt>Returns:</dt>
479 <dd>
480 flag indicating tiling of windows is available
481 </dd>
482 </dl><a NAME="Listspace.cascade" ID="Listspace.cascade"></a>
483 <h4>Listspace.cascade</h4>
484 <b>cascade</b>(<i></i>)
485 <p>
486 Public method to cascade the managed windows.
487 </p><a NAME="Listspace.eventFilter" ID="Listspace.eventFilter"></a>
488 <h4>Listspace.eventFilter</h4>
489 <b>eventFilter</b>(<i>watched, event</i>)
490 <p>
491 Public method called to filter the event queue.
492 </p><dl>
493 <dt><i>watched</i></dt>
494 <dd>
495 the QObject being watched
496 </dd><dt><i>event</i></dt>
497 <dd>
498 the event that occurred
499 </dd>
500 </dl><dl>
501 <dt>Returns:</dt>
502 <dd>
503 flag indicating, if we handled the event
504 </dd>
505 </dl><a NAME="Listspace.getSplitOrientation" ID="Listspace.getSplitOrientation"></a>
506 <h4>Listspace.getSplitOrientation</h4>
507 <b>getSplitOrientation</b>(<i></i>)
508 <p>
509 Public method to get the orientation of the split view.
510 </p><dl>
511 <dt>Returns:</dt>
512 <dd>
513 orientation of the split (Qt.Horizontal or Qt.Vertical)
514 </dd>
515 </dl><a NAME="Listspace.nextSplit" ID="Listspace.nextSplit"></a>
516 <h4>Listspace.nextSplit</h4>
517 <b>nextSplit</b>(<i></i>)
518 <p>
519 Public slot used to move to the next split.
520 </p><a NAME="Listspace.prevSplit" ID="Listspace.prevSplit"></a>
521 <h4>Listspace.prevSplit</h4>
522 <b>prevSplit</b>(<i></i>)
523 <p>
524 Public slot used to move to the previous split.
525 </p><a NAME="Listspace.removeSplit" ID="Listspace.removeSplit"></a>
526 <h4>Listspace.removeSplit</h4>
527 <b>removeSplit</b>(<i></i>)
528 <p>
529 Public method used to remove the current split view.
530 </p><dl>
531 <dt>Returns:</dt>
532 <dd>
533 flag indicating successfull removal
534 </dd>
535 </dl><a NAME="Listspace.setEditorName" ID="Listspace.setEditorName"></a>
536 <h4>Listspace.setEditorName</h4>
537 <b>setEditorName</b>(<i>editor, newName</i>)
538 <p>
539 Public method to change the displayed name of the editor.
540 </p><dl>
541 <dt><i>editor</i></dt>
542 <dd>
543 editor window to be changed
544 </dd><dt><i>newName</i></dt>
545 <dd>
546 new name to be shown (string)
547 </dd>
548 </dl><a NAME="Listspace.setSplitOrientation" ID="Listspace.setSplitOrientation"></a>
549 <h4>Listspace.setSplitOrientation</h4>
550 <b>setSplitOrientation</b>(<i>orientation</i>)
551 <p>
552 Public method used to set the orientation of the split view.
553 </p><dl>
554 <dt><i>orientation</i></dt>
555 <dd>
556 orientation of the split
557 (Qt.Horizontal or Qt.Vertical)
558 </dd>
559 </dl><a NAME="Listspace.showWindowMenu" ID="Listspace.showWindowMenu"></a>
560 <h4>Listspace.showWindowMenu</h4>
561 <b>showWindowMenu</b>(<i>windowMenu</i>)
562 <p>
563 Public method to set up the viewmanager part of the Window menu.
564 </p><dl>
565 <dt><i>windowMenu</i></dt>
566 <dd>
567 reference to the window menu
568 </dd>
569 </dl><a NAME="Listspace.tile" ID="Listspace.tile"></a>
570 <h4>Listspace.tile</h4>
571 <b>tile</b>(<i></i>)
572 <p>
573 Public method to tile the managed windows.
574 </p>
575 <div align="right"><a href="#top">Up</a></div>
576 <hr /><hr />
577 <a NAME="StackedWidget" ID="StackedWidget"></a>
578 <h2>StackedWidget</h2>
579 <p>
580 Class implementing a custimized StackedWidget.
581 </p>
582 <h3>Derived from</h3>
583 QStackedWidget
584 <h3>Class Attributes</h3>
585 <table>
586 <tr><td>None</td></tr>
587 </table>
588 <h3>Class Methods</h3>
589 <table>
590 <tr><td>None</td></tr>
591 </table>
592 <h3>Methods</h3>
593 <table>
594 <tr>
595 <td><a href="#StackedWidget.__init__">StackedWidget</a></td>
596 <td>Constructor</td>
597 </tr><tr>
598 <td><a href="#StackedWidget.addWidget">addWidget</a></td>
599 <td>Public method to add a new widget.</td>
600 </tr><tr>
601 <td><a href="#StackedWidget.currentWidget">currentWidget</a></td>
602 <td>Public method to get a reference to the current editor.</td>
603 </tr><tr>
604 <td><a href="#StackedWidget.firstEditor">firstEditor</a></td>
605 <td>Public method to retrieve the first editor in the list of managed editors.</td>
606 </tr><tr>
607 <td><a href="#StackedWidget.hasEditor">hasEditor</a></td>
608 <td>Public method to check for an editor.</td>
609 </tr><tr>
610 <td><a href="#StackedWidget.nextTab">nextTab</a></td>
611 <td>Public slot used to show the next tab.</td>
612 </tr><tr>
613 <td><a href="#StackedWidget.prevTab">prevTab</a></td>
614 <td>Public slot used to show the previous tab.</td>
615 </tr><tr>
616 <td><a href="#StackedWidget.removeWidget">removeWidget</a></td>
617 <td>Public method to remove a widget.</td>
618 </tr><tr>
619 <td><a href="#StackedWidget.setCurrentIndex">setCurrentIndex</a></td>
620 <td>Public method to set the current widget by its index.</td>
621 </tr><tr>
622 <td><a href="#StackedWidget.setCurrentWidget">setCurrentWidget</a></td>
623 <td>Public method to set the current widget.</td>
624 </tr>
625 </table>
626 <h3>Static Methods</h3>
627 <table>
628 <tr><td>None</td></tr>
629 </table>
630 <a NAME="StackedWidget.__init__" ID="StackedWidget.__init__"></a>
631 <h4>StackedWidget (Constructor)</h4>
632 <b>StackedWidget</b>(<i>parent</i>)
633 <p>
634 Constructor
635 </p><dl>
636 <dt><i>parent</i></dt>
637 <dd>
638 parent widget (QWidget)
639 </dd>
640 </dl><a NAME="StackedWidget.addWidget" ID="StackedWidget.addWidget"></a>
641 <h4>StackedWidget.addWidget</h4>
642 <b>addWidget</b>(<i>assembly</i>)
643 <p>
644 Public method to add a new widget.
645 </p><dl>
646 <dt><i>assembly</i></dt>
647 <dd>
648 editor assembly object to be added
649 (QScintilla.EditorAssembly.EditorAssembly)
650 </dd>
651 </dl><a NAME="StackedWidget.currentWidget" ID="StackedWidget.currentWidget"></a>
652 <h4>StackedWidget.currentWidget</h4>
653 <b>currentWidget</b>(<i></i>)
654 <p>
655 Public method to get a reference to the current editor.
656 </p><dl>
657 <dt>Returns:</dt>
658 <dd>
659 reference to the current editor (Editor)
660 </dd>
661 </dl><a NAME="StackedWidget.firstEditor" ID="StackedWidget.firstEditor"></a>
662 <h4>StackedWidget.firstEditor</h4>
663 <b>firstEditor</b>(<i></i>)
664 <p>
665 Public method to retrieve the first editor in the list of managed
666 editors.
667 </p><dl>
668 <dt>Returns:</dt>
669 <dd>
670 first editor in list (QScintilla.Editor.Editor)
671 </dd>
672 </dl><a NAME="StackedWidget.hasEditor" ID="StackedWidget.hasEditor"></a>
673 <h4>StackedWidget.hasEditor</h4>
674 <b>hasEditor</b>(<i>editor</i>)
675 <p>
676 Public method to check for an editor.
677 </p><dl>
678 <dt><i>editor</i></dt>
679 <dd>
680 editor object to check for
681 </dd>
682 </dl><dl>
683 <dt>Returns:</dt>
684 <dd>
685 flag indicating, whether the editor to be checked belongs
686 to the list of editors managed by this stacked widget.
687 </dd>
688 </dl><a NAME="StackedWidget.nextTab" ID="StackedWidget.nextTab"></a>
689 <h4>StackedWidget.nextTab</h4>
690 <b>nextTab</b>(<i></i>)
691 <p>
692 Public slot used to show the next tab.
693 </p><a NAME="StackedWidget.prevTab" ID="StackedWidget.prevTab"></a>
694 <h4>StackedWidget.prevTab</h4>
695 <b>prevTab</b>(<i></i>)
696 <p>
697 Public slot used to show the previous tab.
698 </p><a NAME="StackedWidget.removeWidget" ID="StackedWidget.removeWidget"></a>
699 <h4>StackedWidget.removeWidget</h4>
700 <b>removeWidget</b>(<i>widget</i>)
701 <p>
702 Public method to remove a widget.
703 </p><dl>
704 <dt><i>widget</i></dt>
705 <dd>
706 widget to be removed (QWidget)
707 </dd>
708 </dl><a NAME="StackedWidget.setCurrentIndex" ID="StackedWidget.setCurrentIndex"></a>
709 <h4>StackedWidget.setCurrentIndex</h4>
710 <b>setCurrentIndex</b>(<i>index</i>)
711 <p>
712 Public method to set the current widget by its index.
713 </p><dl>
714 <dt><i>index</i></dt>
715 <dd>
716 index of widget to be made current (integer)
717 </dd>
718 </dl><a NAME="StackedWidget.setCurrentWidget" ID="StackedWidget.setCurrentWidget"></a>
719 <h4>StackedWidget.setCurrentWidget</h4>
720 <b>setCurrentWidget</b>(<i>widget</i>)
721 <p>
722 Public method to set the current widget.
723 </p><dl>
724 <dt><i>widget</i></dt>
725 <dd>
726 widget to be made current (QWidget)
727 </dd>
728 </dl>
729 <div align="right"><a href="#top">Up</a></div>
730 <hr />
731 </body></html>

Mercurial Repository: eric

eric ide

mercurial