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