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 \brief Implementation of xdxf plugin's main class.
25 \author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
36 #include <QSqlDatabase>
39 #include <QXmlStreamReader>
43 #include "../../include/CommonDictInterface.h"
44 #include "../../include/settings.h"
45 #include "XdxfDictDialog.h"
46 #include "XdxfCachingDialog.h"
47 #include "TranslationXdxf.h"
48 #include "XdxfDictDownloader.h"
50 class TranslationXdxf;
52 class XdxfPlugin : public CommonDictInterface
55 Q_INTERFACES(CommonDictInterface)
57 XdxfPlugin(QObject *parent=0);
60 //! \returns source language code iso 639-2
61 QString langFrom() const;
63 //! \returns destination language code iso 639-2
64 QString langTo() const;
66 //! \returns dictionary name (like "old English" or so)
69 //! \returns dictionary type (xdxf, google translate, etc)
72 //! \returns information about dictionary in xml (name, authors, etc)
73 QString infoNote() const;
76 \returns DictDialog object that creates dialogs
77 for adding a new dictionary and changing plugin settings
79 DictDialog* dictDialog();
81 //! \returns new, clean copy of plugin with settings set as in Settings*
82 CommonDictInterface* getNew(const Settings*) const;
84 //! \returns whether plugin can start searching
85 bool isAvailable() const;
87 //! \returns a description of a word given by a QString
88 QString search(QString key);
90 //! \returns current plugin settings
93 //! \returns words count in a dictionary
97 bool setSettings(const Settings*);
99 //! \returns plugin icon
103 plugin should delete any files (eg. cache) that have been created and are ready
108 static XdxfDictDownloader dictDownloader;
112 performs search in a dictionary
113 \param word word to search for in a dictionary
114 \param limit limit on number of results
116 After finishing search it has to emit
117 \see CommonDictInterface:finalTranslation finalTranslation
119 QList<Translation*> searchWordList(QString word, int limit=0);
121 //! stops current operation
124 //! loads translations for each plugin only once
128 //! emitted with percent count of caching progress, and time elapsed from
130 void updateCachingProgress(int, int);
134 \returns true or false depending on whether the dictionary is cached
139 searches for a list of words similar to a word in a database file
140 \param word key compared with keys in a database
141 \param limit limits the number of translations in returned list,
143 \returns list of translations
145 QList<Translation*> searchWordListCache(QString word, int limit=0);
148 searches for a list of words similar to a word in a xdxf file
149 \param word key compared with keys in a xdxf file
150 \param limit limits the number of translations in returned list,
152 \returns list of translations
154 QList<Translation*> searchWordListFile(QString word, int limit=0);
157 searches for a translation of a word which is exactly like a key
160 QString searchFile(QString key);
163 searches for a translation of a word which is exactly like a key
166 QString searchCache(QString key);
168 //! scans dictionary file to get information about it
169 bool getDictionaryInfo();
171 //! counts the keys in a xdxf file
175 transforms xdxf files to database files (caching operation)
176 \returns true on success, false on failure
178 bool makeCache(QString dir);
180 static bool dictDownloaderInitialized;
186 QString _dictionaryInfo;
191 volatile bool stopped;
193 XdxfDictDialog* _dictDialog;
194 XdxfCachingDialog* cachingDialog;
197 #endif // XDXFPLUGIN_H