Contents

Sonnet::Dialog Class

Spellcheck dialog. More...

Header: #include <Sonnet/Dialog>
CMake: find_package(KF6 REQUIRED COMPONENTS Sonnet)
target_link_libraries(mytarget PRIVATE KF6::SonnetUi)
Inherits: QDialog

Public Functions

Dialog(Sonnet::BackgroundChecker *checker, QWidget *parent)
void activeAutoCorrect(bool _active)
QString buffer() const
QString originalBuffer() const
(since 4.4) void setSpellCheckContinuedAfterReplacement(bool b)
void show()
(since 4.4) void showProgressDialog(int timeout = 500)
(since 4.4) void showSpellCheckCompletionMessage(bool b = true)

Public Slots

void setBuffer(const QString &)

Signals

void autoCorrect(const QString &currentWord, const QString &replaceWord)
void cancel()
(since 4.1) void languageChanged(const QString &language)
void misspelling(const QString &word, int start)
void replace(const QString &oldWord, int start, const QString &newWord)
(since 5.65) void spellCheckDone(const QString &newBuffer)
(since 4.1) void spellCheckStatus(const QString &)
void stop()

Detailed Description

Sonnet::Dialog dlg = new Sonnet::Dialog(
      new Sonnet::BackgroundChecker(this), this);
//connect signals
...
dlg->setBuffer( someText );
dlg->show();

You can change buffer inside a slot connected to done() signal and spellcheck will continue with new data automatically.

Member Function Documentation

Dialog::Dialog(Sonnet::BackgroundChecker *checker, QWidget *parent)

void Dialog::activeAutoCorrect(bool _active)

[signal] void Dialog::autoCorrect(const QString &currentWord, const QString &replaceWord)

QString Dialog::buffer() const

See also setBuffer().

[signal] void Dialog::cancel()

[signal, since 4.1] void Dialog::languageChanged(const QString &language)

Emitted when the user changes the language used for spellchecking, which is shown in a combobox of this dialog.

dictionary the new language the user selected

This function was introduced in 4.1.

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

QString Dialog::originalBuffer() const

[signal] void Dialog::replace(const QString &oldWord, int start, const QString &newWord)

[slot] void Dialog::setBuffer(const QString &)

See also buffer().

[since 4.4] void Dialog::setSpellCheckContinuedAfterReplacement(bool b)

Controls whether the spell checking is continued after the replacement of a misspelled word has been performed. By default it is continued.

This function was introduced in 4.4.

void Dialog::show()

[since 4.4] void Dialog::showProgressDialog(int timeout = 500)

Controls whether an (indefinite) progress dialog is shown when the spell checking takes longer than the given time to complete. By default no progress dialog is shown. If the progress dialog is set to be shown, no time consuming operation (for example, showing a notification message) should be performed in a slot connected to the 'done' signal as this might trigger the progress dialog unnecessarily.

timeout time after which the progress dialog should appear; a negative value can be used to hide it

This function was introduced in 4.4.

[since 4.4] void Dialog::showSpellCheckCompletionMessage(bool b = true)

Controls whether a message box indicating the completion of the spell checking is shown or not. By default it is not shown.

This function was introduced in 4.4.

[signal, since 5.65] void Dialog::spellCheckDone(const QString &newBuffer)

The dialog won't be closed if you setBuffer() in slot connected to this signal Also emitted after stop() signal

This function was introduced in 5.65.

[signal, since 4.1] void Dialog::spellCheckStatus(const QString &)

Signal sends when spell checking is finished/stopped/completed

This function was introduced in 4.1.

[signal] void Dialog::stop()