An abstract class providing spell checking support. More...

#include <QtSpell.hpp>

Public Slots
void	setSpellingEnabled (bool enabled)
	Set whether spell checking should be performed.

Signals
void	languageChanged (const QString &newLang)
	This signal is emitted when the user selects a new language from the spellchecker UI.

Public Member Functions
	Checker (QObject *parent=0)
	QtSpell::Checker object constructor.
virtual	~Checker ()
	QtSpell::Checker object destructor.
virtual void	checkSpelling (int start=0, int end=-1)=0
	Check the spelling.
bool	setLanguage (const QString &lang)
	Set the spell checking language.
QString	getLanguage () const
	Retreive the current spelling language.
void	setDecodeLanguageCodes (bool decode)
	Set whether to decode language codes in the UI.
bool	getDecodeLanguageCodes () const
	Return whether langauge codes are decoded in the UI.
void	setShowCheckSpellingCheckbox (bool show)
	Set whether to display an "Check spelling" checkbox in the UI.
bool	getShowCheckSpellingCheckbox () const
	Return whether a "Check spelling" checkbox is displayed in the UI.
bool	getSpellingEnabled () const
	Return whether spellchecking is performed.
void	addWordToDictionary (const QString &word)
	Add the specified word to the user dictionary.
bool	checkWord (const QString &word) const
	Check the specified word.
void	ignoreWord (const QString &word) const
	Ignore a word for the current session.
QList< QString >	getSpellingSuggestions (const QString &word) const
	Retreive a list of spelling suggestions for the misspelled word.

Static Public Member Functions
static QList< QString >	getLanguageList ()
	Requests the list of languages available for spell checking.
static QString	decodeLanguageCode (const QString &lang)
	Translates a language code to a human readable format (i.e. "en_US" -> "English (United States)").

Private Member Functions
virtual QString	getWord (int pos, int start=0, int end=0) const =0
	Get the word at the specified cursor position.
virtual void	insertWord (int start, int end, const QString &word)=0
	Replaces the specified range with the specified word.
virtual bool	isAttached () const =0
	Returns whether a widget is attached to the checker.

Detailed Description

An abstract class providing spell checking support.

Definition at line 49 of file QtSpell.hpp.

Member Function Documentation

◆ addWordToDictionary()

void QtSpell::Checker::addWordToDictionary ( const QString & word )

Add the specified word to the user dictionary.

Parameters

word	The word to add to the dictionary

Definition at line 196 of file Checker.cpp.

References Checker().

Referenced by checkSpelling().

◆ checkSpelling()

virtual void QtSpell::Checker::checkSpelling	(	int	start = 0,
		int	end = -1 )

pure virtual

Check the spelling.

Parameters

start	The start position within the buffer.
end	The end position within the buffer (-1 for the buffer end).

Implemented in QtSpell::TextEditChecker.

References addWordToDictionary(), checkWord(), decodeLanguageCode(), getDecodeLanguageCodes(), getLanguage(), getLanguageList(), getShowCheckSpellingCheckbox(), getSpellingEnabled(), getSpellingSuggestions(), ignoreWord(), setDecodeLanguageCodes(), setLanguage(), setShowCheckSpellingCheckbox(), and setSpellingEnabled().

Referenced by setLanguage(), and setSpellingEnabled().

◆ checkWord()

bool QtSpell::Checker::checkWord ( const QString & word ) const

Check the specified word.

Parameters

word A word.

Returns: Whether the word is correct.

Definition at line 204 of file Checker.cpp.

References Checker().

Referenced by checkSpelling(), and QtSpell::TextEditChecker::checkSpelling().

◆ decodeLanguageCode()

QString QtSpell::Checker::decodeLanguageCode ( const QString & lang )

static

Translates a language code to a human readable format (i.e. "en_US" -> "English (United States)").

Parameters

lang	The language locale specifier.

Note: If the iso-codes package is unavailable, the unchanged code is returned.

Returns: The human readable language description.

Definition at line 250 of file Checker.cpp.

References QtSpell::Codetable::instance(), and QtSpell::Codetable::lookup().

Referenced by checkSpelling().

◆ getDecodeLanguageCodes()

bool QtSpell::Checker::getDecodeLanguageCodes ( ) const

Return whether langauge codes are decoded in the UI.

Returns: Whether langauge codes are decoded in the UI.

Definition at line 172 of file Checker.cpp.

References Checker().

Referenced by checkSpelling().

◆ getLanguage()

QString QtSpell::Checker::getLanguage ( ) const

Retreive the current spelling language.

Returns: The current spelling language.

Definition at line 132 of file Checker.cpp.

References Checker().

Referenced by checkSpelling().

◆ getLanguageList()

QList< QString > QtSpell::Checker::getLanguageList ( )

