Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.E5Gui.E5Application.html
Documentation/Source/eric5.E5Gui.E5Application.html
- changeset 55
- b5c84934de9c
- child 58
- 37f0444c3479
equal
deleted
inserted
replaced
| 54:31463df17fd5 | 55:b5c84934de9c |
|---|---|
| 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.E5Gui.E5Application</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>eric5.E5Gui.E5Application</h1> | |
| 24 <p> | |
| 25 Class implementing a specialized application class. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>e5App</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#E5Application">E5Application</a></td> | |
| 35 <td>Eric application class with an object registry.</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="E5Application" ID="E5Application"></a> | |
| 44 <h2>E5Application</h2> | |
| 45 <p> | |
| 46 Eric application class with an object registry. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QApplication | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#E5Application.__init__">E5Application</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#E5Application.getObject">getObject</a></td> | |
| 61 <td>Public method to get a reference to a registered object.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#E5Application.getPluginObject">getPluginObject</a></td> | |
| 64 <td>Public method to get a reference to a registered plugin object.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#E5Application.getPluginObjectType">getPluginObjectType</a></td> | |
| 67 <td>Public method to get the type of a registered plugin object.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#E5Application.getPluginObjects">getPluginObjects</a></td> | |
| 70 <td>Public method to get a list of (name, reference) pairs of all registered plugin objects.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#E5Application.registerObject">registerObject</a></td> | |
| 73 <td>Public method to register an object in the object registry.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#E5Application.registerPluginObject">registerPluginObject</a></td> | |
| 76 <td>Public method to register a plugin object in the object registry.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#E5Application.unregisterPluginObject">unregisterPluginObject</a></td> | |
| 79 <td>Public method to unregister a plugin object in the object registry.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <a NAME="E5Application.__init__" ID="E5Application.__init__"></a> | |
| 83 <h4>E5Application (Constructor)</h4> | |
| 84 <b>E5Application</b>(<i>argv</i>) | |
| 85 <p> | |
| 86 Constructor | |
| 87 </p><dl> | |
| 88 <dt><i>argv</i></dt> | |
| 89 <dd> | |
| 90 command line arguments | |
| 91 </dd> | |
| 92 </dl><a NAME="E5Application.getObject" ID="E5Application.getObject"></a> | |
| 93 <h4>E5Application.getObject</h4> | |
| 94 <b>getObject</b>(<i>name</i>) | |
| 95 <p> | |
| 96 Public method to get a reference to a registered object. | |
| 97 </p><dl> | |
| 98 <dt><i>name</i></dt> | |
| 99 <dd> | |
| 100 name of the object (string) | |
| 101 </dd> | |
| 102 </dl><dl> | |
| 103 <dt>Returns:</dt> | |
| 104 <dd> | |
| 105 reference to the registered object | |
| 106 </dd> | |
| 107 </dl><dl> | |
| 108 <dt>Raises <b>KeyError</b>:</dt> | |
| 109 <dd> | |
| 110 raised when the given name is not known | |
| 111 </dd> | |
| 112 </dl><a NAME="E5Application.getPluginObject" ID="E5Application.getPluginObject"></a> | |
| 113 <h4>E5Application.getPluginObject</h4> | |
| 114 <b>getPluginObject</b>(<i>name</i>) | |
| 115 <p> | |
| 116 Public method to get a reference to a registered plugin object. | |
| 117 </p><dl> | |
| 118 <dt><i>name</i></dt> | |
| 119 <dd> | |
| 120 name of the plugin object (string) | |
| 121 </dd> | |
| 122 </dl><dl> | |
| 123 <dt>Returns:</dt> | |
| 124 <dd> | |
| 125 reference to the registered plugin object | |
| 126 </dd> | |
| 127 </dl><dl> | |
| 128 <dt>Raises <b>KeyError</b>:</dt> | |
| 129 <dd> | |
| 130 raised when the given name is not known | |
| 131 </dd> | |
| 132 </dl><a NAME="E5Application.getPluginObjectType" ID="E5Application.getPluginObjectType"></a> | |
| 133 <h4>E5Application.getPluginObjectType</h4> | |
| 134 <b>getPluginObjectType</b>(<i>name</i>) | |
| 135 <p> | |
| 136 Public method to get the type of a registered plugin object. | |
| 137 </p><dl> | |
| 138 <dt><i>name</i></dt> | |
| 139 <dd> | |
| 140 name of the plugin object (string) | |
| 141 </dd> | |
| 142 </dl><dl> | |
| 143 <dt>Returns:</dt> | |
| 144 <dd> | |
| 145 type of the plugin object (string) | |
| 146 </dd> | |
| 147 </dl><dl> | |
| 148 <dt>Raises <b>KeyError</b>:</dt> | |
| 149 <dd> | |
| 150 raised when the given name is not known | |
| 151 </dd> | |
| 152 </dl><a NAME="E5Application.getPluginObjects" ID="E5Application.getPluginObjects"></a> | |
| 153 <h4>E5Application.getPluginObjects</h4> | |
| 154 <b>getPluginObjects</b>(<i></i>) | |
| 155 <p> | |
| 156 Public method to get a list of (name, reference) pairs of all | |
| 157 registered plugin objects. | |
| 158 </p><dl> | |
| 159 <dt>Returns:</dt> | |
| 160 <dd> | |
| 161 list of (name, reference) pairs | |
| 162 </dd> | |
| 163 </dl><a NAME="E5Application.registerObject" ID="E5Application.registerObject"></a> | |
| 164 <h4>E5Application.registerObject</h4> | |
| 165 <b>registerObject</b>(<i>name, object</i>) | |
| 166 <p> | |
| 167 Public method to register an object in the object registry. | |
| 168 </p><dl> | |
| 169 <dt><i>name</i></dt> | |
| 170 <dd> | |
| 171 name of the object (string) | |
| 172 </dd><dt><i>object</i></dt> | |
| 173 <dd> | |
| 174 reference to the object | |
| 175 </dd> | |
| 176 </dl><dl> | |
| 177 <dt>Raises <b>KeyError</b>:</dt> | |
| 178 <dd> | |
| 179 raised when the given name is already in use | |
| 180 </dd> | |
| 181 </dl><a NAME="E5Application.registerPluginObject" ID="E5Application.registerPluginObject"></a> | |
| 182 <h4>E5Application.registerPluginObject</h4> | |
| 183 <b>registerPluginObject</b>(<i>name, object, pluginType = None</i>) | |
| 184 <p> | |
| 185 Public method to register a plugin object in the object registry. | |
| 186 </p><dl> | |
| 187 <dt><i>name</i></dt> | |
| 188 <dd> | |
| 189 name of the plugin object (string) | |
| 190 </dd><dt><i>object</i></dt> | |
| 191 <dd> | |
| 192 reference to the plugin object | |
| 193 </dd><dt><i>pluginType=</i></dt> | |
| 194 <dd> | |
| 195 type of the plugin object (string) | |
| 196 </dd> | |
| 197 </dl><dl> | |
| 198 <dt>Raises <b>KeyError</b>:</dt> | |
| 199 <dd> | |
| 200 raised when the given name is already in use | |
| 201 </dd> | |
| 202 </dl><a NAME="E5Application.unregisterPluginObject" ID="E5Application.unregisterPluginObject"></a> | |
| 203 <h4>E5Application.unregisterPluginObject</h4> | |
| 204 <b>unregisterPluginObject</b>(<i>name</i>) | |
| 205 <p> | |
| 206 Public method to unregister a plugin object in the object registry. | |
| 207 </p><dl> | |
| 208 <dt><i>name</i></dt> | |
| 209 <dd> | |
| 210 name of the plugin object (string) | |
| 211 </dd> | |
| 212 </dl> | |
| 213 <div align="right"><a href="#top">Up</a></div> | |
| 214 <hr /> | |
| 215 </body></html> |
