/usr/src/RPM/BUILD/qtspell-0.8.2/src/QtSpell.hpp

/* QtSpell - Spell checking for Qt text widgets.
 * Copyright (c) 2014 Sandro Mani
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program 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 General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License along
 *    with this program; if not, write to the Free Software Foundation, Inc.,
 *    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef QTSPELL_HPP
#define QTSPELL_HPP

#if defined(QTSPELL_LIBRARY)
#  define QTSPELL_API Q_DECL_EXPORT
#else
#  define QTSPELL_API Q_DECL_IMPORT
#endif

#include <QObject>
#include <QRegExp>

class QLineEdit;
class QMenu;
class QPlainTextEdit;
class QPoint;
class QTextCursor;
class QTextDocument;
class QTextEdit;

namespace enchant { class Dict; }


namespace QtSpell {

bool QTSPELL_API checkLanguageInstalled(const QString& lang);


class QTSPELL_API Checker : public QObject
{
        Q_OBJECT
public:
        Checker(QObject* parent = 0);

        virtual ~Checker();

        virtual void checkSpelling(int start = 0, int end = -1) = 0;

        bool setLanguage(const QString& lang);

        const QString& getLanguage() const{ return m_lang; }

        void setDecodeLanguageCodes(bool decode){ m_decodeCodes = decode; }

        bool getDecodeLanguageCodes() const{ return m_decodeCodes; }

        void setShowCheckSpellingCheckbox(bool show) { m_spellingCheckbox = show; }

        bool getShowCheckSpellingCheckbox() const{ return m_spellingCheckbox; }

        bool getSpellingEnabled() const{ return m_spellingEnabled; }

        void addWordToDictionary(const QString& word);

        bool checkWord(const QString& word) const;

        void ignoreWord(const QString& word) const;

        QList<QString> getSpellingSuggestions(const QString& word) const;


        static QList<QString> getLanguageList();

        static QString decodeLanguageCode(const QString& lang);

public slots:
        void setSpellingEnabled(bool enabled) { m_spellingEnabled = enabled; checkSpelling(); }

signals:
        void languageChanged(const QString& newLang);

protected:
        void showContextMenu(QMenu* menu, const QPoint& pos, int wordPos);

private slots:
        void slotAddWord();
        void slotIgnoreWord();
        void slotReplaceWord();
        void slotSetLanguage(bool checked);

private:
        enchant::Dict* m_speller;
        QString m_lang;
        bool m_decodeCodes;
        bool m_spellingCheckbox;
        bool m_spellingEnabled;

        virtual QString getWord(int pos, int* start = 0, int* end = 0) const = 0;

        virtual void insertWord(int start, int end, const QString& word) = 0;

        virtual bool isAttached() const = 0;
        bool setLanguageInternal(const QString& lang);
};


class TextEditProxy;
class UndoRedoStack;

class QTSPELL_API TextEditChecker : public Checker
{
        Q_OBJECT
public:
        TextEditChecker(QObject* parent = 0);

        ~TextEditChecker();

        void setTextEdit(QTextEdit* textEdit);

        void setTextEdit(QPlainTextEdit* textEdit);

        void setNoSpellingPropertyId(int propertyId){ m_noSpellingProperty = propertyId; }

        int noSpellingPropertyId() const{ return m_noSpellingProperty; }

        void checkSpelling(int start = 0, int end = -1);

        void setUndoRedoEnabled(bool enabled);

public slots:
        void undo();
        void redo();

        void clearUndoRedo();

signals:
        void undoAvailable(bool available);

        void redoAvailable(bool available);

private:
        TextEditProxy* m_textEdit;
        QTextDocument* m_document;
        UndoRedoStack* m_undoRedoStack;
        bool m_undoRedoInProgress;
        Qt::ContextMenuPolicy m_oldContextMenuPolicy;
        int m_noSpellingProperty;

        QString getWord(int pos, int* start = 0, int* end = 0) const;
        void insertWord(int start, int end, const QString& word);
        bool isAttached() const{ return m_textEdit != 0; }
        void setTextEdit(TextEditProxy* textEdit);
        bool eventFilter(QObject *obj, QEvent *event);
        bool noSpellingPropertySet(const QTextCursor& cursor) const;

private slots:
        void slotShowContextMenu(const QPoint& pos);
        void slotCheckDocumentChanged();
        void slotDetachTextEdit();
        void slotCheckRange(int pos, int removed, int added);
};

} // QtSpell

#endif // QTSPELL_HPP