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 *******************************************************************************/
23 /*! \file xdxfplugin.h
34 #include <QSqlDatabase>
37 #include <QXmlStreamReader>
41 #include "../../include/CommonDictInterface.h"
42 #include "../../include/settings.h"
43 #include "XdxfDictDialog.h"
44 #include "XdxfCachingDialog.h"
45 #include "TranslationXdxf.h"
47 class TranslationXdxf;
49 class XdxfPlugin : public CommonDictInterface
52 Q_INTERFACES(CommonDictInterface)
54 XdxfPlugin(QObject *parent=0);
58 //! \returns source language code iso 639-2
59 QString langFrom() const;
61 //! \returns destination language code iso 639-2
62 QString langTo() const;
64 //! \returns dictionary name (like "old English" or so)
67 //! \returns dictionary type (xdxf, google translate, etc)
70 //! returns information about dictionary in xml (name, authors, etc)
71 QString infoNote() const;
73 /*! \returns DictDialog object that creates dialogs
74 for adding a new dictionary and changing plugin settings
76 DictDialog* dictDialog();
78 //! \returns new, clean copy of plugin with settings set as in Settings*
79 CommonDictInterface* getNew(const Settings*) const;
81 //! \returns whether plugin can start searching
82 bool isAvailable() const;
84 //! \returns a description of a word given by a QString
85 QString search(QString key);
87 //! \returns current plugin settings
90 //! \returns words count in a dictionary
94 bool setSettings(const Settings*);
96 //! \returns plugin icon
99 /*! plugin should delete any files (eg. cache) that have been created and are ready
107 /*! performs search in a dictionary
108 \param word word to search for in a dictionary
109 \param limit limit on number of results
111 After finishing search it has to emit
112 \see CommonDictInterface:finalTranslation finalTranslation
114 QList<Translation*> searchWordList(QString word, int limit=0);
116 //! stops current operation
119 //! loads translations for each plugin only once
123 //! emitted with percent count of caching progress, and time elapsed from
125 void updateCachingProgress(int, int);
130 /*! \returns true or false depending on whether the dictionary is cached
134 /*! searches for a list of words similar to a word in a database file
135 \param word key compared with keys in a database
136 \param limit limits the number of translations in returned list,
138 \returns list of translations
140 QList<Translation*> searchWordListCache(QString word, int limit=0);
142 /*! searches for a list of words similar to a word in a xdxf file
143 \param word key compared with keys in a xdxf file
144 \param limit limits the number of translations in returned list,
146 \returns list of translations
148 QList<Translation*> searchWordListFile(QString word, int limit=0);
150 /*! searches for a translation of a word which is exactly like a key
152 QString searchFile(QString key);
154 /*! searches for a translation of a word which is exactly like a key
155 in a database file */
156 QString searchCache(QString key);
158 //! scans dictionary file to get information about it
159 bool getDictionaryInfo();
161 //! counts the keys in a xdxf file
164 /*! transforms xdxf files to database files (caching operation)
165 \returns true on success, false on failure */
166 bool makeCache(QString dir);
168 //! language from which we translate
170 //! language to which we translate
172 //! name of a dictionary
174 //! information about dictionary
177 QString _dictionaryInfo;
179 //! icon displayed during translations and when a dictionary is chosen
183 //! number of words in a dictionary
185 //! indicates if search is stopped
186 volatile bool stopped;
188 XdxfDictDialog* _dictDialog;
189 XdxfCachingDialog* cachingDialog;
192 #endif // XDXFPLUGIN_H