Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.QScintilla.SpellChecker.html

src/eric7/Documentation/Source/eric7.QScintilla.SpellChecker.html

branch
eric7
changeset 10431
64157aeb0312
parent 9209
b99e7fd55fd3
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.QScintilla.SpellChecker.html	Wed Dec 20 19:28:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.QScintilla.SpellChecker.html	Thu Dec 21 12:03:40 2023 +0100
@@ -201,24 +201,30 @@
 </p>
 <dl>
 
-<dt><i>lang</i></dt>
+<dt><i>lang</i> (str)</dt>
 <dd>
-the language to be used as the default (string).
-            The string should be in language locale format (e.g. en_US, de).
+the language to be used as the default. The string should
+            be in language locale format (e.g. en_US, de).
 </dd>
-<dt><i>pwl</i></dt>
+<dt><i>pwl</i> (str)</dt>
 <dd>
-name of the personal/project word list (string)
+name of the personal/project word list
 </dd>
-<dt><i>pel</i></dt>
+<dt><i>pel</i> (str)</dt>
 <dd>
-name of the personal/project exclude list (string)
+name of the personal/project exclude list
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the dictionary (enchant.Dict)
+reference to the dictionary
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+enchant.Dict
 </dd>
 </dl>
 <a NAME="SpellChecker.getAvailableLanguages" ID="SpellChecker.getAvailableLanguages"></a>
@@ -231,7 +237,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of available languages (list of strings)
+list of available languages
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="SpellChecker.getDefaultPath" ID="SpellChecker.getDefaultPath"></a>
@@ -243,17 +255,23 @@
 </p>
 <dl>
 
-<dt><i>isException</i></dt>
+<dt><i>isException</i> (bool)</dt>
 <dd>
 flag indicating to return the name of the default
-            exception dictionary (boolean)
+            exception dictionary
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 file name of the default user dictionary or the default user
-            exception dictionary (string)
+            exception dictionary
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="SpellChecker.getUserDictionaryPath" ID="SpellChecker.getUserDictionaryPath"></a>
@@ -265,17 +283,23 @@
 </p>
 <dl>
 
-<dt><i>isException</i></dt>
+<dt><i>isException</i> (bool)</dt>
 <dd>
 flag indicating to return the name of the user
-            exception dictionary (boolean)
+            exception dictionary
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 file name of the user dictionary or the user exception
-            dictionary (string)
+            dictionary
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="SpellChecker.isAvailable" ID="SpellChecker.isAvailable"></a>
@@ -288,7 +312,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating availability (boolean)
+flag indicating availability
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="SpellChecker.setDefaultLanguage" ID="SpellChecker.setDefaultLanguage"></a>
@@ -300,10 +330,10 @@
 </p>
 <dl>
 
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-the language to be used as the default (string).
-            The string should be in language locale format (e.g. en_US, de).
+the language to be used as the default. The string should
+            be in language locale format (e.g. en_US, de).
 </dd>
 </dl>
 <a NAME="SpellChecker.__init__" ID="SpellChecker.__init__"></a>
@@ -315,21 +345,20 @@
 </p>
 <dl>
 
-<dt><i>editor</i></dt>
+<dt><i>editor</i> (QScintilla.Editor)</dt>
 <dd>
-reference to the editor object (QScintilla.Editor)
+reference to the editor object
 </dd>
-<dt><i>indicator</i></dt>
+<dt><i>indicator</i> (int)</dt>
 <dd>
 spell checking indicator
 </dd>
-<dt><i>defaultLanguage</i></dt>
+<dt><i>defaultLanguage</i> (str)</dt>
 <dd>
-the language to be used as the default
-            (string). The string should be in language locale format
-            (e.g. en_US, de).
+the language to be used as the default. The string
+            should be in language locale format (e.g. en_US, de).
 </dd>
-<dt><i>checkRegion</i></dt>
+<dt><i>checkRegion</i> (function)</dt>
 <dd>
 reference to a function to check for a valid
             region
