lib.spelltextedit.*

Provides

• format()

• LineNumberArea

• SpellTextEdit

• PythonEnchantHighlighter

class lib.spelltextedit.LineNumberArea(parent)

Bases: QWidget

Parameters:

parent (QPlainTextEdit) – Editor in which the line numbers shall be displayed

paintEvent(event)

Paint event called by parent

sizeHint(self) → QSize

class lib.spelltextedit.PythonEnchantHighlighter(*args)

Bases: QSyntaxHighlighter

QSyntaxHighlighter subclass which consults a PyEnchant dictionary

braces = ['\\{', '\\}', '\\(', '\\)', '\\[', '\\]']

chunkers()

Gets the chunkers in use

dict()

Gets the spelling dictionary in use

enable_enchant = False

err_format = <PyQt5.QtGui.QTextCharFormat object>

highlightBlock(text)

Overridden QSyntaxHighlighter method to apply the highlight

highlightBlock_enchant(text)

Method for pyenchant spell checker

highlightBlock_python(text)

Method for Python highlighter

keywords = ['False', 'None', 'True', 'and', 'as', 'assert', 'async', 'await', 'break', 'class', 'continue', 'def', 'del', 'elif', 'else', 'except', 'finally', 'for', 'from', 'global', 'if', 'import', 'in', 'is', 'lambda', 'nonlocal', 'not', 'or', 'pass', 'raise', 'return', 'try', 'while', 'with', 'yield']

match_multiline(text, delimiter, in_state, style)

Do highlighting of multi-line strings. delimiter should be a regex for triple-single-quotes or triple-double-quotes, and in_state should be a unique integer to represent the corresponding state changes when inside those strings. Returns True if we’re still inside a multi-line string when this function is finished.

operators = ['=', '==', '!=', '<', '<=', '>', '>=', '\\+', '-', '\\*', '/', '//', '\\%', '\\*\\*', '\\+=', '-=', '\\*=', '/=', '\\%=', '\\^', '\\|', '\\&', '\\~', '>>', '<<']

setChunkers(chunkers)

Sets the list of chunkers to be used

setDict(sp_dict)

Sets the spelling dictionary to be used

class lib.spelltextedit.SpellTextEdit(parent=None, line_numbers=True, font_family='Monospace')

Bases: QPlainTextEdit

QPlainTextEdit subclass which does spell-checking using PyEnchant

cb_correct_word(action)

Event handler for ‘Spelling Suggestions’ entries.

cb_set_format(action)

Event handler for ‘Language’ menu entries.

cb_set_language(action)

Event handler for ‘Language’ menu entries.

contextMenuEvent(event)

Custom context menu handler to add a spelling suggestions submenu

createCorrectionsMenu(cursor, parent=None)

Create and return a menu for correcting the selected word.

createFormatsMenu(parent=None)

Create and return a menu for selecting the spell-check language.

createLanguagesMenu(parent=None)

Create and return a menu for selecting the spell-check language.

createSpellcheckContextMenu(pos)

Create and return an augmented default context menu.

This may be used as an alternative to the QPoint-taking form of createStandardContextMenu and will work on pre-5.5 Qt.

cursorForMisspelling(pos)

Return a cursor selecting the misspelled word at pos or None

This leverages the fact that QPlainTextEdit already has a system for processing its contents in limited-size blocks to keep things fast.

get_line_number_area_width()

Returns width of line number area

Return type:

int

keyPressEvent(event)

Overide to change tab into spaces_per_tab spaces

max_suggestions = 20

resizeEvent(event)

Overides QPlainTextEdit.resizeEvent for handling line_number_area

show_line_numbers(visible)

Show line number area if visible else hide it

Parameters:

visible (bool) – Line number area visibility

spaces_per_tab = 4

update_line_number_area(rect, dy)

Handle updates for line_number_area

update_line_number_area_width()

Updates width of line_number_area

lib.spelltextedit.format(color, style='')

Return a QTextCharFormat with the given attributes.

lib.spelltextedit.trim_suggestions(word, suggs, maxlen, calcdist=None)

API Polyfill for earlier versions of PyEnchant.