Merge branch 'master' of ssh://drop.maemo.org/git/mdictionary
[mdictionary] / trunk / src / includes / CommonDictInterface.h
index f2d8c5a..27a5e06 100644 (file)
@@ -19,7 +19,7 @@
 
 *******************************************************************************/
 
-/*! /file CommonDictInterface.h
+/*! \file CommonDictInterface.h
 \brief Common interface for all dicts and plugins \see CommonDictInterface
 
 \author Bartosz Szatkowski <bulislaw@linux.com>
@@ -54,7 +54,7 @@ class CommonDictInterface : public QObject, public AccentsNormalizer {
     //! returns destination language code iso 639-2
     virtual QString langTo() const = 0;
 
-    //! returns dictionary name (like "old english" or so
+    //! returns dictionary name (like "old English" or so
     virtual QString name() const = 0;
 
     //! returns dictionary type (xdxf, google translate, etc)
@@ -64,7 +64,7 @@ class CommonDictInterface : public QObject, public AccentsNormalizer {
     virtual QString infoNote() const = 0;
 
     /*! returns DictDialog object that creates dialogs
-        for adding new dictionary and change plugin settings*/
+        for adding new dictionary and changing plugin settings*/
     virtual DictDialog* dictDialog() = 0;
 
 
@@ -77,7 +77,7 @@ class CommonDictInterface : public QObject, public AccentsNormalizer {
     //! returns the actual translation of a word given in key
     virtual QString search(QString key) = 0;
 
-    //! \returns unique value (unique for every dictionary not plugin
+    //! \returns unique value (unique for every dictionary not plugin)
     virtual uint hash() const = 0;
 
     //! sets unique value (unique for every dictionary not plugin)
@@ -89,13 +89,15 @@ class CommonDictInterface : public QObject, public AccentsNormalizer {
     //! returns plugin icon
     virtual QIcon* icon() = 0;
 
+    virtual Translation* getTranslationFor(QString key) {return 0;}
+
  public Q_SLOTS:
     /*! performs search in dictionary
         \param  word word to search in dictionary
         \param  limit limit on number of results,
                 if limit=0 all matching words are returned
 
-        After finishing search it have to emit
+        After finishing search it has to emit
         \see CommonDictInterface:finalTranslation  finalTranslation
     */
     virtual QList<Translation*> searchWordList(QString word, int limit=0) = 0;
@@ -111,7 +113,7 @@ class CommonDictInterface : public QObject, public AccentsNormalizer {
     //! emited after change dictionary settings
     void settingsChanged();
 
-    /*! emmited to backbone when needed to inform user about something
+    /*! emitted to backbone when needed to inform user about something
         \param Backbone::NotifyType gui my dacide to show different typet in
             different ways
         \param QString text of the notification