change and add some comments, remove some warning
[mdictionary] / src / plugins / xdxf / TranslationXdxf.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     \file TranslationXdxf.h
23     \author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
24 */
25 #ifndef TRANSLATIONXDXF_H
26 #define TRANSLATIONXDXF_H
27
28 #include <QString>
29 #include "../../include/translation.h"
30 #include "xdxfplugin.h"
31
32 class TranslationXdxf : public Translation
33 {
34 public:
35     TranslationXdxf();
36     TranslationXdxf(QString _key,
37                     QString _dictionaryInfo,
38                     XdxfPlugin *xdxfPlugin);
39
40     //! \return word to be translated
41     QString key() const;
42
43     //! \return parsed raw format into xml
44     QString toXml() const;
45
46     /*! sets the word for which we want to find a translation
47         \param word for which we want to find a translation */
48     void setKey(QString);
49
50     //! sets information about dictionary
51     void setDictionaryInfo(QString);
52
53     //! \return whether given translation is taken from bookmarks
54     int isBookmark() const {
55         return _bookmark;
56    }
57
58     //! \return corresponding dict object
59     uint dict() const {return _dictHash;}
60
61 private:
62     QString _key;
63     QString _dictionaryInfo;
64     XdxfPlugin *xdxfPlugin;
65     int _dictHash;
66 };
67
68 #endif // TRANSLATIONXDXF_H
69