KDECore
#include <speller.h>
Public Types | |
enum | Attribute { CheckUppercase , SkipRunTogether } |
Public Member Functions | |
Speller (const QString &lang=QString()) | |
Speller (const Speller &speller) | |
~Speller () | |
bool | addToPersonal (const QString &word) |
bool | addToSession (const QString &word) |
QStringList | availableBackends () const |
QMap< QString, QString > | availableDictionaries () const |
QStringList | availableLanguageNames () const |
QStringList | availableLanguages () const |
bool | checkAndSuggest (const QString &word, QStringList &suggestions) const |
QString | defaultClient () const |
QString | defaultLanguage () const |
bool | isCorrect (const QString &word) const |
bool | isMisspelled (const QString &word) const |
bool | isValid () const |
QString | language () const |
Speller & | operator= (const Speller &speller) |
void | restore (KConfig *config) |
void | save (KConfig *config) |
void | setAttribute (Attribute attr, bool b=true) |
void | setDefaultClient (const QString &client) |
void | setDefaultLanguage (const QString &lang) |
void | setLanguage (const QString &lang) |
bool | storeReplacement (const QString &bad, const QString &good) |
QStringList | suggest (const QString &word) const |
bool | testAttribute (Attribute attr) const |
Detailed Description
Spell checker object.
class used for actuall spell checking
Member Enumeration Documentation
◆ Attribute
Constructor & Destructor Documentation
◆ Speller() [1/2]
Sonnet::Speller::Speller | ( | const QString & | lang = QString() | ) |
Definition at line 77 of file speller.cpp.
◆ ~Speller()
Sonnet::Speller::~Speller | ( | ) |
Definition at line 84 of file speller.cpp.
◆ Speller() [2/2]
Sonnet::Speller::Speller | ( | const Speller & | speller | ) |
Definition at line 91 of file speller.cpp.
Member Function Documentation
◆ addToPersonal()
bool Sonnet::Speller::addToPersonal | ( | const QString & | word | ) |
Adds word to the list of of personal words.
- Returns
- true on success
Definition at line 147 of file speller.cpp.
◆ addToSession()
bool Sonnet::Speller::addToSession | ( | const QString & | word | ) |
Adds word to the words recognizable in the current session.
- Returns
- true on success
Definition at line 155 of file speller.cpp.
◆ availableBackends()
QStringList Sonnet::Speller::availableBackends | ( | ) | const |
Returns names of all supported backends (e.g.
ISpell, ASpell)
Definition at line 188 of file speller.cpp.
◆ availableDictionaries()
QMap< QString, QString > Sonnet::Speller::availableDictionaries | ( | ) | const |
Returns a map of all available language descriptions and their codes.
Definition at line 270 of file speller.cpp.
◆ availableLanguageNames()
QStringList Sonnet::Speller::availableLanguageNames | ( | ) | const |
Returns a localized list of names of supported languages.
Note: use availableDictionaries
Definition at line 202 of file speller.cpp.
◆ availableLanguages()
QStringList Sonnet::Speller::availableLanguages | ( | ) | const |
Returns a list of supported languages.
Note: use availableDictionaries
Definition at line 195 of file speller.cpp.
◆ checkAndSuggest()
bool Sonnet::Speller::checkAndSuggest | ( | const QString & | word, |
QStringList & | suggestions | ||
) | const |
Convience method calling isCorrect() and suggest() if the word isn't correct.
Definition at line 129 of file speller.cpp.
◆ defaultClient()
QString Sonnet::Speller::defaultClient | ( | ) | const |
Definition at line 227 of file speller.cpp.
◆ defaultLanguage()
QString Sonnet::Speller::defaultLanguage | ( | ) | const |
Definition at line 215 of file speller.cpp.
◆ isCorrect()
bool Sonnet::Speller::isCorrect | ( | const QString & | word | ) | const |
Checks the given word.
- Returns
- false if the word is misspelled. true otherwise
Definition at line 107 of file speller.cpp.
◆ isMisspelled()
bool Sonnet::Speller::isMisspelled | ( | const QString & | word | ) | const |
Checks the given word.
- Returns
- true if the word is misspelled. false otherwise
Definition at line 115 of file speller.cpp.
◆ isValid()
bool Sonnet::Speller::isValid | ( | ) | const |
Returns true if the speller supports currently selected language.
Definition at line 259 of file speller.cpp.
◆ language()
QString Sonnet::Speller::language | ( | ) | const |
Returns language supported by this speller.
Definition at line 163 of file speller.cpp.
◆ operator=()
Definition at line 99 of file speller.cpp.
◆ restore()
void Sonnet::Speller::restore | ( | KConfig * | config | ) |
Definition at line 179 of file speller.cpp.
◆ save()
void Sonnet::Speller::save | ( | KConfig * | config | ) |
Definition at line 171 of file speller.cpp.
◆ setAttribute()
void Sonnet::Speller::setAttribute | ( | Attribute | attr, |
bool | b = true |
||
) |
Definition at line 233 of file speller.cpp.
◆ setDefaultClient()
void Sonnet::Speller::setDefaultClient | ( | const QString & | client | ) |
Definition at line 221 of file speller.cpp.
◆ setDefaultLanguage()
void Sonnet::Speller::setDefaultLanguage | ( | const QString & | lang | ) |
Definition at line 209 of file speller.cpp.
◆ setLanguage()
void Sonnet::Speller::setLanguage | ( | const QString & | lang | ) |
Sets the language supported by this speller.
Definition at line 264 of file speller.cpp.
◆ storeReplacement()
bool Sonnet::Speller::storeReplacement | ( | const QString & | bad, |
const QString & | good | ||
) |
Stores user defined good replacement for the bad word.
- Returns
- true on success
Definition at line 138 of file speller.cpp.
◆ suggest()
QStringList Sonnet::Speller::suggest | ( | const QString & | word | ) | const |
Fetches suggestions for the word.
- Returns
- list of all suggestions for the word
Definition at line 122 of file speller.cpp.
◆ testAttribute()
bool Sonnet::Speller::testAttribute | ( | Attribute | attr | ) | const |
Definition at line 246 of file speller.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Feb 3 2022 00:00:00 by doxygen 1.9.1 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.