Mercurial Repositories > eric / file comparison

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

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

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Plugins.ViewManagerPlugins.MdiArea.MdiArea</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Plugins.ViewManagerPlugins.MdiArea.MdiArea</h1>
24 <p>
25 Module implementing the mdi area viewmanager class.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#MdiArea">MdiArea</a></td>
35 <td>Class implementing the mdi area viewmanager class.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="MdiArea" ID="MdiArea"></a>
44 <h2>MdiArea</h2>
45 <p>
46 Class implementing the mdi area viewmanager class.
47 </p><h4>Signals</h4>
48 <dl>
49 <dt>editorChanged(string)</dt>
50 <dd>
51 emitted when the current editor has changed
52 </dd>
53 </dl>
54 <h3>Derived from</h3>
55 QMdiArea, ViewManager
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#MdiArea.__init__">MdiArea</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#MdiArea.__iconizeAllWindows">__iconizeAllWindows</a></td>
67 <td>Private slot to iconize all windows.</td>
68 </tr><tr>
69 <td><a href="#MdiArea.__restoreAllWindows">__restoreAllWindows</a></td>
70 <td>Private slot to restore all windows.</td>
71 </tr><tr>
72 <td><a href="#MdiArea.__setSubWindowIcon">__setSubWindowIcon</a></td>
73 <td>Private method to set the icon of a subwindow given it's internal widget.</td>
74 </tr><tr>
75 <td><a href="#MdiArea.__subWindowActivated">__subWindowActivated</a></td>
76 <td>Private slot to handle the windowActivated signal.</td>
77 </tr><tr>
78 <td><a href="#MdiArea._addView">_addView</a></td>
79 <td>Protected method to add a view (i.e.</td>
80 </tr><tr>
81 <td><a href="#MdiArea._initWindowActions">_initWindowActions</a></td>
82 <td>Protected method to define the user interface actions for window handling.</td>
83 </tr><tr>
84 <td><a href="#MdiArea._modificationStatusChanged">_modificationStatusChanged</a></td>
85 <td>Protected slot to handle the modificationStatusChanged signal.</td>
86 </tr><tr>
87 <td><a href="#MdiArea._removeAllViews">_removeAllViews</a></td>
88 <td>Protected method to remove all views (i.e.</td>
89 </tr><tr>
90 <td><a href="#MdiArea._removeView">_removeView</a></td>
91 <td>Protected method to remove a view (i.e.</td>
92 </tr><tr>
93 <td><a href="#MdiArea._showView">_showView</a></td>
94 <td>Private method to show a view (i.e.</td>
95 </tr><tr>
96 <td><a href="#MdiArea._syntaxErrorToggled">_syntaxErrorToggled</a></td>
97 <td>Protected slot to handle the syntaxerrorToggled signal.</td>
98 </tr><tr>
99 <td><a href="#MdiArea.activeWindow">activeWindow</a></td>
100 <td>Private method to return the active (i.e.</td>
101 </tr><tr>
102 <td><a href="#MdiArea.canCascade">canCascade</a></td>
103 <td>Public method to signal if cascading of managed windows is available.</td>
104 </tr><tr>
105 <td><a href="#MdiArea.canSplit">canSplit</a></td>
106 <td>public method to signal if splitting of the view is available.</td>
107 </tr><tr>
108 <td><a href="#MdiArea.canTile">canTile</a></td>
109 <td>Public method to signal if tiling of managed windows is available.</td>
110 </tr><tr>
111 <td><a href="#MdiArea.cascade">cascade</a></td>
112 <td>Public method to cascade the managed windows.</td>
113 </tr><tr>
114 <td><a href="#MdiArea.eventFilter">eventFilter</a></td>
115 <td>Public method called to filter the event queue.</td>
116 </tr><tr>
117 <td><a href="#MdiArea.setEditorName">setEditorName</a></td>
118 <td>Public method to change the displayed name of the editor.</td>
119 </tr><tr>
120 <td><a href="#MdiArea.showWindowMenu">showWindowMenu</a></td>
121 <td>Public method to set up the viewmanager part of the Window menu.</td>
122 </tr><tr>
123 <td><a href="#MdiArea.tile">tile</a></td>
124 <td>Public method to tile the managed windows.</td>
125 </tr>
126 </table>
127 <a NAME="MdiArea.__init__" ID="MdiArea.__init__"></a>
128 <h4>MdiArea (Constructor)</h4>
129 <b>MdiArea</b>(<i>parent</i>)
130 <p>
131 Constructor
132 </p><dl>
133 <dt><i>parent</i></dt>
134 <dd>
135 parent widget (QWidget)
136 </dd><dt><i>ui</i></dt>
137 <dd>
138 reference to the main user interface
139 </dd><dt><i>dbs</i></dt>
140 <dd>
141 reference to the debug server object
142 </dd>
143 </dl><a NAME="MdiArea.__iconizeAllWindows" ID="MdiArea.__iconizeAllWindows"></a>
144 <h4>MdiArea.__iconizeAllWindows</h4>
145 <b>__iconizeAllWindows</b>(<i></i>)
146 <p>
147 Private slot to iconize all windows.
148 </p><a NAME="MdiArea.__restoreAllWindows" ID="MdiArea.__restoreAllWindows"></a>
149 <h4>MdiArea.__restoreAllWindows</h4>
150 <b>__restoreAllWindows</b>(<i></i>)
151 <p>
152 Private slot to restore all windows.
153 </p><a NAME="MdiArea.__setSubWindowIcon" ID="MdiArea.__setSubWindowIcon"></a>
154 <h4>MdiArea.__setSubWindowIcon</h4>
155 <b>__setSubWindowIcon</b>(<i>widget, icon</i>)
156 <p>
157 Private method to set the icon of a subwindow given it's internal widget.
158 </p><dl>
159 <dt><i>widget</i></dt>
160 <dd>
161 reference to the internal widget (QWidget)
162 </dd><dt><i>icon</i></dt>
163 <dd>
164 reference to the icon (QIcon)
165 </dd>
166 </dl><a NAME="MdiArea.__subWindowActivated" ID="MdiArea.__subWindowActivated"></a>
167 <h4>MdiArea.__subWindowActivated</h4>
168 <b>__subWindowActivated</b>(<i>subWindow</i>)
169 <p>
170 Private slot to handle the windowActivated signal.
171 </p><dl>
172 <dt><i>subWindow</i></dt>
173 <dd>
174 the activated subwindow (QMdiSubWindow)
175 </dd>
176 </dl><a NAME="MdiArea._addView" ID="MdiArea._addView"></a>
177 <h4>MdiArea._addView</h4>
178 <b>_addView</b>(<i>win, fn = None, noName = ""</i>)
179 <p>
180 Protected method to add a view (i.e. window)
181 </p><dl>
182 <dt><i>win</i></dt>
183 <dd>
184 editor window to be added
185 </dd><dt><i>fn</i></dt>
186 <dd>
187 filename of this editor
188 </dd><dt><i>noName</i></dt>
189 <dd>
190 name to be used for an unnamed editor (string or QString)
191 </dd>
192 </dl><a NAME="MdiArea._initWindowActions" ID="MdiArea._initWindowActions"></a>
193 <h4>MdiArea._initWindowActions</h4>
194 <b>_initWindowActions</b>(<i></i>)
195 <p>
196 Protected method to define the user interface actions for window handling.
197 </p><a NAME="MdiArea._modificationStatusChanged" ID="MdiArea._modificationStatusChanged"></a>
198 <h4>MdiArea._modificationStatusChanged</h4>
199 <b>_modificationStatusChanged</b>(<i>m, editor</i>)
200 <p>
201 Protected slot to handle the modificationStatusChanged signal.
202 </p><dl>
203 <dt><i>m</i></dt>
204 <dd>
205 flag indicating the modification status (boolean)
206 </dd><dt><i>editor</i></dt>
207 <dd>
208 editor window changed
209 </dd>
210 </dl><a NAME="MdiArea._removeAllViews" ID="MdiArea._removeAllViews"></a>
211 <h4>MdiArea._removeAllViews</h4>
212 <b>_removeAllViews</b>(<i></i>)
213 <p>
214 Protected method to remove all views (i.e. windows)
215 </p><a NAME="MdiArea._removeView" ID="MdiArea._removeView"></a>
216 <h4>MdiArea._removeView</h4>
217 <b>_removeView</b>(<i>win</i>)
218 <p>
219 Protected method to remove a view (i.e. window)
220 </p><dl>
221 <dt><i>win</i></dt>
222 <dd>
223 editor window to be removed
224 </dd>
225 </dl><a NAME="MdiArea._showView" ID="MdiArea._showView"></a>
226 <h4>MdiArea._showView</h4>
227 <b>_showView</b>(<i>win, fn = None</i>)
228 <p>
229 Private method to show a view (i.e. window)
230 </p><dl>
231 <dt><i>win</i></dt>
232 <dd>
233 editor window to be shown
234 </dd><dt><i>fn</i></dt>
235 <dd>
236 filename of this editor (string)
237 </dd>
238 </dl><a NAME="MdiArea._syntaxErrorToggled" ID="MdiArea._syntaxErrorToggled"></a>
239 <h4>MdiArea._syntaxErrorToggled</h4>
240 <b>_syntaxErrorToggled</b>(<i>editor</i>)
241 <p>
242 Protected slot to handle the syntaxerrorToggled signal.
243 </p><dl>
244 <dt><i>editor</i></dt>
245 <dd>
246 editor that sent the signal
247 </dd>
248 </dl><a NAME="MdiArea.activeWindow" ID="MdiArea.activeWindow"></a>
249 <h4>MdiArea.activeWindow</h4>
250 <b>activeWindow</b>(<i></i>)
251 <p>
252 Private method to return the active (i.e. current) window.
253 </p><dl>
254 <dt>Returns:</dt>
255 <dd>
256 reference to the active editor
257 </dd>
258 </dl><a NAME="MdiArea.canCascade" ID="MdiArea.canCascade"></a>
259 <h4>MdiArea.canCascade</h4>
260 <b>canCascade</b>(<i></i>)
261 <p>
262 Public method to signal if cascading of managed windows is available.
263 </p><dl>
264 <dt>Returns:</dt>
265 <dd>
266 flag indicating cascading of windows is available
267 </dd>
268 </dl><a NAME="MdiArea.canSplit" ID="MdiArea.canSplit"></a>
269 <h4>MdiArea.canSplit</h4>
270 <b>canSplit</b>(<i></i>)
271 <p>
272 public method to signal if splitting of the view is available.
273 </p><dl>
274 <dt>Returns:</dt>
275 <dd>
276 flag indicating splitting of the view is available.
277 </dd>
278 </dl><a NAME="MdiArea.canTile" ID="MdiArea.canTile"></a>
279 <h4>MdiArea.canTile</h4>
280 <b>canTile</b>(<i></i>)
281 <p>
282 Public method to signal if tiling of managed windows is available.
283 </p><dl>
284 <dt>Returns:</dt>
285 <dd>
286 flag indicating tiling of windows is available
287 </dd>
288 </dl><a NAME="MdiArea.cascade" ID="MdiArea.cascade"></a>
289 <h4>MdiArea.cascade</h4>
290 <b>cascade</b>(<i></i>)
291 <p>
292 Public method to cascade the managed windows.
293 </p><a NAME="MdiArea.eventFilter" ID="MdiArea.eventFilter"></a>
294 <h4>MdiArea.eventFilter</h4>
295 <b>eventFilter</b>(<i>watched, event</i>)
296 <p>
297 Public method called to filter the event queue.
298 </p><dl>
299 <dt><i>watched</i></dt>
300 <dd>
301 the QObject being watched
302 </dd><dt><i>event</i></dt>
303 <dd>
304 the event that occurred
305 </dd>
306 </dl><dl>
307 <dt>Returns:</dt>
308 <dd>
309 flag indicating, whether the event was handled (boolean)
310 </dd>
311 </dl><a NAME="MdiArea.setEditorName" ID="MdiArea.setEditorName"></a>
312 <h4>MdiArea.setEditorName</h4>
313 <b>setEditorName</b>(<i>editor, newName</i>)
314 <p>
315 Public method to change the displayed name of the editor.
316 </p><dl>
317 <dt><i>editor</i></dt>
318 <dd>
319 editor window to be changed
320 </dd><dt><i>newName</i></dt>
321 <dd>
322 new name to be shown (string or QString)
323 </dd>
324 </dl><a NAME="MdiArea.showWindowMenu" ID="MdiArea.showWindowMenu"></a>
325 <h4>MdiArea.showWindowMenu</h4>
326 <b>showWindowMenu</b>(<i>windowMenu</i>)
327 <p>
328 Public method to set up the viewmanager part of the Window menu.
329 </p><dl>
330 <dt><i>windowMenu</i></dt>
331 <dd>
332 reference to the window menu
333 </dd>
334 </dl><a NAME="MdiArea.tile" ID="MdiArea.tile"></a>
335 <h4>MdiArea.tile</h4>
336 <b>tile</b>(<i></i>)
337 <p>
338 Public method to tile the managed windows.
339 </p>
340 <div align="right"><a href="#top">Up</a></div>
341 <hr />
342 </body></html>

Mercurial Repository: eric

eric ide

mercurial