eric: comparison Documentation/Source/eric6.QScintilla.Editor.html

-:9a6ce5faed7a
+:f23f3d2b7516
 <td>Private method to calculate an adjusted position for showing calltips.</td>
 </tr><tr>
 <td><a href="#Editor.__applyTemplate">__applyTemplate</a></td>
 <td>Private method to apply a template by name.</td>
 </tr><tr>
+<td><a href="#Editor.__autoComplete">__autoComplete</a></td>
+<td>Private method to start auto-completion via plug-ins.</td>
+</tr><tr>
 <td><a href="#Editor.__autosaveEnable">__autosaveEnable</a></td>
 <td>Private slot handling the autosave enable context menu action.</td>
 </tr><tr>
 <td><a href="#Editor.__bindCompleter">__bindCompleter</a></td>
 <td>Private slot to set the correct typing completer depending on language.</td>
 <td>Private slot to check the word below the spelling context menu.</td>
 </tr><tr>
 <td><a href="#Editor.__clearBreakpoints">__clearBreakpoints</a></td>
 <td>Private slot to clear all breakpoints.</td>
 </tr><tr>
+<td><a href="#Editor.__clearCompletionsCache">__clearCompletionsCache</a></td>
+<td>Private method to clear the auto-completions cache.</td>
+</tr><tr>
 <td><a href="#Editor.__clearTypedWarning">__clearTypedWarning</a></td>
 <td>Private method to clear warnings of a specific kind.</td>
 </tr><tr>
 <td><a href="#Editor.__codeCoverageHideAnnotations">__codeCoverageHideAnnotations</a></td>
 <td>Private method to handle the hide code coverage annotations context menu action.</td>
 </tr><tr>
 <td><a href="#Editor.addedToProject">addedToProject</a></td>
 <td>Public method to signal, that this editor has been added to a project.</td>
 </tr><tr>
 <td><a href="#Editor.autoComplete">autoComplete</a></td>
-<td>Public method to start autocompletion.</td>
+<td>Public method to start auto-completion.</td>
 </tr><tr>
 <td><a href="#Editor.autoCompleteQScintilla">autoCompleteQScintilla</a></td>
 <td>Public method to perform an autocompletion using QScintilla methods.</td>
 </tr><tr>
 <td><a href="#Editor.boxCommentLine">boxCommentLine</a></td>
 <td><a href="#Editor.commentLineOrSelection">commentLineOrSelection</a></td>
 <td>Public slot to comment the current line or current selection.</td>
 </tr><tr>
 <td><a href="#Editor.commentSelection">commentSelection</a></td>
 <td>Public slot to comment the current selection.</td>
+</tr><tr>
+<td><a href="#Editor.completionsListReady">completionsListReady</a></td>
+<td>Public method to show the completions determined by a completions provider.</td>
 </tr><tr>
 <td><a href="#Editor.contextMenuEvent">contextMenuEvent</a></td>
 <td>Protected method implementing the context menu event.</td>
 </tr><tr>
 <td><a href="#Editor.curLineHasBreakpoint">curLineHasBreakpoint</a></td>
 </dd><dt><i>language</i></dt>
 <dd>
 name of the language (group) to get the template
 from (string)
 </dd>
+</dl><a NAME="Editor.__autoComplete" ID="Editor.__autoComplete"></a>
+<h4>Editor.__autoComplete</h4>
+<b>__autoComplete</b>(<i>context=None</i>)
+<p>
+Private method to start auto-completion via plug-ins.
+</p><dl>
+<dt><i>context=</i> (bool or None)</dt>
+<dd>
+flag indicating to complete a context
+</dd>
 </dl><a NAME="Editor.__autosaveEnable" ID="Editor.__autosaveEnable"></a>
 <h4>Editor.__autosaveEnable</h4>
 <b>__autosaveEnable</b>(<i></i>)
 <p>
 Private slot handling the autosave enable context menu action.
 </p><dl>
 <dt><i>fileName</i></dt>
 <dd>
 name of the file (string)
 </dd>
