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/strfwd.h"
25 * Base class of all spellchecker implementations.
26 * The class can be instantiated but will have no functionality.
31 /// the result from checking a single word
35 /// root of given word was found
37 /// word found through compound formation
41 /// not found, with suggestions
43 /// number of other ignored "word"
47 virtual ~SpellChecker() {}
49 /// check the given word of the given lang code and return the result
50 virtual enum Result check(WordLangTuple const &) = 0;
53 /// insert the given word into the personal dictionary
54 virtual void insert(WordLangTuple const &) = 0;
56 /// accept the given word temporarily
57 virtual void accept(WordLangTuple const &) = 0;
59 /// return the next near miss after a SUGGESTED_WORDS result
60 virtual docstring const nextMiss() = 0;
62 /// give an error message on messy exit
63 virtual docstring const error() = 0;
66 /// Access to the singleton SpellChecker.
67 /// Implemented in LyX.cpp
68 SpellChecker * theSpellChecker();
72 #endif // SPELL_BASE_H