Contents

Sonnet::BackgroundChecker Class

class Sonnet::BackgroundChecker

class used for spell checking in the background. More...

Header: #include <Sonnet/BackgroundChecker>
CMake: find_package(KF6 REQUIRED COMPONENTS Sonnet)
target_link_libraries(mytarget PRIVATE KF6::SonnetCore)
Inherits: QObject

Public Functions

BackgroundChecker(QObject *parent = nullptr)
BackgroundChecker(const Sonnet::Speller &speller, QObject *parent = nullptr)
bool addWordToPersonal(const QString &word)
(since 5.55) bool addWordToSession(const QString &word)
(since 5.71) bool autoDetectLanguageDisabled() const
bool checkWord(const QString &word)
QString currentContext() const
(since 5.71) void setAutoDetectLanguageDisabled(bool autoDetectDisabled)
void setSpeller(const Sonnet::Speller &speller)
void setText(const QString &text)
Sonnet::Speller speller() const
QStringList suggest(const QString &word) const
QString text() const

Public Slots

void changeLanguage(const QString &lang)
virtual void continueChecking()
void replace(int start, const QString &oldText, const QString &newText)
virtual void start()
virtual void stop()

Signals

void done()
void misspelling(const QString &word, int start)

Protected Functions

virtual QString fetchMoreText()
virtual void finishedCurrentFeed()

Protected Slots

void slotEngineDone()

Detailed Description

BackgroundChecker is used to perform spell checking without blocking the application. You can use it as is by calling the checkText function or subclass it and reimplement getMoreText function.

The misspelling signal is emitted whenever a misspelled word is found. The background checker stops right before emitting the signal. So the parent has to call continueChecking function to resume the checking.

The done() signal is emitted when whole text is spell checked.

Member Function Documentation

[explicit] BackgroundChecker::BackgroundChecker(QObject *parent = nullptr)

[explicit] BackgroundChecker::BackgroundChecker(const Sonnet::Speller &speller, QObject *parent = nullptr)

bool BackgroundChecker::addWordToPersonal(const QString &word)

[since 5.55] bool BackgroundChecker::addWordToSession(const QString &word)

This method is used to add a word to the session of the speller currently set in BackgroundChecker.

This function was introduced in 5.55.

[since 5.71] bool BackgroundChecker::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().

[slot] void BackgroundChecker::changeLanguage(const QString &lang)

bool BackgroundChecker::checkWord(const QString &word)

[virtual slot] void BackgroundChecker::continueChecking()

After emitting misspelling signal the background checker stops. The catcher is responsible for calling continueChecking function to resume checking.

QString BackgroundChecker::currentContext() const

[signal] void BackgroundChecker::done()

Emitted after the whole text has been spell checked.

[virtual protected] QString BackgroundChecker::fetchMoreText()

This function is called to get the text to spell check. It will be called continuesly until it returns QString() in which case the done() signal is emitted.

Note: the start parameter in misspelling() is not a combined position but a position in the last string returned by fetchMoreText. You need to store the state in the derivatives.

[virtual protected] void BackgroundChecker::finishedCurrentFeed()

This function will be called whenever the background checker will be finished text which it got from fetchMoreText.

[signal] void BackgroundChecker::misspelling(const QString &word, int start)

Emitted whenever a misspelled word is found

[slot] void BackgroundChecker::replace(int start, const QString &oldText, const QString &newText)

[since 5.71] void BackgroundChecker::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 BackgroundChecker::setSpeller(const Sonnet::Speller &speller)

See also speller().

void BackgroundChecker::setText(const QString &text)

This method is used to spell check static text. It automatically invokes start().

Use fetchMoreText() with start() to spell check a stream.

See also text().

[protected slot] void BackgroundChecker::slotEngineDone()

Sonnet::Speller BackgroundChecker::speller() const

See also setSpeller().

[virtual slot] void BackgroundChecker::start()

[virtual slot] void BackgroundChecker::stop()

QStringList BackgroundChecker::suggest(const QString &word) const

QString BackgroundChecker::text() const

See also setText().