vcs.maemo.org Git - mdictionary/blob - trunk/src/plugins/xdxf/src/xdxfplugin.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 #ifndef XDXFPLUGIN_H
  23 #define XDXFPLUGIN_H
  24
  25 #include "../../../includes/CommonDictInterface.h"
  26 #include <QObject>
  27 #include <QDialog>
  28 #include <QRegExp>
  29 #include <QTime>
  30 #include "XdxfDictDialog.h"
  31
  32 class TranslationXdxf;
  33
  34 class XdxfPlugin : public CommonDictInterface
  35 {
  36     Q_OBJECT
  37     Q_INTERFACES(CommonDictInterface)
  38 public:
  39     XdxfPlugin(QObject *parent=0);
  40
  41     //! returns source language code iso 639-2
  42     QString langFrom() const;
  43
  44     //! returns destination language code iso 639-2
  45     QString langTo() const;
  46
  47     //! returns dictionary name (like "old english" or so)
  48     QString name() const;
  49
  50     //! returns dictionary type (xdxf, google translate, etc)
  51     QString type() const;
  52
  53     //! returns information about dictionary in html (name, authors, etc)
  54     QString infoNote() const;
  55
  56     /*! returns DictDialog object that creates dialogs
  57         for adding new dictionary and change plugin settings
  58       */
  59     DictDialog* dictDialog();
  60
  61
  62     //! returns new, clean copy of plugin with setting set as in Settings*
  63     CommonDictInterface* getNew(const Settings*) const;
  64
  65     //! returns whether plugin can start searching
  66     bool isAvailable() const;
  67
  68     //! returns a description of a word given by a QString
  69     QString search(QString key);
  70
  71     //! returns a unique hash for a dictionary
  72     uint hash() const;
  73
  74     //! set unique value (unique for every dictionary not plugin)
  75     void setHash(uint);
  76
  77     //! returns current plugin settings
  78     Settings* settings();
  79
  80 public Q_SLOTS:
  81     /*! performs search in dictionary
  82       \param  word word to search in dictionary
  83       \param limit limit on number of results
  84
  85       After finishing search it has to emit
  86       \see CommonDictInterface:finalTranslation  finalTranslation
  87     */
  88     QList<Translation*> searchWordList(QString word, int limit=0);
  89
  90     //! stop current operation
  91     void stop();
  92
  93 private:
  94     bool isCached();
  95     void setPath(QString);
  96     QString _langFrom;
  97     QString _langTo;
  98     QString _name;
  99     QString _type;
 100     QString _infoNote;
 101     QDialog *_loadDialog;
 102     QDialog *_settingsDialog;
 103     QString path;
 104     uint _hash;
 105     bool stopped;   /*volatile*/
 106     Settings *_settings;
 107     XdxfDictDialog* _dictDialog;
 108 };
 109
 110 #endif // XDXFPLUGIN_H
 111
 112