Documentation/Source/eric5.QScintilla.SpellChecker.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- a/Documentation/Source/eric5.QScintilla.SpellChecker.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.QScintilla.SpellChecker.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,9 +22,9 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.QScintilla.SpellChecker</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#115;&#112;&#101;&#108;&#108; &#99;&#104;&#101;&#99;&#107;&#101;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#101;&#100;&#105;&#116;&#111;&#114; &#99;&#111;&#109;&#112;&#111;&#110;&#101;&#110;&#116;.
+Module implementing the spell checker for the editor component.
 </p><p>
-&#84;&#104;&#101; &#115;&#112;&#101;&#108;&#108; &#99;&#104;&#101;&#99;&#107;&#101;&#114; &#105;&#115; &#98;&#97;&#115;&#101;&#100; &#111;&#110; &#112;y&#101;&#110;&#99;&#104;&#97;&#110;&#116;.
+The spell checker is based on pyenchant.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -34,7 +34,7 @@
 <table>
 <tr>
 <td><a href="#SpellChecker">SpellChecker</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#112;y&#101;&#110;&#99;&#104;&#97;&#110;&#116; &#98;&#97;&#115;&#101;&#100; &#115;&#112;&#101;&#108;&#108; &#99;&#104;&#101;&#99;&#107;&#101;&#114;.</td>
+<td>Class implementing a pyenchant based spell checker.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -45,7 +45,7 @@
 <a NAME="SpellChecker" ID="SpellChecker"></a>
 <h2>SpellChecker</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#112;y&#101;&#110;&#99;&#104;&#97;&#110;&#116; &#98;&#97;&#115;&#101;&#100; &#115;&#112;&#101;&#108;&#108; &#99;&#104;&#101;&#99;&#107;&#101;&#114;.
+    Class implementing a pyenchant based spell checker.
 </p>
 <h3>Derived from</h3>
 QObject
@@ -57,430 +57,430 @@
 <table>
 <tr>
 <td><a href="#SpellChecker.__init__">SpellChecker</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#SpellChecker.__checkDocumentPart">__checkDocumentPart</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#115;&#111;&#109;&#101; &#112;&#97;&#114;&#116; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.</td>
+<td>Private method to check some part of the document.</td>
 </tr><tr>
 <td><a href="#SpellChecker.__getNextWord">__getNextWord</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#110;&#101;x&#116; w&#111;&#114;&#100; &#105;&#110; &#116;&#104;&#101; &#116;&#101;x&#116; &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#103;&#105;v&#101;&#110; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;.</td>
+<td>Private method to get the next word in the text after the given position.</td>
 </tr><tr>
 <td><a href="#SpellChecker.__incrementalCheck">__incrementalCheck</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116;&#97;&#108;&#108;y.</td>
+<td>Private method to check the document incrementally.</td>
 </tr><tr>
 <td><a href="#SpellChecker.__iter__">__iter__</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#97;&#110; &#105;&#116;&#101;&#114;&#97;&#116;&#111;&#114;.</td>
+<td>Private method to create an iterator.</td>
 </tr><tr>
 <td><a href="#SpellChecker.__next__">__next__</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;v&#97;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#110;&#101;x&#116; &#101;&#114;&#114;&#111;&#114;.</td>
+<td>Public method to advance to the next error.</td>
 </tr><tr>
 <td><a href="#SpellChecker._getDict">_getDict</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#99;&#108;&#97;&#115;&#115;&#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#110;&#101;w &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y.</td>
+<td>Protected classmethod to get a new dictionary.</td>
 </tr><tr>
 <td><a href="#SpellChecker.add">add</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; w&#111;&#114;&#100; &#116;&#111; &#116;&#104;&#101; &#112;&#101;&#114;&#115;&#111;&#110;&#97;&#108; w&#111;&#114;&#100; &#108;&#105;&#115;&#116;.</td>
+<td>Public method to add a word to the personal word list.</td>
 </tr><tr>
 <td><a href="#SpellChecker.checkCurrentPage">checkCurrentPage</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116;&#108;y v&#105;&#115;&#105;&#98;&#108;&#101; &#112;&#97;&#103;&#101;.</td>
+<td>Private method to check the currently visible page.</td>
 </tr><tr>
 <td><a href="#SpellChecker.checkDocument">checkDocument</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;</td>
