tip/ProjectKivy/Documentation/source/Plugin_Project_Kivy.PluginProjectKivy.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Project_Kivy.PluginProjectKivy</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Project_Kivy.PluginProjectKivy</h1>

<p>
Module implementing the Kivy project plug-in.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#ProjectKivyPlugin">ProjectKivyPlugin</a></td>
<td>Class implementing the Kivy project plugin.</td>
</tr>
</table>
<h3>Functions</h3>

<table>

<tr>
<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 />
<a NAME="ProjectKivyPlugin" ID="ProjectKivyPlugin"></a>
<h2>ProjectKivyPlugin</h2>

<p>
    Class implementing the Kivy project plugin.
</p>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>

<table>
<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>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#ProjectKivyPlugin.__init__">ProjectKivyPlugin</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#ProjectKivyPlugin.__initialize">__initialize</a></td>
<td>Private slot to (re)initialize the plugin.</td>
</tr>
<tr>
<td><a href="#ProjectKivyPlugin.__loadTranslator">__loadTranslator</a></td>
<td>Private method to load the translation file.</td>
</tr>
<tr>
<td><a href="#ProjectKivyPlugin.activate">activate</a></td>
<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>
<tr>
<td><a href="#ProjectKivyPlugin.fileTypesCallback">fileTypesCallback</a></td>
<td>Public method get the filetype associations of the Kivy project type.</td>
</tr>
<tr>
<td><a href="#ProjectKivyPlugin.getLexer">getLexer</a></td>
<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>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="ProjectKivyPlugin.__init__" ID="ProjectKivyPlugin.__init__"></a>
<h4>ProjectKivyPlugin (Constructor)</h4>
<b>ProjectKivyPlugin</b>(<i>ui</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>ui</i> (UserInterface)</dt>
<dd>
reference to the user interface object
</dd>
</dl>
<a NAME="ProjectKivyPlugin.__initialize" ID="ProjectKivyPlugin.__initialize"></a>
<h4>ProjectKivyPlugin.__initialize</h4>
<b>__initialize</b>(<i></i>)

<p>
        Private slot to (re)initialize the plugin.
</p>
<a NAME="ProjectKivyPlugin.__loadTranslator" ID="ProjectKivyPlugin.__loadTranslator"></a>
<h4>ProjectKivyPlugin.__loadTranslator</h4>
<b>__loadTranslator</b>(<i></i>)

<p>
        Private method to load the translation file.
</p>
<a NAME="ProjectKivyPlugin.activate" ID="ProjectKivyPlugin.activate"></a>
<h4>ProjectKivyPlugin.activate</h4>
<b>activate</b>(<i></i>)

<p>
        Public method to activate this plugin.
</p>
<dl>
<dt>Return:</dt>
<dd>
tuple of None and activation status
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
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>)

<p>
        Public method to deactivate this plugin.
</p>
<a NAME="ProjectKivyPlugin.fileTypesCallback" ID="ProjectKivyPlugin.fileTypesCallback"></a>
<h4>ProjectKivyPlugin.fileTypesCallback</h4>
<b>fileTypesCallback</b>(<i></i>)

<p>
        Public method get the filetype associations of the Kivy project type.
</p>
<dl>
<dt>Return:</dt>
<dd>
dictionary with file type associations
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="ProjectKivyPlugin.getLexer" ID="ProjectKivyPlugin.getLexer"></a>
<h4>ProjectKivyPlugin.getLexer</h4>
<b>getLexer</b>(<i>parent=None</i>)

<p>
        Public method to instantiate a Pygments Kivy lexer object.
</p>
<dl>

<dt><i>parent</i> (QObject)</dt>
<dd>
reference to the parent object
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the instanciated lexer object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
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>)

<p>
        Public method to get the lexer association of the Kivy project type for
        a file.
</p>
<dl>

<dt><i>filename</i> (str)</dt>
<dd>
name of the file
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
name of the lexer (Pygments lexers are prefixed with
            'Pygments|')
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
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 />
<a NAME="apiFiles" ID="apiFiles"></a>
<h2>apiFiles</h2>
<b>apiFiles</b>(<i>language</i>)

<p>
    Module function to return the API files made available by this plugin.
</p>
<dl>

<dt><i>language</i> (str)</dt>
<dd>
language to get API file for
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
list of API filenames
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</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>