LeechCraft  0.6.70-13729-g7046a9d2a7
Modular cross-platform feature rich live environment.
ispellcheckprovider.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2014 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #pragma once
31 
32 #include <memory>
33 #include <QtPlugin>
34 
44 {
45 public:
48  virtual ~ISpellChecker () {}
49 
65  virtual bool IsCorrect (const QString& word) const = 0;
66 
78  virtual QStringList GetPropositions (const QString& word) const = 0;
79 
91  virtual void LearnWord (const QString& word) = 0;
92 };
93 
96 using ISpellChecker_ptr = std::shared_ptr<ISpellChecker>;
97 
111 {
112 protected:
113  virtual ~ISpellCheckProvider () {}
114 public:
121  virtual ISpellChecker_ptr CreateSpellchecker () = 0;
122 };
123 
124 Q_DECLARE_INTERFACE (ISpellChecker, "org.LeechCraft.ISpellChecker/1.0")
125 Q_DECLARE_INTERFACE (ISpellCheckProvider, "org.LeechCraft.ISpellCheckProvider/1.0")
virtual ~ISpellChecker()
Destroys the spell checker instance.
virtual bool IsCorrect(const QString &word) const =0
Returns if the given word is correct.
std::shared_ptr< ISpellChecker > ISpellChecker_ptr
A shared pointer to an ISpellChecker instance.
virtual void LearnWord(const QString &word)=0
Asks the spell checker to learn the given word.
An instance of a spell checker.
Interface for plugins providing spell checker capabilities.
virtual QStringList GetPropositions(const QString &word) const =0
Returns the list of propositions for the word.
virtual ISpellChecker_ptr CreateSpellchecker()=0
Requests a new spellchecker.