Sonnet::SpellerPlugin Class Reference

Class is returned by from Loader. More...

#include <spellerplugin_p.h>

List of all members.

Public Member Functions
virtual	~SpellerPlugin ()
virtual bool	addToPersonal (const QString &word)=0
virtual bool	addToSession (const QString &word)=0
virtual bool	checkAndSuggest (const QString &word, QStringList &suggestions) const
virtual bool	isCorrect (const QString &word) const =0
bool	isMisspelled (const QString &word) const
QString	language () const
virtual bool	storeReplacement (const QString &bad, const QString &good)=0
virtual QStringList	suggest (const QString &word) const =0
Protected Member Functions
	SpellerPlugin (const QString &lang)

---

Detailed Description

Class is returned by from Loader.

It acts as the actual spellchecker.

Author:

Zack Rusin <zack@kde.org> class used for actuall spell checking

Definition at line 38 of file spellerplugin_p.h.

---

Constructor & Destructor Documentation

Sonnet::SpellerPlugin::~SpellerPlugin

(

)

[virtual]

Definition at line 38 of file spellerplugin.cpp.

Sonnet::SpellerPlugin::SpellerPlugin

(

const QString &

lang

)

[protected]

Definition at line 32 of file spellerplugin.cpp.

---

Member Function Documentation

virtual bool Sonnet::SpellerPlugin::addToPersonal

(

const QString &

word

)

[pure virtual]

Adds word to the list of of personal words.

Returns:

true on success

virtual bool Sonnet::SpellerPlugin::addToSession

(

const QString &

word

)

[pure virtual]

Adds word to the words recognizable in the current session.

Returns:

true on success

bool Sonnet::SpellerPlugin::checkAndSuggest	(	const QString &	word,
		QStringList &	suggestions
	)		const [virtual]

Convience method calling isCorrect() and suggest() if the word isn't correct.

Definition at line 53 of file spellerplugin.cpp.

virtual bool Sonnet::SpellerPlugin::isCorrect

(

const QString &

word

)

const [pure virtual]

Checks the given word.

Returns:

false if the word is misspelled. true otherwise

bool Sonnet::SpellerPlugin::isMisspelled

(

const QString &

word

)

const

Checks the given word.

Returns:

true if the word is misspelled. false otherwise

Definition at line 48 of file spellerplugin.cpp.

QString Sonnet::SpellerPlugin::language

(

)

const

Returns language supported by this dictionary.

Definition at line 43 of file spellerplugin.cpp.

virtual bool Sonnet::SpellerPlugin::storeReplacement	(	const QString &	bad,
		const QString &	good
	)		[pure virtual]

Stores user defined good replacement for the bad word.

Returns:

true on success

virtual QStringList Sonnet::SpellerPlugin::suggest

(

const QString &

word

)

const [pure virtual]

Fetches suggestions for the word.

Returns:

list of all suggestions for the word

---

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

• spellerplugin_p.h
• spellerplugin.cpp