src/eric7/Documentation/Source/eric7.QScintilla.TypingCompleters.CompleterYaml.html

<!DOCTYPE html>
<html><head>
<title>eric7.QScintilla.TypingCompleters.CompleterYaml</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.TypingCompleters.CompleterYaml</h1>
<p>
Module implementing a typing completer for YAML.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#CompleterYaml">CompleterYaml</a></td>
<td>Class implementing typing completer for YAML.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr>
<td><a href="#createCompleter">createCompleter</a></td>
<td>Function to instantiate a typing completer object.</td>
</tr>
</table>

<hr />
<hr />
<a NAME="CompleterYaml" ID="CompleterYaml"></a>
<h2>CompleterYaml</h2>
<p>
    Class implementing typing completer for YAML.
</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="#CompleterYaml.__init__">CompleterYaml</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#CompleterYaml.__inComment">__inComment</a></td>
<td>Private method to check, if the cursor is inside a comment.</td>
</tr>
<tr>
<td><a href="#CompleterYaml.charAdded">charAdded</a></td>
<td>Public slot called to handle the user entering a character.</td>
</tr>
<tr>
<td><a href="#CompleterYaml.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="CompleterYaml.__init__" ID="CompleterYaml.__init__"></a>
<h4>CompleterYaml (Constructor)</h4>
<b>CompleterYaml</b>(<i>editor, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>editor</i> (QScintilla.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="CompleterYaml.__inComment" ID="CompleterYaml.__inComment"></a>
<h4>CompleterYaml.__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="CompleterYaml.charAdded" ID="CompleterYaml.charAdded"></a>
<h4>CompleterYaml.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="CompleterYaml.readSettings" ID="CompleterYaml.readSettings"></a>
<h4>CompleterYaml.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 />
<hr />
<a NAME="createCompleter" ID="createCompleter"></a>
<h2>createCompleter</h2>
<b>createCompleter</b>(<i>editor, parent=None</i>)
<p>
    Function to instantiate a typing completer object.
</p>

<dl>

<dt><i>editor</i> (QScintilla.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>
CompleterYaml
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>