Clean and order documentation in source files. Source ready to beta 2 release
[mdictionary] / src / mdictionary / gui / WordListWidget.h
index f06d889..9f7c3a2 100644 (file)
     Copyright 2010 Comarch S.A.
 
 *******************************************************************************/
-//! \file WordListwidget.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file WordListwidget.h
+    \brief Displays list of words found in dictionaries
+
+    \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
 
 #ifndef WORDLISTWIDGET_H
 #define WORDLISTWIDGET_H
@@ -29,7 +32,6 @@
 #include "../backbone/backbone.h"
 #include "WordListProxyStyle.h"
 
-//! Displays list of words found in dictionaries
 /*!
     It allows user to select word to see its translation or to mark or unmark
     it as "star" (add/remove from bookmarks). It inherits from QTreeView
@@ -70,26 +72,31 @@ public Q_SLOTS:
     //! Unlocks words list
     void unlockList();
 
+    //! clears list
+    void clear();
+
 protected:
     //! Reimplemented standard mouseReleaseEvent to check if user clicked on
-    //! word or on its star to emit suitable signal
+    //! a word or on its star to emit suitable signal
     void mouseReleaseEvent(QMouseEvent *event);
 
     //! Resizes the size of columns to assure that stars are always on right
     //! side next to scroll bar
     void resizeEvent(QResizeEvent *event);
 
+    //! Checks if user press return and if so displays translation of selected word
+    void keyPressEvent( QKeyEvent * event);
+
 private Q_SLOTS:
     //! Emits signal to show translation of clicked item. Signal is emitted
-    //! only when word was clicked.
+    //! only when a word was clicked.
     void wordClicked(QModelIndex index);
 
     //! Emits signal to show add or remove word from bookmarks.
-    //! Signal is emitted only when star was clicked.
+    //! Signal is emitted only when a star was clicked.
     void wordChecked(QModelIndex index);
 
-    //! clears list
-    void clear();
+
 
 private:
     //! Adds word to model. Row is row in the model
@@ -97,7 +104,7 @@ private:
 
     QStandardItemModel* model;
 
-    //! Describes width of star checkbox in pixels
+    //! Describes width of a star checkbox in pixels
     int checkBoxWidth;
 
     //! Resizes sizes of colums after adding new words or after resize event.