@@ -344,13 +373,13 @@
 </p>
 <dl>
 
-<dt><i>startPos</i></dt>
+<dt><i>startPos</i> (int)</dt>
 <dd>
-position to start at (integer)
+position to start at
 </dd>
-<dt><i>endPos</i></dt>
+<dt><i>endPos</i> (int)</dt>
 <dd>
-position to end at (integer)
+position to end at
 </dd>
 </dl>
 <a NAME="SpellChecker.__getNextWord" ID="SpellChecker.__getNextWord"></a>
@@ -363,20 +392,25 @@
 </p>
 <dl>
 
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
 <dd>
-position to start word extraction (integer)
+position to start word extraction
 </dd>
-<dt><i>endPosition</i></dt>
+<dt><i>endPosition</i> (int)</dt>
 <dd>
-position to stop word extraction (integer)
+position to stop word extraction
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of three values (the extracted word (string),
-            start position (integer), end position (integer))
+tuple of three values (the extracted word, start position, end position)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, int, int)
 </dd>
 </dl>
 <a NAME="SpellChecker.__incrementalCheck" ID="SpellChecker.__incrementalCheck"></a>
@@ -399,6 +433,12 @@
 self
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+SpellChecker
+</dd>
+</dl>
 <a NAME="SpellChecker.__next__" ID="SpellChecker.__next__"></a>
 <h4>SpellChecker.__next__</h4>
 <b>__next__</b>(<i></i>)
@@ -413,6 +453,12 @@
 </dd>
 </dl>
 <dl>
+<dt>Return Type:</dt>
+<dd>
+SpellChecker
+</dd>
+</dl>
+<dl>
 
 <dt>Raises <b>StopIteration</b>:</dt>
 <dd>
@@ -428,9 +474,9 @@
 </p>
 <dl>
 
-<dt><i>word</i></dt>
+<dt><i>word</i> (str)</dt>
 <dd>
-word to add (string)
+word to add
 </dd>
 </dl>
 <a NAME="SpellChecker.checkCurrentPage" ID="SpellChecker.checkCurrentPage"></a>
@@ -463,13 +509,13 @@
 </p>
 <dl>
 
-<dt><i>firstLine</i></dt>
+<dt><i>firstLine</i> (int)</dt>
 <dd>
-line number of first line to check (integer)
+line number of first line to check
 </dd>
-<dt><i>lastLine</i></dt>
+<dt><i>lastLine</i> (int)</dt>
 <dd>
-line number of last line to check (integer)
+line number of last line to check
 </dd>
 </dl>
 <a NAME="SpellChecker.checkSelection" ID="SpellChecker.checkSelection"></a>
@@ -488,14 +534,13 @@
 </p>
 <dl>
 
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (int)</dt>
 <dd>
-position to check at (integer)
+position to check at
 </dd>
-<dt><i>atEnd</i></dt>
+<dt><i>atEnd</i> (bool)</dt>
 <dd>
-flag indicating the position is at the end of the word
-            to check (boolean)
+flag indicating the position is at the end of the word to check
 </dd>
 </dl>
 <a NAME="SpellChecker.clearAll" ID="SpellChecker.clearAll"></a>
@@ -514,19 +559,25 @@
 </p>
 <dl>
 
-<dt><i>wordStart</i></dt>
+<dt><i>wordStart</i> (int)</dt>
 <dd>
-the starting position of the word (integer)
+the starting position of the word
 </dd>
-<dt><i>wordEnd</i></dt>
+<dt><i>wordEnd</i> (int)</dt>
 <dd>
-the ending position of the word (integer)
+the ending position of the word
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of the leading and trailing context (string, string)
+tuple of the leading and trailing context
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
 </dd>
 </dl>
 <a NAME="SpellChecker.getError" ID="SpellChecker.getError"></a>
