Sonnet::Dialog Class Reference

Spellcheck dialog. More...

#include <dialog.h>

Inheritance diagram for Sonnet::Dialog:

List of all members.

Public Slots
void	setBuffer (const QString &)
Signals
void	autoCorrect (const QString &currentWord, const QString &replaceWord)
void	cancel ()
void	done (const QString &newBuffer)
void	languageChanged (const QString &language)
void	misspelling (const QString &word, int start)
void	replace (const QString &oldWord, int start, const QString &newWord)
void	spellCheckStatus (const QString &)
void	stop ()
Public Member Functions
	Dialog (BackgroundChecker *checker, QWidget *parent)
	~Dialog ()
void	activeAutoCorrect (bool _active)
QString	buffer () const
QString	originalBuffer () const
void	setSpellCheckContinuedAfterReplacement (bool b)
void	show ()
void	showProgressDialog (int timeout=500)
void	showSpellCheckCompletionMessage (bool b=true)

---

Detailed Description

Spellcheck dialog.

 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.

Definition at line 50 of file dialog.h.

---

Constructor & Destructor Documentation

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

Definition at line 98 of file dialog.cpp.

Sonnet::Dialog::~Dialog

(

)

Definition at line 123 of file dialog.cpp.

---

Member Function Documentation

void Sonnet::Dialog::activeAutoCorrect

(

bool

_active

)

Definition at line 176 of file dialog.cpp.

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

QString Sonnet::Dialog::buffer

(

)

const

Definition at line 267 of file dialog.cpp.

void Sonnet::Dialog::cancel

(

)

[signal]

void Sonnet::Dialog::done

(

const QString &

newBuffer

)

[signal]

The dialog won't be closed if you setBuffer() in slot connected to this signal.

Also emitted after stop() signal

void Sonnet::Dialog::languageChanged

(

const QString &

language

)

[signal]

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

Parameters:

dictionary

the new language the user selected

Since:

4.1

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

QString Sonnet::Dialog::originalBuffer

(

)

const

Definition at line 262 of file dialog.cpp.

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

void Sonnet::Dialog::setBuffer

(

const QString &

buf

)

[slot]

Definition at line 272 of file dialog.cpp.

void Sonnet::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.

Since:

4.4

Definition at line 194 of file dialog.cpp.

void Sonnet::Dialog::show

(

)

Definition at line 303 of file dialog.cpp.

void Sonnet::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.

Parameters:

timeout

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

Since:

4.4

Definition at line 184 of file dialog.cpp.

void Sonnet::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.

Since:

4.4

Definition at line 189 of file dialog.cpp.

void Sonnet::Dialog::spellCheckStatus

(

const QString &

)

[signal]

Signal sends when spell checking is finished/stopped/completed.

Since:

4.1

void Sonnet::Dialog::stop

(

)

[signal]

---

The documentation for this class was generated from the following files:

• dialog.h
• dialog.cpp