Documentation/Source/eric5.QScintilla.TypingCompleters.CompleterPython.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.QScintilla.TypingCompleters.CompleterPython</title>
<style>
body {
    background:white;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #4FA4FF; }
h2 { color: white; background: #4FA4FF; }
h3 { color: white; background: #00557F; }
h4 { color: white; background: #00557F; }
    
a { color: #AA5500; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.QScintilla.TypingCompleters.CompleterPython</h1>
<p>
Module implementing a typing completer for Python.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#CompleterPython">CompleterPython</a></td>
<td>Class implementing typing completer for Python.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="CompleterPython" ID="CompleterPython"></a>
<h2>CompleterPython</h2>
<p>
    Class implementing typing completer for Python.
</p>
<h3>Derived from</h3>
CompleterBase
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#CompleterPython.__init__">CompleterPython</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#CompleterPython.__dedentDefStatement">__dedentDefStatement</a></td>
<td>Private method to dedent the line of the def statement to a previous def statement or class statement.</td>
</tr><tr>
<td><a href="#CompleterPython.__dedentElseToIfWhileForTry">__dedentElseToIfWhileForTry</a></td>
<td>Private method to dedent the line of the else statement to the last if, while, for or try statement with less (or equal) indentation.</td>
</tr><tr>
<td><a href="#CompleterPython.__dedentExceptToTry">__dedentExceptToTry</a></td>
<td>Private method to dedent the line of the except statement to the last try statement with less (or equal) indentation.</td>
</tr><tr>
<td><a href="#CompleterPython.__dedentFinallyToTry">__dedentFinallyToTry</a></td>
<td>Private method to dedent the line of the except statement to the last try statement with less (or equal) indentation.</td>
</tr><tr>
<td><a href="#CompleterPython.__dedentToIf">__dedentToIf</a></td>
<td>Private method to dedent the last line to the last if statement with less (or equal) indentation.</td>
</tr><tr>
<td><a href="#CompleterPython.__inComment">__inComment</a></td>
<td>Private method to check, if the cursor is inside a comment</td>
</tr><tr>
<td><a href="#CompleterPython.__inDoubleQuotedString">__inDoubleQuotedString</a></td>
<td>Private method to check, if the cursor is within a double quoted string.</td>
</tr><tr>
<td><a href="#CompleterPython.__inSingleQuotedString">__inSingleQuotedString</a></td>
<td>Private method to check, if the cursor is within a single quoted string.</td>
</tr><tr>
<td><a href="#CompleterPython.__inTripleDoubleQuotedString">__inTripleDoubleQuotedString</a></td>
<td>Private method to check, if the cursor is within a triple double quoted string.</td>
</tr><tr>
<td><a href="#CompleterPython.__inTripleSingleQuotedString">__inTripleSingleQuotedString</a></td>
<td>Private method to check, if the cursor is within a triple single quoted string.</td>
</tr><tr>
<td><a href="#CompleterPython.__isClassMethod">__isClassMethod</a></td>
<td>Private method to check, if the user is defining a class method.</td>
</tr><tr>
<td><a href="#CompleterPython.__isClassmethodDef">__isClassmethodDef</a></td>
<td>Private method to check, if the user is defing a classmethod (@classmethod) method.</td>
</tr><tr>
<td><a href="#CompleterPython.charAdded">charAdded</a></td>
<td>Public slot called to handle the user entering a character.</td>
</tr><tr>
<td><a href="#CompleterPython.readSettings">readSettings</a></td>
<td>Public slot called to reread the configuration parameters.</td>
</tr>
</table>
<a NAME="CompleterPython.__init__" ID="CompleterPython.__init__"></a>
<h4>CompleterPython (Constructor)</h4>
<b>CompleterPython</b>(<i>editor, parent = None</i>)
<p>
        Constructor
</p><dl>
<dt><i>editor</i></dt>
<dd>
reference to the editor object (QScintilla.Editor)
</dd><dt><i>parent</i></dt>
<dd>
reference to the parent object (QObject)
</dd>
</dl><a NAME="CompleterPython.__dedentDefStatement" ID="CompleterPython.__dedentDefStatement"></a>
<h4>CompleterPython.__dedentDefStatement</h4>
<b>__dedentDefStatement</b>(<i></i>)
<p>
        Private method to dedent the line of the def statement to a previous def
        statement or class statement.
</p><a NAME="CompleterPython.__dedentElseToIfWhileForTry" ID="CompleterPython.__dedentElseToIfWhileForTry"></a>
<h4>CompleterPython.__dedentElseToIfWhileForTry</h4>
<b>__dedentElseToIfWhileForTry</b>(<i></i>)
<p>
        Private method to dedent the line of the else statement to the last
        if, while, for or try statement with less (or equal) indentation.
</p><a NAME="CompleterPython.__dedentExceptToTry" ID="CompleterPython.__dedentExceptToTry"></a>
<h4>CompleterPython.__dedentExceptToTry</h4>
<b>__dedentExceptToTry</b>(<i>hasColon</i>)
<p>
        Private method to dedent the line of the except statement to the last 
        try statement with less (or equal) indentation.
</p><dl>
<dt><i>hasColon</i></dt>
<dd>
flag indicating the except type (boolean)
</dd>
</dl><a NAME="CompleterPython.__dedentFinallyToTry" ID="CompleterPython.__dedentFinallyToTry"></a>
<h4>CompleterPython.__dedentFinallyToTry</h4>
<b>__dedentFinallyToTry</b>(<i></i>)
<p>
        Private method to dedent the line of the except statement to the last 
        try statement with less (or equal) indentation.
</p><a NAME="CompleterPython.__dedentToIf" ID="CompleterPython.__dedentToIf"></a>
<h4>CompleterPython.__dedentToIf</h4>
<b>__dedentToIf</b>(<i></i>)
<p>
        Private method to dedent the last line to the last if statement with
        less (or equal) indentation.
</p><a NAME="CompleterPython.__inComment" ID="CompleterPython.__inComment"></a>
<h4>CompleterPython.__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></dt>
<dd>
current line (integer)
</dd><dt><i>col</i></dt>
<dd>
current position within line (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating, if the cursor is inside a comment (boolean)
</dd>
</dl><a NAME="CompleterPython.__inDoubleQuotedString" ID="CompleterPython.__inDoubleQuotedString"></a>
<h4>CompleterPython.__inDoubleQuotedString</h4>
<b>__inDoubleQuotedString</b>(<i></i>)
<p>
        Private method to check, if the cursor is within a double quoted string.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating, if the cursor is inside a double
            quoted string (boolean)
</dd>
</dl><a NAME="CompleterPython.__inSingleQuotedString" ID="CompleterPython.__inSingleQuotedString"></a>
<h4>CompleterPython.__inSingleQuotedString</h4>
<b>__inSingleQuotedString</b>(<i></i>)
<p>
        Private method to check, if the cursor is within a single quoted string.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating, if the cursor is inside a single
            quoted string (boolean)
</dd>
</dl><a NAME="CompleterPython.__inTripleDoubleQuotedString" ID="CompleterPython.__inTripleDoubleQuotedString"></a>
<h4>CompleterPython.__inTripleDoubleQuotedString</h4>
<b>__inTripleDoubleQuotedString</b>(<i></i>)
<p>
        Private method to check, if the cursor is within a triple double quoted string.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating, if the cursor is inside a triple double
            quoted string (boolean)
</dd>
</dl><a NAME="CompleterPython.__inTripleSingleQuotedString" ID="CompleterPython.__inTripleSingleQuotedString"></a>
<h4>CompleterPython.__inTripleSingleQuotedString</h4>
<b>__inTripleSingleQuotedString</b>(<i></i>)
<p>
        Private method to check, if the cursor is within a triple single quoted string.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating, if the cursor is inside a triple single
            quoted string (boolean)
</dd>
</dl><a NAME="CompleterPython.__isClassMethod" ID="CompleterPython.__isClassMethod"></a>
<h4>CompleterPython.__isClassMethod</h4>
<b>__isClassMethod</b>(<i></i>)
<p>
        Private method to check, if the user is defining a class method.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating the definition of a class method (boolean)
</dd>
</dl><a NAME="CompleterPython.__isClassmethodDef" ID="CompleterPython.__isClassmethodDef"></a>
<h4>CompleterPython.__isClassmethodDef</h4>
<b>__isClassmethodDef</b>(<i></i>)
<p>
        Private method to check, if the user is defing a classmethod 
        (@classmethod) method.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating the definition of a classmethod method (boolean)
</dd>
</dl><a NAME="CompleterPython.charAdded" ID="CompleterPython.charAdded"></a>
<h4>CompleterPython.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></dt>
<dd>
value of the character entered (integer)
</dd>
</dl><a NAME="CompleterPython.readSettings" ID="CompleterPython.readSettings"></a>
<h4>CompleterPython.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>