static

Requests the list of languages available for spell checking.

Returns: A list of languages available for spell checking.

Definition at line 241 of file Checker.cpp.

Referenced by checkSpelling().

◆ getShowCheckSpellingCheckbox()

bool QtSpell::Checker::getShowCheckSpellingCheckbox ( ) const

Return whether a "Check spelling" checkbox is displayed in the UI.

Returns: Whether a "Check spelling" checkbox is displayed in the UI.

Definition at line 184 of file Checker.cpp.

References Checker().

Referenced by checkSpelling().

◆ getSpellingEnabled()

bool QtSpell::Checker::getSpellingEnabled ( ) const

Return whether spellchecking is performed.

Returns: Whether spellchecking is performed.

Definition at line 190 of file Checker.cpp.

References Checker().

Referenced by checkSpelling().

◆ getSpellingSuggestions()

QList< QString > QtSpell::Checker::getSpellingSuggestions ( const QString & word ) const

Retreive a list of spelling suggestions for the misspelled word.

Parameters

word	The misspelled word.

Returns: A list of spelling suggestions.

Definition at line 227 of file Checker.cpp.

References Checker().

Referenced by checkSpelling().

◆ getWord()

virtual QString QtSpell::Checker::getWord	(	int	pos,
		int *	start = 0,
		int *	end = 0 ) const

privatepure virtual

Get the word at the specified cursor position.

Parameters

pos	The cursor position.
start	If not 0, will contain the start position of the word.
end	If not 0, will contain the end position of the word.

Returns: The word.

Implemented in QtSpell::TextEditChecker.

◆ ignoreWord()

void QtSpell::Checker::ignoreWord ( const QString & word ) const

Ignore a word for the current session.

Parameters

word	The word to ignore.

Definition at line 221 of file Checker.cpp.

References Checker().

Referenced by checkSpelling().

◆ insertWord()

virtual void QtSpell::Checker::insertWord	(	int	start,
		int	end,
		const QString &	word )

privatepure virtual

Replaces the specified range with the specified word.

Parameters

start	The start position.
end	The end position.
word	The word to insert.

Implemented in QtSpell::TextEditChecker.

◆ isAttached()

virtual bool QtSpell::Checker::isAttached ( ) const

privatepure virtual

Returns whether a widget is attached to the checker.

Returns: Whether a widget is attached to the checker.

Implemented in QtSpell::TextEditChecker.

References Checker().

Referenced by setLanguage().

◆ languageChanged

void QtSpell::Checker::languageChanged ( const QString & newLang )

signal

This signal is emitted when the user selects a new language from the spellchecker UI.

Parameters

newLang The new language, as a locale specifier.

◆ setDecodeLanguageCodes()

void QtSpell::Checker::setDecodeLanguageCodes ( bool decode )

Set whether to decode language codes in the UI.

Note: Requres the iso-codes package.

Parameters

decode Whether to decode the language codes.

Definition at line 166 of file Checker.cpp.

References Checker().

Referenced by checkSpelling().

◆ setLanguage()

bool QtSpell::Checker::setLanguage ( const QString & lang )

Set the spell checking language.

Parameters

lang	The language, as a locale specifier (i.e. "en_US"), or an empty string to attempt to use the system locale.

Returns: true on success, false on failure.

Definition at line 122 of file Checker.cpp.

References Checker(), checkSpelling(), and isAttached().

Referenced by checkSpelling().

◆ setShowCheckSpellingCheckbox()

void QtSpell::Checker::setShowCheckSpellingCheckbox ( bool show )

Set whether to display an "Check spelling" checkbox in the UI.

Parameters

show	Whether to display an "Check spelling" checkbox in the UI.

Definition at line 178 of file Checker.cpp.

References Checker().

Referenced by checkSpelling().

◆ setSpellingEnabled

void QtSpell::Checker::setSpellingEnabled ( bool enabled )

slot

Set whether spell checking should be performed.

Parameters

enabled True if spell checking should be performed.

Definition at line 265 of file Checker.cpp.

References Checker(), and checkSpelling().

Referenced by checkSpelling().

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

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Private Member Functions

Detailed Description

Member Function Documentation

◆ addWordToDictionary()

◆ checkSpelling()

◆ checkWord()

◆ decodeLanguageCode()

◆ getDecodeLanguageCodes()

◆ getLanguage()

◆ getLanguageList()

◆ getShowCheckSpellingCheckbox()

◆ getSpellingEnabled()

◆ getSpellingSuggestions()

◆ getWord()

◆ ignoreWord()

◆ insertWord()

◆ isAttached()

◆ languageChanged

◆ setDecodeLanguageCodes()

◆ setLanguage()

◆ setShowCheckSpellingCheckbox()

◆ setSpellingEnabled