Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.E5Gui.E5Application.html
eric6/Documentation/Source/eric6.E5Gui.E5Application.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.E5Gui.E5Application</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.E5Gui.E5Application</h1> | |
| 23 <p> | |
| 24 Class implementing a specialized application class. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>e5App</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#E5Application">E5Application</a></td> | |
| 34 <td>Eric application class with an object registry.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="E5Application" ID="E5Application"></a> | |
| 43 <h2>E5Application</h2> | |
| 44 <p> | |
| 45 Eric application class with an object registry. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QApplication | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#E5Application.__init__">E5Application</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#E5Application.getObject">getObject</a></td> | |
| 64 <td>Public method to get a reference to a registered object.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#E5Application.getPluginObject">getPluginObject</a></td> | |
| 67 <td>Public method to get a reference to a registered plugin object.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#E5Application.getPluginObjectType">getPluginObjectType</a></td> | |
| 70 <td>Public method to get the type of a registered plugin object.</td> | |
| 71 </tr><tr> | |
| 72 <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> | |
| 74 </tr><tr> | |
| 75 <td><a href="#E5Application.registerObject">registerObject</a></td> | |
| 76 <td>Public method to register an object in the object registry.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#E5Application.registerPluginObject">registerPluginObject</a></td> | |
| 79 <td>Public method to register a plugin object in the object registry.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#E5Application.unregisterPluginObject">unregisterPluginObject</a></td> | |
| 82 <td>Public method to unregister a plugin object in the object registry.</td> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <h3>Static Methods</h3> | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 <a NAME="E5Application.__init__" ID="E5Application.__init__"></a> | |
| 90 <h4>E5Application (Constructor)</h4> | |
| 91 <b>E5Application</b>(<i>argv</i>) | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p><dl> | |
| 95 <dt><i>argv</i></dt> | |
| 96 <dd> | |
| 97 command line arguments | |
| 98 </dd> | |
| 99 </dl><a NAME="E5Application.getObject" ID="E5Application.getObject"></a> | |
| 100 <h4>E5Application.getObject</h4> | |
| 101 <b>getObject</b>(<i>name</i>) | |
| 102 <p> | |
| 103 Public method to get a reference to a registered object. | |
| 104 </p><dl> | |
| 105 <dt><i>name</i></dt> | |
| 106 <dd> | |
| 107 name of the object (string) | |
| 108 </dd> | |
| 109 </dl><dl> | |
| 110 <dt>Returns:</dt> | |
| 111 <dd> | |
| 112 reference to the registered object | |
| 113 </dd> | |
| 114 </dl><dl> | |
| 115 <dt>Raises <b>KeyError</b>:</dt> | |
| 116 <dd> | |
| 117 raised when the given name is not known | |
| 118 </dd> | |
| 119 </dl><a NAME="E5Application.getPluginObject" ID="E5Application.getPluginObject"></a> | |
| 120 <h4>E5Application.getPluginObject</h4> | |
| 121 <b>getPluginObject</b>(<i>name</i>) | |
| 122 <p> | |
| 123 Public method to get a reference to a registered plugin object. | |
| 124 </p><dl> | |
| 125 <dt><i>name</i></dt> | |
| 126 <dd> | |
| 127 name of the plugin object (string) | |
| 128 </dd> | |
| 129 </dl><dl> | |
| 130 <dt>Returns:</dt> | |
| 131 <dd> | |
| 132 reference to the registered plugin object | |
| 133 </dd> | |
| 134 </dl><dl> | |
| 135 <dt>Raises <b>KeyError</b>:</dt> | |
| 136 <dd> | |
| 137 raised when the given name is not known | |
| 138 </dd> | |
| 139 </dl><a NAME="E5Application.getPluginObjectType" ID="E5Application.getPluginObjectType"></a> | |
| 140 <h4>E5Application.getPluginObjectType</h4> | |
| 141 <b>getPluginObjectType</b>(<i>name</i>) | |
| 142 <p> | |
| 143 Public method to get the type of a registered plugin object. | |
| 144 </p><dl> | |
| 145 <dt><i>name</i></dt> | |
| 146 <dd> | |
| 147 name of the plugin object (string) | |
| 148 </dd> | |
| 149 </dl><dl> | |
| 150 <dt>Returns:</dt> | |
| 151 <dd> | |
| 152 type of the plugin object (string) | |
| 153 </dd> | |
| 154 </dl><dl> | |
| 155 <dt>Raises <b>KeyError</b>:</dt> | |
| 156 <dd> | |
| 157 raised when the given name is not known | |
| 158 </dd> | |
| 159 </dl><a NAME="E5Application.getPluginObjects" ID="E5Application.getPluginObjects"></a> | |
| 160 <h4>E5Application.getPluginObjects</h4> | |
| 161 <b>getPluginObjects</b>(<i></i>) | |
| 162 <p> | |
| 163 Public method to get a list of (name, reference) pairs of all | |
| 164 registered plugin objects. | |
| 165 </p><dl> | |
| 166 <dt>Returns:</dt> | |
| 167 <dd> | |
| 168 list of (name, reference) pairs | |
| 169 </dd> | |
| 170 </dl><a NAME="E5Application.registerObject" ID="E5Application.registerObject"></a> | |
| 171 <h4>E5Application.registerObject</h4> | |
| 172 <b>registerObject</b>(<i>name, objectRef</i>) | |
| 173 <p> | |
| 174 Public method to register an object in the object registry. | |
| 175 </p><dl> | |
| 176 <dt><i>name</i></dt> | |
| 177 <dd> | |
| 178 name of the object (string) | |
| 179 </dd><dt><i>objectRef</i></dt> | |
| 180 <dd> | |
| 181 reference to the object | |
| 182 </dd> | |
| 183 </dl><dl> | |
| 184 <dt>Raises <b>KeyError</b>:</dt> | |
| 185 <dd> | |
| 186 raised when the given name is already in use | |
| 187 </dd> | |
| 188 </dl><a NAME="E5Application.registerPluginObject" ID="E5Application.registerPluginObject"></a> | |
| 189 <h4>E5Application.registerPluginObject</h4> | |
| 190 <b>registerPluginObject</b>(<i>name, objectRef, pluginType=None</i>) | |
| 191 <p> | |
| 192 Public method to register a plugin object in the object registry. | |
| 193 </p><dl> | |
| 194 <dt><i>name</i></dt> | |
| 195 <dd> | |
| 196 name of the plugin object (string) | |
| 197 </dd><dt><i>objectRef</i></dt> | |
| 198 <dd> | |
| 199 reference to the plugin object | |
| 200 </dd><dt><i>pluginType=</i></dt> | |
| 201 <dd> | |
| 202 type of the plugin object (string) | |
| 203 </dd> | |
| 204 </dl><dl> | |
| 205 <dt>Raises <b>KeyError</b>:</dt> | |
| 206 <dd> | |
| 207 raised when the given name is already in use | |
| 208 </dd> | |
| 209 </dl><a NAME="E5Application.unregisterPluginObject" ID="E5Application.unregisterPluginObject"></a> | |
| 210 <h4>E5Application.unregisterPluginObject</h4> | |
| 211 <b>unregisterPluginObject</b>(<i>name</i>) | |
| 212 <p> | |
| 213 Public method to unregister a plugin object in the object registry. | |
| 214 </p><dl> | |
| 215 <dt><i>name</i></dt> | |
| 216 <dd> | |
| 217 name of the plugin object (string) | |
| 218 </dd> | |
| 219 </dl> | |
| 220 <div align="right"><a href="#top">Up</a></div> | |
| 221 <hr /> | |
| 222 </body></html> |
