Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.E5Gui.E5Application.html
eric6/Documentation/Source/eric6.E5Gui.E5Application.html
- branch
- maintenance
- changeset 7286
- 7eb04391adf7
- parent 7273
- 391d6b7b1eff
- child 7502
- 426f64d419f0
equal
deleted
inserted
replaced
| 7226:babe80d84a3e | 7286:7eb04391adf7 |
|---|---|
| 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.E5Gui.E5Application</h1> | 23 <h1>eric6.E5Gui.E5Application</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Class implementing a specialized application class. | 26 Class implementing a specialized application class. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>e5App</td></tr> | 31 <tr><td>e5App</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#E5Application">E5Application</a></td> | 38 <td><a href="#E5Application">E5Application</a></td> |
| 34 <td>Eric application class with an object registry.</td> | 39 <td>Eric application class with an object registry.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 39 <tr><td>None</td></tr> | 44 <table> |
| 40 </table> | 45 <tr><td>None</td></tr> |
| 41 <hr /><hr /> | 46 </table> |
| 47 <hr /> | |
| 48 <hr /> | |
| 42 <a NAME="E5Application" ID="E5Application"></a> | 49 <a NAME="E5Application" ID="E5Application"></a> |
| 43 <h2>E5Application</h2> | 50 <h2>E5Application</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Eric application class with an object registry. | 53 Eric application class with an object registry. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QApplication | 56 QApplication |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 58 <table> | 68 |
| 69 <table> | |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#E5Application.__init__">E5Application</a></td> | 72 <td><a href="#E5Application.__init__">E5Application</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#E5Application.getObject">getObject</a></td> | 76 <td><a href="#E5Application.getObject">getObject</a></td> |
| 64 <td>Public method to get a reference to a registered object.</td> | 77 <td>Public method to get a reference to a registered object.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#E5Application.getPluginObject">getPluginObject</a></td> | 80 <td><a href="#E5Application.getPluginObject">getPluginObject</a></td> |
| 67 <td>Public method to get a reference to a registered plugin object.</td> | 81 <td>Public method to get a reference to a registered plugin object.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#E5Application.getPluginObjectType">getPluginObjectType</a></td> | 84 <td><a href="#E5Application.getPluginObjectType">getPluginObjectType</a></td> |
| 70 <td>Public method to get the type of a registered plugin object.</td> | 85 <td>Public method to get the type of a registered plugin object.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#E5Application.getPluginObjects">getPluginObjects</a></td> | 88 <td><a href="#E5Application.getPluginObjects">getPluginObjects</a></td> |
| 73 <td>Public method to get a list of (name, reference) pairs of all registered plugin objects.</td> | 89 <td>Public method to get a list of (name, reference) pairs of all registered plugin objects.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#E5Application.registerObject">registerObject</a></td> | 92 <td><a href="#E5Application.registerObject">registerObject</a></td> |
| 76 <td>Public method to register an object in the object registry.</td> | 93 <td>Public method to register an object in the object registry.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#E5Application.registerPluginObject">registerPluginObject</a></td> | 96 <td><a href="#E5Application.registerPluginObject">registerPluginObject</a></td> |
| 79 <td>Public method to register a plugin object in the object registry.</td> | 97 <td>Public method to register a plugin object in the object registry.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#E5Application.unregisterPluginObject">unregisterPluginObject</a></td> | 100 <td><a href="#E5Application.unregisterPluginObject">unregisterPluginObject</a></td> |
| 82 <td>Public method to unregister a plugin object in the object registry.</td> | 101 <td>Public method to unregister a plugin object in the object registry.</td> |
| 83 </tr> | 102 </tr> |
| 84 </table> | 103 </table> |
| 85 <h3>Static Methods</h3> | 104 <h3>Static Methods</h3> |
| 86 <table> | 105 |
| 87 <tr><td>None</td></tr> | 106 <table> |
| 88 </table> | 107 <tr><td>None</td></tr> |
| 108 </table> | |
| 109 | |
| 89 <a NAME="E5Application.__init__" ID="E5Application.__init__"></a> | 110 <a NAME="E5Application.__init__" ID="E5Application.__init__"></a> |
| 90 <h4>E5Application (Constructor)</h4> | 111 <h4>E5Application (Constructor)</h4> |
| 91 <b>E5Application</b>(<i>argv</i>) | 112 <b>E5Application</b>(<i>argv</i>) |
| 113 | |
| 92 <p> | 114 <p> |
| 93 Constructor | 115 Constructor |
| 94 </p><dl> | 116 </p> |
| 117 <dl> | |
| 118 | |
| 95 <dt><i>argv</i></dt> | 119 <dt><i>argv</i></dt> |
| 96 <dd> | 120 <dd> |
| 97 command line arguments | 121 command line arguments |
| 98 </dd> | 122 </dd> |
| 99 </dl><a NAME="E5Application.getObject" ID="E5Application.getObject"></a> | 123 </dl> |
| 124 <a NAME="E5Application.getObject" ID="E5Application.getObject"></a> | |
| 100 <h4>E5Application.getObject</h4> | 125 <h4>E5Application.getObject</h4> |
| 101 <b>getObject</b>(<i>name</i>) | 126 <b>getObject</b>(<i>name</i>) |
| 127 | |
| 102 <p> | 128 <p> |
| 103 Public method to get a reference to a registered object. | 129 Public method to get a reference to a registered object. |
| 104 </p><dl> | 130 </p> |
| 131 <dl> | |
| 132 | |
| 105 <dt><i>name</i></dt> | 133 <dt><i>name</i></dt> |
| 106 <dd> | 134 <dd> |
| 107 name of the object (string) | 135 name of the object (string) |
| 108 </dd> | 136 </dd> |
| 109 </dl><dl> | 137 </dl> |
| 138 <dl> | |
| 110 <dt>Returns:</dt> | 139 <dt>Returns:</dt> |
| 111 <dd> | 140 <dd> |
| 112 reference to the registered object | 141 reference to the registered object |
| 113 </dd> | 142 </dd> |
| 114 </dl><dl> | 143 </dl> |
| 144 <dl> | |
| 145 | |
| 115 <dt>Raises <b>KeyError</b>:</dt> | 146 <dt>Raises <b>KeyError</b>:</dt> |
| 116 <dd> | 147 <dd> |
| 117 raised when the given name is not known | 148 raised when the given name is not known |
| 118 </dd> | 149 </dd> |
| 119 </dl><a NAME="E5Application.getPluginObject" ID="E5Application.getPluginObject"></a> | 150 </dl> |
| 151 <a NAME="E5Application.getPluginObject" ID="E5Application.getPluginObject"></a> | |
| 120 <h4>E5Application.getPluginObject</h4> | 152 <h4>E5Application.getPluginObject</h4> |
| 121 <b>getPluginObject</b>(<i>name</i>) | 153 <b>getPluginObject</b>(<i>name</i>) |
| 154 | |
| 122 <p> | 155 <p> |
| 123 Public method to get a reference to a registered plugin object. | 156 Public method to get a reference to a registered plugin object. |
| 124 </p><dl> | 157 </p> |
| 125 <dt><i>name</i></dt> | 158 <dl> |
| 126 <dd> | 159 |
| 127 name of the plugin object (string) | 160 <dt><i>name</i></dt> |
| 128 </dd> | 161 <dd> |
| 129 </dl><dl> | 162 name of the plugin object (string) |
| 163 </dd> | |
| 164 </dl> | |
| 165 <dl> | |
| 130 <dt>Returns:</dt> | 166 <dt>Returns:</dt> |
| 131 <dd> | 167 <dd> |
| 132 reference to the registered plugin object | 168 reference to the registered plugin object |
| 133 </dd> | 169 </dd> |
| 134 </dl><dl> | 170 </dl> |
| 171 <dl> | |
| 172 | |
| 135 <dt>Raises <b>KeyError</b>:</dt> | 173 <dt>Raises <b>KeyError</b>:</dt> |
| 136 <dd> | 174 <dd> |
| 137 raised when the given name is not known | 175 raised when the given name is not known |
| 138 </dd> | 176 </dd> |
| 139 </dl><a NAME="E5Application.getPluginObjectType" ID="E5Application.getPluginObjectType"></a> | 177 </dl> |
| 178 <a NAME="E5Application.getPluginObjectType" ID="E5Application.getPluginObjectType"></a> | |
| 140 <h4>E5Application.getPluginObjectType</h4> | 179 <h4>E5Application.getPluginObjectType</h4> |
| 141 <b>getPluginObjectType</b>(<i>name</i>) | 180 <b>getPluginObjectType</b>(<i>name</i>) |
| 181 | |
| 142 <p> | 182 <p> |
| 143 Public method to get the type of a registered plugin object. | 183 Public method to get the type of a registered plugin object. |
| 144 </p><dl> | 184 </p> |
| 145 <dt><i>name</i></dt> | 185 <dl> |
| 146 <dd> | 186 |
| 147 name of the plugin object (string) | 187 <dt><i>name</i></dt> |
| 148 </dd> | 188 <dd> |
| 149 </dl><dl> | 189 name of the plugin object (string) |
| 190 </dd> | |
| 191 </dl> | |
| 192 <dl> | |
| 150 <dt>Returns:</dt> | 193 <dt>Returns:</dt> |
| 151 <dd> | 194 <dd> |
| 152 type of the plugin object (string) | 195 type of the plugin object (string) |
| 153 </dd> | 196 </dd> |
| 154 </dl><dl> | 197 </dl> |
| 198 <dl> | |
| 199 | |
| 155 <dt>Raises <b>KeyError</b>:</dt> | 200 <dt>Raises <b>KeyError</b>:</dt> |
| 156 <dd> | 201 <dd> |
| 157 raised when the given name is not known | 202 raised when the given name is not known |
| 158 </dd> | 203 </dd> |
| 159 </dl><a NAME="E5Application.getPluginObjects" ID="E5Application.getPluginObjects"></a> | 204 </dl> |
| 205 <a NAME="E5Application.getPluginObjects" ID="E5Application.getPluginObjects"></a> | |
| 160 <h4>E5Application.getPluginObjects</h4> | 206 <h4>E5Application.getPluginObjects</h4> |
| 161 <b>getPluginObjects</b>(<i></i>) | 207 <b>getPluginObjects</b>(<i></i>) |
| 208 | |
| 162 <p> | 209 <p> |
| 163 Public method to get a list of (name, reference) pairs of all | 210 Public method to get a list of (name, reference) pairs of all |
| 164 registered plugin objects. | 211 registered plugin objects. |
| 165 </p><dl> | 212 </p> |
| 213 <dl> | |
| 166 <dt>Returns:</dt> | 214 <dt>Returns:</dt> |
| 167 <dd> | 215 <dd> |
| 168 list of (name, reference) pairs | 216 list of (name, reference) pairs |
| 169 </dd> | 217 </dd> |
| 170 </dl><a NAME="E5Application.registerObject" ID="E5Application.registerObject"></a> | 218 </dl> |
| 219 <a NAME="E5Application.registerObject" ID="E5Application.registerObject"></a> | |
| 171 <h4>E5Application.registerObject</h4> | 220 <h4>E5Application.registerObject</h4> |
| 172 <b>registerObject</b>(<i>name, objectRef</i>) | 221 <b>registerObject</b>(<i>name, objectRef</i>) |
| 222 | |
| 173 <p> | 223 <p> |
| 174 Public method to register an object in the object registry. | 224 Public method to register an object in the object registry. |
| 175 </p><dl> | 225 </p> |
| 226 <dl> | |
| 227 | |
| 176 <dt><i>name</i></dt> | 228 <dt><i>name</i></dt> |
| 177 <dd> | 229 <dd> |
| 178 name of the object (string) | 230 name of the object (string) |
| 179 </dd><dt><i>objectRef</i></dt> | 231 </dd> |
| 232 <dt><i>objectRef</i></dt> | |
| 180 <dd> | 233 <dd> |
| 181 reference to the object | 234 reference to the object |
| 182 </dd> | 235 </dd> |
| 183 </dl><dl> | 236 </dl> |
| 237 <dl> | |
| 238 | |
| 184 <dt>Raises <b>KeyError</b>:</dt> | 239 <dt>Raises <b>KeyError</b>:</dt> |
| 185 <dd> | 240 <dd> |
| 186 raised when the given name is already in use | 241 raised when the given name is already in use |
| 187 </dd> | 242 </dd> |
| 188 </dl><a NAME="E5Application.registerPluginObject" ID="E5Application.registerPluginObject"></a> | 243 </dl> |
| 244 <a NAME="E5Application.registerPluginObject" ID="E5Application.registerPluginObject"></a> | |
| 189 <h4>E5Application.registerPluginObject</h4> | 245 <h4>E5Application.registerPluginObject</h4> |
| 190 <b>registerPluginObject</b>(<i>name, objectRef, pluginType=None</i>) | 246 <b>registerPluginObject</b>(<i>name, objectRef, pluginType=None</i>) |
| 247 | |
| 191 <p> | 248 <p> |
| 192 Public method to register a plugin object in the object registry. | 249 Public method to register a plugin object in the object registry. |
| 193 </p><dl> | 250 </p> |
| 194 <dt><i>name</i></dt> | 251 <dl> |
| 195 <dd> | 252 |
| 196 name of the plugin object (string) | 253 <dt><i>name</i></dt> |
| 197 </dd><dt><i>objectRef</i></dt> | 254 <dd> |
| 255 name of the plugin object (string) | |
| 256 </dd> | |
| 257 <dt><i>objectRef</i></dt> | |
| 198 <dd> | 258 <dd> |
| 199 reference to the plugin object | 259 reference to the plugin object |
| 200 </dd><dt><i>pluginType=</i></dt> | 260 </dd> |
| 261 <dt><i>pluginType=</i></dt> | |
| 201 <dd> | 262 <dd> |
| 202 type of the plugin object (string) | 263 type of the plugin object (string) |
| 203 </dd> | 264 </dd> |
| 204 </dl><dl> | 265 </dl> |
| 266 <dl> | |
| 267 | |
| 205 <dt>Raises <b>KeyError</b>:</dt> | 268 <dt>Raises <b>KeyError</b>:</dt> |
| 206 <dd> | 269 <dd> |
| 207 raised when the given name is already in use | 270 raised when the given name is already in use |
| 208 </dd> | 271 </dd> |
| 209 </dl><a NAME="E5Application.unregisterPluginObject" ID="E5Application.unregisterPluginObject"></a> | 272 </dl> |
| 273 <a NAME="E5Application.unregisterPluginObject" ID="E5Application.unregisterPluginObject"></a> | |
| 210 <h4>E5Application.unregisterPluginObject</h4> | 274 <h4>E5Application.unregisterPluginObject</h4> |
| 211 <b>unregisterPluginObject</b>(<i>name</i>) | 275 <b>unregisterPluginObject</b>(<i>name</i>) |
| 276 | |
| 212 <p> | 277 <p> |
| 213 Public method to unregister a plugin object in the object registry. | 278 Public method to unregister a plugin object in the object registry. |
| 214 </p><dl> | 279 </p> |
| 280 <dl> | |
| 281 | |
| 215 <dt><i>name</i></dt> | 282 <dt><i>name</i></dt> |
| 216 <dd> | 283 <dd> |
| 217 name of the plugin object (string) | 284 name of the plugin object (string) |
| 218 </dd> | 285 </dd> |
| 219 </dl> | 286 </dl> |
