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