Salome HOME
Documentation update
[modules/shaper.git] / src / XGUI / XGUI_HistoryMenu.h
index 9dd2951acc579de46bb27aca188100592571ea4a..267ce67f79561ae3440fe7bc4038d4b1a08253b9 100644 (file)
@@ -17,25 +17,43 @@ class QListWidget;
 class QToolButton;
 class QListWidgetItem;
 
+/**
+ * \class XGUI_HistoryMenu
+ * \ingroup GUI
+ * \brief Extends regular QToolButton of QAction with HistoryMenu (stack of actions)
+ */
 class XGUI_EXPORT XGUI_HistoryMenu : public QMenu
 {
   Q_OBJECT
  public:
+  /// Creates history menu for button
   explicit XGUI_HistoryMenu(QToolButton* theParent);
+  /// Creates history menu for action
+  explicit XGUI_HistoryMenu(QAction* theParent);
   virtual ~XGUI_HistoryMenu();
 
  signals:
-  void actionsSelected(int);
+  /// Signal. Emited then n-th action is selected in stack
+  void actionSelected(int);
 
  public slots:
+  /// Set list of actions
   void setHistory(const QList<ActionInfo>&);
 
+ protected:
+  /// Unselects all items when cursor leaves the list
+  virtual void leaveEvent(QEvent *);
+
  protected slots:
+  /// Selects all items in stack to the given item including it
   void setStackSelectedTo(QListWidgetItem *);
+  /// Emits actionSelected() signal.
   void onItemPressed(QListWidgetItem *);
+  /// Initializes internal controls of the Menu
+  void initMenu();
 
  private:
-  QListWidget* myHistoryList;
+  QListWidget* myHistoryList; ///< List to contain actions
 };
 
 #endif /* XGUI_OPERATIONSSTACKPOPUP_H_ */