1 /*******************************************************************************
3 This file is part of mDictionary.
5 mDictionary is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 mDictionary is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with mDictionary. If not, see <http://www.gnu.org/licenses/>.
18 Copyright 2010 Comarch S.A.
20 *******************************************************************************/
22 /*! \file CommonDictInterface.h
23 \brief Common interface for all dicts and plugins \see CommonDictInterface
25 \author Bartosz Szatkowski <bulislaw@linux.com>
28 #ifndef COMMONDICTINTERFACE_H
29 #define COMMONDICTINTERFACE_H
35 #include "translation.h"
38 #include "AccentsNormalizer.h"
43 //! Interface for dict engines plugins
44 class CommonDictInterface : public QObject, public AccentsNormalizer {
47 CommonDictInterface(QObject *parent = 0):QObject(parent) {}
49 virtual ~CommonDictInterface() {}
51 //! returns source language code iso 639-2
52 virtual QString langFrom() const = 0;
54 //! returns destination language code iso 639-2
55 virtual QString langTo() const = 0;
57 //! returns dictionary name (like "old English" or so)
58 virtual QString name() const = 0;
60 //! returns dictionary type (xdxf, google translate, etc)
61 virtual QString type() const = 0;
63 //! returns information about dictionary in html (name, authors, etc)
64 virtual QString infoNote() const = 0;
66 /*! returns DictDialog object that creates dialogs
67 for adding new dictionary and changing plugin settings*/
68 virtual DictDialog* dictDialog() = 0;
71 //! returns new, clean copy of plugin with settings set as in Settings*
72 virtual CommonDictInterface* getNew(const Settings*) const = 0;
74 //! returns whether plugin can start searching
75 virtual bool isAvailable() const = 0;
77 //! returns the actual translation of a word given in key
78 virtual QString search(QString key) = 0;
80 //! \returns unique value (unique for every dictionary, not plugin)
81 virtual uint hash() const = 0;
83 //! sets unique value (unique for every dictionary, not plugin)
84 virtual void setHash(uint) = 0;
86 //! returns current plugin settings
87 virtual Settings* settings() = 0;
89 //! returns plugin icon
90 virtual QIcon* icon() = 0;
92 //! returns empty translation object (to be fetched later) for given key
93 virtual Translation* getTranslationFor(QString ) {return 0;}
95 /*! plugin should delete any files (eg. cache) that have been created and are ready
98 virtual void clean() {}
102 /*! performs search in dictionary
103 \param word word to search in dictionary
104 \param limit limit on number of results,
105 if limit=0 all matching words are returned
107 After finishing search it has to emit
108 \see CommonDictInterface:finalTranslation finalTranslation
110 virtual QList<Translation*> searchWordList(QString word, int limit=0) = 0;
112 //! stops current operation
113 virtual void stop() = 0;
115 virtual void retranslate() = 0;
119 //! emitted when dictionary is ready to use afer being loaded
120 void loaded(CommonDictInterface*);
122 //! emitted after change in dictionary settings
123 void settingsChanged();
125 /*! emitted to backbone when it's needed to inform user about something
126 \param Backbone::NotifyType GUI may decide to show different types in
128 \param QString text of the notification
130 void notify(Notify::NotifyType, QString);
134 QString removeAccents(QString string) {
135 if(settings()->value("strip_accents") == "true")
136 return AccentsNormalizer::removeAccents(string);
141 Q_DECLARE_INTERFACE(CommonDictInterface, "CommonDictInterface/0.1");