-</dl><a NAME="Editor.__clearTypedWarning" ID="Editor.__clearTypedWarning"></a>
+</dl><a NAME="Editor.__clearCompletionsCache" ID="Editor.__clearCompletionsCache"></a>
+<h4>Editor.__clearCompletionsCache</h4>
+<b>__clearCompletionsCache</b>(<i></i>)
+<p>
+Private method to clear the auto-completions cache.
+</p><a NAME="Editor.__clearTypedWarning" ID="Editor.__clearTypedWarning"></a>
 <h4>Editor.__clearTypedWarning</h4>
 <b>__clearTypedWarning</b>(<i>warningKind</i>)
 <p>
 Private method to clear warnings of a specific kind.
 </p><dl>
 <dd>
 reference to the cloned editor (Editor)
 </dd>
 </dl><a NAME="Editor.addCompletionListHook" ID="Editor.addCompletionListHook"></a>
 <h4>Editor.addCompletionListHook</h4>
-<b>addCompletionListHook</b>(<i>key, func</i>)
+<b>addCompletionListHook</b>(<i>key, func, async=False</i>)
 <p>
 Public method to set an auto-completion list provider.
 </p><dl>
 <dt><i>key</i> (str)</dt>
 <dd>
 name of the provider
-</dd><dt><i>func</i> (function(editor, bool) -> list of str)</dt>
+</dd><dt><i>func</i> (function(editor, bool) -> list of str in case async is False)</dt>
 <dd>
 function providing completion list. func
 should be a function taking a reference to the editor and
 a boolean indicating to complete a context. It should return
 the possible completions as a list of strings.
+and function(editor, bool, str) returning nothing in case async
+is True
+</dd><dt><i>async</i> (bool)</dt>
+<dd>
+flag indicating an asynchroneous function
 </dd>
 </dl><a NAME="Editor.addedToProject" ID="Editor.addedToProject"></a>
 <h4>Editor.addedToProject</h4>
 <b>addedToProject</b>(<i></i>)
 <p>
 Public method to signal, that this editor has been added to a project.
 </p><a NAME="Editor.autoComplete" ID="Editor.autoComplete"></a>
 <h4>Editor.autoComplete</h4>
 <b>autoComplete</b>(<i>auto=False, context=True</i>)
 <p>
-Public method to start autocompletion.
+Public method to start auto-completion.
 </p><dl>
 <dt><i>auto=</i></dt>
 <dd>
 flag indicating a call from the __charAdded method
 (boolean)
 </p><a NAME="Editor.commentSelection" ID="Editor.commentSelection"></a>
 <h4>Editor.commentSelection</h4>
 <b>commentSelection</b>(<i></i>)
 <p>
 Public slot to comment the current selection.
-</p><a NAME="Editor.contextMenuEvent" ID="Editor.contextMenuEvent"></a>
+</p><a NAME="Editor.completionsListReady" ID="Editor.completionsListReady"></a>
+<h4>Editor.completionsListReady</h4>
+<b>completionsListReady</b>(<i>completions, acText</i>)
+<p>
+Public method to show the completions determined by a completions
+provider.
+</p><dl>
+<dt><i>completions</i> (list of str or set of str)</dt>
+<dd>
+list of possible completions
+</dd><dt><i>acText</i> (str)</dt>
+<dd>
+text to be completed
+</dd>
+</dl><a NAME="Editor.contextMenuEvent" ID="Editor.contextMenuEvent"></a>
 <h4>Editor.contextMenuEvent</h4>
 <b>contextMenuEvent</b>(<i>evt</i>)
 <p>
 Protected method implementing the context menu event.
 </p><dl>

Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.QScintilla.Editor.html

Documentation/Source/eric6.QScintilla.Editor.html