/***************************************************************************
 *   Copyright (C) 2006 by Ian Reinhart Geiser   *
 *   geiseri@yahoo.com   *
 *                                                                         *
 *   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.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef QTEXTDOCUMENTSPELLCHECKER_H
#define QTEXTDOCUMENTSPELLCHECKER_H

#include <QObject>

class QASpell;
class QTextDocument;
class QTextCursor;
class QStringListModel;
class QAbstractItemModel;

/**
A simple wrapper around the ASpell library to spell check a QTextDocument object.

	@author Ian Reinhart Geiser <geiseri@yahoo.com>
*/
class QTextDocumentSpellChecker : public QObject
{
	Q_OBJECT
public:
	QTextDocumentSpellChecker(QObject *parent = 0);
	QTextDocumentSpellChecker(QTextDocument *document, QObject *parent = 0);

	~QTextDocumentSpellChecker();

	void setWatchedDocument(QTextDocument* theValue);
	QTextDocument* watchedDocument() const;

	bool replaceStringInDocument(const QTextCursor &cursor, const QString &original, const QString &replacement, bool replaceAll = false );
	void updateSuggestions( const QString &word );
	QTextCursor findNextMisspelling( const QTextCursor &cursor ) const;

	QAbstractItemModel* suggestionsModel() const;

private:
	void replaceString( QTextCursor *cursor, const QString &replacement );
	QASpell *m_speller;
	QTextDocument *m_watchedDocument;
	QStringListModel *m_suggestions;
};

#endif