Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Tabview.Tabview.html

eric7/Documentation/Source/eric7.Plugins.ViewManagerPlugins.Tabview.Tabview.html

branch
eric7
changeset 8372
e0227a7c850e
child 8523
14e1ee6e720b
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.ViewManagerPlugins.Tabview.Tabview</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.ViewManagerPlugins.Tabview.Tabview</h1>
24
25 <p>
26 Module implementing a tabbed viewmanager class.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#TabBar">TabBar</a></td>
39 <td>Class implementing a customized tab bar supporting drag & drop.</td>
40 </tr>
41 <tr>
42 <td><a href="#TabWidget">TabWidget</a></td>
43 <td>Class implementing a custimized tab widget.</td>
44 </tr>
45 <tr>
46 <td><a href="#Tabview">Tabview</a></td>
47 <td>Class implementing a tabbed viewmanager class embedded in a splitter.</td>
48 </tr>
49 </table>
50 <h3>Functions</h3>
51
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <hr />
56 <hr />
57 <a NAME="TabBar" ID="TabBar"></a>
58 <h2>TabBar</h2>
59
60 <p>
61 Class implementing a customized tab bar supporting drag & drop.
62 </p>
63 <h3>Signals</h3>
64 <dl>
65
66 <dt>tabCopyRequested(int, int)</dt>
67 <dd>
68 emitted to signal a clone request giving
69 the old and new index position
70 </dd>
71 <dt>tabCopyRequested(str, int, int)</dt>
72 <dd>
73 emitted to signal a clone request
74 giving the string encoded id of the source tab widget, the index in the
75 source tab widget and the new index position
76 </dd>
77 <dt>tabMoveRequested(int, int)</dt>
78 <dd>
79 emitted to signal a tab move request
80 giving the old and new index position
81 </dd>
82 <dt>tabRelocateRequested(str, int, int)</dt>
83 <dd>
84 emitted to signal a tab
85 relocation request giving the string encoded id of the old tab widget,
86 the index in the old tab widget and the new index position
87 </dd>
88 </dl>
89 <h3>Derived from</h3>
90 EricWheelTabBar
91 <h3>Class Attributes</h3>
92
93 <table>
94 <tr><td>None</td></tr>
95 </table>
96 <h3>Class Methods</h3>
97
98 <table>
99 <tr><td>None</td></tr>
100 </table>
101 <h3>Methods</h3>
102
103 <table>
104
105 <tr>
106 <td><a href="#TabBar.__init__">TabBar</a></td>
107 <td>Constructor</td>
108 </tr>
109 <tr>
110 <td><a href="#TabBar.dragEnterEvent">dragEnterEvent</a></td>
111 <td>Protected method to handle drag enter events.</td>
112 </tr>
113 <tr>
114 <td><a href="#TabBar.dropEvent">dropEvent</a></td>
115 <td>Protected method to handle drop events.</td>
116 </tr>
117 <tr>
118 <td><a href="#TabBar.mouseMoveEvent">mouseMoveEvent</a></td>
119 <td>Protected method to handle mouse move events.</td>
120 </tr>
121 <tr>
122 <td><a href="#TabBar.mousePressEvent">mousePressEvent</a></td>
123 <td>Protected method to handle mouse press events.</td>
124 </tr>
125 </table>
126 <h3>Static Methods</h3>
127
128 <table>
129 <tr><td>None</td></tr>
130 </table>
131
132 <a NAME="TabBar.__init__" ID="TabBar.__init__"></a>
133 <h4>TabBar (Constructor)</h4>
134 <b>TabBar</b>(<i>parent=None</i>)
135
136 <p>
137 Constructor
138 </p>
139 <dl>
140
141 <dt><i>parent</i> (QWidget)</dt>
142 <dd>
143 reference to the parent widget
144 </dd>
145 </dl>
146 <a NAME="TabBar.dragEnterEvent" ID="TabBar.dragEnterEvent"></a>
147 <h4>TabBar.dragEnterEvent</h4>
148 <b>dragEnterEvent</b>(<i>event</i>)
149
150 <p>
151 Protected method to handle drag enter events.
152 </p>
153 <dl>
154
155 <dt><i>event</i> (QDragEnterEvent)</dt>
156 <dd>
157 reference to the drag enter event
158 </dd>
159 </dl>
160 <a NAME="TabBar.dropEvent" ID="TabBar.dropEvent"></a>
161 <h4>TabBar.dropEvent</h4>
162 <b>dropEvent</b>(<i>event</i>)
163
164 <p>
165 Protected method to handle drop events.
166 </p>
167 <dl>
168
169 <dt><i>event</i> (QDropEvent)</dt>
170 <dd>
171 reference to the drop event
172 </dd>
173 </dl>
174 <a NAME="TabBar.mouseMoveEvent" ID="TabBar.mouseMoveEvent"></a>
175 <h4>TabBar.mouseMoveEvent</h4>
176 <b>mouseMoveEvent</b>(<i>event</i>)
177
178 <p>
179 Protected method to handle mouse move events.
180 </p>
181 <dl>
182
183 <dt><i>event</i> (QMouseEvent)</dt>
184 <dd>
185 reference to the mouse move event
186 </dd>
187 </dl>
188 <a NAME="TabBar.mousePressEvent" ID="TabBar.mousePressEvent"></a>
189 <h4>TabBar.mousePressEvent</h4>
190 <b>mousePressEvent</b>(<i>event</i>)
191
192 <p>
193 Protected method to handle mouse press events.
194 </p>
195 <dl>
196
197 <dt><i>event</i> (QMouseEvent)</dt>
198 <dd>
199 reference to the mouse press event
200 </dd>
201 </dl>
202 <div align="right"><a href="#top">Up</a></div>
203 <hr />
204 <hr />
205 <a NAME="TabWidget" ID="TabWidget"></a>
206 <h2>TabWidget</h2>
207
208 <p>
209 Class implementing a custimized tab widget.
210 </p>
211 <h3>Derived from</h3>
212 EricTabWidget
213 <h3>Class Attributes</h3>
214
215 <table>
216 <tr><td>None</td></tr>
217 </table>
218 <h3>Class Methods</h3>
219
220 <table>
221 <tr><td>None</td></tr>
222 </table>
223 <h3>Methods</h3>
224
225 <table>
226
227 <tr>
228 <td><a href="#TabWidget.__init__">TabWidget</a></td>
229 <td>Constructor</td>
230 </tr>
231 <tr>
232 <td><a href="#TabWidget.__captionChange">__captionChange</a></td>
233 <td>Private slot to handle Caption change signals from the editor.</td>
234 </tr>
235 <tr>
236 <td><a href="#TabWidget.__closeButtonClicked">__closeButtonClicked</a></td>
237 <td>Private method to handle the press of the close button.</td>
238 </tr>
239 <tr>
240 <td><a href="#TabWidget.__closeRequested">__closeRequested</a></td>
241 <td>Private method to handle the press of the individual tab close button.</td>
242 </tr>
243 <tr>
244 <td><a href="#TabWidget.__contextMenuClose">__contextMenuClose</a></td>
245 <td>Private method to close the selected tab.</td>
246 </tr>
247 <tr>
248 <td><a href="#TabWidget.__contextMenuCloseAll">__contextMenuCloseAll</a></td>
249 <td>Private method to close all tabs.</td>
250 </tr>
251 <tr>
252 <td><a href="#TabWidget.__contextMenuCloseOthers">__contextMenuCloseOthers</a></td>
253 <td>Private method to close the other tabs.</td>
254 </tr>
255 <tr>
256 <td><a href="#TabWidget.__contextMenuCopyPathToClipboard">__contextMenuCopyPathToClipboard</a></td>
257 <td>Private method to copy the file name of the selected tab to the clipboard.</td>
258 </tr>
259 <tr>
260 <td><a href="#TabWidget.__contextMenuMoveFirst">__contextMenuMoveFirst</a></td>
261 <td>Private method to move a tab to the first position.</td>
262 </tr>
263 <tr>
264 <td><a href="#TabWidget.__contextMenuMoveLast">__contextMenuMoveLast</a></td>
265 <td>Private method to move a tab to the last position.</td>
266 </tr>
267 <tr>
268 <td><a href="#TabWidget.__contextMenuMoveLeft">__contextMenuMoveLeft</a></td>
269 <td>Private method to move a tab one position to the left.</td>
270 </tr>
271 <tr>
272 <td><a href="#TabWidget.__contextMenuMoveRight">__contextMenuMoveRight</a></td>
273 <td>Private method to move a tab one position to the right.</td>
274 </tr>
275 <tr>
276 <td><a href="#TabWidget.__contextMenuOpenRejections">__contextMenuOpenRejections</a></td>
277 <td>Private slot to open a rejections file associated with the selected tab.</td>
278 </tr>
279 <tr>
280 <td><a href="#TabWidget.__contextMenuPrintFile">__contextMenuPrintFile</a></td>
281 <td>Private method to print the selected tab.</td>
282 </tr>
283 <tr>
284 <td><a href="#TabWidget.__contextMenuSave">__contextMenuSave</a></td>
285 <td>Private method to save the selected tab.</td>
286 </tr>
287 <tr>
288 <td><a href="#TabWidget.__contextMenuSaveAll">__contextMenuSaveAll</a></td>
289 <td>Private method to save all tabs.</td>
290 </tr>
291 <tr>
292 <td><a href="#TabWidget.__contextMenuSaveAs">__contextMenuSaveAs</a></td>
293 <td>Private method to save the selected tab to a new file.</td>
294 </tr>
295 <tr>
296 <td><a href="#TabWidget.__copyTab">__copyTab</a></td>
297 <td>Private method to copy an editor.</td>
298 </tr>
299 <tr>
300 <td><a href="#TabWidget.__copyTabOther">__copyTabOther</a></td>
301 <td>Private method to copy an editor from another TabWidget.</td>
302 </tr>
303 <tr>
304 <td><a href="#TabWidget.__cursorLineChanged">__cursorLineChanged</a></td>
305 <td>Private slot to handle a change of the current editor's cursor line.</td>
306 </tr>
307 <tr>
308 <td><a href="#TabWidget.__initMenu">__initMenu</a></td>
309 <td>Private method to initialize the tab context menu.</td>
310 </tr>
311 <tr>
312 <td><a href="#TabWidget.__navigationMenuTriggered">__navigationMenuTriggered</a></td>
313 <td>Private slot called to handle the navigation button menu selection.</td>
314 </tr>
315 <tr>
316 <td><a href="#TabWidget.__relocateTab">__relocateTab</a></td>
317 <td>Private method to relocate an editor from another TabWidget.</td>
318 </tr>
319 <tr>
320 <td><a href="#TabWidget.__showContextMenu">__showContextMenu</a></td>
321 <td>Private slot to show the tab context menu.</td>
322 </tr>
323 <tr>
324 <td><a href="#TabWidget.__showNavigationMenu">__showNavigationMenu</a></td>
325 <td>Private slot to show the navigation button menu.</td>
326 </tr>
327 <tr>
328 <td><a href="#TabWidget.addTab">addTab</a></td>
329 <td>Public method to add a new tab.</td>
330 </tr>
331 <tr>
332 <td><a href="#TabWidget.currentWidget">currentWidget</a></td>
333 <td>Public method to return a reference to the current page.</td>
334 </tr>
335 <tr>
336 <td><a href="#TabWidget.hasEditor">hasEditor</a></td>
337 <td>Public method to check for an editor.</td>
338 </tr>
339 <tr>
340 <td><a href="#TabWidget.hasEditors">hasEditors</a></td>
341 <td>Public method to test, if any editor is managed.</td>
342 </tr>
343 <tr>
344 <td><a href="#TabWidget.indexOf">indexOf</a></td>
345 <td>Public method to get the tab index of the given editor.</td>
346 </tr>
347 <tr>
348 <td><a href="#TabWidget.insertWidget">insertWidget</a></td>
349 <td>Public method to insert a new tab.</td>
350 </tr>
351 <tr>
352 <td><a href="#TabWidget.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td>
353 <td>Protected method handling double click events.</td>
354 </tr>
355 <tr>
356 <td><a href="#TabWidget.removeWidget">removeWidget</a></td>
357 <td>Public method to remove a widget.</td>
358 </tr>
359 <tr>
360 <td><a href="#TabWidget.setCurrentWidget">setCurrentWidget</a></td>
361 <td>Public method to set the current tab by the given editor assembly.</td>
362 </tr>
363 <tr>
364 <td><a href="#TabWidget.showIndicator">showIndicator</a></td>
365 <td>Public slot to set the indicator on or off.</td>
366 </tr>
367 </table>
368 <h3>Static Methods</h3>
369
370 <table>
371 <tr><td>None</td></tr>
372 </table>
373
374 <a NAME="TabWidget.__init__" ID="TabWidget.__init__"></a>
375 <h4>TabWidget (Constructor)</h4>
376 <b>TabWidget</b>(<i>vm</i>)
377
378 <p>
379 Constructor
380 </p>
381 <dl>
382
383 <dt><i>vm</i> (Tabview)</dt>
384 <dd>
385 view manager widget
386 </dd>
387 </dl>
388 <a NAME="TabWidget.__captionChange" ID="TabWidget.__captionChange"></a>
389 <h4>TabWidget.__captionChange</h4>
390 <b>__captionChange</b>(<i>cap, editor</i>)
391
392 <p>
393 Private slot to handle Caption change signals from the editor.
394 </p>
395 <p>
396 Updates the tab text and tooltip text to reflect the new caption
397 information.
398 </p>
399 <dl>
400
401 <dt><i>cap</i> (str)</dt>
402 <dd>
403 Caption for the editor
404 </dd>
405 <dt><i>editor</i> (Editor)</dt>
406 <dd>
407 Editor to update the caption for
408 </dd>
409 </dl>
410 <a NAME="TabWidget.__closeButtonClicked" ID="TabWidget.__closeButtonClicked"></a>
411 <h4>TabWidget.__closeButtonClicked</h4>
412 <b>__closeButtonClicked</b>(<i></i>)
413
414 <p>
415 Private method to handle the press of the close button.
416 </p>
417 <a NAME="TabWidget.__closeRequested" ID="TabWidget.__closeRequested"></a>
418 <h4>TabWidget.__closeRequested</h4>
419 <b>__closeRequested</b>(<i>index</i>)
420
421 <p>
422 Private method to handle the press of the individual tab close button.
423 </p>
424 <dl>
425
426 <dt><i>index</i></dt>
427 <dd>
428 index of the tab (integer)
429 </dd>
430 </dl>
431 <a NAME="TabWidget.__contextMenuClose" ID="TabWidget.__contextMenuClose"></a>
432 <h4>TabWidget.__contextMenuClose</h4>
433 <b>__contextMenuClose</b>(<i></i>)
434
435 <p>
436 Private method to close the selected tab.
437 </p>
438 <a NAME="TabWidget.__contextMenuCloseAll" ID="TabWidget.__contextMenuCloseAll"></a>
439 <h4>TabWidget.__contextMenuCloseAll</h4>
440 <b>__contextMenuCloseAll</b>(<i></i>)
441
442 <p>
443 Private method to close all tabs.
444 </p>
445 <a NAME="TabWidget.__contextMenuCloseOthers" ID="TabWidget.__contextMenuCloseOthers"></a>
446 <h4>TabWidget.__contextMenuCloseOthers</h4>
447 <b>__contextMenuCloseOthers</b>(<i></i>)
448
449 <p>
450 Private method to close the other tabs.
451 </p>
452 <a NAME="TabWidget.__contextMenuCopyPathToClipboard" ID="TabWidget.__contextMenuCopyPathToClipboard"></a>
453 <h4>TabWidget.__contextMenuCopyPathToClipboard</h4>
454 <b>__contextMenuCopyPathToClipboard</b>(<i></i>)
455
456 <p>
457 Private method to copy the file name of the selected tab to the
458 clipboard.
459 </p>
460 <a NAME="TabWidget.__contextMenuMoveFirst" ID="TabWidget.__contextMenuMoveFirst"></a>
461 <h4>TabWidget.__contextMenuMoveFirst</h4>
462 <b>__contextMenuMoveFirst</b>(<i></i>)
463
464 <p>
465 Private method to move a tab to the first position.
466 </p>
467 <a NAME="TabWidget.__contextMenuMoveLast" ID="TabWidget.__contextMenuMoveLast"></a>
468 <h4>TabWidget.__contextMenuMoveLast</h4>
469 <b>__contextMenuMoveLast</b>(<i></i>)
470
471 <p>
472 Private method to move a tab to the last position.
473 </p>
474 <a NAME="TabWidget.__contextMenuMoveLeft" ID="TabWidget.__contextMenuMoveLeft"></a>
475 <h4>TabWidget.__contextMenuMoveLeft</h4>
476 <b>__contextMenuMoveLeft</b>(<i></i>)
477
478 <p>
479 Private method to move a tab one position to the left.
480 </p>
481 <a NAME="TabWidget.__contextMenuMoveRight" ID="TabWidget.__contextMenuMoveRight"></a>
482 <h4>TabWidget.__contextMenuMoveRight</h4>
483 <b>__contextMenuMoveRight</b>(<i></i>)
484
485 <p>
486 Private method to move a tab one position to the right.
487 </p>
488 <a NAME="TabWidget.__contextMenuOpenRejections" ID="TabWidget.__contextMenuOpenRejections"></a>
489 <h4>TabWidget.__contextMenuOpenRejections</h4>
490 <b>__contextMenuOpenRejections</b>(<i></i>)
491
492 <p>
493 Private slot to open a rejections file associated with the selected
494 tab.
495 </p>
496 <a NAME="TabWidget.__contextMenuPrintFile" ID="TabWidget.__contextMenuPrintFile"></a>
497 <h4>TabWidget.__contextMenuPrintFile</h4>
498 <b>__contextMenuPrintFile</b>(<i></i>)
499
500 <p>
501 Private method to print the selected tab.
502 </p>
503 <a NAME="TabWidget.__contextMenuSave" ID="TabWidget.__contextMenuSave"></a>
504 <h4>TabWidget.__contextMenuSave</h4>
505 <b>__contextMenuSave</b>(<i></i>)
506
507 <p>
508 Private method to save the selected tab.
509 </p>
510 <a NAME="TabWidget.__contextMenuSaveAll" ID="TabWidget.__contextMenuSaveAll"></a>
511 <h4>TabWidget.__contextMenuSaveAll</h4>
512 <b>__contextMenuSaveAll</b>(<i></i>)
513
514 <p>
515 Private method to save all tabs.
516 </p>
517 <a NAME="TabWidget.__contextMenuSaveAs" ID="TabWidget.__contextMenuSaveAs"></a>
518 <h4>TabWidget.__contextMenuSaveAs</h4>
519 <b>__contextMenuSaveAs</b>(<i></i>)
520
521 <p>
522 Private method to save the selected tab to a new file.
523 </p>
524 <a NAME="TabWidget.__copyTab" ID="TabWidget.__copyTab"></a>
525 <h4>TabWidget.__copyTab</h4>
526 <b>__copyTab</b>(<i>sourceIndex, targetIndex</i>)
527
528 <p>
529 Private method to copy an editor.
530 </p>
531 <dl>
532
533 <dt><i>sourceIndex</i> (int)</dt>
534 <dd>
535 index of the tab
536 </dd>
537 <dt><i>targetIndex</i> (int)</dt>
538 <dd>
539 index position to place it to
540 </dd>
541 </dl>
542 <a NAME="TabWidget.__copyTabOther" ID="TabWidget.__copyTabOther"></a>
543 <h4>TabWidget.__copyTabOther</h4>
544 <b>__copyTabOther</b>(<i>sourceId, sourceIndex, targetIndex</i>)
545
546 <p>
547 Private method to copy an editor from another TabWidget.
548 </p>
549 <dl>
550
551 <dt><i>sourceId</i> (str)</dt>
552 <dd>
553 id of the TabWidget to get the editor from
554 </dd>
555 <dt><i>sourceIndex</i> (int)</dt>
556 <dd>
557 index of the tab in the old tab widget
558 </dd>
559 <dt><i>targetIndex</i> (int)</dt>
560 <dd>
561 index position to place it to
562 </dd>
563 </dl>
564 <a NAME="TabWidget.__cursorLineChanged" ID="TabWidget.__cursorLineChanged"></a>
565 <h4>TabWidget.__cursorLineChanged</h4>
566 <b>__cursorLineChanged</b>(<i>lineno, editor</i>)
567
568 <p>
569 Private slot to handle a change of the current editor's cursor line.
570 </p>
571 <dl>
572
573 <dt><i>lineno</i> (int)</dt>
574 <dd>
575 line number of the editor's cursor (zero based)
576 </dd>
577 <dt><i>editor</i> (Editor)</dt>
578 <dd>
579 reference to the editor
580 </dd>
581 </dl>
582 <a NAME="TabWidget.__initMenu" ID="TabWidget.__initMenu"></a>
583 <h4>TabWidget.__initMenu</h4>
584 <b>__initMenu</b>(<i></i>)
585
586 <p>
587 Private method to initialize the tab context menu.
588 </p>
589 <a NAME="TabWidget.__navigationMenuTriggered" ID="TabWidget.__navigationMenuTriggered"></a>
590 <h4>TabWidget.__navigationMenuTriggered</h4>
591 <b>__navigationMenuTriggered</b>(<i>act</i>)
592
593 <p>
594 Private slot called to handle the navigation button menu selection.
595 </p>
596 <dl>
597
598 <dt><i>act</i> (QAction)</dt>
599 <dd>
600 reference to the selected action
601 </dd>
602 </dl>
603 <a NAME="TabWidget.__relocateTab" ID="TabWidget.__relocateTab"></a>
604 <h4>TabWidget.__relocateTab</h4>
605 <b>__relocateTab</b>(<i>sourceId, sourceIndex, targetIndex</i>)
606
607 <p>
608 Private method to relocate an editor from another TabWidget.
609 </p>
610 <dl>
611
612 <dt><i>sourceId</i> (str)</dt>
613 <dd>
614 id of the TabWidget to get the editor from
615 </dd>
616 <dt><i>sourceIndex</i> (int)</dt>
617 <dd>
618 index of the tab in the old tab widget
619 </dd>
620 <dt><i>targetIndex</i> (int)</dt>
621 <dd>
622 index position to place it to
623 </dd>
624 </dl>
625 <a NAME="TabWidget.__showContextMenu" ID="TabWidget.__showContextMenu"></a>
626 <h4>TabWidget.__showContextMenu</h4>
627 <b>__showContextMenu</b>(<i>coord, index</i>)
628
629 <p>
630 Private slot to show the tab context menu.
631 </p>
632 <dl>
633
634 <dt><i>coord</i> (QPoint)</dt>
635 <dd>
636 the position of the mouse pointer
637 </dd>
638 <dt><i>index</i> (int)</dt>
639 <dd>
640 index of the tab the menu is requested for
641 </dd>
642 </dl>
643 <a NAME="TabWidget.__showNavigationMenu" ID="TabWidget.__showNavigationMenu"></a>
644 <h4>TabWidget.__showNavigationMenu</h4>
645 <b>__showNavigationMenu</b>(<i></i>)
646
647 <p>
648 Private slot to show the navigation button menu.
649 </p>
650 <a NAME="TabWidget.addTab" ID="TabWidget.addTab"></a>
651 <h4>TabWidget.addTab</h4>
652 <b>addTab</b>(<i>assembly, title</i>)
653
654 <p>
655 Public method to add a new tab.
656 </p>
657 <dl>
658
659 <dt><i>assembly</i> (QScintilla.EditorAssembly.EditorAssembly)</dt>
660 <dd>
661 editor assembly object to be added
662 </dd>
663 <dt><i>title</i> (str)</dt>
664 <dd>
665 title for the new tab
666 </dd>
667 </dl>
668 <a NAME="TabWidget.currentWidget" ID="TabWidget.currentWidget"></a>
669 <h4>TabWidget.currentWidget</h4>
670 <b>currentWidget</b>(<i></i>)
671
672 <p>
673 Public method to return a reference to the current page.
674 </p>
675 <dl>
676 <dt>Return:</dt>
677 <dd>
678 reference to the current page
679 </dd>
680 </dl>
681 <dl>
682 <dt>Return Type:</dt>
683 <dd>
684 Editor
685 </dd>
686 </dl>
687 <a NAME="TabWidget.hasEditor" ID="TabWidget.hasEditor"></a>
688 <h4>TabWidget.hasEditor</h4>
689 <b>hasEditor</b>(<i>editor</i>)
690
691 <p>
692 Public method to check for an editor.
693 </p>
694 <dl>
695
696 <dt><i>editor</i> (Editor)</dt>
697 <dd>
698 editor object to check for
699 </dd>
700 </dl>
701 <dl>
702 <dt>Return:</dt>
703 <dd>
704 flag indicating, whether the editor to be checked belongs
705 to the list of editors managed by this tab widget.
706 </dd>
707 </dl>
708 <dl>
709 <dt>Return Type:</dt>
710 <dd>
711 bool
712 </dd>
713 </dl>
714 <a NAME="TabWidget.hasEditors" ID="TabWidget.hasEditors"></a>
715 <h4>TabWidget.hasEditors</h4>
716 <b>hasEditors</b>(<i></i>)
717
718 <p>
719 Public method to test, if any editor is managed.
720 </p>
721 <dl>
722 <dt>Return:</dt>
723 <dd>
724 flag indicating editors are managed
725 </dd>
726 </dl>
727 <dl>
728 <dt>Return Type:</dt>
729 <dd>
730 bool
731 </dd>
732 </dl>
733 <a NAME="TabWidget.indexOf" ID="TabWidget.indexOf"></a>
734 <h4>TabWidget.indexOf</h4>
735 <b>indexOf</b>(<i>widget</i>)
736
737 <p>
738 Public method to get the tab index of the given editor.
739 </p>
740 <dl>
741
742 <dt><i>widget</i> (QLabel or Editor)</dt>
743 <dd>
744 widget to get the index for
745 </dd>
746 </dl>
747 <dl>
748 <dt>Return:</dt>
749 <dd>
750 tab index of the editor
751 </dd>
752 </dl>
753 <dl>
754 <dt>Return Type:</dt>
755 <dd>
756 int
757 </dd>
758 </dl>
759 <a NAME="TabWidget.insertWidget" ID="TabWidget.insertWidget"></a>
760 <h4>TabWidget.insertWidget</h4>
761 <b>insertWidget</b>(<i>index, assembly, title</i>)
762
763 <p>
764 Public method to insert a new tab.
765 </p>
766 <dl>
767
768 <dt><i>index</i> (int)</dt>
769 <dd>
770 index position for the new tab
771 </dd>
772 <dt><i>assembly</i> (QScintilla.EditorAssembly.EditorAssembly)</dt>
773 <dd>
774 editor assembly object to be added
775 </dd>
776 <dt><i>title</i> (str)</dt>
777 <dd>
778 title for the new tab
779 </dd>
780 </dl>
781 <dl>
782 <dt>Return:</dt>
783 <dd>
784 index of the inserted tab
785 </dd>
786 </dl>
787 <dl>
788 <dt>Return Type:</dt>
789 <dd>
790 int
791 </dd>
792 </dl>
793 <a NAME="TabWidget.mouseDoubleClickEvent" ID="TabWidget.mouseDoubleClickEvent"></a>
794 <h4>TabWidget.mouseDoubleClickEvent</h4>
795 <b>mouseDoubleClickEvent</b>(<i>event</i>)
796
797 <p>
798 Protected method handling double click events.
799 </p>
800 <dl>
801
802 <dt><i>event</i></dt>
803 <dd>
804 reference to the event object (QMouseEvent)
805 </dd>
806 </dl>
807 <a NAME="TabWidget.removeWidget" ID="TabWidget.removeWidget"></a>
808 <h4>TabWidget.removeWidget</h4>
809 <b>removeWidget</b>(<i>widget</i>)
810
811 <p>
812 Public method to remove a widget.
813 </p>
814 <dl>
815
816 <dt><i>widget</i> (QWidget)</dt>
817 <dd>
818 widget to be removed
819 </dd>
820 </dl>
821 <a NAME="TabWidget.setCurrentWidget" ID="TabWidget.setCurrentWidget"></a>
822 <h4>TabWidget.setCurrentWidget</h4>
823 <b>setCurrentWidget</b>(<i>assembly</i>)
824
825 <p>
826 Public method to set the current tab by the given editor assembly.
827 </p>
828 <dl>
829
830 <dt><i>assembly</i> (EditorAssembly.EditorAssembly)</dt>
831 <dd>
832 editor assembly to determine current tab from
833 </dd>
834 </dl>
835 <a NAME="TabWidget.showIndicator" ID="TabWidget.showIndicator"></a>
836 <h4>TabWidget.showIndicator</h4>
837 <b>showIndicator</b>(<i>on</i>)
838
839 <p>
840 Public slot to set the indicator on or off.
841 </p>
842 <dl>
843
844 <dt><i>on</i> (bool)</dt>
845 <dd>
846 flag indicating the state of the indicator
847 </dd>
848 </dl>
849 <div align="right"><a href="#top">Up</a></div>
850 <hr />
851 <hr />
852 <a NAME="Tabview" ID="Tabview"></a>
853 <h2>Tabview</h2>
854
855 <p>
856 Class implementing a tabbed viewmanager class embedded in a splitter.
857 </p>
858 <h3>Signals</h3>
859 <dl>
860
861 <dt>astViewerStateChanged(bool)</dt>
862 <dd>
863 emitted to signal a change in the
864 AST viewer state
865 </dd>
866 <dt>bookmarkToggled(Editor)</dt>
867 <dd>
868 emitted when a bookmark is toggled.
869 </dd>
870 <dt>breakpointToggled(Editor)</dt>
871 <dd>
872 emitted when a breakpoint is toggled.
873 </dd>
874 <dt>changeCaption(str)</dt>
875 <dd>
876 emitted if a change of the caption is necessary
877 </dd>
878 <dt>checkActions(Editor)</dt>
879 <dd>
880 emitted when some actions should be checked
881 for their status
882 </dd>
883 <dt>cursorChanged(Editor)</dt>
884 <dd>
885 emitted after the cursor position of the
886 active window has changed
887 </dd>
888 <dt>editorChanged(str)</dt>
889 <dd>
890 emitted when the current editor has changed
891 </dd>
892 <dt>editorChangedEd(Editor)</dt>
893 <dd>
894 emitted when the current editor has changed
895 </dd>
896 <dt>editorClosed(str)</dt>
897 <dd>
898 emitted just before an editor window gets closed
899 </dd>
900 <dt>editorClosedEd(Editor)</dt>
901 <dd>
902 emitted just before an editor window gets
903 closed
904 </dd>
905 <dt>editorLanguageChanged(Editor)</dt>
906 <dd>
907 emitted to signal a change of an
908 editors language
909 </dd>
910 <dt>editorLineChanged(str,int)</dt>
911 <dd>
912 emitted to signal a change of an
913 editor's current line (line is given one based)
914 </dd>
915 <dt>editorLineChangedEd(Editor,int)</dt>
916 <dd>
917 emitted to signal a change of an
918 editor's current line (line is given one based)
919 </dd>
920 <dt>editorOpened(str)</dt>
921 <dd>
922 emitted after an editor window was opened
923 </dd>
924 <dt>editorOpenedEd(Editor)</dt>
925 <dd>
926 emitted after an editor window was opened
927 </dd>
928 <dt>editorRenamed(str)</dt>
929 <dd>
930 emitted after an editor was renamed
931 </dd>
932 <dt>editorRenamedEd(Editor)</dt>
933 <dd>
934 emitted after an editor was renamed
935 </dd>
936 <dt>editorSaved(str)</dt>
937 <dd>
938 emitted after an editor window was saved
939 </dd>
940 <dt>editorSavedEd(Editor)</dt>
941 <dd>
942 emitted after an editor window was saved
943 </dd>
944 <dt>editorTextChanged(Editor)</dt>
945 <dd>
946 emitted to signal a change of an
947 editor's text
948 </dd>
949 <dt>lastEditorClosed()</dt>
950 <dd>
951 emitted after the last editor window was closed
952 </dd>
953 <dt>previewStateChanged(bool)</dt>
954 <dd>
955 emitted to signal a change in the
956 preview state
957 </dd>
958 <dt>syntaxerrorToggled(Editor)</dt>
959 <dd>
960 emitted when a syntax error is toggled.
961 </dd>
962 </dl>
963 <h3>Derived from</h3>
964 ViewManager
965 <h3>Class Attributes</h3>
966
967 <table>
968 <tr><td>None</td></tr>
969 </table>
970 <h3>Class Methods</h3>
971
972 <table>
973 <tr><td>None</td></tr>
974 </table>
975 <h3>Methods</h3>
976
977 <table>
978
979 <tr>
980 <td><a href="#Tabview.__init__">Tabview</a></td>
981 <td>Constructor</td>
982 </tr>
983 <tr>
984 <td><a href="#Tabview.__currentChanged">__currentChanged</a></td>
985 <td>Private slot to handle the currentChanged signal.</td>
986 </tr>
987 <tr>
988 <td><a href="#Tabview._addView">_addView</a></td>
989 <td>Protected method to add a view (i.e.</td>
990 </tr>
991 <tr>
992 <td><a href="#Tabview._initWindowActions">_initWindowActions</a></td>
993 <td>Protected method to define the user interface actions for window handling.</td>
994 </tr>
995 <tr>
996 <td><a href="#Tabview._modificationStatusChanged">_modificationStatusChanged</a></td>
997 <td>Protected slot to handle the modificationStatusChanged signal.</td>
998 </tr>
999 <tr>
1000 <td><a href="#Tabview._removeAllViews">_removeAllViews</a></td>
1001 <td>Protected method to remove all views (i.e.</td>
1002 </tr>
1003 <tr>
1004 <td><a href="#Tabview._removeView">_removeView</a></td>
1005 <td>Protected method to remove a view (i.e.</td>
1006 </tr>
1007 <tr>
1008 <td><a href="#Tabview._showView">_showView</a></td>
1009 <td>Protected method to show a view (i.e.</td>
1010 </tr>
1011 <tr>
1012 <td><a href="#Tabview._syntaxErrorToggled">_syntaxErrorToggled</a></td>
1013 <td>Protected slot to handle the syntaxerrorToggled signal.</td>
1014 </tr>
1015 <tr>
1016 <td><a href="#Tabview.activeWindow">activeWindow</a></td>
1017 <td>Public method to return the active (i.e.</td>
1018 </tr>
1019 <tr>
1020 <td><a href="#Tabview.addSplit">addSplit</a></td>
1021 <td>Public method used to split the current view.</td>
1022 </tr>
1023 <tr>
1024 <td><a href="#Tabview.canCascade">canCascade</a></td>
1025 <td>Public method to signal if cascading of managed windows is available.</td>
1026 </tr>
1027 <tr>
1028 <td><a href="#Tabview.canSplit">canSplit</a></td>
1029 <td>public method to signal if splitting of the view is available.</td>
1030 </tr>
1031 <tr>
1032 <td><a href="#Tabview.canTile">canTile</a></td>
1033 <td>Public method to signal if tiling of managed windows is available.</td>
1034 </tr>
1035 <tr>
1036 <td><a href="#Tabview.cascade">cascade</a></td>
1037 <td>Public method to cascade the managed windows.</td>
1038 </tr>
1039 <tr>
1040 <td><a href="#Tabview.eventFilter">eventFilter</a></td>
1041 <td>Public method called to filter the event queue.</td>
1042 </tr>
1043 <tr>
1044 <td><a href="#Tabview.getOpenEditorsForSession">getOpenEditorsForSession</a></td>
1045 <td>Public method to get a lists of all open editors.</td>
1046 </tr>
1047 <tr>
1048 <td><a href="#Tabview.getSplitOrientation">getSplitOrientation</a></td>
1049 <td>Public method to get the orientation of the split view.</td>
1050 </tr>
1051 <tr>
1052 <td><a href="#Tabview.getTabWidgetById">getTabWidgetById</a></td>
1053 <td>Public method to get a reference to a tab widget knowing its ID.</td>
1054 </tr>
1055 <tr>
1056 <td><a href="#Tabview.insertView">insertView</a></td>
1057 <td>Public method to add a view (i.e.</td>
1058 </tr>
1059 <tr>
1060 <td><a href="#Tabview.mainWidget">mainWidget</a></td>
1061 <td>Public method to return a reference to the main Widget of a specific view manager subclass.</td>
1062 </tr>
1063 <tr>
1064 <td><a href="#Tabview.nextSplit">nextSplit</a></td>
1065 <td>Public slot used to move to the next split.</td>
1066 </tr>
1067 <tr>
1068 <td><a href="#Tabview.preferencesChanged">preferencesChanged</a></td>
1069 <td>Public slot to handle the preferencesChanged signal.</td>
1070 </tr>
1071 <tr>
1072 <td><a href="#Tabview.prevSplit">prevSplit</a></td>
1073 <td>Public slot used to move to the previous split.</td>
1074 </tr>
1075 <tr>
1076 <td><a href="#Tabview.removeSplit">removeSplit</a></td>
1077 <td>Public method used to remove the current split view or a split view by index.</td>
1078 </tr>
1079 <tr>
1080 <td><a href="#Tabview.setEditorName">setEditorName</a></td>
1081 <td>Public method to change the displayed name of the editor.</td>
1082 </tr>
1083 <tr>
1084 <td><a href="#Tabview.setSplitCount">setSplitCount</a></td>
1085 <td>Public method to set the number of split views.</td>
1086 </tr>
1087 <tr>
1088 <td><a href="#Tabview.setSplitOrientation">setSplitOrientation</a></td>
1089 <td>Public method used to set the orientation of the split view.</td>
1090 </tr>
1091 <tr>
1092 <td><a href="#Tabview.showWindowMenu">showWindowMenu</a></td>
1093 <td>Public method to set up the viewmanager part of the Window menu.</td>
1094 </tr>
1095 <tr>
1096 <td><a href="#Tabview.splitCount">splitCount</a></td>
1097 <td>Public method to get the number of splitted views.</td>
1098 </tr>
1099 <tr>
1100 <td><a href="#Tabview.tile">tile</a></td>
1101 <td>Public method to tile the managed windows.</td>
1102 </tr>
1103 </table>
1104 <h3>Static Methods</h3>
1105
1106 <table>
1107 <tr><td>None</td></tr>
1108 </table>
1109
1110 <a NAME="Tabview.__init__" ID="Tabview.__init__"></a>
1111 <h4>Tabview (Constructor)</h4>
1112 <b>Tabview</b>(<i>parent</i>)
1113
1114 <p>
1115 Constructor
1116 </p>
1117 <dl>
1118
1119 <dt><i>parent</i> (QWidget)</dt>
1120 <dd>
1121 parent widget
1122 </dd>
1123 </dl>
1124 <a NAME="Tabview.__currentChanged" ID="Tabview.__currentChanged"></a>
1125 <h4>Tabview.__currentChanged</h4>
1126 <b>__currentChanged</b>(<i>index</i>)
1127
1128 <p>
1129 Private slot to handle the currentChanged signal.
1130 </p>
1131 <dl>
1132
1133 <dt><i>index</i> (int)</dt>
1134 <dd>
1135 index of the current tab
1136 </dd>
1137 </dl>
1138 <a NAME="Tabview._addView" ID="Tabview._addView"></a>
1139 <h4>Tabview._addView</h4>
1140 <b>_addView</b>(<i>win, fn=None, noName="", addNext=False, indexes=None</i>)
1141
1142 <p>
1143 Protected method to add a view (i.e. window).
1144 </p>
1145 <dl>
1146
1147 <dt><i>win</i> (EditorAssembly)</dt>
1148 <dd>
1149 editor assembly to be added
1150 </dd>
1151 <dt><i>fn</i> (str)</dt>
1152 <dd>
1153 filename of this editor
1154 </dd>
1155 <dt><i>noName</i> (str)</dt>
1156 <dd>
1157 name to be used for an unnamed editor
1158 </dd>
1159 <dt><i>addNext</i> (bool)</dt>
1160 <dd>
1161 flag indicating to add the view next to the current
1162 view
1163 </dd>
1164 <dt><i>indexes</i> (tuple of two int)</dt>
1165 <dd>
1166 of the editor, first the split view index, second the
1167 index within the view
1168 </dd>
1169 </dl>
1170 <a NAME="Tabview._initWindowActions" ID="Tabview._initWindowActions"></a>
1171 <h4>Tabview._initWindowActions</h4>
1172 <b>_initWindowActions</b>(<i></i>)
1173
1174 <p>
1175 Protected method to define the user interface actions for window
1176 handling.
1177 </p>
1178 <a NAME="Tabview._modificationStatusChanged" ID="Tabview._modificationStatusChanged"></a>
1179 <h4>Tabview._modificationStatusChanged</h4>
1180 <b>_modificationStatusChanged</b>(<i>m, editor</i>)
1181
1182 <p>
1183 Protected slot to handle the modificationStatusChanged signal.
1184 </p>
1185 <dl>
1186
1187 <dt><i>m</i> (bool)</dt>
1188 <dd>
1189 flag indicating the modification status
1190 </dd>
1191 <dt><i>editor</i> (Editor)</dt>
1192 <dd>
1193 editor window changed
1194 </dd>
1195 </dl>
1196 <a NAME="Tabview._removeAllViews" ID="Tabview._removeAllViews"></a>
1197 <h4>Tabview._removeAllViews</h4>
1198 <b>_removeAllViews</b>(<i></i>)
1199
1200 <p>
1201 Protected method to remove all views (i.e. windows).
1202 </p>
1203 <a NAME="Tabview._removeView" ID="Tabview._removeView"></a>
1204 <h4>Tabview._removeView</h4>
1205 <b>_removeView</b>(<i>win</i>)
1206
1207 <p>
1208 Protected method to remove a view (i.e. window).
1209 </p>
1210 <dl>
1211
1212 <dt><i>win</i> (Editor)</dt>
1213 <dd>
1214 editor window to be removed
1215 </dd>
1216 </dl>
1217 <a NAME="Tabview._showView" ID="Tabview._showView"></a>
1218 <h4>Tabview._showView</h4>
1219 <b>_showView</b>(<i>win, fn=None</i>)
1220
1221 <p>
1222 Protected method to show a view (i.e. window).
1223 </p>
1224 <dl>
1225
1226 <dt><i>win</i> (EditorAssembly)</dt>
1227 <dd>
1228 editor assembly to be shown
1229 </dd>
1230 <dt><i>fn</i> (str)</dt>
1231 <dd>
1232 filename of this editor
1233 </dd>
1234 </dl>
1235 <a NAME="Tabview._syntaxErrorToggled" ID="Tabview._syntaxErrorToggled"></a>
1236 <h4>Tabview._syntaxErrorToggled</h4>
1237 <b>_syntaxErrorToggled</b>(<i>editor</i>)
1238
1239 <p>
1240 Protected slot to handle the syntaxerrorToggled signal.
1241 </p>
1242 <dl>
1243
1244 <dt><i>editor</i> (Editor)</dt>
1245 <dd>
1246 editor that sent the signal
1247 </dd>
1248 </dl>
1249 <a NAME="Tabview.activeWindow" ID="Tabview.activeWindow"></a>
1250 <h4>Tabview.activeWindow</h4>
1251 <b>activeWindow</b>(<i></i>)
1252
1253 <p>
1254 Public method to return the active (i.e. current) window.
1255 </p>
1256 <dl>
1257 <dt>Return:</dt>
1258 <dd>
1259 reference to the active editor
1260 </dd>
1261 </dl>
1262 <dl>
1263 <dt>Return Type:</dt>
1264 <dd>
1265 Editor
1266 </dd>
1267 </dl>
1268 <a NAME="Tabview.addSplit" ID="Tabview.addSplit"></a>
1269 <h4>Tabview.addSplit</h4>
1270 <b>addSplit</b>(<i></i>)
1271
1272 <p>
1273 Public method used to split the current view.
1274 </p>
1275 <a NAME="Tabview.canCascade" ID="Tabview.canCascade"></a>
1276 <h4>Tabview.canCascade</h4>
1277 <b>canCascade</b>(<i></i>)
1278
1279 <p>
1280 Public method to signal if cascading of managed windows is available.
1281 </p>
1282 <dl>
1283 <dt>Return:</dt>
1284 <dd>
1285 flag indicating cascading of windows is available
1286 </dd>
1287 </dl>
1288 <dl>
1289 <dt>Return Type:</dt>
1290 <dd>
1291 bool
1292 </dd>
1293 </dl>
1294 <a NAME="Tabview.canSplit" ID="Tabview.canSplit"></a>
1295 <h4>Tabview.canSplit</h4>
1296 <b>canSplit</b>(<i></i>)
1297
1298 <p>
1299 public method to signal if splitting of the view is available.
1300 </p>
1301 <dl>
1302 <dt>Return:</dt>
1303 <dd>
1304 flag indicating splitting of the view is available.
1305 </dd>
1306 </dl>
1307 <dl>
1308 <dt>Return Type:</dt>
1309 <dd>
1310 bool
1311 </dd>
1312 </dl>
1313 <a NAME="Tabview.canTile" ID="Tabview.canTile"></a>
1314 <h4>Tabview.canTile</h4>
1315 <b>canTile</b>(<i></i>)
1316
1317 <p>
1318 Public method to signal if tiling of managed windows is available.
1319 </p>
1320 <dl>
1321 <dt>Return:</dt>
1322 <dd>
1323 flag indicating tiling of windows is available
1324 </dd>
1325 </dl>
1326 <dl>
1327 <dt>Return Type:</dt>
1328 <dd>
1329 bool
1330 </dd>
1331 </dl>
1332 <a NAME="Tabview.cascade" ID="Tabview.cascade"></a>
1333 <h4>Tabview.cascade</h4>
1334 <b>cascade</b>(<i></i>)
1335
1336 <p>
1337 Public method to cascade the managed windows.
1338 </p>
1339 <a NAME="Tabview.eventFilter" ID="Tabview.eventFilter"></a>
1340 <h4>Tabview.eventFilter</h4>
1341 <b>eventFilter</b>(<i>watched, event</i>)
1342
1343 <p>
1344 Public method called to filter the event queue.
1345 </p>
1346 <dl>
1347
1348 <dt><i>watched</i> (QObject)</dt>
1349 <dd>
1350 the QObject being watched
1351 </dd>
1352 <dt><i>event</i> (QEvent)</dt>
1353 <dd>
1354 the event that occurred
1355 </dd>
1356 </dl>
1357 <dl>
1358 <dt>Return:</dt>
1359 <dd>
1360 always False
1361 </dd>
1362 </dl>
1363 <dl>
1364 <dt>Return Type:</dt>
1365 <dd>
1366 bool
1367 </dd>
1368 </dl>
1369 <a NAME="Tabview.getOpenEditorsForSession" ID="Tabview.getOpenEditorsForSession"></a>
1370 <h4>Tabview.getOpenEditorsForSession</h4>
1371 <b>getOpenEditorsForSession</b>(<i></i>)
1372
1373 <p>
1374 Public method to get a lists of all open editors.
1375 </p>
1376 <p>
1377 The returned list contains one list per split view. If the view manager
1378 cannot split the view, only one list of editors is returned.
1379 </p>
1380 <dl>
1381 <dt>Return:</dt>
1382 <dd>
1383 list of list of editor references
1384 </dd>
1385 </dl>
1386 <dl>
1387 <dt>Return Type:</dt>
1388 <dd>
1389 list of list of Editor
1390 </dd>
1391 </dl>
1392 <a NAME="Tabview.getSplitOrientation" ID="Tabview.getSplitOrientation"></a>
1393 <h4>Tabview.getSplitOrientation</h4>
1394 <b>getSplitOrientation</b>(<i></i>)
1395
1396 <p>
1397 Public method to get the orientation of the split view.
1398 </p>
1399 <dl>
1400 <dt>Return:</dt>
1401 <dd>
1402 orientation of the split
1403 </dd>
1404 </dl>
1405 <dl>
1406 <dt>Return Type:</dt>
1407 <dd>
1408 Qt.Orientation.Horizontal or Qt.Orientation.Vertical
1409 </dd>
1410 </dl>
1411 <a NAME="Tabview.getTabWidgetById" ID="Tabview.getTabWidgetById"></a>
1412 <h4>Tabview.getTabWidgetById</h4>
1413 <b>getTabWidgetById</b>(<i>id_</i>)
1414
1415 <p>
1416 Public method to get a reference to a tab widget knowing its ID.
1417 </p>
1418 <dl>
1419
1420 <dt><i>id_</i> (int)</dt>
1421 <dd>
1422 id of the tab widget
1423 </dd>
1424 </dl>
1425 <dl>
1426 <dt>Return:</dt>
1427 <dd>
1428 reference to the tab widget
1429 </dd>
1430 </dl>
1431 <dl>
1432 <dt>Return Type:</dt>
1433 <dd>
1434 TabWidget
1435 </dd>
1436 </dl>
1437 <a NAME="Tabview.insertView" ID="Tabview.insertView"></a>
1438 <h4>Tabview.insertView</h4>
1439 <b>insertView</b>(<i>win, tabWidget, index, fn=None, noName=""</i>)
1440
1441 <p>
1442 Public method to add a view (i.e. window).
1443 </p>
1444 <dl>
1445
1446 <dt><i>win</i> (EditorAssembly)</dt>
1447 <dd>
1448 editor assembly to be inserted
1449 </dd>
1450 <dt><i>tabWidget</i> (TabWidget)</dt>
1451 <dd>
1452 reference to the tab widget to insert the editor into
1453 </dd>
1454 <dt><i>index</i> (int)</dt>
1455 <dd>
1456 index position to insert at
1457 </dd>
1458 <dt><i>fn</i> (str)</dt>
1459 <dd>
1460 filename of this editor
1461 </dd>
1462 <dt><i>noName</i> (str)</dt>
1463 <dd>
1464 name to be used for an unnamed editor
1465 </dd>
1466 </dl>
1467 <a NAME="Tabview.mainWidget" ID="Tabview.mainWidget"></a>
1468 <h4>Tabview.mainWidget</h4>
1469 <b>mainWidget</b>(<i></i>)
1470
1471 <p>
1472 Public method to return a reference to the main Widget of a
1473 specific view manager subclass.
1474 </p>
1475 <dl>
1476 <dt>Return:</dt>
1477 <dd>
1478 reference to the main widget
1479 </dd>
1480 </dl>
1481 <dl>
1482 <dt>Return Type:</dt>
1483 <dd>
1484 QWidget
1485 </dd>
1486 </dl>
1487 <a NAME="Tabview.nextSplit" ID="Tabview.nextSplit"></a>
1488 <h4>Tabview.nextSplit</h4>
1489 <b>nextSplit</b>(<i></i>)
1490
1491 <p>
1492 Public slot used to move to the next split.
1493 </p>
1494 <a NAME="Tabview.preferencesChanged" ID="Tabview.preferencesChanged"></a>
1495 <h4>Tabview.preferencesChanged</h4>
1496 <b>preferencesChanged</b>(<i></i>)
1497
1498 <p>
1499 Public slot to handle the preferencesChanged signal.
1500 </p>
1501 <a NAME="Tabview.prevSplit" ID="Tabview.prevSplit"></a>
1502 <h4>Tabview.prevSplit</h4>
1503 <b>prevSplit</b>(<i></i>)
1504
1505 <p>
1506 Public slot used to move to the previous split.
1507 </p>
1508 <a NAME="Tabview.removeSplit" ID="Tabview.removeSplit"></a>
1509 <h4>Tabview.removeSplit</h4>
1510 <b>removeSplit</b>(<i>index=-1</i>)
1511
1512 <p>
1513 Public method used to remove the current split view or a split view
1514 by index.
1515 </p>
1516 <dl>
1517
1518 <dt><i>index</i> (int)</dt>
1519 <dd>
1520 index of the split to be removed (-1 means to
1521 delete the current split)
1522 </dd>
1523 </dl>
1524 <dl>
1525 <dt>Return:</dt>
1526 <dd>
1527 flag indicating successful deletion
1528 </dd>
1529 </dl>
1530 <dl>
1531 <dt>Return Type:</dt>
1532 <dd>
1533 bool
1534 </dd>
1535 </dl>
1536 <a NAME="Tabview.setEditorName" ID="Tabview.setEditorName"></a>
1537 <h4>Tabview.setEditorName</h4>
1538 <b>setEditorName</b>(<i>editor, newName</i>)
1539
1540 <p>
1541 Public method to change the displayed name of the editor.
1542 </p>
1543 <dl>
1544
1545 <dt><i>editor</i> (Editor)</dt>
1546 <dd>
1547 editor window to be changed
1548 </dd>
1549 <dt><i>newName</i> (str)</dt>
1550 <dd>
1551 new name to be shown
1552 </dd>
1553 </dl>
1554 <a NAME="Tabview.setSplitCount" ID="Tabview.setSplitCount"></a>
1555 <h4>Tabview.setSplitCount</h4>
1556 <b>setSplitCount</b>(<i>count</i>)
1557
1558 <p>
1559 Public method to set the number of split views.
1560 </p>
1561 <dl>
1562
1563 <dt><i>count</i> (int)</dt>
1564 <dd>
1565 number of split views
1566 </dd>
1567 </dl>
1568 <a NAME="Tabview.setSplitOrientation" ID="Tabview.setSplitOrientation"></a>
1569 <h4>Tabview.setSplitOrientation</h4>
1570 <b>setSplitOrientation</b>(<i>orientation</i>)
1571
1572 <p>
1573 Public method used to set the orientation of the split view.
1574 </p>
1575 <dl>
1576
1577 <dt><i>orientation</i> (Qt.Orientation.Horizontal or Qt.Orientation.Vertical)</dt>
1578 <dd>
1579 orientation of the split
1580 </dd>
1581 </dl>
1582 <a NAME="Tabview.showWindowMenu" ID="Tabview.showWindowMenu"></a>
1583 <h4>Tabview.showWindowMenu</h4>
1584 <b>showWindowMenu</b>(<i>windowMenu</i>)
1585
1586 <p>
1587 Public method to set up the viewmanager part of the Window menu.
1588 </p>
1589 <dl>
1590
1591 <dt><i>windowMenu</i> (QMenu)</dt>
1592 <dd>
1593 reference to the window menu
1594 </dd>
1595 </dl>
1596 <a NAME="Tabview.splitCount" ID="Tabview.splitCount"></a>
1597 <h4>Tabview.splitCount</h4>
1598 <b>splitCount</b>(<i></i>)
1599
1600 <p>
1601 Public method to get the number of splitted views.
1602 </p>
1603 <dl>
1604 <dt>Return:</dt>
1605 <dd>
1606 number of splitted views
1607 </dd>
1608 </dl>
1609 <dl>
1610 <dt>Return Type:</dt>
1611 <dd>
1612 int
1613 </dd>
1614 </dl>
1615 <a NAME="Tabview.tile" ID="Tabview.tile"></a>
1616 <h4>Tabview.tile</h4>
1617 <b>tile</b>(<i></i>)
1618
1619 <p>
1620 Public method to tile the managed windows.
1621 </p>
1622 <div align="right"><a href="#top">Up</a></div>
1623 <hr />
1624 </body></html>

Mercurial Repository: eric

eric ide

mercurial