Mercurial Repositories > Eric Assistant / file comparison
comparison: AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html
AssistantEric/Documentation/source/Plugin_Assistant_Eric.PluginAssistantEric.html
- branch
- eric7
- changeset 180
- 89ff060ef0d9
- parent 177
- 25cb41783971
- child 193
- e1b0e65903d9
equal
deleted
inserted
replaced
| 179:62d9dc4eedd5 | 180:89ff060ef0d9 |
|---|---|
| 108 <td><a href="#AssistantEricPlugin.deactivate">deactivate</a></td> | 108 <td><a href="#AssistantEricPlugin.deactivate">deactivate</a></td> |
| 109 <td>Public method to deactivate this plugin.</td> | 109 <td>Public method to deactivate this plugin.</td> |
| 110 </tr> | 110 </tr> |
| 111 <tr> | 111 <tr> |
| 112 <td><a href="#AssistantEricPlugin.getPreferences">getPreferences</a></td> | 112 <td><a href="#AssistantEricPlugin.getPreferences">getPreferences</a></td> |
| 113 <td>Public method to retrieve the various refactoring settings.</td> | 113 <td>Public method to retrieve the various settings.</td> |
| 114 </tr> | 114 </tr> |
| 115 <tr> | 115 <tr> |
| 116 <td><a href="#AssistantEricPlugin.setPreferences">setPreferences</a></td> | 116 <td><a href="#AssistantEricPlugin.setPreferences">setPreferences</a></td> |
| 117 <td>Public method to store the various refactoring settings.</td> | 117 <td>Public method to store the various settings.</td> |
| 118 </tr> | 118 </tr> |
| 119 </table> | 119 </table> |
| 120 <h3>Static Methods</h3> | 120 <h3>Static Methods</h3> |
| 121 | 121 |
| 122 <table> | 122 <table> |
| 130 <p> | 130 <p> |
| 131 Constructor | 131 Constructor |
| 132 </p> | 132 </p> |
| 133 <dl> | 133 <dl> |
| 134 | 134 |
| 135 <dt><i>ui</i></dt> | 135 <dt><i>ui</i> (UserInterface)</dt> |
| 136 <dd> | 136 <dd> |
| 137 reference to the user interface object (UI.UserInterface) | 137 reference to the user interface object |
| 138 </dd> | 138 </dd> |
| 139 </dl> | 139 </dl> |
| 140 <a NAME="AssistantEricPlugin.__checkQSql" ID="AssistantEricPlugin.__checkQSql"></a> | 140 <a NAME="AssistantEricPlugin.__checkQSql" ID="AssistantEricPlugin.__checkQSql"></a> |
| 141 <h4>AssistantEricPlugin.__checkQSql</h4> | 141 <h4>AssistantEricPlugin.__checkQSql</h4> |
| 142 <b>__checkQSql</b>(<i></i>) | 142 <b>__checkQSql</b>(<i></i>) |
| 145 Private method to perform some checks on QSql. | 145 Private method to perform some checks on QSql. |
| 146 </p> | 146 </p> |
| 147 <dl> | 147 <dl> |
| 148 <dt>Return:</dt> | 148 <dt>Return:</dt> |
| 149 <dd> | 149 <dd> |
| 150 flag indicating QSql is ok (boolean) | 150 flag indicating QSql is ok |
| 151 </dd> | |
| 152 </dl> | |
| 153 <dl> | |
| 154 <dt>Return Type:</dt> | |
| 155 <dd> | |
| 156 bool | |
| 151 </dd> | 157 </dd> |
| 152 </dl> | 158 </dl> |
| 153 <a NAME="AssistantEricPlugin.__initialize" ID="AssistantEricPlugin.__initialize"></a> | 159 <a NAME="AssistantEricPlugin.__initialize" ID="AssistantEricPlugin.__initialize"></a> |
| 154 <h4>AssistantEricPlugin.__initialize</h4> | 160 <h4>AssistantEricPlugin.__initialize</h4> |
| 155 <b>__initialize</b>(<i></i>) | 161 <b>__initialize</b>(<i></i>) |
| 172 Public method to activate this plugin. | 178 Public method to activate this plugin. |
| 173 </p> | 179 </p> |
| 174 <dl> | 180 <dl> |
| 175 <dt>Return:</dt> | 181 <dt>Return:</dt> |
| 176 <dd> | 182 <dd> |
| 177 tuple of None and activation status (boolean) | 183 tuple of None and activation status |
| 184 </dd> | |
| 185 </dl> | |
| 186 <dl> | |
| 187 <dt>Return Type:</dt> | |
| 188 <dd> | |
| 189 bool | |
| 178 </dd> | 190 </dd> |
| 179 </dl> | 191 </dl> |
| 180 <a NAME="AssistantEricPlugin.deactivate" ID="AssistantEricPlugin.deactivate"></a> | 192 <a NAME="AssistantEricPlugin.deactivate" ID="AssistantEricPlugin.deactivate"></a> |
| 181 <h4>AssistantEricPlugin.deactivate</h4> | 193 <h4>AssistantEricPlugin.deactivate</h4> |
| 182 <b>deactivate</b>(<i></i>) | 194 <b>deactivate</b>(<i></i>) |
| 187 <a NAME="AssistantEricPlugin.getPreferences" ID="AssistantEricPlugin.getPreferences"></a> | 199 <a NAME="AssistantEricPlugin.getPreferences" ID="AssistantEricPlugin.getPreferences"></a> |
| 188 <h4>AssistantEricPlugin.getPreferences</h4> | 200 <h4>AssistantEricPlugin.getPreferences</h4> |
| 189 <b>getPreferences</b>(<i>key</i>) | 201 <b>getPreferences</b>(<i>key</i>) |
| 190 | 202 |
| 191 <p> | 203 <p> |
| 192 Public method to retrieve the various refactoring settings. | 204 Public method to retrieve the various settings. |
| 193 </p> | 205 </p> |
| 194 <dl> | 206 <dl> |
| 195 | 207 |
| 196 <dt><i>key</i></dt> | 208 <dt><i>key</i> (str)</dt> |
| 197 <dd> | 209 <dd> |
| 198 the key of the value to get | 210 the key of the value to get |
| 199 </dd> | 211 </dd> |
| 200 </dl> | 212 </dl> |
| 201 <dl> | 213 <dl> |
| 202 <dt>Return:</dt> | 214 <dt>Return:</dt> |
| 203 <dd> | 215 <dd> |
| 204 the requested refactoring setting | 216 value of the requested setting |
| 217 </dd> | |
| 218 </dl> | |
| 219 <dl> | |
| 220 <dt>Return Type:</dt> | |
| 221 <dd> | |
| 222 Any | |
| 205 </dd> | 223 </dd> |
| 206 </dl> | 224 </dl> |
| 207 <a NAME="AssistantEricPlugin.setPreferences" ID="AssistantEricPlugin.setPreferences"></a> | 225 <a NAME="AssistantEricPlugin.setPreferences" ID="AssistantEricPlugin.setPreferences"></a> |
| 208 <h4>AssistantEricPlugin.setPreferences</h4> | 226 <h4>AssistantEricPlugin.setPreferences</h4> |
| 209 <b>setPreferences</b>(<i>key, value</i>) | 227 <b>setPreferences</b>(<i>key, value</i>) |
| 210 | 228 |
| 211 <p> | 229 <p> |
| 212 Public method to store the various refactoring settings. | 230 Public method to store the various settings. |
| 213 </p> | 231 </p> |
| 214 <dl> | 232 <dl> |
| 215 | 233 |
| 216 <dt><i>key</i></dt> | 234 <dt><i>key</i> (str)</dt> |
| 217 <dd> | 235 <dd> |
| 218 the key of the setting to be set (string) | 236 the key of the setting to be set |
| 219 </dd> | 237 </dd> |
| 220 <dt><i>value</i></dt> | 238 <dt><i>value</i> (Any)</dt> |
| 221 <dd> | 239 <dd> |
| 222 the value to be set | 240 value to be set |
| 223 </dd> | 241 </dd> |
| 224 </dl> | 242 </dl> |
| 225 <div align="right"><a href="#top">Up</a></div> | 243 <div align="right"><a href="#top">Up</a></div> |
| 226 <hr /> | 244 <hr /> |
| 227 <hr /> | 245 <hr /> |
| 232 <p> | 250 <p> |
| 233 Module function to create the autocompletion configuration page. | 251 Module function to create the autocompletion configuration page. |
| 234 </p> | 252 </p> |
| 235 <dl> | 253 <dl> |
| 236 | 254 |
| 237 <dt><i>configDlg</i></dt> | 255 <dt><i>configDlg</i> (ConfigurationWidget)</dt> |
| 238 <dd> | 256 <dd> |
| 239 reference to the configuration dialog | 257 reference to the configuration dialog |
| 240 </dd> | 258 </dd> |
| 241 </dl> | 259 </dl> |
| 242 <dl> | 260 <dl> |
| 243 <dt>Return:</dt> | 261 <dt>Return:</dt> |
| 244 <dd> | 262 <dd> |
| 245 reference to the configuration page | 263 reference to the configuration page |
| 264 </dd> | |
| 265 </dl> | |
| 266 <dl> | |
| 267 <dt>Return Type:</dt> | |
| 268 <dd> | |
| 269 QWidget | |
| 246 </dd> | 270 </dd> |
| 247 </dl> | 271 </dl> |
| 248 <div align="right"><a href="#top">Up</a></div> | 272 <div align="right"><a href="#top">Up</a></div> |
| 249 <hr /> | 273 <hr /> |
| 250 <hr /> | 274 <hr /> |
| 255 <p> | 279 <p> |
| 256 Module function to create the calltips configuration page. | 280 Module function to create the calltips configuration page. |
| 257 </p> | 281 </p> |
| 258 <dl> | 282 <dl> |
| 259 | 283 |
| 260 <dt><i>configDlg</i></dt> | 284 <dt><i>configDlg</i> (ConfigurationWidget)</dt> |
| 261 <dd> | 285 <dd> |
| 262 reference to the configuration dialog | 286 reference to the configuration dialog |
| 263 </dd> | 287 </dd> |
| 264 </dl> | 288 </dl> |
| 265 <dl> | 289 <dl> |
| 266 <dt>Return:</dt> | 290 <dt>Return:</dt> |
| 267 <dd> | 291 <dd> |
| 268 reference to the configuration page | 292 reference to the configuration page |
| 293 </dd> | |
| 294 </dl> | |
| 295 <dl> | |
| 296 <dt>Return Type:</dt> | |
| 297 <dd> | |
| 298 QWidget | |
| 269 </dd> | 299 </dd> |
| 270 </dl> | 300 </dl> |
| 271 <div align="right"><a href="#top">Up</a></div> | 301 <div align="right"><a href="#top">Up</a></div> |
| 272 <hr /> | 302 <hr /> |
| 273 <hr /> | 303 <hr /> |
| 282 <dt>Return:</dt> | 312 <dt>Return:</dt> |
| 283 <dd> | 313 <dd> |
| 284 dictionary containing the relevant data | 314 dictionary containing the relevant data |
| 285 </dd> | 315 </dd> |
| 286 </dl> | 316 </dl> |
| 317 <dl> | |
| 318 <dt>Return Type:</dt> | |
| 319 <dd> | |
| 320 dict | |
| 321 </dd> | |
| 322 </dl> | |
| 287 <div align="right"><a href="#top">Up</a></div> | 323 <div align="right"><a href="#top">Up</a></div> |
| 288 <hr /> | 324 <hr /> |
| 289 <hr /> | 325 <hr /> |
| 290 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 326 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 291 <h2>prepareUninstall</h2> | 327 <h2>prepareUninstall</h2> |
