eric6.QScintilla.SpellChecker

Module implementing the spell checker for the editor component.

The spell checker is based on pyenchant.

Global Attributes

Classes

Functions

SpellChecker

Class implementing a pyenchant based spell checker.

Derived from

Class Attributes

Class Methods

Methods

Static Methods

SpellChecker._getDict (class method)

Protected class method to get a new dictionary.

lang

the language to be used as the default (string). The string should be in language locale format (e.g. en_US, de).

pwl=

name of the personal/project word list (string)

pel=

name of the personal/project exclude list (string)

Returns:

reference to the dictionary (enchant.Dict)

SpellChecker.getAvailableLanguages (class method)

Class method to get all available languages.

Returns:

list of available languages (list of strings)

SpellChecker.getDefaultPath (class method)

Class method to get the default path names of the user dictionaries.

isException

flag indicating to return the name of the default exception dictionary (boolean)

Returns:

file name of the default user dictionary or the default user exception dictionary (string)

SpellChecker.getUserDictionaryPath (class method)

Class method to get the path name of a user dictionary file.

isException

flag indicating to return the name of the user exception dictionary (boolean)

Returns:

file name of the user dictionary or the user exception dictionary (string)

SpellChecker.isAvailable (class method)

Class method to check, if spellchecking is available.

Returns:

flag indicating availability (boolean)

SpellChecker.setDefaultLanguage (class method)

Class method to set the default language.

language

the language to be used as the default (string). The string should be in language locale format (e.g. en_US, de).

SpellChecker (Constructor)

Constructor

editor

reference to the editor object (QScintilla.Editor)

indicator

spell checking indicator

defaultLanguage=

the language to be used as the default (string). The string should be in language locale format (e.g. en_US, de).

checkRegion=

reference to a function to check for a valid region

SpellChecker.__checkDocumentPart

Private method to check some part of the document.

startPos

position to start at (integer)

endPos

position to end at (integer)

SpellChecker.__getNextWord

Private method to get the next word in the text after the given position.

pos

position to start word extraction (integer)

endPosition

position to stop word extraction (integer)

Returns:

tuple of three values (the extracted word (string), start position (integer), end position (integer))

SpellChecker.__incrementalCheck

Private method to check the document incrementally.

SpellChecker.__iter__

Special method to create an iterator.

Returns:

self

SpellChecker.__next__

Special method to advance to the next error.

Returns:

self

Raises StopIteration:

raised to indicate the end of the iteration

SpellChecker.add

Public method to add a word to the personal word list.

word

word to add (string)

SpellChecker.checkCurrentPage

Public method to check the currently visible page.

SpellChecker.checkDocument

Public method to check the complete document.

SpellChecker.checkDocumentIncrementally

Public method to check the document incrementally.

SpellChecker.checkLines

Public method to check some lines of text.

firstLine

line number of first line to check (integer)

lastLine

line number of last line to check (integer)

SpellChecker.checkSelection

Public method to check the current selection.

SpellChecker.checkWord

Public method to check the word at position pos.

pos

position to check at (integer)

atEnd=

flag indicating the position is at the end of the word to check (boolean)

SpellChecker.clearAll

Public method to clear all spelling markers.

SpellChecker.getContext

Public method to get the context of a faulty word.

wordStart

the starting position of the word (integer)

wordEnd

the ending position of the word (integer)

Returns:

tuple of the leading and trailing context (string, string)

SpellChecker.getError

Public method to get information about the last error found.

Returns:

tuple of last faulty word (string), starting position of the faulty word (integer) and ending position of the faulty word (integer)

SpellChecker.getLanguage

Public method to get the current language.

Returns:

current language in language locale format (string)

SpellChecker.getSuggestions

Public method to get suggestions for the given word.

word

word to get suggestions for (string)

Returns:

list of suggestions (list of strings)

SpellChecker.ignoreAlways

Public method to tell the checker, to always ignore the given word or the current word.

word

word to be ignored (string)

SpellChecker.initCheck

Public method to initialize a spell check.

startPos

position to start at (integer)

endPos

position to end at (integer)

Returns:

flag indicating successful initialization (boolean)

SpellChecker.remove

Public method to add a word to the personal exclude list.

word

word to add (string)

SpellChecker.replace

Public method to tell the checker to replace the current word with the replacement string.

replacement

replacement string (string)

SpellChecker.replaceAlways

Public method to tell the checker to always replace the current word with the replacement string.

replacement

replacement string (string)

SpellChecker.setLanguage

Public method to set the current language.

language

the language to be used as the default (string). The string should be in language locale format (e.g. en_US, de).

pwl=

name of the personal/project word list (string)

pel=

name of the personal/project exclude list (string)

SpellChecker.setMinimumWordSize

Public method to set the minimum word size.

size

minimum word size (integer)

SpellChecker.stopIncrementalCheck

Public method to stop an incremental check.