a157c19ae03a005dc49f733171567c8f167c23ca
[mdictionary] / trunk / src / includes / translation.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 #ifndef TRANSLATION_H
25 #define TRANSLATION_H
26
27 #include <QString>
28 #include <QMetaType>
29
30
31 //! Keeping raw form of translation to be parsed only when needed
32 class Translation {
33   public:
34     //! \return word to be translated
35     virtual QString key() const = 0;
36  
37     bool operator==(Translation* translation) {
38         return this->key()==translation->key();
39     }
40
41     /*! \returns dictionary information (plugin name, languages, <logo> etc)\
42          to be displayed in translation table header */
43     virtual QString dictionaryInfo() const = 0;
44
45     //! \return parsed raw format into html
46     virtual QString toHtml() const = 0;
47
48 };
49
50 Q_DECLARE_METATYPE(Translation*);
51 Q_DECLARE_METATYPE(QList<Translation*>);
52
53 #endif