eric: diff Documentation/Source/eric5.QScintilla.TypingCompleters.CompleterBase.html

diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.QScintilla.TypingCompleters.CompleterBase.html
--- a/Documentation/Source/eric5.QScintilla.TypingCompleters.CompleterBase.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.QScintilla.TypingCompleters.CompleterBase.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,11 +22,11 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.QScintilla.TypingCompleters.CompleterBase</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#116;y&#112;&#105;&#110;&#103; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114;&#115;.
+Module implementing a base class for all typing completers.
 </p><p>
-&#84;y&#112;&#105;&#110;&#103; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114;&#115; &#97;&#114;&#101; &#99;&#108;&#97;&#115;&#115;&#101;&#115; &#116;&#104;&#97;&#116; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116; &#115;&#111;&#109;&#101; &#99;&#111;&#110;v&#101;&#110;&#105;&#101;&#110;&#99;&#101; &#97;&#99;&#116;&#105;&#111;&#110;&#115;,
-&#116;&#104;&#97;&#116; &#97;&#114;&#101; &#112;&#101;&#114;&#102;&#111;&#114;&#109;&#101;&#100; w&#104;&#105;&#108;&#101; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#105;&#115; &#116;y&#112;&#105;&#110;&#103; (&#101;.&#103;. &#105;&#110;&#115;&#101;&#114;&#116; ')' w&#104;&#101;&#110; &#116;&#104;&#101;
-&#117;&#115;&#101;&#114; &#116;y&#112;&#101;&#115; '(').
+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>
@@ -36,7 +36,7 @@
 <table>
 <tr>
 <td><a href="#CompleterBase">CompleterBase</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114;&#115;.</td>
+<td>Class implementing the base class for all completers.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -47,7 +47,7 @@
 <a NAME="CompleterBase" ID="CompleterBase"></a>
 <h2>CompleterBase</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#98;&#97;&#115;&#101; &#99;&#108;&#97;&#115;&#115; &#102;&#111;&#114; &#97;&#108;&#108; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101;&#114;&#115;.
+    Class implementing the base class for all completers.
 </p>
 <h3>Derived from</h3>
 QObject
@@ -59,73 +59,73 @@
 <table>
 <tr>
 <td><a href="#CompleterBase.__init__">CompleterBase</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#CompleterBase.charAdded">charAdded</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#101;&#110;&#116;&#101;&#114;&#105;&#110;&#103; &#97; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114;.</td>
+<td>Public slot called to handle the user entering a character.</td>
 </tr><tr>
 <td><a href="#CompleterBase.isEnabled">isEnabled</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101;.</td>
+<td>Public method to get the enabled state.</td>
 </tr><tr>
 <td><a href="#CompleterBase.readSettings">readSettings</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#114;&#101;&#114;&#101;&#97;&#100; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;.</td>
+<td>Public slot called to reread the configuration parameters.</td>
 </tr><tr>
 <td><a href="#CompleterBase.setEnabled">setEnabled</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101;.</td>
+<td>Public slot to set the enabled state.</td>
 </tr>
 </table>
 <a NAME="CompleterBase.__init__" ID="CompleterBase.__init__"></a>
 <h4>CompleterBase (Constructor)</h4>
 <b>CompleterBase</b>(<i>editor, parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>editor</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#83;&#99;&#105;&#110;&#116;&#105;&#108;&#108;&#97;.&#69;&#100;&#105;&#116;&#111;&#114;)
+reference to the editor object (QScintilla.Editor)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#81;&#79;&#98;&#106;&#101;&#99;&#116;)
-            &#73;&#102; &#112;&#97;&#114;&#101;&#110;&#116; &#105;&#115; &#78;&#111;&#110;&#101;, w&#101; &#115;&#101;&#116; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114; &#97;&#115; &#116;&#104;&#101; &#112;&#97;&#114;&#101;&#110;&#116;.
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#101;&#110;&#116;&#101;&#114;&#105;&#110;&#103; &#97; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114;.
+        Public slot called to handle the user entering a character.
 </p><p>
-        &#78;&#111;&#116;&#101; &#49;&#58; &#116;&#104;&#105;&#115; &#115;&#108;&#111;&#116; &#109;&#117;&#115;&#116; &#98;&#101; &#111;v&#101;&#114;&#114;&#105;&#100;&#100;&#101;&#110; &#98;y &#115;&#117;&#98;&#99;&#108;&#97;&#115;&#115;&#101;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101;
-        &#115;&#112;&#101;&#99;&#105;&#102;&#105;&#99; &#98;&#101;&#104;&#97;v&#105;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;.
+        Note 1: this slot must be overridden by subclasses implementing the
+        specific behavior for the language.
 </p><p>
-        &#78;&#111;&#116;&#101; &#50;&#58; &#99;&#104;&#97;&#114;&#78;&#117;&#109;&#98;&#101;&#114; &#99;&#97;&#110; &#98;&#101; &#103;&#114;&#101;&#97;&#116;&#101;&#114; &#116;&#104;&#97;&#110; &#50;&#53;&#53; &#98;&#101;&#99;&#97;&#117;&#115;&#101; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114; &#105;&#115;
-        &#105;&#110; &#85;&#84;&#70;-&#56; &#109;&#111;&#100;&#101; &#98;y &#100;&#101;&#102;&#97;&#117;&#108;&#116;.
+        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>
-v&#97;&#108;&#117;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#104;&#97;&#114;&#97;&#99;&#116;&#101;&#114; &#101;&#110;&#116;&#101;&#114;&#101;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101;.
+        Public method to get the enabled state.
 </p><a NAME="CompleterBase.readSettings" ID="CompleterBase.readSettings"></a>
 <h4>CompleterBase.readSettings</h4>
 <b>readSettings</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#116;&#111; &#114;&#101;&#114;&#101;&#97;&#100; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;.
+        Public slot called to reread the configuration parameters.
 </p><p>
-        &#78;&#111;&#116;&#101;&#58; &#116;&#104;&#105;&#115; &#115;&#108;&#111;&#116; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#111;v&#101;&#114;&#114;&#105;&#100;&#100;&#101;&#110; &#98;y &#115;&#117;&#98;&#99;&#108;&#97;&#115;&#115;&#101;&#115; &#104;&#97;v&#105;&#110;&#103;
-        &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#98;&#108;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;.
+        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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101;.
+        Public slot to set the enabled state.
 </p><dl>
 <dt><i>enabled</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#110;&#101;w &#115;&#116;&#97;&#116;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating the new state (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>