Registers Translation as qMetyType
[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 //! Keeping raw form of translation to be parsed only when needed
31 class Translation {
32   public:
33     //! \return word to be translated
34     virtual QString key() const = 0;
35  
36     /*! \returns dictionary information (plugin name, languages, <logo> etc)\
37          to be displayed in translation table header */
38     virtual QString dictionaryInfo() const = 0;
39
40     //! \return parsed raw format into html
41     virtual QString toHtml() const = 0;
42 };
43
44 Q_DECLARE_METATYPE(Translation*);
45
46 #endif