--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.QScintilla.TypingCompleters.CompleterBase.html Sat Jul 05 12:29:15 2014 +0200
@@ -0,0 +1,145 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.QScintilla.TypingCompleters.CompleterBase</title>
+<meta charset="UTF-8">
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.QScintilla.TypingCompleters.CompleterBase</h1>
+<p>
+Module implementing a base class for all typing completers.
+</p><p>
+Typing completers are classes that implement some convenience actions,
+that are performed while the user is typing (e.g. insert ')' when the
+user types '(').
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#CompleterBase">CompleterBase</a></td>
+<td>Class implementing the base class for all completers.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="CompleterBase" ID="CompleterBase"></a>
+<h2>CompleterBase</h2>
+<p>
+ Class implementing the base class for all completers.
+</p>
+<h3>Derived from</h3>
+QObject
+<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="#CompleterBase.__init__">CompleterBase</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#CompleterBase.charAdded">charAdded</a></td>
+<td>Public slot called to handle the user entering a character.</td>
+</tr><tr>
+<td><a href="#CompleterBase.isEnabled">isEnabled</a></td>
+<td>Public method to get the enabled state.</td>
+</tr><tr>
+<td><a href="#CompleterBase.readSettings">readSettings</a></td>
+<td>Public slot called to reread the configuration parameters.</td>
+</tr><tr>
+<td><a href="#CompleterBase.setEnabled">setEnabled</a></td>
+<td>Public slot to set the enabled state.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="CompleterBase.__init__" ID="CompleterBase.__init__"></a>
+<h4>CompleterBase (Constructor)</h4>
+<b>CompleterBase</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)
+ If parent is None, we set the editor as the parent.
+</dd>
+</dl><a NAME="CompleterBase.charAdded" ID="CompleterBase.charAdded"></a>
+<h4>CompleterBase.charAdded</h4>
+<b>charAdded</b>(<i>charNumber</i>)
+<p>
+ Public slot called to handle the user entering a character.
+</p><p>
+ Note 1: this slot must be overridden by subclasses implementing the
+ specific behavior for the language.
+</p><p>
+ Note 2: charNumber can be greater than 255 because the editor is
+ in UTF-8 mode by default.
+</p><dl>
+<dt><i>charNumber</i></dt>
+<dd>
+value of the character entered (integer)
+</dd>
+</dl><a NAME="CompleterBase.isEnabled" ID="CompleterBase.isEnabled"></a>
+<h4>CompleterBase.isEnabled</h4>
+<b>isEnabled</b>(<i></i>)
+<p>
+ Public method to get the enabled state.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+enabled state (boolean)
+</dd>
+</dl><a NAME="CompleterBase.readSettings" ID="CompleterBase.readSettings"></a>
+<h4>CompleterBase.readSettings</h4>
+<b>readSettings</b>(<i></i>)
+<p>
+ Public slot called to reread the configuration parameters.
+</p><p>
+ Note: this slot should be overridden by subclasses having
+ configurable parameters.
+</p><a NAME="CompleterBase.setEnabled" ID="CompleterBase.setEnabled"></a>
+<h4>CompleterBase.setEnabled</h4>
+<b>setEnabled</b>(<i>enable</i>)
+<p>
+ Public slot to set the enabled state.
+</p><dl>
+<dt><i>enable</i></dt>
+<dd>
+flag indicating the new enabled state (boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
