SpellcheckHighlighter QML Type

The Sonnet Highlighter class, used for drawing red lines in text fields when detecting spelling mistakes. More...

Import Statement:	`import org.kde.sonnet`
Since:	5.88

List of all members, including inherited members

Properties

active : bool (since 5.88)
autoDetectLanguageDisabled : bool (since 5.88)
automatic : bool (since 5.88)
currentLanguage : int (since 5.88)
cursorPosition : int (since 5.88)
document : QQuickTextDocument (since 5.88)
misspelledColor : int (since 5.88)
selectionEnd : int (since 5.88)
selectionStart : int (since 5.88)
spellCheckerFound : bool (since 5.88)
wordIsMisspelled : int (since 5.88)
wordUnderMouse : int (since 5.88)

Methods

void addWordToDictionary(string word) (since 5.88)
void ignoreWord(string word) (since 5.88)
bool isWordMisspelled(string word) (since 5.88)
void replaceWord(string word, int at) (since 5.88)
list<string> suggestions(int position, int max) (since 5.88)

Detailed Description

SpellcheckHighlighter is adapted for QML applications. In usual Kirigami/QQC2-desktop-style applications, this can be used directly by adding Kirigami.SpellCheck.enabled: true on a TextArea.

On other QML applications, you can add the SpellcheckHighlighter as a child of a TextArea.

Note: TextField is not supported, as it lacks QTextDocument API that Sonnet relies on.

TextArea {
    id: textArea
    Sonnet.SpellcheckHighlighter {
        id: spellcheckhighlighter
        document: textArea.textDocument
        cursorPosition: textArea.cursorPosition
        selectionStart: textArea.selectionStart
        selectionEnd: textArea.selectionEnd
        misspelledColor: Kirigami.Theme.negativeTextColor
        active: true

        onChangeCursorPosition: {
            textArea.cursorPosition = start;
            textArea.moveCursorSelection(end, TextEdit.SelectCharacters);
        }
    }
}

Additionally SpellcheckHighlighter provides some convenient methods to create a context menu with suggestions.

Property Documentation

active : bool [since 5.88]

This property holds whether spell checking is enabled.

If active is true then spell checking is enabled; otherwise it is disabled. Note that you have to disable automatic (de)activation with automatic before you change the state of spell checking if you want to persistently enable/disable spell checking.

This property was introduced in 5.88.

autoDetectLanguageDisabled : bool [since 5.88]

This property holds whether the automatic language detection is disabled overriding the Sonnet global settings.

This property was introduced in 5.88.

automatic : bool [since 5.88]

This property holds whether spell checking is automatically disabled if there's too many errors.

This property was introduced in 5.88.

currentLanguage : int [since 5.88]

This property holds the current language used for spell checking.

This property was introduced in 5.88.

cursorPosition : int [since 5.88]

This property holds the current cursor position.

This property was introduced in 5.88.

document : QQuickTextDocument [since 5.88]

This property holds the underneath document from a QML TextEdit.

This property was introduced in 5.88.

misspelledColor : int [since 5.88]

This property holds the spell color. By default, it's red.

This property was introduced in 5.88.

selectionEnd : int [since 5.88]

This property holds the end of the selection.

This property was introduced in 5.88.

selectionStart : int [since 5.88]

This property holds the start of the selection.

This property was introduced in 5.88.

spellCheckerFound : bool [since 5.88]

This property holds whether a spell checking backend with support for the currentLanguage was found.

This property was introduced in 5.88.

wordIsMisspelled : int [since 5.88]

This property holds whether the current word under the mouse is misspelled.

This property was introduced in 5.88.

wordUnderMouse : int [since 5.88]

This property holds the current word under the mouse.

This property was introduced in 5.88.

Method Documentation

[since 5.88] void addWordToDictionary(string word)

Adds the given word permanently to the dictionary. It will never be marked as misspelled again, even after restarting the application.

word the word which will be added to the dictionary

This method was introduced in 5.88.

[since 5.88] void ignoreWord(string word)

Ignores the given word. This word will not be marked misspelled for this session. It will again be marked as misspelled when creating new highlighters.

word the word which will be ignored

This method was introduced in 5.88.

[since 5.88] bool isWordMisspelled(string word)

Checks if a given word is marked as misspelled by the highlighter.

word the word to be checked Returns true if the given word is misspelled.

This method was introduced in 5.88.

[since 5.88] void replaceWord(string word, int at = -1)

Replace word at the current cursor position, or at if at is not -1.

This method was introduced in 5.88.

[since 5.88] list<string> suggestions(int position, int max = 5)

Returns a list of suggested replacements for the given misspelled word. If the word is not misspelled, the list will be empty.

word the misspelled word

max at most this many suggestions will be returned. If this is -1, as many suggestions as the spell backend supports will be returned.

Returns a list of suggested replacements for the word

This method was introduced in 5.88.