File indexing completed on 2024-04-28 15:34:19

 /*
  * SPDX-FileCopyrightText: 2004 Zack Rusin <zack@kde.org>
  *
  * SPDX-License-Identifier: LGPL-2.1-or-later
  */
 #ifndef SONNET_SPELLERPLUGIN_P_H
 #define SONNET_SPELLERPLUGIN_P_H
 
 #include <QString>
 #include <QStringList>
 
 #include "sonnetcore_export.h"
 
 namespace Sonnet
 {
 /**
  * Class is returned by from Loader. It acts
  * as the actual spellchecker.
  *
  * @author Zack Rusin <zack@kde.org>
  * @short class used for actual spell checking
  */
 class SpellerPluginPrivate;
 class SONNETCORE_EXPORT SpellerPlugin
 {
 public:
     virtual ~SpellerPlugin();
 
     /**
      * Checks the given word.
      * @return false if the word is misspelled. true otherwise
      */
     virtual bool isCorrect(const QString &word) const = 0;
 
     /**
      * Checks the given word.
      * @return true if the word is misspelled. false otherwise
      */
     bool isMisspelled(const QString &word) const;
 
     /**
      * Fetches suggestions for the word.
      *
      * @return list of all suggestions for the word
      */
     virtual QStringList suggest(const QString &word) const = 0;
 
     /**
      * Convenient method calling isCorrect() and suggest()
      * if the word isn't correct.
      */
     virtual bool checkAndSuggest(const QString &word, QStringList &suggestions) const;
 
     /**
      * Stores user defined good replacement for the bad word.
      * @returns true on success
      */
     virtual bool storeReplacement(const QString &bad, const QString &good) = 0;
 
     /**
      * Adds word to the list of of personal words.
      * @return true on success
      */
     virtual bool addToPersonal(const QString &word) = 0;
 
     /**
      * Adds word to the words recognizable in the current session.
      * @return true on success
      */
     virtual bool addToSession(const QString &word) = 0;
 
     /**
      * Returns language supported by this dictionary.
      */
     QString language() const;
 
 protected:
     SpellerPlugin(const QString &lang);
 
 private:
     SpellerPluginPrivate *const d;
 };
 }
 
 #endif