dictionary.h
// -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*-
/*
* dictionary.h
*
* Copyright (C) 2004 Zack Rusin <zack@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef KSPELL_DICTIONARY_H
#define KSPELL_DICTIONARY_H
#include <qstringlist.h>
#include <qstring.h>
namespace KSpell2
{
class Dictionary
{
public:
virtual ~Dictionary() {}
virtual bool check( const QString& word ) =0;
virtual QStringList suggest( const QString& word ) =0;
virtual bool checkAndSuggest( const QString& word,
QStringList& suggestions ) =0;
virtual bool storeReplacement( const QString& bad,
const QString& good ) =0;
virtual bool addToPersonal( const QString& word ) =0;
virtual bool addToSession( const QString& word ) =0;
QString language() const
{
return m_language;
}
bool isDefault() const
{
return m_default;
}
protected:
Dictionary( const QString& lang, bool def = false )
: m_language( lang ), m_default( def ) {}
protected:
friend class Broker;
QString m_language;
bool m_default;
private:
class Private;
Private *d;
};
}
#endif
KSpell2::Dictionary::suggest
virtual QStringList suggest(const QString &word)=0
Fetches suggestions for the word.
KSpell2::Dictionary::addToPersonal
virtual bool addToPersonal(const QString &word)=0
Adds word to the list of of personal words.
KSpell2::Dictionary::isDefault
bool isDefault() const
Returns true if this dictionary was constructed from default Settings values.
Definition: dictionary.h:92
KSpell2::Dictionary::check
virtual bool check(const QString &word)=0
Checks the given word.
KSpell2::Dictionary::checkAndSuggest
virtual bool checkAndSuggest(const QString &word, QStringList &suggestions)=0
Checks the word and fetches suggestions for it.
KSpell2::Dictionary::addToSession
virtual bool addToSession(const QString &word)=0
Adds word to the words recognizable in the current session.
KSpell2::Dictionary
Class is returned by from Broker.
Definition: dictionary.h:37
KSpell2::Dictionary::language
QString language() const
Returns language supported by this dictionary.
Definition: dictionary.h:83
KSpell2::Dictionary::storeReplacement
virtual bool storeReplacement(const QString &bad, const QString &good)=0
Stores user defined good replacement for the bad word.

KDE Home | KDE Accessibility Home | Description of Access Keys