Salome HOME
Update code documentation
[modules/shaper.git] / src / XGUI / XGUI_ActionsMgr.h
index 38b8e167d689f86173b6fc3936991704cae9b02f..8007e979421e63275f22a73277b729eed1b78e68 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 /*
  * XGUI_ActionsMgr.h
  */
@@ -7,31 +9,58 @@
 
 #include "XGUI.h"
 
+#include <Events_Listener.h>
+#include <ModelAPI_Feature.h>
+
 #include <QObject>
 #include <QMap>
+#include <QList>
 #include <QStringList>
+#include <QKeySequence>
 
-class XGUI_Command;
 class XGUI_Workshop;
 class XGUI_OperationMgr;
+class ModuleBase_Operation;
 class QAction;
 
-class XGUI_EXPORT XGUI_ActionsMgr: public QObject
+/**
+* \ingroup GUI
+* A class for management of actions (features) activation/deactivation
+*/
+class XGUI_EXPORT XGUI_ActionsMgr : public QObject, public Events_Listener
 {
-  Q_OBJECT
+Q_OBJECT
 
-public:
+ public:
+   /// Constructor
+   /// \param theWorkshop an instance of workshop
   XGUI_ActionsMgr(XGUI_Workshop* theWorkshop);
   virtual ~XGUI_ActionsMgr();
 
   //! Add a command in the manager.
-  //! Please note that nested commands in the Salome mode (No XGUI_Command, pure QActions)
+  //! Please note that nested commands in the Salome mode (No AppElements_Command, pure QActions)
   //! won't be extracted and should be added manually using the addNestedCommands method.
   void addCommand(QAction* theCmd);
+
   //! Sets relation between the command (with given Id) and it's nested actions.
   void addNestedCommands(const QString& theId, const QStringList& theCommands);
 
-public slots:
+  //! Returns list of nested commands by parent command Id
+  //! \param theId a parent command Id
+  QStringList nestedCommands(const QString& theId) const;
+
+  /// Returns True if the given Id is an Id of nested command
+  /// \param theId an Id to check
+  bool isNested(const QString& theId) const;
+
+  /// Registers shortcut (key sequence) for the command triggering
+  /// \param theKeySequence a key sequence to register
+  QKeySequence registerShortcut(const QString& theKeySequence);
+
+  //! Redefinition of Events_Listener method
+  virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
+
+ public slots:
   //! Update workbench actions according to OperationMgr state:
   //! No active operations: all actions but nested are available
   //! There is active operation: current operation + it's nested
@@ -39,22 +68,32 @@ public slots:
   void update();
   //! Sets all commands checked if it's operation is active.
   void updateCheckState();
+  //! Updates actions according to current selection in the viewer
+  void updateOnViewSelection();
 
-protected:
+ protected:
   //! Sets all actions to isEnabled state.
   void setAllEnabled(bool isEnabled);
   //! Sets all nested actions to isEnabled state for the command with given ID.
   //! If ID is empty - all nested actions will be affected.
   void setNestedCommandsEnabled(bool isEnabled, const QString& theParent = QString());
+  //! Sets to enabled state all siblings of the given operation and it's parents recursively
+  void setNestedStackEnabled(ModuleBase_Operation* theOperation);
   //! Sets the action with theId to theChecked state.
   void setActionChecked(const QString& theId, const bool theChecked);
   //! Sets the action with theId to theEnabled state.
   void setActionEnabled(const QString& theId, const bool theEnabled);
+  //! Updates actions according to their "document" tag
+  void updateByDocumentKind();
+  //! Asks plugins about their features state, using the Events system
+  void updateByPlugins(FeaturePtr theActiveFeature);
 
-private:
+ private:
   QMap<QString, QAction*> myActions;
   QMap<QString, QStringList> myNestedActions;
+  QList<QKeySequence> myShortcuts;
 
+  XGUI_Workshop* myWorkshop;
   XGUI_OperationMgr* myOperationMgr;
 };