Added custom menu widget

[mdictionary] / trunk / src / base / gui / WordListWidget.h

diff --git a/trunk/src/base/gui/WordListWidget.h b/trunk/src/base/gui/WordListWidget.h
index 0f2a6a8..430e698 100644 (file)
--- a/trunk/src/base/gui/WordListWidget.h
+++ b/trunk/src/base/gui/WordListWidget.h
@@ -30,6 +30,10 @@
 #include "../backbone/backbone.h"
 
 
+//! Displays list of words found in dictionaries
+/*!
+    It allow user to select word to see it's translation or to mark it as "star"
+  */
 class WordListWidget : public QListView {
     Q_OBJECT
 public:
@@ -37,12 +41,16 @@ public:
 
 
 public Q_SLOTS:
+    /*! Request to show search results, requested by backbone when it finished
+      search*/
     void showSearchResults();
 
 private:
     Backbone *backbone;
+    //words are keeping as QStringListModel which allow to sort them
     QStringListModel *wordListModel;
     void addWord(QString word);
+    //clears all list of words
     void clear();
 };