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