Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.QScintilla.TypingCompleters.__init__.html	Fri Sep 08 10:16:05 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.TypingCompleters.__init__.html	Sat Sep 09 17:17:11 2023 +0200
@@ -9,12 +9,12 @@
 <h1>eric7.QScintilla.TypingCompleters.__init__</h1>
 
 <p>
-Package implementing lexers for the various supported programming languages.
+Package implementing typing completers for the various supported programming languages.
 </p>
 <h3>Global Attributes</h3>
 
 <table>
-<tr><td>None</td></tr>
+<tr><td>CompleterRegistry</td></tr><tr><td>CompleterRegistryItem</td></tr>
 </table>
 <h3>Classes</h3>
 
@@ -29,6 +29,14 @@
 <td><a href="#getCompleter">getCompleter</a></td>
 <td>Module function to instantiate a lexer object for a given language.</td>
 </tr>
+<tr>
+<td><a href="#registerCompleter">registerCompleter</a></td>
+<td>Function to register a typing completer for a lexer language.</td>
+</tr>
+<tr>
+<td><a href="#unregisterTypingCompleter">unregisterTypingCompleter</a></td>
+<td>Function to unregister a previously registered typing completer.</td>
+</tr>
 </table>
 <hr />
 <hr />
@@ -41,23 +49,80 @@
 </p>
 <dl>
 
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-language of the lexer (string)
+language of the lexer
 </dd>
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
 <dd>
-reference to the editor object (QScintilla.Editor)
+reference to the editor object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject (optional))</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object (defaults to None)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the instanciated lexer object (QsciLexer)
+reference to the instantiated typing completer object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+CompleterBase
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="registerCompleter" ID="registerCompleter"></a>
+<h2>registerCompleter</h2>
+<b>registerCompleter</b>(<i>language, createCompleterFunction, createConfigPageFunction</i>)
+
+<p>
+    Function to register a typing completer for a lexer language.
+</p>
+<dl>
+
+<dt><i>language</i> (str)</dt>
+<dd>
+lexer language of the typing completer
+</dd>
+<dt><i>createCompleterFunction</i> (function)</dt>
+<dd>
+reference to a function to instantiate a
+        typing completer object
+</dd>
+<dt><i>createConfigPageFunction</i> (function)</dt>
+<dd>
+reference to a function returning a ready
+        populated configuration widget
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>KeyError</b>:</dt>
+<dd>
+raised when the given name is already in use
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="unregisterTypingCompleter" ID="unregisterTypingCompleter"></a>
+<h2>unregisterTypingCompleter</h2>
+<b>unregisterTypingCompleter</b>(<i>language</i>)
+
+<p>
+    Function to unregister a previously registered typing completer.
+</p>
+<dl>
+
+<dt><i>language</i> (str)</dt>
+<dd>
+lexer language of the typing completer
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>