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"
41 //! Interface for dict engines plugins
42 class CommonDictInterface : public QObject {
45 CommonDictInterface(QObject *parent = 0):QObject(parent) {}
47 //! returns source language code iso 639-2
48 virtual QString langFrom() const = 0;
50 //! returns destination language code iso 639-2
51 virtual QString langTo() const = 0;
53 //! returns dictionary name (like "old english" or so
54 virtual QString name() const = 0;
56 //! returns dictionary type (xdxf, google translate, etc)
57 virtual QString type() const = 0;
59 //! returns information about dictionary in html (name, authors, etc)
60 virtual QString infoNote() const = 0;
62 /*! returns DictDialog object that creates dialogs
63 for adding new dictionary and change plugin settings*/
64 virtual DictDialog* dictDialog() = 0;
67 //! returns new, clean copy of plugin with setting set as in Settings*
68 virtual CommonDictInterface* getNew(const Settings*) const = 0;
70 //! returns whether plugin can start searching
71 virtual bool isAvailable() const = 0;
73 //! returns the actual translation of a word given in key
74 virtual QString search(QString key) = 0;
76 //! \returns unique value (unique for every dictionary not plugin
77 virtual uint hash() const = 0;
79 //! sets unique value (unique for every dictionary not plugin)
80 virtual void setHash(uint) = 0;
82 //! returns current plugin settings
83 virtual Settings* settings() = 0;
85 //! returns plugin icon
86 virtual QIcon icon() = 0;
89 /*! performs search in dictionary
90 \param word word to search in dictionary
91 \param limit limit on number of results,
92 if limit=0 all matching words are returned
94 After finishing search it have to emit
95 \see CommonDictInterface:finalTranslation finalTranslation
97 virtual QList<Translation*> searchWordList(QString word, int limit=0) = 0;
99 //! stops current operation
100 virtual void stop() = 0;
104 //! emited after dictionary is ready to use afer being loaded
105 void loaded(CommonDictInterface*);
107 //! emited after change dictionary settings
108 void settingsChanged();
111 Q_DECLARE_INTERFACE(CommonDictInterface, "CommonDictInterface/0.1");