+<td>Public method to check the complete document</td>
 </tr><tr>
 <td><a href="#SpellChecker.checkDocumentIncrementally">checkDocumentIncrementally</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116;&#97;&#108;&#108;y.</td>
+<td>Public method to check the document incrementally.</td>
 </tr><tr>
 <td><a href="#SpellChecker.checkLines">checkLines</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#115;&#111;&#109;&#101; &#108;&#105;&#110;&#101;&#115; &#111;&#102; &#116;&#101;x&#116;.</td>
+<td>Public method to check some lines of text.</td>
 </tr><tr>
 <td><a href="#SpellChecker.checkSelection">checkSelection</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110;.</td>
+<td>Private method to check the current selection.</td>
 </tr><tr>
 <td><a href="#SpellChecker.checkWord">checkWord</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; w&#111;&#114;&#100; &#97;&#116; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#112;&#111;&#115;.</td>
+<td>Public method to check the word at position pos.</td>
 </tr><tr>
 <td><a href="#SpellChecker.clearAll">clearAll</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#108;&#101;&#97;&#114; &#97;&#108;&#108; &#115;&#112;&#101;&#108;&#108;&#105;&#110;&#103; &#109;&#97;&#114;&#107;&#101;&#114;&#115;.</td>
+<td>Public method to clear all spelling markers.</td>
 </tr><tr>
 <td><a href="#SpellChecker.getAvailableLanguages">getAvailableLanguages</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#99;&#108;&#97;&#115;&#115;&#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97;&#108;&#108; &#97;v&#97;&#105;&#108;&#97;&#98;&#108;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;&#115;.</td>
+<td>Public classmethod to get all available languages.</td>
 </tr><tr>
 <td><a href="#SpellChecker.getContext">getContext</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;x&#116; &#111;&#102; &#97; &#102;&#97;&#117;&#108;&#116;y w&#111;&#114;&#100;.</td>
+<td>Public method to get the context of a faulty word.</td>
 </tr><tr>
 <td><a href="#SpellChecker.getError">getError</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#97;&#98;&#111;&#117;&#116; &#116;&#104;&#101; &#108;&#97;&#115;&#116; &#101;&#114;&#114;&#111;&#114; &#102;&#111;&#117;&#110;&#100;.</td>
+<td>Public method to get information about the last error found.</td>
 </tr><tr>
 <td><a href="#SpellChecker.getLanguage">getLanguage</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;.</td>
+<td>Public method to get the current language.</td>
 </tr><tr>
 <td><a href="#SpellChecker.getSuggestions">getSuggestions</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#115;&#117;&#103;&#103;&#101;&#115;&#116;&#105;&#111;&#110;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#103;&#105;v&#101;&#110; w&#111;&#114;&#100;.</td>
+<td>Public method to get suggestions for the given word.</td>
 </tr><tr>
 <td><a href="#SpellChecker.ignoreAlways">ignoreAlways</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#116;&#101;&#108;&#108; &#116;&#104;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#114;, &#116;&#111; &#97;&#108;w&#97;y&#115; &#105;&#103;&#110;&#111;&#114;&#101; &#116;&#104;&#101; &#103;&#105;v&#101;&#110; w&#111;&#114;&#100; &#111;&#114; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; w&#111;&#114;&#100;.</td>
+<td>Public method to tell the checker, to always ignore the given word or the current word.</td>
 </tr><tr>
 <td><a href="#SpellChecker.initCheck">initCheck</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#97; &#115;&#112;&#101;&#108;&#108; &#99;&#104;&#101;&#99;&#107;.</td>
+<td>Public method to initialize a spell check.</td>
 </tr><tr>
 <td><a href="#SpellChecker.isAvailable">isAvailable</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#99;&#108;&#97;&#115;&#115;&#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#115;&#112;&#101;&#108;&#108;&#99;&#104;&#101;&#99;&#107;&#105;&#110;&#103; &#105;&#115; &#97;v&#97;&#105;&#108;&#97;&#98;&#108;&#101;.</td>
+<td>Public classmethod to check, if spellchecking is available.</td>
 </tr><tr>
 <td><a href="#SpellChecker.remove">remove</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; w&#111;&#114;&#100; &#116;&#111; &#116;&#104;&#101; &#112;&#101;&#114;&#115;&#111;&#110;&#97;&#108; &#101;x&#99;&#108;&#117;&#100;&#101; &#108;&#105;&#115;&#116;.</td>
