First Backbone draft ready
[mdictionary] / trunk / src / includes / CommonDictInterface.h
1 /*******************************************************************************
2
3     This file is part of mDictionary.
4
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.
9
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.
14
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/>.
17
18     Copyright 2010 Comarch S.A.
19
20 *******************************************************************************/
21
22 // Created by Bartosz Szatkowski
23
24
25 #ifndef COMMONDICTINTERFACE_H
26 #define COMMONDICTINTERFACE_H
27
28 #include <QString>
29 #include <QDialog>
30 #include <QObject>
31 #include <QList>
32 #include "translation.h"
33 class Settings;
34
35
36
37 //! Interface for dict engines plugins
38 class CommonDictInterface : public QObject {
39   Q_OBJECT
40   public:
41     CommonDictInterface(const QObject *parent = 0) ;
42
43     //! returns source language code iso 639-2
44     virtual QString langFrom() const = 0; 
45
46     //! returns destination language code iso 639-2
47     virtual QString langTo() const = 0;
48
49     //! returns dictionary name (like "old english" or so
50     virtual QString name() const = 0;
51
52     //! returns dictionary type (xdxf, google translate, etc)
53     virtual QString type() const = 0;        
54
55     //! returns information about dictionary in html (name, authors, etc)
56     virtual QString infoNote() const = 0; 
57
58     //! return dialog that creates new dictionary and fills necesary options
59     //! QDialog should returns Setting* object after being showed
60     virtual QDialog* loadDialog() = 0;  
61
62     //! return dialog with dictionary settings
63     virtual QDialog* settingsDialog() = 0;
64
65     //! return new, clean copy of plugin with setting set as in Settings*
66     virtual CommonDictInterface* getNew(const Settings*) const = 0;
67
68     //! returns whether plugin can start searching 
69     virtual bool isAvailable() const = 0;
70
71     virtual uint hash() const = 0;
72
73  public Q_SLOTS:
74     /*! performes search in dictionary
75         \param  word word to search in dictionary
76         \param limit limit on number of results
77
78         After finishing search it have to emit 
79         \see CommonDictInterface:finalTranslation  finalTranslation
80
81     */
82     virtual void search(QString word, int limit) = 0;                         
83
84     //! stop current operation
85     virtual void stop() = 0;                        
86
87   Q_SIGNALS:
88     //! emit list of finded Translations
89     void finalTranslation(QList<Translation*>);
90
91     //! emited after dictionary is ready to use afer being loaded
92     void loaded(CommonDictInterface*);
93 };
94 #endif