X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FSpellBase.h;h=e4ec616bdc360ef641051d1d6eeac0d9d6857bda;hb=ae9dad17702242b63ca6043002a6e500734e9296;hp=2d5f4ddfaaee97e602527bea3eaf10e4fe41f0d0;hpb=c10dfd15cd79499dd23f161d8f1716c00a143e09;p=lyx.git

diff --git a/src/SpellBase.h b/src/SpellBase.h
index 2d5f4ddfaa..e4ec616bdc 100644
--- a/src/SpellBase.h
+++ b/src/SpellBase.h
@@ -1,62 +1,71 @@
 // -*- C++ -*-
 /**
  * \file SpellBase.h
- * Copyright 2002 the LyX Team
- * Read the file COPYING
+ * 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 "LString.h" // can't forward declare...
+#include "support/docstring.h"
+
+
+namespace lyx {
 
 class BufferParams;
 class WordLangTuple;
 
 /**
- * Base class of all spell checker implementations.
+ * Base class of all spellchecker implementations.
+ * The class can be instantiated but will have no functionality.
  */
 class SpellBase {
 public:
 
 	/// the result from checking a single word
 	enum Result  {
-		OK = 1, //< word is correct
-		ROOT, //< root of given word was found
-		COMPOUNDWORD, //< word found through compound formation
-		UNKNOWN, //< word not found
-		MISSED, //< not found, with suggestions
-		IGNORE //< number of other ignored "word"
+		/// 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 ~SpellBase() {}
 
 	/// return true if the spellchecker instance still exists
-	virtual bool alive() = 0;
-
-	/// clean up on messy exit
-	virtual void cleanUp() = 0;
+	virtual bool alive();
 
 	/// check the given word of the given lang code and return the result
-	virtual enum Result check(WordLangTuple const &) = 0;
-
-	/// finish this spellchecker instance
-	virtual void close() = 0;
+	virtual enum Result check(WordLangTuple const &);
 
 	/// insert the given word into the personal dictionary
-	virtual void insert(WordLangTuple const &) = 0;
+	virtual void insert(WordLangTuple const &);
 
 	/// accept the given word temporarily
-	virtual void accept(WordLangTuple const &) = 0;
+	virtual void accept(WordLangTuple const &);
 
-	/// return the next near miss after a MISSED result
-	virtual string const nextMiss() = 0;
- 
-	/// give an error message on messy exit 
-	virtual string const error() = 0;
+	/// return the next near miss after a SUGGESTED_WORDS result
+	virtual docstring const nextMiss();
 
+	/// give an error message on messy exit
+	virtual docstring const error();
 };
 
+
+} // namespace lyx
+
 #endif // SPELL_BASE_H