+<td>Public method to add a word to the personal exclude list.</td>
 </tr><tr>
 <td><a href="#SpellChecker.replace">replace</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#116;&#101;&#108;&#108; &#116;&#104;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#114; &#116;&#111; &#114;&#101;&#112;&#108;&#97;&#99;&#101; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; w&#111;&#114;&#100; w&#105;&#116;&#104; &#116;&#104;&#101; &#114;&#101;&#112;&#108;&#97;&#99;&#101;&#109;&#101;&#110;&#116; &#115;&#116;&#114;&#105;&#110;&#103;.</td>
+<td>Public method to tell the checker to replace the current word with the replacement string.</td>
 </tr><tr>
 <td><a href="#SpellChecker.replaceAlways">replaceAlways</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#116;&#101;&#108;&#108; &#116;&#104;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#114; &#116;&#111; &#97;&#108;w&#97;y&#115; &#114;&#101;&#112;&#108;&#97;&#99;&#101; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; w&#111;&#114;&#100; w&#105;&#116;&#104; &#116;&#104;&#101; &#114;&#101;&#112;&#108;&#97;&#99;&#101;&#109;&#101;&#110;&#116; &#115;&#116;&#114;&#105;&#110;&#103;.</td>
+<td>Public method to tell the checker to always replace the current word with the replacement string.</td>
 </tr><tr>
 <td><a href="#SpellChecker.setDefaultLanguage">setDefaultLanguage</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#99;&#108;&#97;&#115;&#115;&#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;.</td>
+<td>Public classmethod to set the default language.</td>
 </tr><tr>
 <td><a href="#SpellChecker.setLanguage">setLanguage</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;.</td>
+<td>Public method to set the current language.</td>
 </tr><tr>
 <td><a href="#SpellChecker.setMinimumWordSize">setMinimumWordSize</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#109;&#105;&#110;&#105;&#109;&#117;&#109; w&#111;&#114;&#100; &#115;&#105;z&#101;.</td>
+<td>Public method to set the minimum word size.</td>
 </tr><tr>
 <td><a href="#SpellChecker.stopIncrementalCheck">stopIncrementalCheck</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#116;&#111;&#112; &#97;&#110; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116;&#97;&#108; &#99;&#104;&#101;&#99;&#107;.</td>
