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

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

<p>
Module implementing the Kivy typing completer.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#CompleterKivy">CompleterKivy</a></td>
<td>Class implementing the Kivy typing completer.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="CompleterKivy" ID="CompleterKivy"></a>
<h2>CompleterKivy</h2>

<p>
    Class implementing the Kivy typing completer.
</p>
<h3>Derived from</h3>
CompleterBase
<h3>Class Attributes</h3>

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

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

<table>

<tr>
<td><a href="#CompleterKivy.__init__">CompleterKivy</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#CompleterKivy.__inComment">__inComment</a></td>
<td>Private method to check, if the cursor is inside a comment.</td>
</tr>
<tr>
<td><a href="#CompleterKivy.charAdded">charAdded</a></td>
<td>Public slot called to handle the user entering a character.</td>
</tr>
<tr>
<td><a href="#CompleterKivy.readSettings">readSettings</a></td>
<td>Public slot called to reread the configuration parameters.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="CompleterKivy.__init__" ID="CompleterKivy.__init__"></a>
<h4>CompleterKivy (Constructor)</h4>
<b>CompleterKivy</b>(<i>plugin, editor, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>plugin</i> (ProjectKivyPlugin)</dt>
<dd>
reference to the plugin object
</dd>
<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor object
</dd>
<dt><i>parent</i> (QObject)</dt>
<dd>
reference to the parent object
</dd>
</dl>
<a NAME="CompleterKivy.__inComment" ID="CompleterKivy.__inComment"></a>
<h4>CompleterKivy.__inComment</h4>
<b>__inComment</b>(<i>line, col</i>)

<p>
        Private method to check, if the cursor is inside a comment.
</p>
<dl>

<dt><i>line</i> (int)</dt>
<dd>
current line
</dd>
<dt><i>col</i> (int)</dt>
<dd>
current position within line
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating, if the cursor is inside a comment
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="CompleterKivy.charAdded" ID="CompleterKivy.charAdded"></a>
<h4>CompleterKivy.charAdded</h4>
<b>charAdded</b>(<i>charNumber</i>)

<p>
        Public slot called to handle the user entering a character.
</p>
<dl>

<dt><i>charNumber</i> (int)</dt>
<dd>
value of the character entered
</dd>
</dl>
<a NAME="CompleterKivy.readSettings" ID="CompleterKivy.readSettings"></a>
<h4>CompleterKivy.readSettings</h4>
<b>readSettings</b>(<i></i>)

<p>
        Public slot called to reread the configuration parameters.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>