src/AspellChecker.h

   1 // -*- C++ -*-
   2 /**
   3  * \file AspellChecker.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Kevin Atkinson
   8  * \author John Levon
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef LYX_ASPELL_H
  14 #define LYX_ASPELL_H
  15
  16 #include "SpellChecker.h"
  17
  18 namespace lyx {
  19
  20 class AspellChecker : public SpellChecker
  21 {
  22 public:
  23         AspellChecker();
  24         ~AspellChecker();
  25
  26         /// check the given word and return the result
  27         enum Result check(WordLangTuple const &);
  28
  29         /// insert the given word into the personal dictionary
  30         void insert(WordLangTuple const &);
  31
  32         /// accept the given word temporarily
  33         void accept(WordLangTuple const &);
  34
  35         /// return the next near miss after a SUGGESTED_WORDS result
  36         docstring const nextMiss();
  37
  38         /// give an error message on messy exit
  39         docstring const error();
  40
  41 private:
  42         struct Private;
  43         Private * d;
  44 };
  45
  46
  47 } // namespace lyx
  48
  49 #endif // LYX_ASPELL_H