1 /*******************************************************************************
3 This file is part of mDictionary.
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.
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.
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/>.
18 Copyright 2010 Comarch S.A.
20 *******************************************************************************/
22 /*! \file translation.h
23 \brief Interface for translation instances \see Translation
25 \author Bartosz Szatkowski <bulislaw@linux.com>
35 class CommonDictInterface;
38 /*! Translation is kind of GoF proxy, it stores key:translation pair and
39 provides it in a lazy way -> key is available always, but translation is fetched
43 Translation () { _bookmark = 0;}
44 virtual ~Translation () {}
46 //! \return word to be translated
47 virtual QString key() const = 0;
49 //! compares two translations by key
50 bool operator==(Translation* translation) {
51 return this->key()==translation->key();
54 //! \return parsed raw format into html
55 virtual QString toHtml() const = 0;
57 //! \return whether given translation is taken from bookmarks
58 virtual bool isBookmark() const {
62 //! \param b if true then translation is from bookmarks
63 void setBookmark(bool b) {
67 //! \returns corresponding dict object
68 virtual uint dict() const {return 0;}
71 //! indicates whether this translation is in bookmark
76 Q_DECLARE_METATYPE(Translation*);
77 Q_DECLARE_METATYPE(QList<Translation*>);