fix small bug(wildcard), and change some comments
[mdictionary] / src / mdictionary / backbone / BookmarkTranslations.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 /*!
23     \file BookmarkTranslation.h
24     \brief Bookmarks functionality needs its own translation object - because
25     Translation object should use slightly different api of Bookmarks objects
26
27     \author Bartosz Szatkowski <bulislaw@linux.com>
28 */
29 #ifndef BOOKMARKTRANSLATIONS_H
30 #define BOOKMARKTRANSLATIONS_H
31
32 #include "../../include/settings.h"
33 #include "../../include/translation.h"
34 #include "Bookmarks.h"
35 #include "QObject"
36
37
38
39 class BookmarkTranslation : public Translation
40 {
41 public:
42     BookmarkTranslation(QString key, Bookmarks* bookmarks, QString dbName){
43         _key = key;
44         _dictionaryInfo = dbName;
45         _bookmarks = bookmarks;
46         _bookmark = 2;
47     }
48
49     //! \return word to be translated
50     QString key() const {
51         return _key;
52     }
53
54     //! \return parsed raw format into xml
55     QString toXml() const {
56         if(!_key.size() || !_bookmarks)
57             return "";
58
59         QStringList list = _bookmarks->search(_key, _dictionaryInfo);
60         QString result;
61         foreach(QString translation, list)
62             result += translation + "\n";
63         return result;
64
65     }
66
67     /*!
68         sets the word for which we want to find a translation
69         \param word for which we want to find a translation
70     */
71     void setKey(QString key) {
72         _key = key;
73     }
74
75     //! sets information about dictionary
76     void setDictionaryInfo(QString dictionaryInfo) {
77         _dictionaryInfo = dictionaryInfo;
78     }
79
80
81 private:
82     QString _key;
83     QString _dictionaryInfo;
84     Bookmarks* _bookmarks;
85
86 };
87
88 #endif // HISTORYTRANSLATION_H