lyx_mirror/src/SpellChecker.h
Abdelrazak Younes 51978827f4 adjust comment.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@29553 a592a061-630c-0410-9148-cb99ea01b6c8
2009-05-06 17:52:58 +00:00

72 lines
1.5 KiB
C++

// -*- C++ -*-
/**
* \file SpellChecker.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author unknown
* \author John Levon
*
* Full author contact details are available in file CREDITS.
*/
#ifndef SPELL_BASE_H
#define SPELL_BASE_H
#include "support/strfwd.h"
namespace lyx {
class BufferParams;
class WordLangTuple;
/**
* Pure virtual base class of all spellchecker implementations.
*/
class SpellChecker {
public:
/// the result from checking a single word
enum Result {
/// word is correct
OK = 1,
/// root of given word was found
ROOT,
/// word found through compound formation
COMPOUND_WORD,
/// word not found
UNKNOWN_WORD,
/// not found, with suggestions
SUGGESTED_WORDS,
/// number of other ignored "word"
IGNORED_WORD
};
virtual ~SpellChecker() {}
/// check the given word of the given lang code and return the result
virtual enum Result check(WordLangTuple const &) = 0;
/// insert the given word into the personal dictionary
virtual void insert(WordLangTuple const &) = 0;
/// accept the given word temporarily
virtual void accept(WordLangTuple const &) = 0;
/// return the next near miss after a SUGGESTED_WORDS result
virtual docstring const nextMiss() = 0;
/// give an error message on messy exit
virtual docstring const error() = 0;
};
/// Access to the singleton SpellChecker.
/// Implemented in LyX.cpp
SpellChecker * theSpellChecker();
} // namespace lyx
#endif // SPELL_BASE_H