4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
10 * Full author contact details are available in file CREDITS.
16 #include "support/docstring.h"
24 * Base class of all spellchecker implementations.
25 * The class can be instantiated but will have no functionality.
30 /// the result from checking a single word
34 /// root of given word was found
36 /// word found through compound formation
40 /// not found, with suggestions
42 /// number of other ignored "word"
46 virtual ~SpellBase() {}
48 /// return true if the spellchecker instance still exists
51 /// check the given word of the given lang code and return the result
52 virtual enum Result check(WordLangTuple const &);
54 /// insert the given word into the personal dictionary
55 virtual void insert(WordLangTuple const &);
57 /// accept the given word temporarily
58 virtual void accept(WordLangTuple const &);
60 /// return the next near miss after a SUGGESTED_WORDS result
61 virtual std::string const nextMiss();
63 /// give an error message on messy exit
64 virtual lyx::docstring const error();
67 #endif // SPELL_BASE_H