Sonnet::Highlighter Class

Member Function Documentation

[explicit, since 5.12] Highlighter::Highlighter(QPlainTextEdit *textEdit, const QColor &col = QColor())

Highlighter.

col define spellchecking color

This function was introduced in 5.12.

[explicit] Highlighter::Highlighter(QTextEdit *textEdit, const QColor &col = QColor())

[signal] void Highlighter::activeChanged(const QString &description)

Emitted when as-you-type spell checking is enabled or disabled.

description is a i18n description of the new state, with an optional reason

[since 4.1] void Highlighter::addWordToDictionary(const QString &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 function was introduced in 4.1.

[since 5.71] bool Highlighter::autoDetectLanguageDisabled() const

Returns whether the automatic language detection is disabled, overriding the Sonnet settings.

Returns true if the automatic language detection is disabled

This function was introduced in 5.71.

See also setAutoDetectLanguageDisabled().

bool Highlighter::automatic() const

Returns the state of the automatic disabling of spell checking.

Returns true if spell checking is automatically disabled if there's too many errors

See also setAutomatic().

[since 4.5] bool Highlighter::checkerEnabledByDefault() const

Return true if checker is enabled by default

This function was introduced in 4.5.

QString Highlighter::currentLanguage() const

Returns the language code for the current language.

See also setCurrentLanguage().

[since 4.1] void Highlighter::ignoreWord(const QString &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 function was introduced in 4.1.

[protected] bool Highlighter::intraWordEditing() const

See also setIntraWordEditing().

bool Highlighter::isActive() const

Returns the state of spell checking.

Returns true if spell checking is active

See also setActive().

[since 4.1] bool Highlighter::isWordMisspelled(const QString &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 function was introduced in 4.1.

void Highlighter::setActive(bool active)

Enable/Disable spell checking.

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

active if true, then spell checking is enabled

See also isActive() and setAutomatic().

[since 5.71] void Highlighter::setAutoDetectLanguageDisabled(bool autoDetectDisabled)

Sets whether to disable the automatic language detection.

autoDetectDisabled if true, the language will not be detected automatically by the spell checker, even if the option is enabled in the Sonnet settings.

This function was introduced in 5.71.

See also autoDetectLanguageDisabled().

void Highlighter::setAutomatic(bool automatic)

Sets whether to automatically disable spell checking if there's too many errors.

automatic if true, spell checking will be disabled if there's a significant amount of errors.

See also automatic().

[slot] void Highlighter::setCurrentLanguage(const QString &language)

Set language to use for spell checking.

language the language code for the new language to use.

See also currentLanguage().

void Highlighter::setDocument(QTextDocument *document)

Set a new QTextDocument for this highlighter to operate on.

document the new document to operate on.

[protected] void Highlighter::setIntraWordEditing(bool editing)

See also intraWordEditing().

[virtual protected] void Highlighter::setMisspelled(int start, int count)

[since 4.2] void Highlighter::setMisspelledColor(const QColor &color)

Sets the color in which the highlighter underlines misspelled words.

This function was introduced in 4.2.

[slot] void Highlighter::slotAutoDetection()

Run auto detection, disabling spell checking if too many errors are found.

[slot] void Highlighter::slotRehighlight()

Force a new highlighting.

bool Highlighter::spellCheckerFound() const

Returns whether a spell checking backend with support for the currentLanguage() was found.

Returns true if spell checking is supported for the current language.

[since 4.1] QStringList Highlighter::suggestionsForWord(const QString &word, int max = 10)

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 function was introduced in 4.1.

[since 5.42] QStringList Highlighter::suggestionsForWord(const QString &word, const QTextCursor &cursor, int max = 10)

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

cursor the cursor pointing to the beginning of that word. This is used to determine the language to use, when AutoDetectLanguage is enabled.

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 function was introduced in 5.42.

[virtual protected] void Highlighter::unsetMisspelled(int start, int count)