Clean and order documentation in source files. Source ready to beta 2 release
[mdictionary] / src / plugins / google / TranslationGoogle.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 TranslationGoogle.h
23     \brief Implementation of google plugin's translation.
24
25     \author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
26 */
27
28 #ifndef TRANSLATIONGOOGLE_H
29 #define TRANSLATIONGOOGLE_H
30
31 #include "../../include/translation.h"
32 #include "GooglePlugin.h"
33
34 class GooglePlugin;
35
36 class TranslationGoogle : public Translation
37 {
38 public:
39     TranslationGoogle();
40     TranslationGoogle(QString _key,QString _trans,QString _dictionaryInfo,
41                       GooglePlugin *googlePlugin);
42     ~TranslationGoogle();
43
44     //! \return word to be translated
45     QString key() const;
46
47     //! \return parsed raw format into xml
48     QString toXml() const;
49
50     /*!
51         sets the word for which we want to find a translation
52         \param word for which we want to find a translation
53     */
54     void setKey(QString);
55
56     //! sets information about dictionary
57     void setDictionaryInfo(QString);
58
59     //! \return whether given translation is taken from bookmarks
60     int isBookmark() const {
61         return _bookmark;
62     }
63
64     //! \returns corresponding dict object
65     uint dict() const {return _dictHash;}
66
67 private:
68     QString _key;
69     QString _dictionaryInfo;
70     QString _trans;
71     int _dictHash;
72     bool error;
73     GooglePlugin *googlePlugin;
74 };
75
76 #endif // TRANSLATIONGOOGLE_H