diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.QScintilla.SpellChecker.html
--- a/src/eric7/Documentation/Source/eric7.QScintilla.SpellChecker.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.SpellChecker.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,51 +7,49 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.QScintilla.SpellChecker</h1>
-
<p>
Module implementing the spell checker for the editor component.
</p>
<p>
The spell checker is based on pyenchant.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#SpellChecker">SpellChecker</a></td>
<td>Class implementing a pyenchant based spell checker.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="SpellChecker" ID="SpellChecker"></a>
<h2>SpellChecker</h2>
-
<p>
Class implementing a pyenchant based spell checker.
</p>
+
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
-
<table>
-<tr><td>_spelling_dict</td></tr><tr><td>_spelling_lang</td></tr>
+<tr><td>_spelling_dict</td></tr>
+<tr><td>_spelling_lang</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
-
<tr>
<td><a href="#SpellChecker._getDict">_getDict</a></td>
<td>Protected class method to get a new dictionary.</td>
@@ -77,10 +75,9 @@
<td>Class method to set the default language.</td>
</tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#SpellChecker.__init__">SpellChecker</a></td>
<td>Constructor</td>
@@ -186,19 +183,20 @@
<td>Public method to stop an incremental check.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="SpellChecker._getDict" ID="SpellChecker._getDict"></a>
<h4>SpellChecker._getDict (class method)</h4>
<b>_getDict</b>(<i>lang, pwl="", pel=""</i>)
-
<p>
Protected class method to get a new dictionary.
</p>
+
<dl>
<dt><i>lang</i> (str)</dt>
@@ -230,10 +228,10 @@
<a NAME="SpellChecker.getAvailableLanguages" ID="SpellChecker.getAvailableLanguages"></a>
<h4>SpellChecker.getAvailableLanguages (class method)</h4>
<b>getAvailableLanguages</b>(<i></i>)
-
<p>
Class method to get all available languages.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -249,10 +247,10 @@
<a NAME="SpellChecker.getDefaultPath" ID="SpellChecker.getDefaultPath"></a>
<h4>SpellChecker.getDefaultPath (class method)</h4>
<b>getDefaultPath</b>(<i>isException=False</i>)
-
<p>
Class method to get the default path names of the user dictionaries.
</p>
+
<dl>
<dt><i>isException</i> (bool)</dt>
@@ -277,10 +275,10 @@
<a NAME="SpellChecker.getUserDictionaryPath" ID="SpellChecker.getUserDictionaryPath"></a>
<h4>SpellChecker.getUserDictionaryPath (class method)</h4>
<b>getUserDictionaryPath</b>(<i>isException=False</i>)
-
<p>
Class method to get the path name of a user dictionary file.
</p>
+
<dl>
<dt><i>isException</i> (bool)</dt>
@@ -305,10 +303,10 @@
<a NAME="SpellChecker.isAvailable" ID="SpellChecker.isAvailable"></a>
<h4>SpellChecker.isAvailable (class method)</h4>
<b>isAvailable</b>(<i></i>)
-
<p>
Class method to check, if spellchecking is available.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -324,10 +322,10 @@
<a NAME="SpellChecker.setDefaultLanguage" ID="SpellChecker.setDefaultLanguage"></a>
<h4>SpellChecker.setDefaultLanguage (class method)</h4>
<b>setDefaultLanguage</b>(<i>language</i>)
-
<p>
Class method to set the default language.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -339,10 +337,10 @@
<a NAME="SpellChecker.__init__" ID="SpellChecker.__init__"></a>
<h4>SpellChecker (Constructor)</h4>
<b>SpellChecker</b>(<i>editor, indicator, defaultLanguage=None, checkRegion=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>editor</i> (QScintilla.Editor)</dt>
@@ -367,10 +365,10 @@
<a NAME="SpellChecker.__checkDocumentPart" ID="SpellChecker.__checkDocumentPart"></a>
<h4>SpellChecker.__checkDocumentPart</h4>
<b>__checkDocumentPart</b>(<i>startPos, endPos</i>)
-
<p>
Private method to check some part of the document.
</p>
+
<dl>
<dt><i>startPos</i> (int)</dt>
@@ -385,11 +383,11 @@
<a NAME="SpellChecker.__getNextWord" ID="SpellChecker.__getNextWord"></a>
<h4>SpellChecker.__getNextWord</h4>
<b>__getNextWord</b>(<i>pos, endPosition</i>)
-
<p>
Private method to get the next word in the text after the given
position.
</p>
+
<dl>
<dt><i>pos</i> (int)</dt>
@@ -416,17 +414,17 @@
<a NAME="SpellChecker.__incrementalCheck" ID="SpellChecker.__incrementalCheck"></a>
<h4>SpellChecker.__incrementalCheck</h4>
<b>__incrementalCheck</b>(<i></i>)
-
<p>
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>
Special method to create an iterator.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -442,10 +440,10 @@
<a NAME="SpellChecker.__next__" ID="SpellChecker.__next__"></a>
<h4>SpellChecker.__next__</h4>
<b>__next__</b>(<i></i>)
-
<p>
Special method to advance to the next error.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -468,10 +466,10 @@
<a NAME="SpellChecker.add" ID="SpellChecker.add"></a>
<h4>SpellChecker.add</h4>
<b>add</b>(<i>word=None</i>)
-
<p>
Public method to add a word to the personal word list.
</p>
+
<dl>
<dt><i>word</i> (str)</dt>
@@ -482,31 +480,31 @@
<a NAME="SpellChecker.checkCurrentPage" ID="SpellChecker.checkCurrentPage"></a>
<h4>SpellChecker.checkCurrentPage</h4>
<b>checkCurrentPage</b>(<i></i>)
-
<p>
Public 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>
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>
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>
Public method to check some lines of text.
</p>
+
<dl>
<dt><i>firstLine</i> (int)</dt>
@@ -521,17 +519,17 @@
<a NAME="SpellChecker.checkSelection" ID="SpellChecker.checkSelection"></a>
<h4>SpellChecker.checkSelection</h4>
<b>checkSelection</b>(<i></i>)
-
<p>
Public 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>
Public method to check the word at position pos.
</p>
+
<dl>
<dt><i>pos</i> (int)</dt>
@@ -546,17 +544,17 @@
<a NAME="SpellChecker.clearAll" ID="SpellChecker.clearAll"></a>
<h4>SpellChecker.clearAll</h4>
<b>clearAll</b>(<i></i>)
-
<p>
Public method to clear all spelling markers.
</p>
+
<a NAME="SpellChecker.getContext" ID="SpellChecker.getContext"></a>
<h4>SpellChecker.getContext</h4>
<b>getContext</b>(<i>wordStart, wordEnd</i>)
-
<p>
Public method to get the context of a faulty word.
</p>
+
<dl>
<dt><i>wordStart</i> (int)</dt>
@@ -583,10 +581,10 @@
<a NAME="SpellChecker.getError" ID="SpellChecker.getError"></a>
<h4>SpellChecker.getError</h4>
<b>getError</b>(<i></i>)
-
<p>
Public method to get information about the last error found.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -603,10 +601,10 @@
<a NAME="SpellChecker.getLanguage" ID="SpellChecker.getLanguage"></a>
<h4>SpellChecker.getLanguage</h4>
<b>getLanguage</b>(<i></i>)
-
<p>
Public method to get the current language.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -622,10 +620,10 @@
<a NAME="SpellChecker.getSuggestions" ID="SpellChecker.getSuggestions"></a>
<h4>SpellChecker.getSuggestions</h4>
<b>getSuggestions</b>(<i>word</i>)
-
<p>
Public method to get suggestions for the given word.
</p>
+
<dl>
<dt><i>word</i> (str)</dt>
@@ -648,11 +646,11 @@
<a NAME="SpellChecker.ignoreAlways" ID="SpellChecker.ignoreAlways"></a>
<h4>SpellChecker.ignoreAlways</h4>
<b>ignoreAlways</b>(<i>word=None</i>)
-
<p>
Public method to tell the checker, to always ignore the given word
or the current word.
</p>
+
<dl>
<dt><i>word</i> (str)</dt>
@@ -663,10 +661,10 @@
<a NAME="SpellChecker.initCheck" ID="SpellChecker.initCheck"></a>
<h4>SpellChecker.initCheck</h4>
<b>initCheck</b>(<i>startPos, endPos</i>)
-
<p>
Public method to initialize a spell check.
</p>
+
<dl>
<dt><i>startPos</i> (int)</dt>
@@ -693,10 +691,10 @@
<a NAME="SpellChecker.remove" ID="SpellChecker.remove"></a>
<h4>SpellChecker.remove</h4>
<b>remove</b>(<i>word</i>)
-
<p>
Public method to add a word to the personal exclude list.
</p>
+
<dl>
<dt><i>word</i> (str)</dt>
@@ -707,11 +705,11 @@
<a NAME="SpellChecker.replace" ID="SpellChecker.replace"></a>
<h4>SpellChecker.replace</h4>
<b>replace</b>(<i>replacement</i>)
-
<p>
Public method to tell the checker to replace the current word with
the replacement string.
</p>
+
<dl>
<dt><i>replacement</i> (str)</dt>
@@ -722,11 +720,11 @@
<a NAME="SpellChecker.replaceAlways" ID="SpellChecker.replaceAlways"></a>
<h4>SpellChecker.replaceAlways</h4>
<b>replaceAlways</b>(<i>replacement</i>)
-
<p>
Public method to tell the checker to always replace the current word
with the replacement string.
</p>
+
<dl>
<dt><i>replacement</i> (str)</dt>
@@ -737,10 +735,10 @@
<a NAME="SpellChecker.setLanguage" ID="SpellChecker.setLanguage"></a>
<h4>SpellChecker.setLanguage</h4>
<b>setLanguage</b>(<i>language, pwl="", pel=""</i>)
-
<p>
Public method to set the current language.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -760,10 +758,10 @@
<a NAME="SpellChecker.setMinimumWordSize" ID="SpellChecker.setMinimumWordSize"></a>
<h4>SpellChecker.setMinimumWordSize</h4>
<b>setMinimumWordSize</b>(<i>size</i>)
-
<p>
Public method to set the minimum word size.
</p>
+
<dl>
<dt><i>size</i> (int)</dt>
@@ -774,10 +772,10 @@
<a NAME="SpellChecker.stopIncrementalCheck" ID="SpellChecker.stopIncrementalCheck"></a>
<h4>SpellChecker.stopIncrementalCheck</h4>
<b>stopIncrementalCheck</b>(<i></i>)
-
<p>
Public method to stop an incremental check.
</p>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