@@ -539,9 +590,14 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of last faulty word (string), starting position of the
-            faulty word (integer) and ending position of the faulty word
-            (integer)
+tuple of last faulty word, starting position of the
+            faulty word and ending position of the faulty word
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, int, int)
 </dd>
 </dl>
 <a NAME="SpellChecker.getLanguage" ID="SpellChecker.getLanguage"></a>
@@ -554,7 +610,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-current language in language locale format (string)
+current language in language locale format
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="SpellChecker.getSuggestions" ID="SpellChecker.getSuggestions"></a>
@@ -566,15 +628,21 @@
 </p>
 <dl>
 
-<dt><i>word</i></dt>
+<dt><i>word</i> (str)</dt>
 <dd>
-word to get suggestions for (string)
+word to get suggestions for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of suggestions (list of strings)
+list of suggestions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="SpellChecker.ignoreAlways" ID="SpellChecker.ignoreAlways"></a>
@@ -587,9 +655,9 @@
 </p>
 <dl>
 
-<dt><i>word</i></dt>
+<dt><i>word</i> (str)</dt>
 <dd>
-word to be ignored (string)
+word to be ignored
 </dd>
 </dl>
 <a NAME="SpellChecker.initCheck" ID="SpellChecker.initCheck"></a>
@@ -601,19 +669,25 @@
 </p>
 <dl>
 
-<dt><i>startPos</i></dt>
+<dt><i>startPos</i> (int)</dt>
 <dd>
-position to start at (integer)
+position to start at
 </dd>
-<dt><i>endPos</i></dt>
+<dt><i>endPos</i> (int)</dt>
 <dd>
-position to end at (integer)
+position to end at
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating successful initialization (boolean)
+flag indicating successful initialization
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="SpellChecker.remove" ID="SpellChecker.remove"></a>
@@ -625,9 +699,9 @@
 </p>
 <dl>
 
-<dt><i>word</i></dt>
+<dt><i>word</i> (str)</dt>
 <dd>
-word to add (string)
+word to add
 </dd>
 </dl>
 <a NAME="SpellChecker.replace" ID="SpellChecker.replace"></a>
@@ -640,9 +714,9 @@
 </p>
 <dl>
 
-<dt><i>replacement</i></dt>
+<dt><i>replacement</i> (str)</dt>
 <dd>
-replacement string (string)
+replacement string
 </dd>
 </dl>
 <a NAME="SpellChecker.replaceAlways" ID="SpellChecker.replaceAlways"></a>
@@ -655,9 +729,9 @@
 </p>
 <dl>
 
-<dt><i>replacement</i></dt>
+<dt><i>replacement</i> (str)</dt>
 <dd>
-replacement string (string)
+replacement string
 </dd>
 </dl>
 <a NAME="SpellChecker.setLanguage" ID="SpellChecker.setLanguage"></a>
@@ -669,18 +743,18 @@
 </p>
 <dl>
 
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-the language to be used as the default (string).
-            The string should be in language locale format (e.g. en_US, de).
+the language to be used as the default. The string should
+            be in language locale format (e.g. en_US, de).
 </dd>
-<dt><i>pwl</i></dt>
+<dt><i>pwl</i> (str)</dt>
 <dd>
-name of the personal/project word list (string)
+name of the personal/project word list
 </dd>
-<dt><i>pel</i></dt>
+<dt><i>pel</i> (str)</dt>
 <dd>
-name of the personal/project exclude list (string)
+name of the personal/project exclude list
 </dd>
 </dl>
 <a NAME="SpellChecker.setMinimumWordSize" ID="SpellChecker.setMinimumWordSize"></a>
@@ -692,9 +766,9 @@
 </p>
 <dl>
 
-<dt><i>size</i></dt>
+<dt><i>size</i> (int)</dt>
 <dd>
-minimum word size (integer)
+minimum word size
 </dd>
 </dl>
 <a NAME="SpellChecker.stopIncrementalCheck" ID="SpellChecker.stopIncrementalCheck"></a>

Mercurial Repository: eric

eric ide

mercurial