+<td>Public method to stop an incremental check.</td>
 </tr>
 </table>
 <a NAME="SpellChecker.__init__" ID="SpellChecker.__init__"></a>
 <h4>SpellChecker (Constructor)</h4>
 <b>SpellChecker</b>(<i>editor, indicator, defaultLanguage = None, checkRegion = 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>indicator</i></dt>
 <dd>
-&#115;&#112;&#101;&#108;&#108; &#99;&#104;&#101;&#99;&#107;&#105;&#110;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#111;&#114;
+spell checking indicator
 </dd><dt><i>defaultLanguage=</i></dt>
 <dd>
-&#116;&#104;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;).
-            &#84;&#104;&#101; &#115;&#116;&#114;&#105;&#110;&#103; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#105;&#110; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#108;&#111;&#99;&#97;&#108;&#101; &#102;&#111;&#114;&#109;&#97;&#116; (&#101;.&#103;. &#101;&#110;&#95;&#85;&#83;, &#100;&#101;).
+the language to be used as the default (string).
+            The string should be in language locale format (e.g. en_US, de).
 </dd><dt><i>checkRegion=</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#97; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#102;&#111;&#114; &#97; v&#97;&#108;&#105;&#100; &#114;&#101;&#103;&#105;&#111;&#110;
+reference to a function to check for a valid region
 </dd>
 </dl><a NAME="SpellChecker.__checkDocumentPart" ID="SpellChecker.__checkDocumentPart"></a>
 <h4>SpellChecker.__checkDocumentPart</h4>
 <b>__checkDocumentPart</b>(<i>startPos, endPos</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#115;&#111;&#109;&#101; &#112;&#97;&#114;&#116; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;.
+        Private method to check some part of the document.
 </p><dl>
 <dt><i>startPos</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#97;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position to start at (integer)
 </dd><dt><i>endPos</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#116;&#111; &#101;&#110;&#100; &#97;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position to end at (integer)
 </dd>
 </dl><a NAME="SpellChecker.__getNextWord" ID="SpellChecker.__getNextWord"></a>
 <h4>SpellChecker.__getNextWord</h4>
 <b>__getNextWord</b>(<i>pos, endPosition</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#110;&#101;x&#116; w&#111;&#114;&#100; &#105;&#110; &#116;&#104;&#101; &#116;&#101;x&#116; &#97;&#102;&#116;&#101;&#114; &#116;&#104;&#101; &#103;&#105;v&#101;&#110; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110;.
+        Private method to get the next word in the text after the given position.
 </p><dl>
 <dt><i>pos</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#116;&#97;&#114;&#116; w&#111;&#114;&#100; &#101;x&#116;&#114;&#97;&#99;&#116;&#105;&#111;&#110; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position to start word extraction (integer)
 </dd><dt><i>endPosition</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#116;&#111;&#112; w&#111;&#114;&#100; &#101;x&#116;&#114;&#97;&#99;&#116;&#105;&#111;&#110; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position to stop word extraction (integer)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;&#104;&#114;&#101;&#101; v&#97;&#108;&#117;&#101;&#115; (&#116;&#104;&#101; &#101;x&#116;&#114;&#97;&#99;&#116;&#101;&#100; w&#111;&#114;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;),
-            &#115;&#116;&#97;&#114;&#116; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;), &#101;&#110;&#100; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;))
+tuple of three values (the extracted word (string),
+            start position (integer), end position (integer))
 </dd>
 </dl><a NAME="SpellChecker.__incrementalCheck" ID="SpellChecker.__incrementalCheck"></a>
 <h4>SpellChecker.__incrementalCheck</h4>
 <b>__incrementalCheck</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116;&#97;&#108;&#108;y.
+        Private method to check the document incrementally.
 </p><a NAME="SpellChecker.__iter__" ID="SpellChecker.__iter__"></a>
 <h4>SpellChecker.__iter__</h4>
 <b>__iter__</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#97;&#110; &#105;&#116;&#101;&#114;&#97;&#116;&#111;&#114;.
+        Private method to create an iterator.
 </p><a NAME="SpellChecker.__next__" ID="SpellChecker.__next__"></a>
 <h4>SpellChecker.__next__</h4>
 <b>__next__</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;v&#97;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#110;&#101;x&#116; &#101;&#114;&#114;&#111;&#114;.
+        Public method to advance to the next error.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#115;&#101;&#108;&#102;
+self
 </dd>
 </dl><a NAME="SpellChecker._getDict" ID="SpellChecker._getDict"></a>
 <h4>SpellChecker._getDict</h4>
 <b>_getDict</b>(<i>lang, pwl = "", pel = ""</i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#99;&#108;&#97;&#115;&#115;&#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#110;&#101;w &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y.
+        Protected classmethod to get a new dictionary.
 </p><dl>
 <dt><i>lang</i></dt>
 <dd>
-&#116;&#104;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;).
-            &#84;&#104;&#101; &#115;&#116;&#114;&#105;&#110;&#103; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#105;&#110; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#108;&#111;&#99;&#97;&#108;&#101; &#102;&#111;&#114;&#109;&#97;&#116; (&#101;.&#103;. &#101;&#110;&#95;&#85;&#83;, &#100;&#101;).
+the language to be used as the default (string).
+            The string should be in language locale format (e.g. en_US, de).
 </dd><dt><i>pwl=</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#112;&#101;&#114;&#115;&#111;&#110;&#97;&#108;/&#112;&#114;&#111;&#106;&#101;&#99;&#116; w&#111;&#114;&#100; &#108;&#105;&#115;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the personal/project word list (string)
 </dd><dt><i>pel=</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#112;&#101;&#114;&#115;&#111;&#110;&#97;&#108;/&#112;&#114;&#111;&#106;&#101;&#99;&#116; &#101;x&#99;&#108;&#117;&#100;&#101; &#108;&#105;&#115;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the personal/project exclude list (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y (&#101;&#110;&#99;&#104;&#97;&#110;&#116;.&#68;&#105;&#99;&#116;)
+reference to the dictionary (enchant.Dict)
 </dd>
 </dl><a NAME="SpellChecker.add" ID="SpellChecker.add"></a>
 <h4>SpellChecker.add</h4>
 <b>add</b>(<i>word = None</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; w&#111;&#114;&#100; &#116;&#111; &#116;&#104;&#101; &#112;&#101;&#114;&#115;&#111;&#110;&#97;&#108; w&#111;&#114;&#100; &#108;&#105;&#115;&#116;.
+        Public method to add a word to the personal word list.
 </p><dl>
 <dt><i>word</i></dt>
 <dd>
-w&#111;&#114;&#100; &#116;&#111; &#97;&#100;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+word to add (string)
 </dd>
 </dl><a NAME="SpellChecker.checkCurrentPage" ID="SpellChecker.checkCurrentPage"></a>
 <h4>SpellChecker.checkCurrentPage</h4>
 <b>checkCurrentPage</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116;&#108;y v&#105;&#115;&#105;&#98;&#108;&#101; &#112;&#97;&#103;&#101;.
+        Private method to check the currently visible page.
 </p><a NAME="SpellChecker.checkDocument" ID="SpellChecker.checkDocument"></a>
 <h4>SpellChecker.checkDocument</h4>
 <b>checkDocument</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#99;&#111;&#109;&#112;&#108;&#101;&#116;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;
+        Public method to check the complete document
 </p><a NAME="SpellChecker.checkDocumentIncrementally" ID="SpellChecker.checkDocumentIncrementally"></a>
 <h4>SpellChecker.checkDocumentIncrementally</h4>
 <b>checkDocumentIncrementally</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116;&#97;&#108;&#108;y.
+        Public method to check the document incrementally.
 </p><a NAME="SpellChecker.checkLines" ID="SpellChecker.checkLines"></a>
 <h4>SpellChecker.checkLines</h4>
 <b>checkLines</b>(<i>firstLine, lastLine</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#115;&#111;&#109;&#101; &#108;&#105;&#110;&#101;&#115; &#111;&#102; &#116;&#101;x&#116;.
+        Public method to check some lines of text.
 </p><dl>
 <dt><i>firstLine</i></dt>
 <dd>
-&#108;&#105;&#110;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#102;&#105;&#114;&#115;&#116; &#108;&#105;&#110;&#101; &#116;&#111; &#99;&#104;&#101;&#99;&#107; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+line number of first line to check (integer)
 </dd><dt><i>lastLine</i></dt>
 <dd>
-&#108;&#105;&#110;&#101; &#110;&#117;&#109;&#98;&#101;&#114; &#111;&#102; &#108;&#97;&#115;&#116; &#108;&#105;&#110;&#101; &#116;&#111; &#99;&#104;&#101;&#99;&#107; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+line number of last line to check (integer)
 </dd>
 </dl><a NAME="SpellChecker.checkSelection" ID="SpellChecker.checkSelection"></a>
 <h4>SpellChecker.checkSelection</h4>
 <b>checkSelection</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110;.
+        Private method to check the current selection.
 </p><a NAME="SpellChecker.checkWord" ID="SpellChecker.checkWord"></a>
 <h4>SpellChecker.checkWord</h4>
 <b>checkWord</b>(<i>pos, atEnd = False</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; w&#111;&#114;&#100; &#97;&#116; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#112;&#111;&#115;.
+        Public method to check the word at position pos.
 </p><dl>
 <dt><i>pos</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#97;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position to check at (integer)
 </dd><dt><i>atEnd=</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#105;&#115; &#97;&#116; &#116;&#104;&#101; &#101;&#110;&#100; &#111;&#102; &#116;&#104;&#101; w&#111;&#114;&#100;
-            &#116;&#111; &#99;&#104;&#101;&#99;&#107; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating the position is at the end of the word
+            to check (boolean)
 </dd>
 </dl><a NAME="SpellChecker.clearAll" ID="SpellChecker.clearAll"></a>
 <h4>SpellChecker.clearAll</h4>
 <b>clearAll</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#108;&#101;&#97;&#114; &#97;&#108;&#108; &#115;&#112;&#101;&#108;&#108;&#105;&#110;&#103; &#109;&#97;&#114;&#107;&#101;&#114;&#115;.
+        Public method to clear all spelling markers.
 </p><a NAME="SpellChecker.getAvailableLanguages" ID="SpellChecker.getAvailableLanguages"></a>
 <h4>SpellChecker.getAvailableLanguages</h4>
 <b>getAvailableLanguages</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#99;&#108;&#97;&#115;&#115;&#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97;&#108;&#108; &#97;v&#97;&#105;&#108;&#97;&#98;&#108;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;&#115;.
+        Public classmethod to get all available languages.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#97;v&#97;&#105;&#108;&#97;&#98;&#108;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of available languages (list of strings)
 </dd>
 </dl><a NAME="SpellChecker.getContext" ID="SpellChecker.getContext"></a>
 <h4>SpellChecker.getContext</h4>
 <b>getContext</b>(<i>wordStart, wordEnd</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;x&#116; &#111;&#102; &#97; &#102;&#97;&#117;&#108;&#116;y w&#111;&#114;&#100;.
+        Public method to get the context of a faulty word.
 </p><dl>
 <dt><i>wordStart</i></dt>
 <dd>
-&#116;&#104;&#101; &#115;&#116;&#97;&#114;&#116;&#105;&#110;&#103; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; w&#111;&#114;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+the starting position of the word (integer)
 </dd><dt><i>wordEnd</i></dt>
 <dd>
-&#116;&#104;&#101; &#101;&#110;&#100;&#105;&#110;&#103; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; w&#111;&#114;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+the ending position of the word (integer)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;&#104;&#101; &#108;&#101;&#97;&#100;&#105;&#110;&#103; &#97;&#110;&#100; &#116;&#114;&#97;&#105;&#108;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#101;x&#116; (&#115;&#116;&#114;&#105;&#110;&#103;, &#115;&#116;&#114;&#105;&#110;&#103;)
+tuple of the leading and trailing context (string, string)
 </dd>
 </dl><a NAME="SpellChecker.getError" ID="SpellChecker.getError"></a>
 <h4>SpellChecker.getError</h4>
 <b>getError</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#97;&#98;&#111;&#117;&#116; &#116;&#104;&#101; &#108;&#97;&#115;&#116; &#101;&#114;&#114;&#111;&#114; &#102;&#111;&#117;&#110;&#100;.
+        Public method to get information about the last error found.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#108;&#97;&#115;&#116; &#102;&#97;&#117;&#108;&#116;y w&#111;&#114;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;), &#115;&#116;&#97;&#114;&#116;&#105;&#110;&#103; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101;
-            &#102;&#97;&#117;&#108;&#116;y w&#111;&#114;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;) &#97;&#110;&#100; &#101;&#110;&#100;&#105;&#110;&#103; &#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#102;&#97;&#117;&#108;&#116;y w&#111;&#114;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+tuple of last faulty word (string), starting position of the
+            faulty word (integer) and ending position of the faulty word (integer)
 </dd>
 </dl><a NAME="SpellChecker.getLanguage" ID="SpellChecker.getLanguage"></a>
 <h4>SpellChecker.getLanguage</h4>
 <b>getLanguage</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;.
+        Public method to get the current language.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#99;&#117;&#114;&#114;&#101;&#110;&#116; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#105;&#110; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#108;&#111;&#99;&#97;&#108;&#101; &#102;&#111;&#114;&#109;&#97;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+current language in language locale format (string)
 </dd>
 </dl><a NAME="SpellChecker.getSuggestions" ID="SpellChecker.getSuggestions"></a>
 <h4>SpellChecker.getSuggestions</h4>
 <b>getSuggestions</b>(<i>word</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#115;&#117;&#103;&#103;&#101;&#115;&#116;&#105;&#111;&#110;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#103;&#105;v&#101;&#110; w&#111;&#114;&#100;.
+        Public method to get suggestions for the given word.
 </p><dl>
 <dt><i>word</i></dt>
 <dd>
-w&#111;&#114;&#100; &#116;&#111; &#103;&#101;&#116; &#115;&#117;&#103;&#103;&#101;&#115;&#116;&#105;&#111;&#110;&#115; &#102;&#111;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;)
+word to get suggestions for (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#117;&#103;&#103;&#101;&#115;&#116;&#105;&#111;&#110;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of suggestions (list of strings)
 </dd>
 </dl><a NAME="SpellChecker.ignoreAlways" ID="SpellChecker.ignoreAlways"></a>
 <h4>SpellChecker.ignoreAlways</h4>
 <b>ignoreAlways</b>(<i>word = None</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#116;&#101;&#108;&#108; &#116;&#104;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#114;, &#116;&#111; &#97;&#108;w&#97;y&#115; &#105;&#103;&#110;&#111;&#114;&#101; &#116;&#104;&#101; &#103;&#105;v&#101;&#110; w&#111;&#114;&#100;
-        &#111;&#114; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; w&#111;&#114;&#100;.
+        Public method to tell the checker, to always ignore the given word
+        or the current word.
 </p><dl>
 <dt><i>word</i></dt>
 <dd>
-w&#111;&#114;&#100; &#116;&#111; &#98;&#101; &#105;&#103;&#110;&#111;&#114;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+word to be ignored (string)
 </dd>
 </dl><a NAME="SpellChecker.initCheck" ID="SpellChecker.initCheck"></a>
 <h4>SpellChecker.initCheck</h4>
 <b>initCheck</b>(<i>startPos, endPos</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#97; &#115;&#112;&#101;&#108;&#108; &#99;&#104;&#101;&#99;&#107;.
+        Public method to initialize a spell check.
 </p><dl>
 <dt><i>startPos</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#97;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position to start at (integer)
 </dd><dt><i>endPos</i></dt>
 <dd>
-&#112;&#111;&#115;&#105;&#116;&#105;&#111;&#110; &#116;&#111; &#101;&#110;&#100; &#97;&#116; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+position to end at (integer)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#115;&#117;&#99;&#99;&#101;&#115;&#115;&#102;&#117;&#108; &#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#97;&#116;&#105;&#111;&#110; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating successful initialization (boolean)
 </dd>
 </dl><a NAME="SpellChecker.isAvailable" ID="SpellChecker.isAvailable"></a>
 <h4>SpellChecker.isAvailable</h4>
 <b>isAvailable</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#99;&#108;&#97;&#115;&#115;&#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#115;&#112;&#101;&#108;&#108;&#99;&#104;&#101;&#99;&#107;&#105;&#110;&#103; &#105;&#115; &#97;v&#97;&#105;&#108;&#97;&#98;&#108;&#101;.
+        Public classmethod to check, if spellchecking is available.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97;v&#97;&#105;&#108;&#97;&#98;&#105;&#108;&#105;&#116;y (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating availability (boolean)
 </dd>
 </dl><a NAME="SpellChecker.remove" ID="SpellChecker.remove"></a>
 <h4>SpellChecker.remove</h4>
 <b>remove</b>(<i>word</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; w&#111;&#114;&#100; &#116;&#111; &#116;&#104;&#101; &#112;&#101;&#114;&#115;&#111;&#110;&#97;&#108; &#101;x&#99;&#108;&#117;&#100;&#101; &#108;&#105;&#115;&#116;.
+        Public method to add a word to the personal exclude list.
 </p><dl>
 <dt><i>word</i></dt>
 <dd>
-w&#111;&#114;&#100; &#116;&#111; &#97;&#100;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+word to add (string)
 </dd>
 </dl><a NAME="SpellChecker.replace" ID="SpellChecker.replace"></a>
 <h4>SpellChecker.replace</h4>
 <b>replace</b>(<i>replacement</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#116;&#101;&#108;&#108; &#116;&#104;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#114; &#116;&#111; &#114;&#101;&#112;&#108;&#97;&#99;&#101; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; w&#111;&#114;&#100; w&#105;&#116;&#104; 
-        &#116;&#104;&#101; &#114;&#101;&#112;&#108;&#97;&#99;&#101;&#109;&#101;&#110;&#116; &#115;&#116;&#114;&#105;&#110;&#103;.
+        Public method to tell the checker to replace the current word with 
+        the replacement string.
 </p><dl>
 <dt><i>replacement</i></dt>
 <dd>
-&#114;&#101;&#112;&#108;&#97;&#99;&#101;&#109;&#101;&#110;&#116; &#115;&#116;&#114;&#105;&#110;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;)
+replacement string (string)
 </dd>
 </dl><a NAME="SpellChecker.replaceAlways" ID="SpellChecker.replaceAlways"></a>
 <h4>SpellChecker.replaceAlways</h4>
 <b>replaceAlways</b>(<i>replacement</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#116;&#101;&#108;&#108; &#116;&#104;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#114; &#116;&#111; &#97;&#108;w&#97;y&#115; &#114;&#101;&#112;&#108;&#97;&#99;&#101; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; w&#111;&#114;&#100;
-        w&#105;&#116;&#104; &#116;&#104;&#101; &#114;&#101;&#112;&#108;&#97;&#99;&#101;&#109;&#101;&#110;&#116; &#115;&#116;&#114;&#105;&#110;&#103;.
+        Public method to tell the checker to always replace the current word
+        with the replacement string.
 </p><dl>
 <dt><i>replacement</i></dt>
 <dd>
-&#114;&#101;&#112;&#108;&#97;&#99;&#101;&#109;&#101;&#110;&#116; &#115;&#116;&#114;&#105;&#110;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;)
+replacement string (string)
 </dd>
 </dl><a NAME="SpellChecker.setDefaultLanguage" ID="SpellChecker.setDefaultLanguage"></a>
 <h4>SpellChecker.setDefaultLanguage</h4>
 <b>setDefaultLanguage</b>(<i>language</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#99;&#108;&#97;&#115;&#115;&#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;.
+        Public classmethod to set the default language.
 </p><dl>
 <dt><i>language</i></dt>
 <dd>
-&#116;&#104;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;).
-            &#84;&#104;&#101; &#115;&#116;&#114;&#105;&#110;&#103; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#105;&#110; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#108;&#111;&#99;&#97;&#108;&#101; &#102;&#111;&#114;&#109;&#97;&#116; (&#101;.&#103;. &#101;&#110;&#95;&#85;&#83;, &#100;&#101;).
+the language to be used as the default (string).
+            The string should be in language locale format (e.g. en_US, de).
 </dd>
 </dl><a NAME="SpellChecker.setLanguage" ID="SpellChecker.setLanguage"></a>
 <h4>SpellChecker.setLanguage</h4>
 <b>setLanguage</b>(<i>language, pwl = "", pel = ""</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101;.
+        Public method to set the current language.
 </p><dl>
 <dt><i>language</i></dt>
 <dd>
-&#116;&#104;&#101; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;).
-            &#84;&#104;&#101; &#115;&#116;&#114;&#105;&#110;&#103; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#105;&#110; &#108;&#97;&#110;&#103;&#117;&#97;&#103;&#101; &#108;&#111;&#99;&#97;&#108;&#101; &#102;&#111;&#114;&#109;&#97;&#116; (&#101;.&#103;. &#101;&#110;&#95;&#85;&#83;, &#100;&#101;).
+the language to be used as the default (string).
+            The string should be in language locale format (e.g. en_US, de).
 </dd><dt><i>pwl=</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#112;&#101;&#114;&#115;&#111;&#110;&#97;&#108;/&#112;&#114;&#111;&#106;&#101;&#99;&#116; w&#111;&#114;&#100; &#108;&#105;&#115;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the personal/project word list (string)
 </dd><dt><i>pel=</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#112;&#101;&#114;&#115;&#111;&#110;&#97;&#108;/&#112;&#114;&#111;&#106;&#101;&#99;&#116; &#101;x&#99;&#108;&#117;&#100;&#101; &#108;&#105;&#115;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the personal/project exclude list (string)
 </dd>
 </dl><a NAME="SpellChecker.setMinimumWordSize" ID="SpellChecker.setMinimumWordSize"></a>
 <h4>SpellChecker.setMinimumWordSize</h4>
 <b>setMinimumWordSize</b>(<i>size</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#109;&#105;&#110;&#105;&#109;&#117;&#109; w&#111;&#114;&#100; &#115;&#105;z&#101;.
+        Public method to set the minimum word size.
 </p><dl>
 <dt><i>size</i></dt>
 <dd>
-&#109;&#105;&#110;&#105;&#109;&#117;&#109; w&#111;&#114;&#100; &#115;&#105;z&#101; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+minimum word size (integer)
 </dd>
 </dl><a NAME="SpellChecker.stopIncrementalCheck" ID="SpellChecker.stopIncrementalCheck"></a>
 <h4>SpellChecker.stopIncrementalCheck</h4>
 <b>stopIncrementalCheck</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#116;&#111;&#112; &#97;&#110; &#105;&#110;&#99;&#114;&#101;&#109;&#101;&#110;&#116;&#97;&#108; &#99;&#104;&#101;&#99;&#107;.
+        Public method to stop an incremental check.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

eric ide

mercurial