speller.h

Go to the documentation of this file.

// -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*-
/*
 *
 * Copyright (C)  2007  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 SONNET_SPELLER_H
#define SONNET_SPELLER_H

#include <QtCore/QStringList>
#include <QtCore/QString>

#include <kdecore_export.h>

class KConfig;

namespace Sonnet
{
    class KDECORE_EXPORT Speller
    {
    public:
        Speller(const QString &lang=QString());
        ~Speller();

        Speller(const Speller &speller);
        Speller &operator=(const Speller &speller);

        bool isValid() const;

        void setLanguage(const QString &lang);
        QString language() const;

        bool isCorrect(const QString &word) const;

        bool isMisspelled(const QString &word) const;

        QStringList suggest(const QString &word) const;

        bool checkAndSuggest(const QString &word,
                             QStringList &suggestions) const;

        bool storeReplacement(const QString &bad,
                              const QString &good);

        bool addToPersonal(const QString &word);

        bool addToSession(const QString &word);

    public: // Configuration API
        enum Attribute {
            CheckUppercase,
            SkipRunTogether
        };
        void save(KConfig *config);
        void restore(KConfig *config);

        QStringList availableBackends() const;

        QStringList availableLanguages() const;
        QStringList availableLanguageNames() const;

        QMap<QString, QString> availableDictionaries() const;


        void setDefaultLanguage(const QString &lang);
        QString defaultLanguage() const;

        void setDefaultClient(const QString &client);
        QString defaultClient() const;

        void setAttribute(Attribute attr, bool b = true);
        bool testAttribute(Attribute attr) const;
    private:
        class Private;
        Private *const d;
    };
}
#endif