Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial