vcs.maemo.org Git - mdictionary/blob - trunk/src/includes/CommonDictInterface.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 /*! /file CommonDictInterface.h
  23 \brief Common interface for all dicts and plugins \see CommonDictInterface
  24
  25 \author Bartosz Szatkowski <bulislaw@linux.com>
  26 */
  27
  28 #ifndef COMMONDICTINTERFACE_H
  29 #define COMMONDICTINTERFACE_H
  30
  31 #include <QString>
  32 #include <QDialog>
  33 #include <QObject>
  34 #include <QList>
  35 #include "translation.h"
  36 #include "Notify.h"
  37
  38 class DictDialog;
  39 class Settings;
  40
  41
  42 //! Interface for dict engines plugins
  43 class CommonDictInterface : public QObject {
  44   Q_OBJECT
  45   public:
  46     CommonDictInterface(QObject *parent = 0):QObject(parent) {}
  47
  48     //! returns source language code iso 639-2
  49     virtual QString langFrom() const = 0;
  50
  51     //! returns destination language code iso 639-2
  52     virtual QString langTo() const = 0;
  53
  54     //! returns dictionary name (like "old english" or so
  55     virtual QString name() const = 0;
  56
  57     //! returns dictionary type (xdxf, google translate, etc)
  58     virtual QString type() const = 0;
  59
  60     //! returns information about dictionary in html (name, authors, etc)
  61     virtual QString infoNote() const = 0;
  62
  63     /*! returns DictDialog object that creates dialogs
  64         for adding new dictionary and change plugin settings*/
  65     virtual DictDialog* dictDialog() = 0;
  66
  67
  68     //! returns new, clean copy of plugin with setting set as in Settings*
  69     virtual CommonDictInterface* getNew(const Settings*) const = 0;
  70
  71     //! returns whether plugin can start searching
  72     virtual bool isAvailable() const = 0;
  73
  74     //! returns the actual translation of a word given in key
  75     virtual QString search(QString key) = 0;
  76
  77     //! \returns unique value (unique for every dictionary not plugin
  78     virtual uint hash() const = 0;
  79
  80     //! sets unique value (unique for every dictionary not plugin)
  81     virtual void setHash(uint) = 0;
  82
  83     //! returns current plugin settings
  84     virtual Settings* settings() = 0;
  85
  86     //! returns plugin icon
  87     virtual QIcon* icon() = 0;
  88
  89  public Q_SLOTS:
  90     /*! performs search in dictionary
  91         \param  word word to search in dictionary
  92         \param  limit limit on number of results,
  93                 if limit=0 all matching words are returned
  94
  95         After finishing search it have to emit
  96         \see CommonDictInterface:finalTranslation  finalTranslation
  97     */
  98     virtual QList<Translation*> searchWordList(QString word, int limit=0) = 0;
  99
 100     //! stops current operation
 101     virtual void stop() = 0;
 102
 103   Q_SIGNALS:
 104
 105     //! emited after dictionary is ready to use afer being loaded
 106     void loaded(CommonDictInterface*);
 107
 108     //! emited after change dictionary settings
 109     void settingsChanged();
 110
 111     /*! emmited to backbone when needed to inform user about something
 112         \param Backbone::NotifyType gui my dacide to show different typet in
 113             different ways
 114         \param QString text of the notification
 115     */
 116     void notify(Notify::NotifyType, QString);
 117 };
 118
 119 Q_DECLARE_INTERFACE(CommonDictInterface, "CommonDictInterface/0.1");
 120
 121 #endif