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

Mercurial Repository: eric

eric ide

mercurial