--- a/ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html Sat Dec 31 16:27:50 2022 +0100
+++ b/ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html Sat Sep 09 17:43:15 2023 +0200
@@ -33,6 +33,10 @@
<td><a href="#apiFiles">apiFiles</a></td>
<td>Module function to return the API files made available by this plugin.</td>
</tr>
+<tr>
+<td><a href="#prepareUninstall">prepareUninstall</a></td>
+<td>Module function to prepare for an uninstallation.</td>
+</tr>
</table>
<hr />
<hr />
@@ -47,7 +51,7 @@
<h3>Class Attributes</h3>
<table>
-<tr><td>KivyLexerEntry</td></tr><tr><td>KivyLexerKey</td></tr><tr><td>lexerAssociations</td></tr>
+<tr><td>KivyLexerEntry</td></tr><tr><td>KivyLexerKey</td></tr><tr><td>PreferencesKey</td></tr><tr><td>lexerAssociations</td></tr>
</table>
<h3>Class Methods</h3>
@@ -75,6 +79,14 @@
<td>Public method to activate this plugin.</td>
</tr>
<tr>
+<td><a href="#ProjectKivyPlugin.createTypingCompleter">createTypingCompleter</a></td>
+<td>Public method to create a typing completer object for the given editor.</td>
+</tr>
+<tr>
+<td><a href="#ProjectKivyPlugin.createTypingCompleterConfigWidget">createTypingCompleterConfigWidget</a></td>
+<td>Public method to create and populate the typing completer configuration widget.</td>
+</tr>
+<tr>
<td><a href="#ProjectKivyPlugin.deactivate">deactivate</a></td>
<td>Public method to deactivate this plugin.</td>
</tr>
@@ -87,9 +99,17 @@
<td>Public method to instantiate a Pygments Kivy lexer object.</td>
</tr>
<tr>
+<td><a href="#ProjectKivyPlugin.getTypingPreferences">getTypingPreferences</a></td>
+<td>Public method to retrieve the typing completer settings.</td>
+</tr>
+<tr>
<td><a href="#ProjectKivyPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td>
<td>Public method to get the lexer association of the Kivy project type for a file.</td>
</tr>
+<tr>
+<td><a href="#ProjectKivyPlugin.setTypingPreferences">setTypingPreferences</a></td>
+<td>Public method to store the typing completer settings.</td>
+</tr>
</table>
<h3>Static Methods</h3>
@@ -144,6 +164,55 @@
bool
</dd>
</dl>
+<a NAME="ProjectKivyPlugin.createTypingCompleter" ID="ProjectKivyPlugin.createTypingCompleter"></a>
+<h4>ProjectKivyPlugin.createTypingCompleter</h4>
+<b>createTypingCompleter</b>(<i>editor, parent=None</i>)
+
+<p>
+ Public method to create a typing completer object for the given editor.
+</p>
+<dl>
+
+<dt><i>editor</i> (Editor)</dt>
+<dd>
+reference to the editor object
+</dd>
+<dt><i>parent</i> (QObject (optional))</dt>
+<dd>
+reference to the parent object (defaults to None)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the instantiated typing completer object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+CompleterKivy
+</dd>
+</dl>
+<a NAME="ProjectKivyPlugin.createTypingCompleterConfigWidget" ID="ProjectKivyPlugin.createTypingCompleterConfigWidget"></a>
+<h4>ProjectKivyPlugin.createTypingCompleterConfigWidget</h4>
+<b>createTypingCompleterConfigWidget</b>(<i></i>)
+
+<p>
+ Public method to create and populate the typing completer configuration widget.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+instantiated and populated configuration widget
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+CompleterKivyConfigWidget
+</dd>
+</dl>
<a NAME="ProjectKivyPlugin.deactivate" ID="ProjectKivyPlugin.deactivate"></a>
<h4>ProjectKivyPlugin.deactivate</h4>
<b>deactivate</b>(<i></i>)
@@ -196,6 +265,32 @@
QsciLexer
</dd>
</dl>
+<a NAME="ProjectKivyPlugin.getTypingPreferences" ID="ProjectKivyPlugin.getTypingPreferences"></a>
+<h4>ProjectKivyPlugin.getTypingPreferences</h4>
+<b>getTypingPreferences</b>(<i>key</i>)
+
+<p>
+ Public method to retrieve the typing completer settings.
+</p>
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+the key of the value to get
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+value of the requested setting
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
<a NAME="ProjectKivyPlugin.lexerAssociationCallback" ID="ProjectKivyPlugin.lexerAssociationCallback"></a>
<h4>ProjectKivyPlugin.lexerAssociationCallback</h4>
<b>lexerAssociationCallback</b>(<i>filename</i>)
@@ -224,6 +319,24 @@
str
</dd>
</dl>
+<a NAME="ProjectKivyPlugin.setTypingPreferences" ID="ProjectKivyPlugin.setTypingPreferences"></a>
+<h4>ProjectKivyPlugin.setTypingPreferences</h4>
+<b>setTypingPreferences</b>(<i>key, value</i>)
+
+<p>
+ Public method to store the typing completer settings.
+</p>
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+the key of the setting to be set
+</dd>
+<dt><i>value</i> (Any)</dt>
+<dd>
+value to be set
+</dd>
+</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
@@ -255,4 +368,14 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
+<hr />
+<a NAME="prepareUninstall" ID="prepareUninstall"></a>
+<h2>prepareUninstall</h2>
+<b>prepareUninstall</b>(<i></i>)
+
+<p>
+ Module function to prepare for an uninstallation.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
</body></html>
\ No newline at end of file
