Clean and order documentation in source files. Source ready to beta 2 release

[mdictionary] / src / mdictionary / gui / DictManagerWidget.h

diff --git a/src/mdictionary/gui/DictManagerWidget.h b/src/mdictionary/gui/DictManagerWidget.h
index 990d654..3e7e4d7 100644 (file)
--- a/src/mdictionary/gui/DictManagerWidget.h
+++ b/src/mdictionary/gui/DictManagerWidget.h
@@ -19,21 +19,24 @@
 
 *******************************************************************************/
 
-//! \file DictManagerWidget.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file DictManagerWidget.h
+    \brief Implements dictionaries management widget
+
+    \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
 
 #ifndef DICTMANAGERWIDGET_H
 #define DICTMANAGERWIDGET_H
 
 #include <QWidget>
 #include <QtGui>
-#include "../../common/GUIInterface.h"
+#include "../../include/GUIInterface.h"
+#include "MenuWidget.h"
 
 
-//! Implements dictionaries management widget
 /*!
   Shows list of loaded dictionaries and their states (active/inactive).
-  It allows to change dicts states, add new dict, remove selected one or
+  It allows to change dicts states, add a new dict, remove selected one or
   change settings of selected dict. All changes are saved automatically after
   hiding of this widget.
 */
@@ -42,7 +45,7 @@ class DictManagerWidget : public QDialog {
 public:
     //! Constructor
     /*!
-      \param parent parent of this widget, which must be subclass of
+      \param parent parent of this widget, which must be a subclass of
       GUIInterface, because it will use it to get info about loaded plugins
       and dicts.
     */
@@ -51,6 +54,7 @@ public:
 protected:
     void showEvent(QShowEvent *e);
     void hideEvent(QHideEvent *e);
+    void keyPressEvent(QKeyEvent *e);
 
 Q_SIGNALS:
     //! Emitted when hiding widget, it will save states of dictionaries
@@ -59,13 +63,13 @@ Q_SIGNALS:
     */
     void selectedDictionaries(QList<CommonDictInterface*>);
 
-    //! Emitted when user wants to add new dictionary
+    //! Emitted when user wants to add a new dictionary
     /*!
         \param new dictionary returned by specific plugin dialog
     */
     void addDictionary(CommonDictInterface*);
 
-    //! Emitted when user wants to remove dictionary
+    //! Emitted when user wants to remove a dictionary
     /*!
         \param dictionary which will be removed
     */
@@ -73,25 +77,22 @@ Q_SIGNALS:
 
 
 public Q_SLOTS:
+
     #ifndef Q_WS_MAEMO_5
         void save();
     #endif
 
 private Q_SLOTS:
-    /*!
-        Shows plugin select dialog and then specific plugin add new dictionary
+    /*! Shows "plugin select" dialog and then plugin specific "add a new dictionary"
         dialog, which will return new CommonDictInterface* object, which is
-        later passed as parameter of addDictionary signal
-    */
+        later passed as a parameter of addDictionary signal*/
     void addNewDictButtonClicked();
 
-    /*!
-        Passes selected dictionary from list as parameter of removeDictionary
-        signal
-    */
+    /*! Passes dictionary selected from a list as a parameter of removeDictionary
+        signal */
     void removeButtonClicked();
 
-    //! user select one of items
+    //! user selects one of items
     void itemSelected(QListWidgetItem*);
 
     //! Shows plugin's settings dialog
@@ -112,7 +113,7 @@ private:
 
     QVBoxLayout* verticalLayout;
     QHBoxLayout* buttonGroup;
-    QListWidget* dictListWidget;
+    QListWidget* dictList;
 
     //holds association between items on list and CommonDictInterface objects
     QHash<QListWidgetItem*, CommonDictInterface*> dictsHash;