Mercurial Repositories > eric / file comparison

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

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

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Plugins.ViewManagerPlugins.Tabview.Tabview</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Plugins.ViewManagerPlugins.Tabview.Tabview</h1>
24 <p>
25 Module implementing a tabbed viewmanager class.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#TabBar">TabBar</a></td>
35 <td>Class implementing a customized tab bar supporting drag & drop.</td>
36 </tr><tr>
37 <td><a href="#TabWidget">TabWidget</a></td>
38 <td>Class implementing a custimized tab widget.</td>
39 </tr><tr>
40 <td><a href="#Tabview">Tabview</a></td>
41 <td>Class implementing a tabbed viewmanager class embedded in a splitter.</td>
42 </tr>
43 </table>
44 <h3>Functions</h3>
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr /><hr />
49 <a NAME="TabBar" ID="TabBar"></a>
50 <h2>TabBar</h2>
51 <p>
52 Class implementing a customized tab bar supporting drag & drop.
53 </p><h4>Signals</h4>
54 <dl>
55 <dt>tabCopyRequested(int, int)</dt>
56 <dd>
57 emitted to signal a clone request giving
58 the old and new index position
59 </dd><dt>tabCopyRequested(long, int, int)</dt>
60 <dd>
61 emitted to signal a clone request
62 giving the id of the source tab widget, the index in the source tab widget
63 and the new index position
64 </dd><dt>tabMoveRequested(int, int)</dt>
65 <dd>
66 emitted to signal a tab move request giving
67 the old and new index position
68 </dd><dt>tabRelocateRequested(long, int, int)</dt>
69 <dd>
70 emitted to signal a tab relocation
71 request giving the id of the old tab widget, the index in the old tab widget
72 and the new index position
73 </dd>
74 </dl>
75 <h3>Derived from</h3>
76 E4WheelTabBar
77 <h3>Class Attributes</h3>
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81 <h3>Methods</h3>
82 <table>
83 <tr>
84 <td><a href="#TabBar.__init__">TabBar</a></td>
85 <td>Constructor</td>
86 </tr><tr>
87 <td><a href="#TabBar.dragEnterEvent">dragEnterEvent</a></td>
88 <td>Protected method to handle drag enter events.</td>
89 </tr><tr>
90 <td><a href="#TabBar.dropEvent">dropEvent</a></td>
91 <td>Protected method to handle drop events.</td>
92 </tr><tr>
93 <td><a href="#TabBar.mouseMoveEvent">mouseMoveEvent</a></td>
94 <td>Protected method to handle mouse move events.</td>
95 </tr><tr>
96 <td><a href="#TabBar.mousePressEvent">mousePressEvent</a></td>
97 <td>Protected method to handle mouse press events.</td>
98 </tr>
99 </table>
100 <a NAME="TabBar.__init__" ID="TabBar.__init__"></a>
101 <h4>TabBar (Constructor)</h4>
102 <b>TabBar</b>(<i>parent = None</i>)
103 <p>
104 Constructor
105 </p><dl>
106 <dt><i>parent</i></dt>
107 <dd>
108 reference to the parent widget (QWidget)
109 </dd>
110 </dl><a NAME="TabBar.dragEnterEvent" ID="TabBar.dragEnterEvent"></a>
111 <h4>TabBar.dragEnterEvent</h4>
112 <b>dragEnterEvent</b>(<i>event</i>)
113 <p>
114 Protected method to handle drag enter events.
115 </p><dl>
116 <dt><i>event</i></dt>
117 <dd>
118 reference to the drag enter event (QDragEnterEvent)
119 </dd>
120 </dl><a NAME="TabBar.dropEvent" ID="TabBar.dropEvent"></a>
121 <h4>TabBar.dropEvent</h4>
122 <b>dropEvent</b>(<i>event</i>)
123 <p>
124 Protected method to handle drop events.
125 </p><dl>
126 <dt><i>event</i></dt>
127 <dd>
128 reference to the drop event (QDropEvent)
129 </dd>
130 </dl><a NAME="TabBar.mouseMoveEvent" ID="TabBar.mouseMoveEvent"></a>
131 <h4>TabBar.mouseMoveEvent</h4>
132 <b>mouseMoveEvent</b>(<i>event</i>)
133 <p>
134 Protected method to handle mouse move events.
135 </p><dl>
136 <dt><i>event</i></dt>
137 <dd>
138 reference to the mouse move event (QMouseEvent)
139 </dd>
140 </dl><a NAME="TabBar.mousePressEvent" ID="TabBar.mousePressEvent"></a>
141 <h4>TabBar.mousePressEvent</h4>
142 <b>mousePressEvent</b>(<i>event</i>)
143 <p>
144 Protected method to handle mouse press events.
145 </p><dl>
146 <dt><i>event</i></dt>
147 <dd>
148 reference to the mouse press event (QMouseEvent)
149 </dd>
150 </dl>
151 <div align="right"><a href="#top">Up</a></div>
152 <hr /><hr />
153 <a NAME="TabWidget" ID="TabWidget"></a>
154 <h2>TabWidget</h2>
155 <p>
156 Class implementing a custimized tab widget.
157 </p>
158 <h3>Derived from</h3>
159 E4TabWidget
160 <h3>Class Attributes</h3>
161 <table>
162 <tr><td>None</td></tr>
163 </table>
164 <h3>Methods</h3>
165 <table>
166 <tr>
167 <td><a href="#TabWidget.__init__">TabWidget</a></td>
168 <td>Constructor</td>
169 </tr><tr>
170 <td><a href="#TabWidget.__captionChange">__captionChange</a></td>
171 <td>Private method to handle Caption change signals from the editor.</td>
172 </tr><tr>
173 <td><a href="#TabWidget.__closeButtonClicked">__closeButtonClicked</a></td>
174 <td>Private method to handle the press of the close button.</td>
175 </tr><tr>
176 <td><a href="#TabWidget.__closeRequested">__closeRequested</a></td>
177 <td>Private method to handle the press of the individual tab close button.</td>
178 </tr><tr>
179 <td><a href="#TabWidget.__contextMenuClose">__contextMenuClose</a></td>
180 <td>Private method to close the selected tab.</td>
181 </tr><tr>
182 <td><a href="#TabWidget.__contextMenuCloseAll">__contextMenuCloseAll</a></td>
183 <td>Private method to close all tabs.</td>
184 </tr><tr>
185 <td><a href="#TabWidget.__contextMenuCloseOthers">__contextMenuCloseOthers</a></td>
186 <td>Private method to close the other tabs.</td>
187 </tr><tr>
188 <td><a href="#TabWidget.__contextMenuMoveFirst">__contextMenuMoveFirst</a></td>
189 <td>Private method to move a tab to the first position.</td>
190 </tr><tr>
191 <td><a href="#TabWidget.__contextMenuMoveLast">__contextMenuMoveLast</a></td>
192 <td>Private method to move a tab to the last position.</td>
193 </tr><tr>
194 <td><a href="#TabWidget.__contextMenuMoveLeft">__contextMenuMoveLeft</a></td>
195 <td>Private method to move a tab one position to the left.</td>
196 </tr><tr>
197 <td><a href="#TabWidget.__contextMenuMoveRight">__contextMenuMoveRight</a></td>
198 <td>Private method to move a tab one position to the right.</td>
199 </tr><tr>
200 <td><a href="#TabWidget.__contextMenuPrintFile">__contextMenuPrintFile</a></td>
201 <td>Private method to print the selected tab.</td>
202 </tr><tr>
203 <td><a href="#TabWidget.__contextMenuSave">__contextMenuSave</a></td>
204 <td>Private method to save the selected tab.</td>
205 </tr><tr>
206 <td><a href="#TabWidget.__contextMenuSaveAll">__contextMenuSaveAll</a></td>
207 <td>Private method to save all tabs.</td>
208 </tr><tr>
209 <td><a href="#TabWidget.__contextMenuSaveAs">__contextMenuSaveAs</a></td>
210 <td>Private method to save the selected tab to a new file.</td>
211 </tr><tr>
212 <td><a href="#TabWidget.__contextMenuSaveToProject">__contextMenuSaveToProject</a></td>
213 <td>Private method to save the selected tab to the current project.</td>
214 </tr><tr>
215 <td><a href="#TabWidget.__initMenu">__initMenu</a></td>
216 <td>Private method to initialize the tab context menu.</td>
217 </tr><tr>
218 <td><a href="#TabWidget.__navigationMenuTriggered">__navigationMenuTriggered</a></td>
219 <td>Private slot called to handle the navigation button menu selection.</td>
220 </tr><tr>
221 <td><a href="#TabWidget.__showContextMenu">__showContextMenu</a></td>
222 <td>Private slot to show the tab context menu.</td>
223 </tr><tr>
224 <td><a href="#TabWidget.__showNavigationMenu">__showNavigationMenu</a></td>
225 <td>Private slot to show the navigation button menu.</td>
226 </tr><tr>
227 <td><a href="#TabWidget.addTab">addTab</a></td>
228 <td>Overwritten method to add a new tab.</td>
229 </tr><tr>
230 <td><a href="#TabWidget.copyTab">copyTab</a></td>
231 <td>Public method to copy an editor.</td>
232 </tr><tr>
233 <td><a href="#TabWidget.copyTabOther">copyTabOther</a></td>
234 <td>Public method to copy an editor from another TabWidget.</td>
235 </tr><tr>
236 <td><a href="#TabWidget.currentWidget">currentWidget</a></td>
237 <td>Overridden method to return a reference to the current page.</td>
238 </tr><tr>
239 <td><a href="#TabWidget.hasEditor">hasEditor</a></td>
240 <td>Public method to check for an editor.</td>
241 </tr><tr>
242 <td><a href="#TabWidget.hasEditors">hasEditors</a></td>
243 <td>Public method to test, if any editor is managed.</td>
244 </tr><tr>
245 <td><a href="#TabWidget.insertWidget">insertWidget</a></td>
246 <td>Overwritten method to insert a new tab.</td>
247 </tr><tr>
248 <td><a href="#TabWidget.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td>
249 <td>Protected method handling double click events.</td>
250 </tr><tr>
251 <td><a href="#TabWidget.relocateTab">relocateTab</a></td>
252 <td>Public method to relocate an editor from another TabWidget.</td>
253 </tr><tr>
254 <td><a href="#TabWidget.removeWidget">removeWidget</a></td>
255 <td>Public method to remove a widget.</td>
256 </tr><tr>
257 <td><a href="#TabWidget.showIndicator">showIndicator</a></td>
258 <td>Public slot to set the indicator on or off.</td>
259 </tr>
260 </table>
261 <a NAME="TabWidget.__init__" ID="TabWidget.__init__"></a>
262 <h4>TabWidget (Constructor)</h4>
263 <b>TabWidget</b>(<i>vm</i>)
264 <p>
265 Constructor
266 </p><dl>
267 <dt><i>vm</i></dt>
268 <dd>
269 view manager widget (Tabview)
270 </dd>
271 </dl><a NAME="TabWidget.__captionChange" ID="TabWidget.__captionChange"></a>
272 <h4>TabWidget.__captionChange</h4>
273 <b>__captionChange</b>(<i>cap, editor</i>)
274 <p>
275 Private method to handle Caption change signals from the editor.
276 </p><p>
277 Updates the tab text and tooltip text to reflect the new caption information.
278 </p><dl>
279 <dt><i>cap</i></dt>
280 <dd>
281 Caption for the editor
282 </dd><dt><i>editor</i></dt>
283 <dd>
284 Editor to update the caption for
285 </dd>
286 </dl><a NAME="TabWidget.__closeButtonClicked" ID="TabWidget.__closeButtonClicked"></a>
287 <h4>TabWidget.__closeButtonClicked</h4>
288 <b>__closeButtonClicked</b>(<i></i>)
289 <p>
290 Private method to handle the press of the close button.
291 </p><a NAME="TabWidget.__closeRequested" ID="TabWidget.__closeRequested"></a>
292 <h4>TabWidget.__closeRequested</h4>
293 <b>__closeRequested</b>(<i>index</i>)
294 <p>
295 Private method to handle the press of the individual tab close button.
296 </p><dl>
297 <dt><i>index</i></dt>
298 <dd>
299 index of the tab (integer)
300 </dd>
301 </dl><a NAME="TabWidget.__contextMenuClose" ID="TabWidget.__contextMenuClose"></a>
302 <h4>TabWidget.__contextMenuClose</h4>
303 <b>__contextMenuClose</b>(<i></i>)
304 <p>
305 Private method to close the selected tab.
306 </p><a NAME="TabWidget.__contextMenuCloseAll" ID="TabWidget.__contextMenuCloseAll"></a>
307 <h4>TabWidget.__contextMenuCloseAll</h4>
308 <b>__contextMenuCloseAll</b>(<i></i>)
309 <p>
310 Private method to close all tabs.
311 </p><a NAME="TabWidget.__contextMenuCloseOthers" ID="TabWidget.__contextMenuCloseOthers"></a>
312 <h4>TabWidget.__contextMenuCloseOthers</h4>
313 <b>__contextMenuCloseOthers</b>(<i></i>)
314 <p>
315 Private method to close the other tabs.
316 </p><a NAME="TabWidget.__contextMenuMoveFirst" ID="TabWidget.__contextMenuMoveFirst"></a>
317 <h4>TabWidget.__contextMenuMoveFirst</h4>
318 <b>__contextMenuMoveFirst</b>(<i></i>)
319 <p>
320 Private method to move a tab to the first position.
321 </p><a NAME="TabWidget.__contextMenuMoveLast" ID="TabWidget.__contextMenuMoveLast"></a>
322 <h4>TabWidget.__contextMenuMoveLast</h4>
323 <b>__contextMenuMoveLast</b>(<i></i>)
324 <p>
325 Private method to move a tab to the last position.
326 </p><a NAME="TabWidget.__contextMenuMoveLeft" ID="TabWidget.__contextMenuMoveLeft"></a>
327 <h4>TabWidget.__contextMenuMoveLeft</h4>
328 <b>__contextMenuMoveLeft</b>(<i></i>)
329 <p>
330 Private method to move a tab one position to the left.
331 </p><a NAME="TabWidget.__contextMenuMoveRight" ID="TabWidget.__contextMenuMoveRight"></a>
332 <h4>TabWidget.__contextMenuMoveRight</h4>
333 <b>__contextMenuMoveRight</b>(<i></i>)
334 <p>
335 Private method to move a tab one position to the right.
336 </p><a NAME="TabWidget.__contextMenuPrintFile" ID="TabWidget.__contextMenuPrintFile"></a>
337 <h4>TabWidget.__contextMenuPrintFile</h4>
338 <b>__contextMenuPrintFile</b>(<i></i>)
339 <p>
340 Private method to print the selected tab.
341 </p><a NAME="TabWidget.__contextMenuSave" ID="TabWidget.__contextMenuSave"></a>
342 <h4>TabWidget.__contextMenuSave</h4>
343 <b>__contextMenuSave</b>(<i></i>)
344 <p>
345 Private method to save the selected tab.
346 </p><a NAME="TabWidget.__contextMenuSaveAll" ID="TabWidget.__contextMenuSaveAll"></a>
347 <h4>TabWidget.__contextMenuSaveAll</h4>
348 <b>__contextMenuSaveAll</b>(<i></i>)
349 <p>
350 Private method to save all tabs.
351 </p><a NAME="TabWidget.__contextMenuSaveAs" ID="TabWidget.__contextMenuSaveAs"></a>
352 <h4>TabWidget.__contextMenuSaveAs</h4>
353 <b>__contextMenuSaveAs</b>(<i></i>)
354 <p>
355 Private method to save the selected tab to a new file.
356 </p><a NAME="TabWidget.__contextMenuSaveToProject" ID="TabWidget.__contextMenuSaveToProject"></a>
357 <h4>TabWidget.__contextMenuSaveToProject</h4>
358 <b>__contextMenuSaveToProject</b>(<i></i>)
359 <p>
360 Private method to save the selected tab to the current project.
361 </p><a NAME="TabWidget.__initMenu" ID="TabWidget.__initMenu"></a>
362 <h4>TabWidget.__initMenu</h4>
363 <b>__initMenu</b>(<i></i>)
364 <p>
365 Private method to initialize the tab context menu.
366 </p><a NAME="TabWidget.__navigationMenuTriggered" ID="TabWidget.__navigationMenuTriggered"></a>
367 <h4>TabWidget.__navigationMenuTriggered</h4>
368 <b>__navigationMenuTriggered</b>(<i>act</i>)
369 <p>
370 Private slot called to handle the navigation button menu selection.
371 </p><dl>
372 <dt><i>act</i></dt>
373 <dd>
374 reference to the selected action (QAction)
375 </dd>
376 </dl><a NAME="TabWidget.__showContextMenu" ID="TabWidget.__showContextMenu"></a>
377 <h4>TabWidget.__showContextMenu</h4>
378 <b>__showContextMenu</b>(<i>coord, index</i>)
379 <p>
380 Private slot to show the tab context menu.
381 </p><dl>
382 <dt><i>coord</i></dt>
383 <dd>
384 the position of the mouse pointer (QPoint)
385 </dd><dt><i>index</i></dt>
386 <dd>
387 index of the tab the menu is requested for (integer)
388 </dd>
389 </dl><a NAME="TabWidget.__showNavigationMenu" ID="TabWidget.__showNavigationMenu"></a>
390 <h4>TabWidget.__showNavigationMenu</h4>
391 <b>__showNavigationMenu</b>(<i></i>)
392 <p>
393 Private slot to show the navigation button menu.
394 </p><a NAME="TabWidget.addTab" ID="TabWidget.addTab"></a>
395 <h4>TabWidget.addTab</h4>
396 <b>addTab</b>(<i>editor, title</i>)
397 <p>
398 Overwritten method to add a new tab.
399 </p><dl>
400 <dt><i>editor</i></dt>
401 <dd>
402 the editor object to be added (QScintilla.Editor.Editor)
403 </dd><dt><i>title</i></dt>
404 <dd>
405 title for the new tab (string)
406 </dd>
407 </dl><a NAME="TabWidget.copyTab" ID="TabWidget.copyTab"></a>
408 <h4>TabWidget.copyTab</h4>
409 <b>copyTab</b>(<i>sourceIndex, targetIndex</i>)
410 <p>
411 Public method to copy an editor.
412 </p><dl>
413 <dt><i>sourceIndex</i></dt>
414 <dd>
415 index of the tab (integer)
416 </dd><dt><i>targetIndex</i></dt>
417 <dd>
418 index position to place it to (integer)
419 </dd>
420 </dl><a NAME="TabWidget.copyTabOther" ID="TabWidget.copyTabOther"></a>
421 <h4>TabWidget.copyTabOther</h4>
422 <b>copyTabOther</b>(<i>sourceId, sourceIndex, targetIndex</i>)
423 <p>
424 Public method to copy an editor from another TabWidget.
425 </p><dl>
426 <dt><i>sourceId</i></dt>
427 <dd>
428 id of the TabWidget to get the editor from (long)
429 </dd><dt><i>sourceIndex</i></dt>
430 <dd>
431 index of the tab in the old tab widget (integer)
432 </dd><dt><i>targetIndex</i></dt>
433 <dd>
434 index position to place it to (integer)
435 </dd>
436 </dl><a NAME="TabWidget.currentWidget" ID="TabWidget.currentWidget"></a>
437 <h4>TabWidget.currentWidget</h4>
438 <b>currentWidget</b>(<i></i>)
439 <p>
440 Overridden method to return a reference to the current page.
441 </p><dl>
442 <dt>Returns:</dt>
443 <dd>
444 reference to the current page (QWidget)
445 </dd>
446 </dl><a NAME="TabWidget.hasEditor" ID="TabWidget.hasEditor"></a>
447 <h4>TabWidget.hasEditor</h4>
448 <b>hasEditor</b>(<i>editor</i>)
449 <p>
450 Public method to check for an editor.
451 </p><dl>
452 <dt><i>editor</i></dt>
453 <dd>
454 editor object to check for
455 </dd>
456 </dl><dl>
457 <dt>Returns:</dt>
458 <dd>
459 flag indicating, whether the editor to be checked belongs
460 to the list of editors managed by this tab widget.
461 </dd>
462 </dl><a NAME="TabWidget.hasEditors" ID="TabWidget.hasEditors"></a>
463 <h4>TabWidget.hasEditors</h4>
464 <b>hasEditors</b>(<i></i>)
465 <p>
466 Public method to test, if any editor is managed.
467 </p><dl>
468 <dt>Returns:</dt>
469 <dd>
470 flag indicating editors are managed
471 </dd>
472 </dl><a NAME="TabWidget.insertWidget" ID="TabWidget.insertWidget"></a>
473 <h4>TabWidget.insertWidget</h4>
474 <b>insertWidget</b>(<i>index, editor, title</i>)
475 <p>
476 Overwritten method to insert a new tab.
477 </p><dl>
478 <dt><i>index</i></dt>
479 <dd>
480 index position for the new tab (integer)
481 </dd><dt><i>editor</i></dt>
482 <dd>
483 the editor object to be added (QScintilla.Editor.Editor)
484 </dd><dt><i>title</i></dt>
485 <dd>
486 title for the new tab (string)
487 </dd>
488 </dl><dl>
489 <dt>Returns:</dt>
490 <dd>
491 index of the inserted tab (integer)
492 </dd>
493 </dl><a NAME="TabWidget.mouseDoubleClickEvent" ID="TabWidget.mouseDoubleClickEvent"></a>
494 <h4>TabWidget.mouseDoubleClickEvent</h4>
495 <b>mouseDoubleClickEvent</b>(<i>event</i>)
496 <p>
497 Protected method handling double click events.
498 </p><dl>
499 <dt><i>event</i></dt>
500 <dd>
501 reference to the event object (QMouseEvent)
502 </dd>
503 </dl><a NAME="TabWidget.relocateTab" ID="TabWidget.relocateTab"></a>
504 <h4>TabWidget.relocateTab</h4>
505 <b>relocateTab</b>(<i>sourceId, sourceIndex, targetIndex</i>)
506 <p>
507 Public method to relocate an editor from another TabWidget.
508 </p><dl>
509 <dt><i>sourceId</i></dt>
510 <dd>
511 id of the TabWidget to get the editor from (long)
512 </dd><dt><i>sourceIndex</i></dt>
513 <dd>
514 index of the tab in the old tab widget (integer)
515 </dd><dt><i>targetIndex</i></dt>
516 <dd>
517 index position to place it to (integer)
518 </dd>
519 </dl><a NAME="TabWidget.removeWidget" ID="TabWidget.removeWidget"></a>
520 <h4>TabWidget.removeWidget</h4>
521 <b>removeWidget</b>(<i>object</i>)
522 <p>
523 Public method to remove a widget.
524 </p><dl>
525 <dt><i>object</i></dt>
526 <dd>
527 object to be removed (QWidget)
528 </dd>
529 </dl><a NAME="TabWidget.showIndicator" ID="TabWidget.showIndicator"></a>
530 <h4>TabWidget.showIndicator</h4>
531 <b>showIndicator</b>(<i>on</i>)
532 <p>
533 Public slot to set the indicator on or off.
534 </p><dl>
535 <dt><i>on</i></dt>
536 <dd>
537 flag indicating the dtate of the indicator (boolean)
538 </dd>
539 </dl>
540 <div align="right"><a href="#top">Up</a></div>
541 <hr /><hr />
542 <a NAME="Tabview" ID="Tabview"></a>
543 <h2>Tabview</h2>
544 <p>
545 Class implementing a tabbed viewmanager class embedded in a splitter.
546 </p><h4>Signals</h4>
547 <dl>
548 <dt>changeCaption(string)</dt>
549 <dd>
550 emitted if a change of the caption is necessary
551 </dd><dt>editorChanged(string)</dt>
552 <dd>
553 emitted when the current editor has changed
554 </dd>
555 </dl>
556 <h3>Derived from</h3>
557 QSplitter, ViewManager
558 <h3>Class Attributes</h3>
559 <table>
560 <tr><td>None</td></tr>
561 </table>
562 <h3>Methods</h3>
563 <table>
564 <tr>
565 <td><a href="#Tabview.__init__">Tabview</a></td>
566 <td>Constructor</td>
567 </tr><tr>
568 <td><a href="#Tabview.__currentChanged">__currentChanged</a></td>
569 <td>Private slot to handle the currentChanged signal.</td>
570 </tr><tr>
571 <td><a href="#Tabview._addView">_addView</a></td>
572 <td>Protected method to add a view (i.e.</td>
573 </tr><tr>
574 <td><a href="#Tabview._initWindowActions">_initWindowActions</a></td>
575 <td>Protected method to define the user interface actions for window handling.</td>
576 </tr><tr>
577 <td><a href="#Tabview._modificationStatusChanged">_modificationStatusChanged</a></td>
578 <td>Protected slot to handle the modificationStatusChanged signal.</td>
579 </tr><tr>
580 <td><a href="#Tabview._removeAllViews">_removeAllViews</a></td>
581 <td>Protected method to remove all views (i.e.</td>
582 </tr><tr>
583 <td><a href="#Tabview._removeView">_removeView</a></td>
584 <td>Protected method to remove a view (i.e.</td>
585 </tr><tr>
586 <td><a href="#Tabview._showView">_showView</a></td>
587 <td>Protected method to show a view (i.e.</td>
588 </tr><tr>
589 <td><a href="#Tabview._syntaxErrorToggled">_syntaxErrorToggled</a></td>
590 <td>Protected slot to handle the syntaxerrorToggled signal.</td>
591 </tr><tr>
592 <td><a href="#Tabview.activeWindow">activeWindow</a></td>
593 <td>Public method to return the active (i.e.</td>
594 </tr><tr>
595 <td><a href="#Tabview.addSplit">addSplit</a></td>
596 <td>Public method used to split the current view.</td>
597 </tr><tr>
598 <td><a href="#Tabview.canCascade">canCascade</a></td>
599 <td>Public method to signal if cascading of managed windows is available.</td>
600 </tr><tr>
601 <td><a href="#Tabview.canSplit">canSplit</a></td>
602 <td>public method to signal if splitting of the view is available.</td>
603 </tr><tr>
604 <td><a href="#Tabview.canTile">canTile</a></td>
605 <td>Public method to signal if tiling of managed windows is available.</td>
606 </tr><tr>
607 <td><a href="#Tabview.cascade">cascade</a></td>
608 <td>Public method to cascade the managed windows.</td>
609 </tr><tr>
610 <td><a href="#Tabview.eventFilter">eventFilter</a></td>
611 <td>Public method called to filter the event queue.</td>
612 </tr><tr>
613 <td><a href="#Tabview.getTabWidgetById">getTabWidgetById</a></td>
614 <td>Public method to get a reference to a tab widget knowing it's ID.</td>
615 </tr><tr>
616 <td><a href="#Tabview.insertView">insertView</a></td>
617 <td>Protected method to add a view (i.e.</td>
618 </tr><tr>
619 <td><a href="#Tabview.nextSplit">nextSplit</a></td>
620 <td>Public slot used to move to the next split.</td>
621 </tr><tr>
622 <td><a href="#Tabview.preferencesChanged">preferencesChanged</a></td>
623 <td>Public slot to handle the preferencesChanged signal.</td>
624 </tr><tr>
625 <td><a href="#Tabview.prevSplit">prevSplit</a></td>
626 <td>Public slot used to move to the previous split.</td>
627 </tr><tr>
628 <td><a href="#Tabview.removeSplit">removeSplit</a></td>
629 <td>Public method used to remove the current split view.</td>
630 </tr><tr>
631 <td><a href="#Tabview.setEditorName">setEditorName</a></td>
632 <td>Public method to change the displayed name of the editor.</td>
633 </tr><tr>
634 <td><a href="#Tabview.setSplitOrientation">setSplitOrientation</a></td>
635 <td>Public method used to set the orientation of the split view.</td>
636 </tr><tr>
637 <td><a href="#Tabview.showWindowMenu">showWindowMenu</a></td>
638 <td>Public method to set up the viewmanager part of the Window menu.</td>
639 </tr><tr>
640 <td><a href="#Tabview.tile">tile</a></td>
641 <td>Public method to tile the managed windows.</td>
642 </tr>
643 </table>
644 <a NAME="Tabview.__init__" ID="Tabview.__init__"></a>
645 <h4>Tabview (Constructor)</h4>
646 <b>Tabview</b>(<i>parent</i>)
647 <p>
648 Constructor
649 </p><dl>
650 <dt><i>parent</i></dt>
651 <dd>
652 parent widget (QWidget)
653 </dd><dt><i>ui</i></dt>
654 <dd>
655 reference to the main user interface
656 </dd><dt><i>dbs</i></dt>
657 <dd>
658 reference to the debug server object
659 </dd>
660 </dl><a NAME="Tabview.__currentChanged" ID="Tabview.__currentChanged"></a>
661 <h4>Tabview.__currentChanged</h4>
662 <b>__currentChanged</b>(<i>index</i>)
663 <p>
664 Private slot to handle the currentChanged signal.
665 </p><dl>
666 <dt><i>index</i></dt>
667 <dd>
668 index of the current tab (integer)
669 </dd>
670 </dl><a NAME="Tabview._addView" ID="Tabview._addView"></a>
671 <h4>Tabview._addView</h4>
672 <b>_addView</b>(<i>win, fn = None, noName = ""</i>)
673 <p>
674 Protected method to add a view (i.e. window)
675 </p><dl>
676 <dt><i>win</i></dt>
677 <dd>
678 editor window to be added
679 </dd><dt><i>fn</i></dt>
680 <dd>
681 filename of this editor (string)
682 </dd><dt><i>noName</i></dt>
683 <dd>
684 name to be used for an unnamed editor (string)
685 </dd>
686 </dl><a NAME="Tabview._initWindowActions" ID="Tabview._initWindowActions"></a>
687 <h4>Tabview._initWindowActions</h4>
688 <b>_initWindowActions</b>(<i></i>)
689 <p>
690 Protected method to define the user interface actions for window handling.
691 </p><a NAME="Tabview._modificationStatusChanged" ID="Tabview._modificationStatusChanged"></a>
692 <h4>Tabview._modificationStatusChanged</h4>
693 <b>_modificationStatusChanged</b>(<i>m, editor</i>)
694 <p>
695 Protected slot to handle the modificationStatusChanged signal.
696 </p><dl>
697 <dt><i>m</i></dt>
698 <dd>
699 flag indicating the modification status (boolean)
700 </dd><dt><i>editor</i></dt>
701 <dd>
702 editor window changed
703 </dd>
704 </dl><a NAME="Tabview._removeAllViews" ID="Tabview._removeAllViews"></a>
705 <h4>Tabview._removeAllViews</h4>
706 <b>_removeAllViews</b>(<i></i>)
707 <p>
708 Protected method to remove all views (i.e. windows)
709 </p><a NAME="Tabview._removeView" ID="Tabview._removeView"></a>
710 <h4>Tabview._removeView</h4>
711 <b>_removeView</b>(<i>win</i>)
712 <p>
713 Protected method to remove a view (i.e. window)
714 </p><dl>
715 <dt><i>win</i></dt>
716 <dd>
717 editor window to be removed
718 </dd>
719 </dl><a NAME="Tabview._showView" ID="Tabview._showView"></a>
720 <h4>Tabview._showView</h4>
721 <b>_showView</b>(<i>win, fn = None</i>)
722 <p>
723 Protected method to show a view (i.e. window)
724 </p><dl>
725 <dt><i>win</i></dt>
726 <dd>
727 editor window to be shown
728 </dd><dt><i>fn</i></dt>
729 <dd>
730 filename of this editor (string)
731 </dd>
732 </dl><a NAME="Tabview._syntaxErrorToggled" ID="Tabview._syntaxErrorToggled"></a>
733 <h4>Tabview._syntaxErrorToggled</h4>
734 <b>_syntaxErrorToggled</b>(<i>editor</i>)
735 <p>
736 Protected slot to handle the syntaxerrorToggled signal.
737 </p><dl>
738 <dt><i>editor</i></dt>
739 <dd>
740 editor that sent the signal
741 </dd>
742 </dl><a NAME="Tabview.activeWindow" ID="Tabview.activeWindow"></a>
743 <h4>Tabview.activeWindow</h4>
744 <b>activeWindow</b>(<i></i>)
745 <p>
746 Public method to return the active (i.e. current) window.
747 </p><dl>
748 <dt>Returns:</dt>
749 <dd>
750 reference to the active editor
751 </dd>
752 </dl><a NAME="Tabview.addSplit" ID="Tabview.addSplit"></a>
753 <h4>Tabview.addSplit</h4>
754 <b>addSplit</b>(<i></i>)
755 <p>
756 Public method used to split the current view.
757 </p><a NAME="Tabview.canCascade" ID="Tabview.canCascade"></a>
758 <h4>Tabview.canCascade</h4>
759 <b>canCascade</b>(<i></i>)
760 <p>
761 Public method to signal if cascading of managed windows is available.
762 </p><dl>
763 <dt>Returns:</dt>
764 <dd>
765 flag indicating cascading of windows is available
766 </dd>
767 </dl><a NAME="Tabview.canSplit" ID="Tabview.canSplit"></a>
768 <h4>Tabview.canSplit</h4>
769 <b>canSplit</b>(<i></i>)
770 <p>
771 public method to signal if splitting of the view is available.
772 </p><dl>
773 <dt>Returns:</dt>
774 <dd>
775 flag indicating splitting of the view is available.
776 </dd>
777 </dl><a NAME="Tabview.canTile" ID="Tabview.canTile"></a>
778 <h4>Tabview.canTile</h4>
779 <b>canTile</b>(<i></i>)
780 <p>
781 Public method to signal if tiling of managed windows is available.
782 </p><dl>
783 <dt>Returns:</dt>
784 <dd>
785 flag indicating tiling of windows is available
786 </dd>
787 </dl><a NAME="Tabview.cascade" ID="Tabview.cascade"></a>
788 <h4>Tabview.cascade</h4>
789 <b>cascade</b>(<i></i>)
790 <p>
791 Public method to cascade the managed windows.
792 </p><a NAME="Tabview.eventFilter" ID="Tabview.eventFilter"></a>
793 <h4>Tabview.eventFilter</h4>
794 <b>eventFilter</b>(<i>watched, event</i>)
795 <p>
796 Public method called to filter the event queue.
797 </p><dl>
798 <dt><i>watched</i></dt>
799 <dd>
800 the QObject being watched (QObject)
801 </dd><dt><i>event</i></dt>
802 <dd>
803 the event that occurred (QEvent)
804 </dd>
805 </dl><dl>
806 <dt>Returns:</dt>
807 <dd>
808 always False
809 </dd>
810 </dl><a NAME="Tabview.getTabWidgetById" ID="Tabview.getTabWidgetById"></a>
811 <h4>Tabview.getTabWidgetById</h4>
812 <b>getTabWidgetById</b>(<i>id_</i>)
813 <p>
814 Public method to get a reference to a tab widget knowing it's ID.
815 </p><dl>
816 <dt><i>id_</i></dt>
817 <dd>
818 id of the tab widget (long)
819 </dd>
820 </dl><dl>
821 <dt>Returns:</dt>
822 <dd>
823 reference to the tab widget (TabWidget)
824 </dd>
825 </dl><a NAME="Tabview.insertView" ID="Tabview.insertView"></a>
826 <h4>Tabview.insertView</h4>
827 <b>insertView</b>(<i>win, tabWidget, index, fn = None, noName = ""</i>)
828 <p>
829 Protected method to add a view (i.e. window)
830 </p><dl>
831 <dt><i>win</i></dt>
832 <dd>
833 editor window to be added
834 </dd><dt><i>tabWidget</i></dt>
835 <dd>
836 reference to the tab widget to insert the editor into (TabWidget)
837 </dd><dt><i>index</i></dt>
838 <dd>
839 index position to insert at (integer)
840 </dd><dt><i>fn</i></dt>
841 <dd>
842 filename of this editor (string)
843 </dd><dt><i>noName</i></dt>
844 <dd>
845 name to be used for an unnamed editor (string)
846 </dd>
847 </dl><a NAME="Tabview.nextSplit" ID="Tabview.nextSplit"></a>
848 <h4>Tabview.nextSplit</h4>
849 <b>nextSplit</b>(<i></i>)
850 <p>
851 Public slot used to move to the next split.
852 </p><a NAME="Tabview.preferencesChanged" ID="Tabview.preferencesChanged"></a>
853 <h4>Tabview.preferencesChanged</h4>
854 <b>preferencesChanged</b>(<i></i>)
855 <p>
856 Public slot to handle the preferencesChanged signal.
857 </p><a NAME="Tabview.prevSplit" ID="Tabview.prevSplit"></a>
858 <h4>Tabview.prevSplit</h4>
859 <b>prevSplit</b>(<i></i>)
860 <p>
861 Public slot used to move to the previous split.
862 </p><a NAME="Tabview.removeSplit" ID="Tabview.removeSplit"></a>
863 <h4>Tabview.removeSplit</h4>
864 <b>removeSplit</b>(<i></i>)
865 <p>
866 Public method used to remove the current split view.
867 </p><dl>
868 <dt>Returns:</dt>
869 <dd>
870 flag indicating successfull removal
871 </dd>
872 </dl><a NAME="Tabview.setEditorName" ID="Tabview.setEditorName"></a>
873 <h4>Tabview.setEditorName</h4>
874 <b>setEditorName</b>(<i>editor, newName</i>)
875 <p>
876 Public method to change the displayed name of the editor.
877 </p><dl>
878 <dt><i>editor</i></dt>
879 <dd>
880 editor window to be changed
881 </dd><dt><i>newName</i></dt>
882 <dd>
883 new name to be shown (string)
884 </dd>
885 </dl><a NAME="Tabview.setSplitOrientation" ID="Tabview.setSplitOrientation"></a>
886 <h4>Tabview.setSplitOrientation</h4>
887 <b>setSplitOrientation</b>(<i>orientation</i>)
888 <p>
889 Public method used to set the orientation of the split view.
890 </p><dl>
891 <dt><i>orientation</i></dt>
892 <dd>
893 orientation of the split
894 (Qt.Horizontal or Qt.Vertical)
895 </dd>
896 </dl><a NAME="Tabview.showWindowMenu" ID="Tabview.showWindowMenu"></a>
897 <h4>Tabview.showWindowMenu</h4>
898 <b>showWindowMenu</b>(<i>windowMenu</i>)
899 <p>
900 Public method to set up the viewmanager part of the Window menu.
901 </p><dl>
902 <dt><i>windowMenu</i></dt>
903 <dd>
904 reference to the window menu
905 </dd>
906 </dl><a NAME="Tabview.tile" ID="Tabview.tile"></a>
907 <h4>Tabview.tile</h4>
908 <b>tile</b>(<i></i>)
909 <p>
910 Public method to tile the managed windows.
911 </p>
912 <div align="right"><a href="#top">Up</a></div>
913 <hr />
914 </body></html>

Mercurial Repository: eric

eric ide

mercurial