Mercurial Repositories > Eric Assistant / file comparison
comparison: AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.Assistant.html
AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.Assistant.html
- changeset 32
- 68ef15fe34c3
- parent 30
- 8f4d794d8ee0
- child 35
- 6b706b02c2dd
equal
deleted
inserted
replaced
| 31:ed537ef44f85 | 32:68ef15fe34c3 |
|---|---|
| 50 QObject | 50 QObject |
| 51 <h3>Class Attributes</h3> | 51 <h3>Class Attributes</h3> |
| 52 <table> | 52 <table> |
| 53 <tr><td>None</td></tr> | 53 <tr><td>None</td></tr> |
| 54 </table> | 54 </table> |
| 55 <h3>Class Methods</h3> | |
| 56 <table> | |
| 57 <tr><td>None</td></tr> | |
| 58 </table> | |
| 55 <h3>Methods</h3> | 59 <h3>Methods</h3> |
| 56 <table> | 60 <table> |
| 57 <tr> | 61 <tr> |
| 58 <td><a href="#Assistant.__init__">Assistant</a></td> | 62 <td><a href="#Assistant.__init__">Assistant</a></td> |
| 59 <td>Constructor</td> | 63 <td>Constructor</td> |
| 65 <td>Private slot called, when an editor was closed.</td> | 69 <td>Private slot called, when an editor was closed.</td> |
| 66 </tr><tr> | 70 </tr><tr> |
| 67 <td><a href="#Assistant.__editorOpened">__editorOpened</a></td> | 71 <td><a href="#Assistant.__editorOpened">__editorOpened</a></td> |
| 68 <td>Private slot called, when a new editor was opened.</td> | 72 <td>Private slot called, when a new editor was opened.</td> |
| 69 </tr><tr> | 73 </tr><tr> |
| 74 <td><a href="#Assistant.__getApiCalltips">__getApiCalltips</a></td> | |
| 75 <td>Private method to determine calltips from APIs.</td> | |
| 76 </tr><tr> | |
| 70 <td><a href="#Assistant.__getApiCompletions">__getApiCompletions</a></td> | 77 <td><a href="#Assistant.__getApiCompletions">__getApiCompletions</a></td> |
| 71 <td>Private method to determine a list of completions from an API object.</td> | 78 <td>Private method to determine a list of completions from an API object.</td> |
| 79 </tr><tr> | |
| 80 <td><a href="#Assistant.__getCalltipsFromDocument">__getCalltipsFromDocument</a></td> | |
| 81 <td>Private method to determine calltips from the document.</td> | |
| 72 </tr><tr> | 82 </tr><tr> |
| 73 <td><a href="#Assistant.__getCharacter">__getCharacter</a></td> | 83 <td><a href="#Assistant.__getCharacter">__getCharacter</a></td> |
| 74 <td>Private method to get the character to the left of the current position in the current line.</td> | 84 <td>Private method to get the character to the left of the current position in the current line.</td> |
| 75 </tr><tr> | 85 </tr><tr> |
| 76 <td><a href="#Assistant.__preferencesChanged">__preferencesChanged</a></td> | 86 <td><a href="#Assistant.__preferencesChanged">__preferencesChanged</a></td> |
| 108 </tr><tr> | 118 </tr><tr> |
| 109 <td><a href="#Assistant.setEnabled">setEnabled</a></td> | 119 <td><a href="#Assistant.setEnabled">setEnabled</a></td> |
| 110 <td>Public method to enable or disable a feature.</td> | 120 <td>Public method to enable or disable a feature.</td> |
| 111 </tr> | 121 </tr> |
| 112 </table> | 122 </table> |
| 123 <h3>Static Methods</h3> | |
| 124 <table> | |
| 125 <tr><td>None</td></tr> | |
| 126 </table> | |
| 113 <a NAME="Assistant.__init__" ID="Assistant.__init__"></a> | 127 <a NAME="Assistant.__init__" ID="Assistant.__init__"></a> |
| 114 <h4>Assistant (Constructor)</h4> | 128 <h4>Assistant (Constructor)</h4> |
| 115 <b>Assistant</b>(<i>plugin, parent=None</i>) | 129 <b>Assistant</b>(<i>plugin, parent=None</i>) |
| 116 <p> | 130 <p> |
| 117 Constructor | 131 Constructor |
| 154 </p><dl> | 168 </p><dl> |
| 155 <dt><i>editor</i></dt> | 169 <dt><i>editor</i></dt> |
| 156 <dd> | 170 <dd> |
| 157 reference to the new editor (QScintilla.Editor) | 171 reference to the new editor (QScintilla.Editor) |
| 158 </dd> | 172 </dd> |
| 173 </dl><a NAME="Assistant.__getApiCalltips" ID="Assistant.__getApiCalltips"></a> | |
| 174 <h4>Assistant.__getApiCalltips</h4> | |
| 175 <b>__getApiCalltips</b>(<i>api, word, commas, prefix, module, editor</i>) | |
| 176 <p> | |
| 177 Private method to determine calltips from APIs. | |
| 178 </p><dl> | |
| 179 <dt><i>api</i></dt> | |
| 180 <dd> | |
| 181 reference to the API object to be used (APIsManager.DbAPIs) | |
| 182 </dd><dt><i>word</i></dt> | |
| 183 <dd> | |
| 184 function to get calltips for (string) | |
| 185 </dd><dt><i>commas</i></dt> | |
| 186 <dd> | |
| 187 minimum number of commas contained in the calltip (integer) | |
| 188 </dd><dt><i>prefix</i></dt> | |
| 189 <dd> | |
| 190 prefix of the word to be completed (string) | |
| 191 </dd><dt><i>module</i></dt> | |
| 192 <dd> | |
| 193 reference to the scanned module info (Module) | |
| 194 </dd><dt><i>editor</i></dt> | |
| 195 <dd> | |
| 196 reference to the editor object (QScintilla.Editor) | |
| 197 </dd> | |
| 198 </dl><dl> | |
| 199 <dt>Returns:</dt> | |
| 200 <dd> | |
| 201 list of calltips (list of string) | |
| 202 </dd> | |
| 159 </dl><a NAME="Assistant.__getApiCompletions" ID="Assistant.__getApiCompletions"></a> | 203 </dl><a NAME="Assistant.__getApiCompletions" ID="Assistant.__getApiCompletions"></a> |
| 160 <h4>Assistant.__getApiCompletions</h4> | 204 <h4>Assistant.__getApiCompletions</h4> |
| 161 <b>__getApiCompletions</b>(<i>api, word, context</i>) | 205 <b>__getApiCompletions</b>(<i>api, word, context, prefix, module, editor</i>) |
| 162 <p> | 206 <p> |
| 163 Private method to determine a list of completions from an API object. | 207 Private method to determine a list of completions from an API object. |
| 164 </p><dl> | 208 </p><dl> |
| 165 <dt><i>api</i></dt> | 209 <dt><i>api</i></dt> |
| 166 <dd> | 210 <dd> |
| 169 <dd> | 213 <dd> |
| 170 word (or wordpart) to complete (string) | 214 word (or wordpart) to complete (string) |
| 171 </dd><dt><i>context</i></dt> | 215 </dd><dt><i>context</i></dt> |
| 172 <dd> | 216 <dd> |
| 173 flag indicating to autocomplete a context (boolean) | 217 flag indicating to autocomplete a context (boolean) |
| 218 </dd><dt><i>prefix</i></dt> | |
| 219 <dd> | |
| 220 prefix of the word to be completed (string) | |
| 221 </dd><dt><i>module</i></dt> | |
| 222 <dd> | |
| 223 reference to the scanned module info (Module) | |
| 224 </dd><dt><i>editor</i></dt> | |
| 225 <dd> | |
| 226 reference to the editor object (QScintilla.Editor) | |
| 174 </dd> | 227 </dd> |
| 175 </dl><dl> | 228 </dl><dl> |
| 176 <dt>Returns:</dt> | 229 <dt>Returns:</dt> |
| 177 <dd> | 230 <dd> |
| 178 list of possible completions (list of strings) | 231 list of possible completions (list of strings) |
| 232 </dd> | |
| 233 </dl><a NAME="Assistant.__getCalltipsFromDocument" ID="Assistant.__getCalltipsFromDocument"></a> | |
| 234 <h4>Assistant.__getCalltipsFromDocument</h4> | |
| 235 <b>__getCalltipsFromDocument</b>(<i>word, prefix, module, editor</i>) | |
| 236 <p> | |
| 237 Private method to determine calltips from the document. | |
| 238 </p><dl> | |
| 239 <dt><i>word</i></dt> | |
| 240 <dd> | |
| 241 function to get calltips for (string) | |
| 242 </dd><dt><i>prefix</i></dt> | |
| 243 <dd> | |
| 244 prefix of the word to be completed (string) | |
| 245 </dd><dt><i>module</i></dt> | |
| 246 <dd> | |
| 247 reference to the scanned module info (Module) | |
| 248 </dd><dt><i>editor</i></dt> | |
| 249 <dd> | |
| 250 reference to the editor object (QScintilla.Editor) | |
| 251 </dd> | |
| 252 </dl><dl> | |
| 253 <dt>Returns:</dt> | |
| 254 <dd> | |
| 255 list of calltips (list of string) | |
| 179 </dd> | 256 </dd> |
| 180 </dl><a NAME="Assistant.__getCharacter" ID="Assistant.__getCharacter"></a> | 257 </dl><a NAME="Assistant.__getCharacter" ID="Assistant.__getCharacter"></a> |
| 181 <h4>Assistant.__getCharacter</h4> | 258 <h4>Assistant.__getCharacter</h4> |
| 182 <b>__getCharacter</b>(<i>pos, editor</i>) | 259 <b>__getCharacter</b>(<i>pos, editor</i>) |
| 183 <p> | 260 <p> |
| 292 <b>deactivate</b>(<i></i>) | 369 <b>deactivate</b>(<i></i>) |
| 293 <p> | 370 <p> |
| 294 Public method to perform actions upon deactivation. | 371 Public method to perform actions upon deactivation. |
| 295 </p><a NAME="Assistant.getCompletionsFromDocument" ID="Assistant.getCompletionsFromDocument"></a> | 372 </p><a NAME="Assistant.getCompletionsFromDocument" ID="Assistant.getCompletionsFromDocument"></a> |
| 296 <h4>Assistant.getCompletionsFromDocument</h4> | 373 <h4>Assistant.getCompletionsFromDocument</h4> |
| 297 <b>getCompletionsFromDocument</b>(<i>editor, word, context, sep</i>) | 374 <b>getCompletionsFromDocument</b>(<i>editor, word, context, sep, prefix, module</i>) |
| 298 <p> | 375 <p> |
| 299 Public method to determine autocompletion proposals from the document. | 376 Public method to determine autocompletion proposals from the document. |
| 300 </p><dl> | 377 </p><dl> |
| 301 <dt><i>editor</i></dt> | 378 <dt><i>editor</i></dt> |
| 302 <dd> | 379 <dd> |
| 308 <dd> | 385 <dd> |
| 309 flag indicating to autocomplete a context (boolean) | 386 flag indicating to autocomplete a context (boolean) |
| 310 </dd><dt><i>sep</i></dt> | 387 </dd><dt><i>sep</i></dt> |
| 311 <dd> | 388 <dd> |
| 312 separator string (string) | 389 separator string (string) |
| 390 </dd><dt><i>prefix</i></dt> | |
| 391 <dd> | |
| 392 prefix of the word to be completed (string) | |
| 393 </dd><dt><i>module</i></dt> | |
| 394 <dd> | |
| 395 reference to the scanned module info (Module) | |
| 313 </dd> | 396 </dd> |
| 314 </dl><dl> | 397 </dl><dl> |
| 315 <dt>Returns:</dt> | 398 <dt>Returns:</dt> |
| 316 <dd> | 399 <dd> |
| 317 list of possible completions (list of strings) | 400 list of possible completions (list of strings) |
