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 35
- 6b706b02c2dd
- parent 32
- 68ef15fe34c3
- child 39
- 7b6ca9397ecc
equal
deleted
inserted
replaced
| 34:f35565337953 | 35:6b706b02c2dd |
|---|---|
| 75 <td>Private method to determine calltips from APIs.</td> | 75 <td>Private method to determine calltips from APIs.</td> |
| 76 </tr><tr> | 76 </tr><tr> |
| 77 <td><a href="#Assistant.__getApiCompletions">__getApiCompletions</a></td> | 77 <td><a href="#Assistant.__getApiCompletions">__getApiCompletions</a></td> |
| 78 <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> | 79 </tr><tr> |
| 80 <td><a href="#Assistant.__getCalltipsFromDocument">__getCalltipsFromDocument</a></td> | |
| 81 <td>Private method to determine calltips from the document.</td> | |
| 82 </tr><tr> | |
| 83 <td><a href="#Assistant.__getCharacter">__getCharacter</a></td> | 80 <td><a href="#Assistant.__getCharacter">__getCharacter</a></td> |
| 84 <td>Private method to get the character to the left of the current position in the current line.</td> | 81 <td>Private method to get the character to the left of the current position in the current line.</td> |
| 85 </tr><tr> | 82 </tr><tr> |
| 83 <td><a href="#Assistant.__getDocumentCalltips">__getDocumentCalltips</a></td> | |
| 84 <td>Private method to determine calltips from the document.</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#Assistant.__getDocumentCompletions">__getDocumentCompletions</a></td> | |
| 87 <td>Private method to determine autocompletion proposals from the document.</td> | |
| 88 </tr><tr> | |
| 86 <td><a href="#Assistant.__preferencesChanged">__preferencesChanged</a></td> | 89 <td><a href="#Assistant.__preferencesChanged">__preferencesChanged</a></td> |
| 87 <td>Private method to handle a change of the global configuration.</td> | 90 <td>Private method to handle a change of the global configuration.</td> |
| 88 </tr><tr> | 91 </tr><tr> |
| 89 <td><a href="#Assistant.__setAutoCompletionHook">__setAutoCompletionHook</a></td> | 92 <td><a href="#Assistant.__setAutoCompletionHook">__setAutoCompletionHook</a></td> |
| 90 <td>Private method to set the autocompletion hook.</td> | 93 <td>Private method to set the autocompletion hook.</td> |
| 110 <td><a href="#Assistant.calltips">calltips</a></td> | 113 <td><a href="#Assistant.calltips">calltips</a></td> |
| 111 <td>Public method to return a list of calltips.</td> | 114 <td>Public method to return a list of calltips.</td> |
| 112 </tr><tr> | 115 </tr><tr> |
| 113 <td><a href="#Assistant.deactivate">deactivate</a></td> | 116 <td><a href="#Assistant.deactivate">deactivate</a></td> |
| 114 <td>Public method to perform actions upon deactivation.</td> | 117 <td>Public method to perform actions upon deactivation.</td> |
| 115 </tr><tr> | |
| 116 <td><a href="#Assistant.getCompletionsFromDocument">getCompletionsFromDocument</a></td> | |
| 117 <td>Public method to determine autocompletion proposals from the document.</td> | |
| 118 </tr><tr> | 118 </tr><tr> |
| 119 <td><a href="#Assistant.setEnabled">setEnabled</a></td> | 119 <td><a href="#Assistant.setEnabled">setEnabled</a></td> |
| 120 <td>Public method to enable or disable a feature.</td> | 120 <td>Public method to enable or disable a feature.</td> |
| 121 </tr> | 121 </tr> |
| 122 </table> | 122 </table> |
| 228 </dl><dl> | 228 </dl><dl> |
| 229 <dt>Returns:</dt> | 229 <dt>Returns:</dt> |
| 230 <dd> | 230 <dd> |
| 231 list of possible completions (list of strings) | 231 list of possible completions (list of strings) |
| 232 </dd> | 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) | |
| 256 </dd> | |
| 257 </dl><a NAME="Assistant.__getCharacter" ID="Assistant.__getCharacter"></a> | 233 </dl><a NAME="Assistant.__getCharacter" ID="Assistant.__getCharacter"></a> |
| 258 <h4>Assistant.__getCharacter</h4> | 234 <h4>Assistant.__getCharacter</h4> |
| 259 <b>__getCharacter</b>(<i>pos, editor</i>) | 235 <b>__getCharacter</b>(<i>pos, editor</i>) |
| 260 <p> | 236 <p> |
| 261 Private method to get the character to the left of the current position | 237 Private method to get the character to the left of the current position |
| 271 </dl><dl> | 247 </dl><dl> |
| 272 <dt>Returns:</dt> | 248 <dt>Returns:</dt> |
| 273 <dd> | 249 <dd> |
| 274 requested character or "", if there are no more (string) and | 250 requested character or "", if there are no more (string) and |
| 275 the next position (i.e. pos - 1) | 251 the next position (i.e. pos - 1) |
| 252 </dd> | |
| 253 </dl><a NAME="Assistant.__getDocumentCalltips" ID="Assistant.__getDocumentCalltips"></a> | |
| 254 <h4>Assistant.__getDocumentCalltips</h4> | |
| 255 <b>__getDocumentCalltips</b>(<i>word, prefix, module, editor</i>) | |
| 256 <p> | |
| 257 Private method to determine calltips from the document. | |
| 258 </p><dl> | |
| 259 <dt><i>word</i></dt> | |
| 260 <dd> | |
| 261 function to get calltips for (string) | |
| 262 </dd><dt><i>prefix</i></dt> | |
| 263 <dd> | |
| 264 prefix of the word to be completed (string) | |
| 265 </dd><dt><i>module</i></dt> | |
| 266 <dd> | |
| 267 reference to the scanned module info (Module) | |
| 268 </dd><dt><i>editor</i></dt> | |
| 269 <dd> | |
| 270 reference to the editor object (QScintilla.Editor) | |
| 271 </dd> | |
| 272 </dl><dl> | |
| 273 <dt>Returns:</dt> | |
| 274 <dd> | |
| 275 list of calltips (list of string) | |
| 276 </dd> | |
| 277 </dl><a NAME="Assistant.__getDocumentCompletions" ID="Assistant.__getDocumentCompletions"></a> | |
| 278 <h4>Assistant.__getDocumentCompletions</h4> | |
| 279 <b>__getDocumentCompletions</b>(<i>editor, word, context, sep, prefix, module</i>) | |
| 280 <p> | |
| 281 Private method to determine autocompletion proposals from the document. | |
| 282 </p><dl> | |
| 283 <dt><i>editor</i></dt> | |
| 284 <dd> | |
| 285 reference to the editor object (QScintilla.Editor) | |
| 286 </dd><dt><i>word</i></dt> | |
| 287 <dd> | |
| 288 string to be completed (string) | |
| 289 </dd><dt><i>context</i></dt> | |
| 290 <dd> | |
| 291 flag indicating to autocomplete a context (boolean) | |
| 292 </dd><dt><i>sep</i></dt> | |
| 293 <dd> | |
| 294 separator string (string) | |
| 295 </dd><dt><i>prefix</i></dt> | |
| 296 <dd> | |
| 297 prefix of the word to be completed (string) | |
| 298 </dd><dt><i>module</i></dt> | |
| 299 <dd> | |
| 300 reference to the scanned module info (Module) | |
| 301 </dd> | |
| 302 </dl><dl> | |
| 303 <dt>Returns:</dt> | |
| 304 <dd> | |
| 305 list of possible completions (list of strings) | |
| 276 </dd> | 306 </dd> |
| 277 </dl><a NAME="Assistant.__preferencesChanged" ID="Assistant.__preferencesChanged"></a> | 307 </dl><a NAME="Assistant.__preferencesChanged" ID="Assistant.__preferencesChanged"></a> |
| 278 <h4>Assistant.__preferencesChanged</h4> | 308 <h4>Assistant.__preferencesChanged</h4> |
| 279 <b>__preferencesChanged</b>(<i></i>) | 309 <b>__preferencesChanged</b>(<i></i>) |
| 280 <p> | 310 <p> |
| 367 </dl><a NAME="Assistant.deactivate" ID="Assistant.deactivate"></a> | 397 </dl><a NAME="Assistant.deactivate" ID="Assistant.deactivate"></a> |
| 368 <h4>Assistant.deactivate</h4> | 398 <h4>Assistant.deactivate</h4> |
| 369 <b>deactivate</b>(<i></i>) | 399 <b>deactivate</b>(<i></i>) |
| 370 <p> | 400 <p> |
| 371 Public method to perform actions upon deactivation. | 401 Public method to perform actions upon deactivation. |
| 372 </p><a NAME="Assistant.getCompletionsFromDocument" ID="Assistant.getCompletionsFromDocument"></a> | 402 </p><a NAME="Assistant.setEnabled" ID="Assistant.setEnabled"></a> |
| 373 <h4>Assistant.getCompletionsFromDocument</h4> | |
| 374 <b>getCompletionsFromDocument</b>(<i>editor, word, context, sep, prefix, module</i>) | |
| 375 <p> | |
| 376 Public method to determine autocompletion proposals from the document. | |
| 377 </p><dl> | |
| 378 <dt><i>editor</i></dt> | |
| 379 <dd> | |
| 380 reference to the editor object (QScintilla.Editor) | |
| 381 </dd><dt><i>word</i></dt> | |
| 382 <dd> | |
| 383 string to be completed (string) | |
| 384 </dd><dt><i>context</i></dt> | |
| 385 <dd> | |
| 386 flag indicating to autocomplete a context (boolean) | |
| 387 </dd><dt><i>sep</i></dt> | |
| 388 <dd> | |
| 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) | |
| 396 </dd> | |
| 397 </dl><dl> | |
| 398 <dt>Returns:</dt> | |
| 399 <dd> | |
| 400 list of possible completions (list of strings) | |
| 401 </dd> | |
| 402 </dl><a NAME="Assistant.setEnabled" ID="Assistant.setEnabled"></a> | |
| 403 <h4>Assistant.setEnabled</h4> | 403 <h4>Assistant.setEnabled</h4> |
| 404 <b>setEnabled</b>(<i>key, enabled</i>) | 404 <b>setEnabled</b>(<i>key, enabled</i>) |
| 405 <p> | 405 <p> |
| 406 Public method to enable or disable a feature. | 406 Public method to enable or disable a feature. |
| 407 </p><dl> | 407 </p><dl> |
