KSpell2::Dictionary Class Reference

#include <dictionary.h>

Inheritance diagram for KSpell2::Dictionary:

Public Member Functions
virtual bool	check (const TQString &word)=0
virtual TQStringList	suggest (const TQString &word)=0
virtual bool	checkAndSuggest (const TQString &word, TQStringList &suggestions)=0
virtual bool	storeReplacement (const TQString &bad, const TQString &good)=0
virtual bool	addToPersonal (const TQString &word)=0
virtual bool	addToSession (const TQString &word)=0
TQString	language () const
bool	isDefault () const

Protected Member Functions
	Dictionary (const TQString &lang, bool def=false)

Protected Attributes
TQString	m_language
bool	m_default

Friends
class	Broker

Detailed Description

Class is returned by from Broker.

It acts as the actual spellchecker.

Author

Zack Rusin zack@.nosp@m.kde..nosp@m.org

class used for actuall spell checking

Definition at line 36 of file dictionary.h.

Constructor & Destructor Documentation

~Dictionary()

virtual KSpell2::Dictionary::~Dictionary ( )

inlinevirtual

Definition at line 39 of file dictionary.h.

Dictionary()

KSpell2::Dictionary::Dictionary ( const TQString &  lang, bool  def = false  )

inlineprotected

Definition at line 97 of file dictionary.h.

Member Function Documentation

addToPersonal()

virtual bool KSpell2::Dictionary::addToPersonal ( const TQString &  word )

pure virtual

Adds word to the list of of personal words.

Returns

true on success

Implemented in ASpellDict, and HSpellDict.

addToSession()

virtual bool KSpell2::Dictionary::addToSession ( const TQString &  word )

pure virtual

Adds word to the words recognizable in the current session.

Returns

true on success

Implemented in ASpellDict, and HSpellDict.

check()

virtual bool KSpell2::Dictionary::check ( const TQString &  word )

pure virtual

Checks the given word.

Returns

false if the word is misspelled. true otherwise

Implemented in ASpellDict, and HSpellDict.

checkAndSuggest()

virtual bool KSpell2::Dictionary::checkAndSuggest ( const TQString &  word, TQStringList &  suggestions  )

pure virtual

Checks the word and fetches suggestions for it.

Implemented in ASpellDict, and HSpellDict.

isDefault()

bool KSpell2::Dictionary::isDefault ( ) const

inline

Returns true if this dictionary was constructed from default Settings values.

Definition at line 91 of file dictionary.h.

language()

TQString KSpell2::Dictionary::language ( ) const

inline

Returns language supported by this dictionary.

Definition at line 82 of file dictionary.h.

storeReplacement()

virtual bool KSpell2::Dictionary::storeReplacement ( const TQString &  bad, const TQString &  good  )

pure virtual

Stores user defined good replacement for the bad word.

Returns

true on success

Implemented in ASpellDict, and HSpellDict.

suggest()

virtual TQStringList KSpell2::Dictionary::suggest ( const TQString &  word )

pure virtual

Fetches suggestions for the word.

Returns

list of all suggestions for the word

Implemented in ASpellDict, and HSpellDict.

Friends And Related Function Documentation

Broker

friend class Broker

friend

Definition at line 100 of file dictionary.h.

Member Data Documentation

m_default

bool KSpell2::Dictionary::m_default

protected

Definition at line 102 of file dictionary.h.

m_language

TQString KSpell2::Dictionary::m_language

protected

Definition at line 101 of file dictionary.h.

---

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

• dictionary.h