src/eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Listspace.Listspace.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10070
9f5758c0fec1
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.ViewManagerPlugins.Listspace.Listspace</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.ViewManagerPlugins.Listspace.Listspace</h1>
10
11 <p>
12 Module implementing the listspace viewmanager class.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#Listspace">Listspace</a></td>
25 <td>Class implementing the listspace viewmanager class.</td>
26 </tr>
27 <tr>
28 <td><a href="#StackedWidget">StackedWidget</a></td>
29 <td>Class implementing a custimized StackedWidget.</td>
30 </tr>
31 </table>
32 <h3>Functions</h3>
33
34 <table>
35 <tr><td>None</td></tr>
36 </table>
37 <hr />
38 <hr />
39 <a NAME="Listspace" ID="Listspace"></a>
40 <h2>Listspace</h2>
41
42 <p>
43 Class implementing the listspace viewmanager class.
44 </p>
45 <h3>Signals</h3>
46 <dl>
47
48 <dt>astViewerStateChanged(bool)</dt>
49 <dd>
50 emitted to signal a change in the
51 AST viewer state
52 </dd>
53 <dt>bookmarkToggled(Editor)</dt>
54 <dd>
55 emitted when a bookmark is toggled.
56 </dd>
57 <dt>breakpointToggled(Editor)</dt>
58 <dd>
59 emitted when a breakpoint is toggled.
60 </dd>
61 <dt>changeCaption(str)</dt>
62 <dd>
63 emitted if a change of the caption is necessary
64 </dd>
65 <dt>checkActions(Editor)</dt>
66 <dd>
67 emitted when some actions should be checked
68 for their status
69 </dd>
70 <dt>cursorChanged(Editor)</dt>
71 <dd>
72 emitted after the cursor position of the
73 active window has changed
74 </dd>
75 <dt>editorChanged(str)</dt>
76 <dd>
77 emitted when the current editor has changed
78 </dd>
79 <dt>editorChangedEd(Editor)</dt>
80 <dd>
81 emitted when the current editor has changed
82 </dd>
83 <dt>editorClosed(str)</dt>
84 <dd>
85 emitted just before an editor window gets closed
86 </dd>
87 <dt>editorClosedEd(Editor)</dt>
88 <dd>
89 emitted just before an editor window gets
90 closed
91 </dd>
92 <dt>editorLanguageChanged(Editor)</dt>
93 <dd>
94 emitted to signal a change of an
95 editors language
96 </dd>
97 <dt>editorLineChanged(str,int)</dt>
98 <dd>
99 emitted to signal a change of an
100 editor's current line (line is given one based)
101 </dd>
102 <dt>editorLineChangedEd(Editor,int)</dt>
103 <dd>
104 emitted to signal a change of an
105 editor's current line (line is given one based)
106 </dd>
107 <dt>editorOpened(str)</dt>
108 <dd>
109 emitted after an editor window was opened
110 </dd>
111 <dt>editorOpenedEd(Editor)</dt>
112 <dd>
113 emitted after an editor window was opened
114 </dd>
115 <dt>editorRenamed(str)</dt>
116 <dd>
117 emitted after an editor was renamed
118 </dd>
119 <dt>editorRenamedEd(Editor)</dt>
120 <dd>
121 emitted after an editor was renamed
122 </dd>
123 <dt>editorSaved(str)</dt>
124 <dd>
125 emitted after an editor window was saved
126 </dd>
127 <dt>editorSavedEd(Editor)</dt>
128 <dd>
129 emitted after an editor window was saved
130 </dd>
131 <dt>editorTextChanged(Editor)</dt>
132 <dd>
133 emitted to signal a change of an
134 editor's text
135 </dd>
136 <dt>lastEditorClosed()</dt>
137 <dd>
138 emitted after the last editor window was closed
139 </dd>
140 <dt>previewStateChanged(bool)</dt>
141 <dd>
142 emitted to signal a change in the
143 preview state
144 </dd>
145 <dt>syntaxerrorToggled(Editor)</dt>
146 <dd>
147 emitted when a syntax error is toggled.
148 </dd>
149 </dl>
150 <h3>Derived from</h3>
151 ViewManager
152 <h3>Class Attributes</h3>
153
154 <table>
155 <tr><td>None</td></tr>
156 </table>
157 <h3>Class Methods</h3>
158
159 <table>
160 <tr><td>None</td></tr>
161 </table>
162 <h3>Methods</h3>
163
164 <table>
165
166 <tr>
167 <td><a href="#Listspace.__init__">Listspace</a></td>
168 <td>Constructor</td>
169 </tr>
170 <tr>
171 <td><a href="#Listspace.__captionChange">__captionChange</a></td>
172 <td>Private method to handle caption change signals from the editor.</td>
173 </tr>
174 <tr>
175 <td><a href="#Listspace.__contextMenuClose">__contextMenuClose</a></td>
176 <td>Private method to close the selected editor.</td>
177 </tr>
178 <tr>
179 <td><a href="#Listspace.__contextMenuCloseAll">__contextMenuCloseAll</a></td>
180 <td>Private method to close all editors.</td>
181 </tr>
182 <tr>
183 <td><a href="#Listspace.__contextMenuCloseOthers">__contextMenuCloseOthers</a></td>
184 <td>Private method to close the other editors.</td>
185 </tr>
186 <tr>
187 <td><a href="#Listspace.__contextMenuCopyPathToClipboard">__contextMenuCopyPathToClipboard</a></td>
188 <td>Private method to copy the file name of the selected editor to the clipboard.</td>
189 </tr>
190 <tr>
191 <td><a href="#Listspace.__contextMenuCoverageScript">__contextMenuCoverageScript</a></td>
192 <td>Private method to run a coverage test of the editor script.</td>
193 </tr>
194 <tr>
195 <td><a href="#Listspace.__contextMenuDebugScript">__contextMenuDebugScript</a></td>
196 <td>Private method to debug the editor script.</td>
197 </tr>
198 <tr>
199 <td><a href="#Listspace.__contextMenuOpenRejections">__contextMenuOpenRejections</a></td>
200 <td>Private slot to open a rejections file associated with the selected editor.</td>
201 </tr>
202 <tr>
203 <td><a href="#Listspace.__contextMenuPrintFile">__contextMenuPrintFile</a></td>
204 <td>Private method to print the selected editor.</td>
205 </tr>
206 <tr>
207 <td><a href="#Listspace.__contextMenuPrintPreviewFile">__contextMenuPrintPreviewFile</a></td>
208 <td>Private method to show a print preview of the selected editor.</td>
209 </tr>
210 <tr>
211 <td><a href="#Listspace.__contextMenuProfileScript">__contextMenuProfileScript</a></td>
212 <td>Private method to profile the editor script.</td>
213 </tr>
214 <tr>
215 <td><a href="#Listspace.__contextMenuRunScript">__contextMenuRunScript</a></td>
216 <td>Private method to run the editor script.</td>
217 </tr>
218 <tr>
219 <td><a href="#Listspace.__contextMenuSave">__contextMenuSave</a></td>
220 <td>Private method to save the selected editor.</td>
221 </tr>
222 <tr>
223 <td><a href="#Listspace.__contextMenuSaveAll">__contextMenuSaveAll</a></td>
224 <td>Private method to save all editors.</td>
225 </tr>
226 <tr>
227 <td><a href="#Listspace.__contextMenuSaveAs">__contextMenuSaveAs</a></td>
228 <td>Private method to save the selected editor to a new file.</td>
229 </tr>
230 <tr>
231 <td><a href="#Listspace.__currentChanged">__currentChanged</a></td>
232 <td>Private slot to handle the currentChanged signal.</td>
233 </tr>
234 <tr>
235 <td><a href="#Listspace.__cursorLineChanged">__cursorLineChanged</a></td>
236 <td>Private slot to handle a change of the current editor's cursor line.</td>
237 </tr>
238 <tr>
239 <td><a href="#Listspace.__initMenu">__initMenu</a></td>
240 <td>Private method to initialize the viewlist context menu.</td>
241 </tr>
242 <tr>
243 <td><a href="#Listspace.__showMenu">__showMenu</a></td>
244 <td>Private slot to handle the customContextMenuRequested signal of the viewlist.</td>
245 </tr>
246 <tr>
247 <td><a href="#Listspace.__showSelectedView">__showSelectedView</a></td>
248 <td>Private slot called to show a view selected in the list.</td>
249 </tr>
250 <tr>
251 <td><a href="#Listspace._addView">_addView</a></td>
252 <td>Protected method to add a view (i.e.</td>
253 </tr>
254 <tr>
255 <td><a href="#Listspace._initWindowActions">_initWindowActions</a></td>
256 <td>Protected method to define the user interface actions for window handling.</td>
257 </tr>
258 <tr>
259 <td><a href="#Listspace._modificationStatusChanged">_modificationStatusChanged</a></td>
260 <td>Protected slot to handle the modificationStatusChanged signal.</td>
261 </tr>
262 <tr>
263 <td><a href="#Listspace._removeAllViews">_removeAllViews</a></td>
264 <td>Protected method to remove all views (i.e.</td>
265 </tr>
266 <tr>
267 <td><a href="#Listspace._removeView">_removeView</a></td>
268 <td>Protected method to remove a view (i.e.</td>
269 </tr>
270 <tr>
271 <td><a href="#Listspace._showView">_showView</a></td>
272 <td>Protected method to show a view (i.e.</td>
273 </tr>
274 <tr>
275 <td><a href="#Listspace._syntaxErrorToggled">_syntaxErrorToggled</a></td>
276 <td>Protected slot to handle the syntaxerrorToggled signal.</td>
277 </tr>
278 <tr>
279 <td><a href="#Listspace.activeWindow">activeWindow</a></td>
280 <td>Public method to return the active (i.e.</td>
281 </tr>
282 <tr>
283 <td><a href="#Listspace.addSplit">addSplit</a></td>
284 <td>Public method used to split the current view.</td>
285 </tr>
286 <tr>
287 <td><a href="#Listspace.canCascade">canCascade</a></td>
288 <td>Public method to signal if cascading of managed windows is available.</td>
289 </tr>
290 <tr>
291 <td><a href="#Listspace.canSplit">canSplit</a></td>
292 <td>public method to signal if splitting of the view is available.</td>
293 </tr>
294 <tr>
295 <td><a href="#Listspace.canTile">canTile</a></td>
296 <td>Public method to signal if tiling of managed windows is available.</td>
297 </tr>
298 <tr>
299 <td><a href="#Listspace.cascade">cascade</a></td>
300 <td>Public method to cascade the managed windows.</td>
301 </tr>
302 <tr>
303 <td><a href="#Listspace.eventFilter">eventFilter</a></td>
304 <td>Public method called to filter the event queue.</td>
305 </tr>
306 <tr>
307 <td><a href="#Listspace.getOpenEditorsForSession">getOpenEditorsForSession</a></td>
308 <td>Public method to get a lists of all open editors.</td>
309 </tr>
310 <tr>
311 <td><a href="#Listspace.getSplitOrientation">getSplitOrientation</a></td>
312 <td>Public method to get the orientation of the split view.</td>
313 </tr>
314 <tr>
315 <td><a href="#Listspace.mainWidget">mainWidget</a></td>
316 <td>Public method to return a reference to the main Widget of a specific view manager subclass.</td>
317 </tr>
318 <tr>
319 <td><a href="#Listspace.nextSplit">nextSplit</a></td>
320 <td>Public slot used to move to the next split.</td>
321 </tr>
322 <tr>
323 <td><a href="#Listspace.prevSplit">prevSplit</a></td>
324 <td>Public slot used to move to the previous split.</td>
325 </tr>
326 <tr>
327 <td><a href="#Listspace.removeSplit">removeSplit</a></td>
328 <td>Public method used to remove the current split view or a split view by index.</td>
329 </tr>
330 <tr>
331 <td><a href="#Listspace.setEditorName">setEditorName</a></td>
332 <td>Public method to change the displayed name of the editor.</td>
333 </tr>
334 <tr>
335 <td><a href="#Listspace.setSplitCount">setSplitCount</a></td>
336 <td>Public method to set the number of split views.</td>
337 </tr>
338 <tr>
339 <td><a href="#Listspace.setSplitOrientation">setSplitOrientation</a></td>
340 <td>Public method used to set the orientation of the split view.</td>
341 </tr>
342 <tr>
343 <td><a href="#Listspace.showWindowMenu">showWindowMenu</a></td>
344 <td>Public method to set up the viewmanager part of the Window menu.</td>
345 </tr>
346 <tr>
347 <td><a href="#Listspace.splitCount">splitCount</a></td>
348 <td>Public method to get the number of splitted views.</td>
349 </tr>
350 <tr>
351 <td><a href="#Listspace.tile">tile</a></td>
352 <td>Public method to tile the managed windows.</td>
353 </tr>
354 </table>
355 <h3>Static Methods</h3>
356
357 <table>
358 <tr><td>None</td></tr>
359 </table>
360
361 <a NAME="Listspace.__init__" ID="Listspace.__init__"></a>
362 <h4>Listspace (Constructor)</h4>
363 <b>Listspace</b>(<i>parent</i>)
364
365 <p>
366 Constructor
367 </p>
368 <dl>
369
370 <dt><i>parent</i> (QWidget)</dt>
371 <dd>
372 parent widget
373 </dd>
374 </dl>
375 <a NAME="Listspace.__captionChange" ID="Listspace.__captionChange"></a>
376 <h4>Listspace.__captionChange</h4>
377 <b>__captionChange</b>(<i>cap, editor</i>)
378
379 <p>
380 Private method to handle caption change signals from the editor.
381 </p>
382 <p>
383 Updates the listwidget text to reflect the new caption information.
384 </p>
385 <dl>
386
387 <dt><i>cap</i> (str)</dt>
388 <dd>
389 Caption for the editor
390 </dd>
391 <dt><i>editor</i> (Editor)</dt>
392 <dd>
393 Editor to update the caption for
394 </dd>
395 </dl>
396 <a NAME="Listspace.__contextMenuClose" ID="Listspace.__contextMenuClose"></a>
397 <h4>Listspace.__contextMenuClose</h4>
398 <b>__contextMenuClose</b>(<i></i>)
399
400 <p>
401 Private method to close the selected editor.
402 </p>
403 <a NAME="Listspace.__contextMenuCloseAll" ID="Listspace.__contextMenuCloseAll"></a>
404 <h4>Listspace.__contextMenuCloseAll</h4>
405 <b>__contextMenuCloseAll</b>(<i></i>)
406
407 <p>
408 Private method to close all editors.
409 </p>
410 <a NAME="Listspace.__contextMenuCloseOthers" ID="Listspace.__contextMenuCloseOthers"></a>
411 <h4>Listspace.__contextMenuCloseOthers</h4>
412 <b>__contextMenuCloseOthers</b>(<i></i>)
413
414 <p>
415 Private method to close the other editors.
416 </p>
417 <a NAME="Listspace.__contextMenuCopyPathToClipboard" ID="Listspace.__contextMenuCopyPathToClipboard"></a>
418 <h4>Listspace.__contextMenuCopyPathToClipboard</h4>
419 <b>__contextMenuCopyPathToClipboard</b>(<i></i>)
420
421 <p>
422 Private method to copy the file name of the selected editor to the
423 clipboard.
424 </p>
425 <a NAME="Listspace.__contextMenuCoverageScript" ID="Listspace.__contextMenuCoverageScript"></a>
426 <h4>Listspace.__contextMenuCoverageScript</h4>
427 <b>__contextMenuCoverageScript</b>(<i></i>)
428
429 <p>
430 Private method to run a coverage test of the editor script.
431 </p>
432 <a NAME="Listspace.__contextMenuDebugScript" ID="Listspace.__contextMenuDebugScript"></a>
433 <h4>Listspace.__contextMenuDebugScript</h4>
434 <b>__contextMenuDebugScript</b>(<i></i>)
435
436 <p>
437 Private method to debug the editor script.
438 </p>
439 <a NAME="Listspace.__contextMenuOpenRejections" ID="Listspace.__contextMenuOpenRejections"></a>
440 <h4>Listspace.__contextMenuOpenRejections</h4>
441 <b>__contextMenuOpenRejections</b>(<i></i>)
442
443 <p>
444 Private slot to open a rejections file associated with the selected
445 editor.
446 </p>
447 <a NAME="Listspace.__contextMenuPrintFile" ID="Listspace.__contextMenuPrintFile"></a>
448 <h4>Listspace.__contextMenuPrintFile</h4>
449 <b>__contextMenuPrintFile</b>(<i></i>)
450
451 <p>
452 Private method to print the selected editor.
453 </p>
454 <a NAME="Listspace.__contextMenuPrintPreviewFile" ID="Listspace.__contextMenuPrintPreviewFile"></a>
455 <h4>Listspace.__contextMenuPrintPreviewFile</h4>
456 <b>__contextMenuPrintPreviewFile</b>(<i></i>)
457
458 <p>
459 Private method to show a print preview of the selected editor.
460 </p>
461 <a NAME="Listspace.__contextMenuProfileScript" ID="Listspace.__contextMenuProfileScript"></a>
462 <h4>Listspace.__contextMenuProfileScript</h4>
463 <b>__contextMenuProfileScript</b>(<i></i>)
464
465 <p>
466 Private method to profile the editor script.
467 </p>
468 <a NAME="Listspace.__contextMenuRunScript" ID="Listspace.__contextMenuRunScript"></a>
469 <h4>Listspace.__contextMenuRunScript</h4>
470 <b>__contextMenuRunScript</b>(<i></i>)
471
472 <p>
473 Private method to run the editor script.
474 </p>
475 <a NAME="Listspace.__contextMenuSave" ID="Listspace.__contextMenuSave"></a>
476 <h4>Listspace.__contextMenuSave</h4>
477 <b>__contextMenuSave</b>(<i></i>)
478
479 <p>
480 Private method to save the selected editor.
481 </p>
482 <a NAME="Listspace.__contextMenuSaveAll" ID="Listspace.__contextMenuSaveAll"></a>
483 <h4>Listspace.__contextMenuSaveAll</h4>
484 <b>__contextMenuSaveAll</b>(<i></i>)
485
486 <p>
487 Private method to save all editors.
488 </p>
489 <a NAME="Listspace.__contextMenuSaveAs" ID="Listspace.__contextMenuSaveAs"></a>
490 <h4>Listspace.__contextMenuSaveAs</h4>
491 <b>__contextMenuSaveAs</b>(<i></i>)
492
493 <p>
494 Private method to save the selected editor to a new file.
495 </p>
496 <a NAME="Listspace.__currentChanged" ID="Listspace.__currentChanged"></a>
497 <h4>Listspace.__currentChanged</h4>
498 <b>__currentChanged</b>(<i>index</i>)
499
500 <p>
501 Private slot to handle the currentChanged signal.
502 </p>
503 <dl>
504
505 <dt><i>index</i> (int)</dt>
506 <dd>
507 index of the current editor
508 </dd>
509 </dl>
510 <a NAME="Listspace.__cursorLineChanged" ID="Listspace.__cursorLineChanged"></a>
511 <h4>Listspace.__cursorLineChanged</h4>
512 <b>__cursorLineChanged</b>(<i>lineno, editor</i>)
513
514 <p>
515 Private slot to handle a change of the current editor's cursor line.
516 </p>
517 <dl>
518
519 <dt><i>lineno</i> (int)</dt>
520 <dd>
521 line number of the editor's cursor (zero based)
522 </dd>
523 <dt><i>editor</i> (Editor)</dt>
524 <dd>
525 reference to the editor
526 </dd>
527 </dl>
528 <a NAME="Listspace.__initMenu" ID="Listspace.__initMenu"></a>
529 <h4>Listspace.__initMenu</h4>
530 <b>__initMenu</b>(<i></i>)
531
532 <p>
533 Private method to initialize the viewlist context menu.
534 </p>
535 <a NAME="Listspace.__showMenu" ID="Listspace.__showMenu"></a>
536 <h4>Listspace.__showMenu</h4>
537 <b>__showMenu</b>(<i>point</i>)
538
539 <p>
540 Private slot to handle the customContextMenuRequested signal of
541 the viewlist.
542 </p>
543 <dl>
544
545 <dt><i>point</i> (QPoint)</dt>
546 <dd>
547 position to open the menu at
548 </dd>
549 </dl>
550 <a NAME="Listspace.__showSelectedView" ID="Listspace.__showSelectedView"></a>
551 <h4>Listspace.__showSelectedView</h4>
552 <b>__showSelectedView</b>(<i>row</i>)
553
554 <p>
555 Private slot called to show a view selected in the list.
556 </p>
557 <dl>
558
559 <dt><i>row</i> (int)</dt>
560 <dd>
561 row number of the item clicked on
562 </dd>
563 </dl>
564 <a NAME="Listspace._addView" ID="Listspace._addView"></a>
565 <h4>Listspace._addView</h4>
566 <b>_addView</b>(<i>win, fn=None, noName="", addNext=False, indexes=None</i>)
567
568 <p>
569 Protected method to add a view (i.e. window).
570 </p>
571 <dl>
572
573 <dt><i>win</i> (EditorAssembly)</dt>
574 <dd>
575 editor assembly to be added
576 </dd>
577 <dt><i>fn</i> (str)</dt>
578 <dd>
579 filename of this editor
580 </dd>
581 <dt><i>noName</i> (str)</dt>
582 <dd>
583 name to be used for an unnamed editor
584 </dd>
585 <dt><i>addNext</i> (bool)</dt>
586 <dd>
587 flag indicating to add the view next to the current
588 view
589 </dd>
590 <dt><i>indexes</i> (tuple of two int)</dt>
591 <dd>
592 of the editor, first the split view index, second the
593 index within the view
594 </dd>
595 </dl>
596 <a NAME="Listspace._initWindowActions" ID="Listspace._initWindowActions"></a>
597 <h4>Listspace._initWindowActions</h4>
598 <b>_initWindowActions</b>(<i></i>)
599
600 <p>
601 Protected method to define the user interface actions for window
602 handling.
603 </p>
604 <a NAME="Listspace._modificationStatusChanged" ID="Listspace._modificationStatusChanged"></a>
605 <h4>Listspace._modificationStatusChanged</h4>
606 <b>_modificationStatusChanged</b>(<i>m, editor</i>)
607
608 <p>
609 Protected slot to handle the modificationStatusChanged signal.
610 </p>
611 <dl>
612
613 <dt><i>m</i> (bool)</dt>
614 <dd>
615 flag indicating the modification status
616 </dd>
617 <dt><i>editor</i> (Editor)</dt>
618 <dd>
619 editor window changed
620 </dd>
621 </dl>
622 <a NAME="Listspace._removeAllViews" ID="Listspace._removeAllViews"></a>
623 <h4>Listspace._removeAllViews</h4>
624 <b>_removeAllViews</b>(<i></i>)
625
626 <p>
627 Protected method to remove all views (i.e. windows).
628 </p>
629 <a NAME="Listspace._removeView" ID="Listspace._removeView"></a>
630 <h4>Listspace._removeView</h4>
631 <b>_removeView</b>(<i>win</i>)
632
633 <p>
634 Protected method to remove a view (i.e. window).
635 </p>
636 <dl>
637
638 <dt><i>win</i> (Editor)</dt>
639 <dd>
640 editor window to be removed
641 </dd>
642 </dl>
643 <a NAME="Listspace._showView" ID="Listspace._showView"></a>
644 <h4>Listspace._showView</h4>
645 <b>_showView</b>(<i>win, fn=None</i>)
646
647 <p>
648 Protected method to show a view (i.e. window).
649 </p>
650 <dl>
651
652 <dt><i>win</i> (EditorAssembly)</dt>
653 <dd>
654 editor assembly to be shown
655 </dd>
656 <dt><i>fn</i> (string)</dt>
657 <dd>
658 filename of this editor
659 </dd>
660 </dl>
661 <a NAME="Listspace._syntaxErrorToggled" ID="Listspace._syntaxErrorToggled"></a>
662 <h4>Listspace._syntaxErrorToggled</h4>
663 <b>_syntaxErrorToggled</b>(<i>editor</i>)
664
665 <p>
666 Protected slot to handle the syntaxerrorToggled signal.
667 </p>
668 <dl>
669
670 <dt><i>editor</i> (Editor)</dt>
671 <dd>
672 editor that sent the signal
673 </dd>
674 </dl>
675 <a NAME="Listspace.activeWindow" ID="Listspace.activeWindow"></a>
676 <h4>Listspace.activeWindow</h4>
677 <b>activeWindow</b>(<i></i>)
678
679 <p>
680 Public method to return the active (i.e. current) window.
681 </p>
682 <dl>
683 <dt>Return:</dt>
684 <dd>
685 reference to the active editor
686 </dd>
687 </dl>
688 <dl>
689 <dt>Return Type:</dt>
690 <dd>
691 EditorAssembly
692 </dd>
693 </dl>
694 <a NAME="Listspace.addSplit" ID="Listspace.addSplit"></a>
695 <h4>Listspace.addSplit</h4>
696 <b>addSplit</b>(<i></i>)
697
698 <p>
699 Public method used to split the current view.
700 </p>
701 <a NAME="Listspace.canCascade" ID="Listspace.canCascade"></a>
702 <h4>Listspace.canCascade</h4>
703 <b>canCascade</b>(<i></i>)
704
705 <p>
706 Public method to signal if cascading of managed windows is available.
707 </p>
708 <dl>
709 <dt>Return:</dt>
710 <dd>
711 flag indicating cascading of windows is available
712 </dd>
713 </dl>
714 <dl>
715 <dt>Return Type:</dt>
716 <dd>
717 bool
718 </dd>
719 </dl>
720 <a NAME="Listspace.canSplit" ID="Listspace.canSplit"></a>
721 <h4>Listspace.canSplit</h4>
722 <b>canSplit</b>(<i></i>)
723
724 <p>
725 public method to signal if splitting of the view is available.
726 </p>
727 <dl>
728 <dt>Return:</dt>
729 <dd>
730 flag indicating splitting of the view is available
731 </dd>
732 </dl>
733 <dl>
734 <dt>Return Type:</dt>
735 <dd>
736 bool
737 </dd>
738 </dl>
739 <a NAME="Listspace.canTile" ID="Listspace.canTile"></a>
740 <h4>Listspace.canTile</h4>
741 <b>canTile</b>(<i></i>)
742
743 <p>
744 Public method to signal if tiling of managed windows is available.
745 </p>
746 <dl>
747 <dt>Return:</dt>
748 <dd>
749 flag indicating tiling of windows is available
750 </dd>
751 </dl>
752 <dl>
753 <dt>Return Type:</dt>
754 <dd>
755 bool
756 </dd>
757 </dl>
758 <a NAME="Listspace.cascade" ID="Listspace.cascade"></a>
759 <h4>Listspace.cascade</h4>
760 <b>cascade</b>(<i></i>)
761
762 <p>
763 Public method to cascade the managed windows.
764 </p>
765 <a NAME="Listspace.eventFilter" ID="Listspace.eventFilter"></a>
766 <h4>Listspace.eventFilter</h4>
767 <b>eventFilter</b>(<i>watched, event</i>)
768
769 <p>
770 Public method called to filter the event queue.
771 </p>
772 <dl>
773
774 <dt><i>watched</i> (QObject)</dt>
775 <dd>
776 the QObject being watched
777 </dd>
778 <dt><i>event</i> (QEvent)</dt>
779 <dd>
780 the event that occurred
781 </dd>
782 </dl>
783 <dl>
784 <dt>Return:</dt>
785 <dd>
786 flag indicating, if we handled the event
787 </dd>
788 </dl>
789 <dl>
790 <dt>Return Type:</dt>
791 <dd>
792 bool
793 </dd>
794 </dl>
795 <a NAME="Listspace.getOpenEditorsForSession" ID="Listspace.getOpenEditorsForSession"></a>
796 <h4>Listspace.getOpenEditorsForSession</h4>
797 <b>getOpenEditorsForSession</b>(<i></i>)
798
799 <p>
800 Public method to get a lists of all open editors.
801 </p>
802 <p>
803 The returned list contains one list per split view. If the view manager
804 cannot split the view, only one list of editors is returned.
805 </p>
806 <dl>
807 <dt>Return:</dt>
808 <dd>
809 list of list of editor references
810 </dd>
811 </dl>
812 <dl>
813 <dt>Return Type:</dt>
814 <dd>
815 list of list of Editor
816 </dd>
817 </dl>
818 <a NAME="Listspace.getSplitOrientation" ID="Listspace.getSplitOrientation"></a>
819 <h4>Listspace.getSplitOrientation</h4>
820 <b>getSplitOrientation</b>(<i></i>)
821
822 <p>
823 Public method to get the orientation of the split view.
824 </p>
825 <dl>
826 <dt>Return:</dt>
827 <dd>
828 orientation of the split
829 </dd>
830 </dl>
831 <dl>
832 <dt>Return Type:</dt>
833 <dd>
834 Qt.Orientation.Horizontal or Qt.Orientation.Vertical
835 </dd>
836 </dl>
837 <a NAME="Listspace.mainWidget" ID="Listspace.mainWidget"></a>
838 <h4>Listspace.mainWidget</h4>
839 <b>mainWidget</b>(<i></i>)
840
841 <p>
842 Public method to return a reference to the main Widget of a
843 specific view manager subclass.
844 </p>
845 <dl>
846 <dt>Return:</dt>
847 <dd>
848 reference to the main widget
849 </dd>
850 </dl>
851 <dl>
852 <dt>Return Type:</dt>
853 <dd>
854 QWidget
855 </dd>
856 </dl>
857 <a NAME="Listspace.nextSplit" ID="Listspace.nextSplit"></a>
858 <h4>Listspace.nextSplit</h4>
859 <b>nextSplit</b>(<i></i>)
860
861 <p>
862 Public slot used to move to the next split.
863 </p>
864 <a NAME="Listspace.prevSplit" ID="Listspace.prevSplit"></a>
865 <h4>Listspace.prevSplit</h4>
866 <b>prevSplit</b>(<i></i>)
867
868 <p>
869 Public slot used to move to the previous split.
870 </p>
871 <a NAME="Listspace.removeSplit" ID="Listspace.removeSplit"></a>
872 <h4>Listspace.removeSplit</h4>
873 <b>removeSplit</b>(<i>index=-1</i>)
874
875 <p>
876 Public method used to remove the current split view or a split view
877 by index.
878 </p>
879 <dl>
880
881 <dt><i>index</i> (int)</dt>
882 <dd>
883 index of the split to be removed (-1 means to
884 delete the current split)
885 </dd>
886 </dl>
887 <dl>
888 <dt>Return:</dt>
889 <dd>
890 flag indicating successful deletion
891 </dd>
892 </dl>
893 <dl>
894 <dt>Return Type:</dt>
895 <dd>
896 bool
897 </dd>
898 </dl>
899 <a NAME="Listspace.setEditorName" ID="Listspace.setEditorName"></a>
900 <h4>Listspace.setEditorName</h4>
901 <b>setEditorName</b>(<i>editor, newName</i>)
902
903 <p>
904 Public method to change the displayed name of the editor.
905 </p>
906 <dl>
907
908 <dt><i>editor</i> (Editor)</dt>
909 <dd>
910 editor window to be changed
911 </dd>
912 <dt><i>newName</i> (str)</dt>
913 <dd>
914 new name to be shown
915 </dd>
916 </dl>
917 <a NAME="Listspace.setSplitCount" ID="Listspace.setSplitCount"></a>
918 <h4>Listspace.setSplitCount</h4>
919 <b>setSplitCount</b>(<i>count</i>)
920
921 <p>
922 Public method to set the number of split views.
923 </p>
924 <dl>
925
926 <dt><i>count</i> (int)</dt>
927 <dd>
928 number of split views
929 </dd>
930 </dl>
931 <a NAME="Listspace.setSplitOrientation" ID="Listspace.setSplitOrientation"></a>
932 <h4>Listspace.setSplitOrientation</h4>
933 <b>setSplitOrientation</b>(<i>orientation</i>)
934
935 <p>
936 Public method used to set the orientation of the split view.
937 </p>
938 <dl>
939
940 <dt><i>orientation</i> (Qt.Orientation.Horizontal or Qt.Orientation.Vertical)</dt>
941 <dd>
942 orientation of the split
943 </dd>
944 </dl>
945 <a NAME="Listspace.showWindowMenu" ID="Listspace.showWindowMenu"></a>
946 <h4>Listspace.showWindowMenu</h4>
947 <b>showWindowMenu</b>(<i>windowMenu</i>)
948
949 <p>
950 Public method to set up the viewmanager part of the Window menu.
951 </p>
952 <dl>
953
954 <dt><i>windowMenu</i> (QMenu)</dt>
955 <dd>
956 reference to the window menu
957 </dd>
958 </dl>
959 <a NAME="Listspace.splitCount" ID="Listspace.splitCount"></a>
960 <h4>Listspace.splitCount</h4>
961 <b>splitCount</b>(<i></i>)
962
963 <p>
964 Public method to get the number of splitted views.
965 </p>
966 <dl>
967 <dt>Return:</dt>
968 <dd>
969 number of splitted views
970 </dd>
971 </dl>
972 <dl>
973 <dt>Return Type:</dt>
974 <dd>
975 int
976 </dd>
977 </dl>
978 <a NAME="Listspace.tile" ID="Listspace.tile"></a>
979 <h4>Listspace.tile</h4>
980 <b>tile</b>(<i></i>)
981
982 <p>
983 Public method to tile the managed windows.
984 </p>
985 <div align="right"><a href="#top">Up</a></div>
986 <hr />
987 <hr />
988 <a NAME="StackedWidget" ID="StackedWidget"></a>
989 <h2>StackedWidget</h2>
990
991 <p>
992 Class implementing a custimized StackedWidget.
993 </p>
994 <h3>Derived from</h3>
995 QStackedWidget
996 <h3>Class Attributes</h3>
997
998 <table>
999 <tr><td>None</td></tr>
1000 </table>
1001 <h3>Class Methods</h3>
1002
1003 <table>
1004 <tr><td>None</td></tr>
1005 </table>
1006 <h3>Methods</h3>
1007
1008 <table>
1009
1010 <tr>
1011 <td><a href="#StackedWidget.__init__">StackedWidget</a></td>
1012 <td>Constructor</td>
1013 </tr>
1014 <tr>
1015 <td><a href="#StackedWidget.addWidget">addWidget</a></td>
1016 <td>Public method to add a new widget.</td>
1017 </tr>
1018 <tr>
1019 <td><a href="#StackedWidget.currentWidget">currentWidget</a></td>
1020 <td>Public method to get a reference to the current editor.</td>
1021 </tr>
1022 <tr>
1023 <td><a href="#StackedWidget.firstEditor">firstEditor</a></td>
1024 <td>Public method to retrieve the first editor in the list of managed editors.</td>
1025 </tr>
1026 <tr>
1027 <td><a href="#StackedWidget.hasEditor">hasEditor</a></td>
1028 <td>Public method to check for an editor.</td>
1029 </tr>
1030 <tr>
1031 <td><a href="#StackedWidget.nextTab">nextTab</a></td>
1032 <td>Public slot used to show the next tab.</td>
1033 </tr>
1034 <tr>
1035 <td><a href="#StackedWidget.prevTab">prevTab</a></td>
1036 <td>Public slot used to show the previous tab.</td>
1037 </tr>
1038 <tr>
1039 <td><a href="#StackedWidget.removeWidget">removeWidget</a></td>
1040 <td>Public method to remove a widget.</td>
1041 </tr>
1042 <tr>
1043 <td><a href="#StackedWidget.setCurrentIndex">setCurrentIndex</a></td>
1044 <td>Public method to set the current widget by its index.</td>
1045 </tr>
1046 <tr>
1047 <td><a href="#StackedWidget.setCurrentWidget">setCurrentWidget</a></td>
1048 <td>Public method to set the current widget.</td>
1049 </tr>
1050 </table>
1051 <h3>Static Methods</h3>
1052
1053 <table>
1054 <tr><td>None</td></tr>
1055 </table>
1056
1057 <a NAME="StackedWidget.__init__" ID="StackedWidget.__init__"></a>
1058 <h4>StackedWidget (Constructor)</h4>
1059 <b>StackedWidget</b>(<i>parent</i>)
1060
1061 <p>
1062 Constructor
1063 </p>
1064 <dl>
1065
1066 <dt><i>parent</i> (QWidget)</dt>
1067 <dd>
1068 parent widget
1069 </dd>
1070 </dl>
1071 <a NAME="StackedWidget.addWidget" ID="StackedWidget.addWidget"></a>
1072 <h4>StackedWidget.addWidget</h4>
1073 <b>addWidget</b>(<i>assembly</i>)
1074
1075 <p>
1076 Public method to add a new widget.
1077 </p>
1078 <dl>
1079
1080 <dt><i>assembly</i> (QScintilla.EditorAssembly.EditorAssembly)</dt>
1081 <dd>
1082 editor assembly object to be added
1083 </dd>
1084 </dl>
1085 <a NAME="StackedWidget.currentWidget" ID="StackedWidget.currentWidget"></a>
1086 <h4>StackedWidget.currentWidget</h4>
1087 <b>currentWidget</b>(<i></i>)
1088
1089 <p>
1090 Public method to get a reference to the current editor.
1091 </p>
1092 <dl>
1093 <dt>Return:</dt>
1094 <dd>
1095 reference to the current editor
1096 </dd>
1097 </dl>
1098 <dl>
1099 <dt>Return Type:</dt>
1100 <dd>
1101 Editor
1102 </dd>
1103 </dl>
1104 <a NAME="StackedWidget.firstEditor" ID="StackedWidget.firstEditor"></a>
1105 <h4>StackedWidget.firstEditor</h4>
1106 <b>firstEditor</b>(<i></i>)
1107
1108 <p>
1109 Public method to retrieve the first editor in the list of managed
1110 editors.
1111 </p>
1112 <dl>
1113 <dt>Return:</dt>
1114 <dd>
1115 first editor in list
1116 </dd>
1117 </dl>
1118 <dl>
1119 <dt>Return Type:</dt>
1120 <dd>
1121 QScintilla.Editor.Editor
1122 </dd>
1123 </dl>
1124 <a NAME="StackedWidget.hasEditor" ID="StackedWidget.hasEditor"></a>
1125 <h4>StackedWidget.hasEditor</h4>
1126 <b>hasEditor</b>(<i>editor</i>)
1127
1128 <p>
1129 Public method to check for an editor.
1130 </p>
1131 <dl>
1132
1133 <dt><i>editor</i> (Editor)</dt>
1134 <dd>
1135 editor object to check for
1136 </dd>
1137 </dl>
1138 <dl>
1139 <dt>Return:</dt>
1140 <dd>
1141 flag indicating, whether the editor to be checked belongs
1142 to the list of editors managed by this stacked widget.
1143 </dd>
1144 </dl>
1145 <dl>
1146 <dt>Return Type:</dt>
1147 <dd>
1148 bool
1149 </dd>
1150 </dl>
1151 <a NAME="StackedWidget.nextTab" ID="StackedWidget.nextTab"></a>
1152 <h4>StackedWidget.nextTab</h4>
1153 <b>nextTab</b>(<i></i>)
1154
1155 <p>
1156 Public slot used to show the next tab.
1157 </p>
1158 <a NAME="StackedWidget.prevTab" ID="StackedWidget.prevTab"></a>
1159 <h4>StackedWidget.prevTab</h4>
1160 <b>prevTab</b>(<i></i>)
1161
1162 <p>
1163 Public slot used to show the previous tab.
1164 </p>
1165 <a NAME="StackedWidget.removeWidget" ID="StackedWidget.removeWidget"></a>
1166 <h4>StackedWidget.removeWidget</h4>
1167 <b>removeWidget</b>(<i>widget</i>)
1168
1169 <p>
1170 Public method to remove a widget.
1171 </p>
1172 <dl>
1173
1174 <dt><i>widget</i> (QWidget)</dt>
1175 <dd>
1176 widget to be removed
1177 </dd>
1178 </dl>
1179 <a NAME="StackedWidget.setCurrentIndex" ID="StackedWidget.setCurrentIndex"></a>
1180 <h4>StackedWidget.setCurrentIndex</h4>
1181 <b>setCurrentIndex</b>(<i>index</i>)
1182
1183 <p>
1184 Public method to set the current widget by its index.
1185 </p>
1186 <dl>
1187
1188 <dt><i>index</i> (int)</dt>
1189 <dd>
1190 index of widget to be made current
1191 </dd>
1192 </dl>
1193 <a NAME="StackedWidget.setCurrentWidget" ID="StackedWidget.setCurrentWidget"></a>
1194 <h4>StackedWidget.setCurrentWidget</h4>
1195 <b>setCurrentWidget</b>(<i>widget</i>)
1196
1197 <p>
1198 Public method to set the current widget.
1199 </p>
1200 <dl>
1201
1202 <dt><i>widget</i> (QWidget)</dt>
1203 <dd>
1204 widget to be made current
1205 </dd>
1206 </dl>
1207 <div align="right"><a href="#top">Up</a></div>
1208 <hr />
1209 </body></html>

eric ide

mercurial