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"
27 * Base class of all spellchecker implementations.
28 * The class can be instantiated but will have no functionality.
33 /// the result from checking a single word
37 /// root of given word was found
39 /// word found through compound formation
43 /// not found, with suggestions
45 /// number of other ignored "word"
49 virtual ~SpellBase() {}
51 /// return true if the spellchecker instance still exists
54 /// check the given word of the given lang code and return the result
55 virtual enum Result check(WordLangTuple const &);
57 /// insert the given word into the personal dictionary
58 virtual void insert(WordLangTuple const &);
60 /// accept the given word temporarily
61 virtual void accept(WordLangTuple const &);
63 /// return the next near miss after a SUGGESTED_WORDS result
64 virtual std::string const nextMiss();
66 /// give an error message on messy exit
67 virtual docstring const error();
73 #endif // SPELL_BASE_H