Salome HOME
Update code documentation
[modules/shaper.git] / src / XGUI / XGUI_ActionsMgr.h
index a3d7dea19192b14da881cd1c233ec2ddea70a268..8007e979421e63275f22a73277b729eed1b78e68 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 /*
  * XGUI_ActionsMgr.h
  */
@@ -5,31 +7,95 @@
 #ifndef XGUI_ACTIONSMGR_H_
 #define XGUI_ACTIONSMGR_H_
 
+#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_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:
-  XGUI_ActionsMgr(QObject* theParent);
+ public:
+   /// Constructor
+   /// \param theWorkshop an instance of workshop
+  XGUI_ActionsMgr(XGUI_Workshop* theWorkshop);
   virtual ~XGUI_ActionsMgr();
 
-  void addCommand(XGUI_Command* theCmd);
-  void restoreCommandState();
-  void saveCommandsState();
+  //! Add a command in the manager.
+  //! 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);
+
+  //! 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;
 
-public slots:
-  void setActionsDisabled(bool isEnabled);
+  /// Registers shortcut (key sequence) for the command triggering
+  /// \param theKeySequence a key sequence to register
+  QKeySequence registerShortcut(const QString& theKeySequence);
 
-private:
+  //! 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
+  //! are enabled, all the rest is disabled. All active commands is checked.
+  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:
+  //! 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:
   QMap<QString, QAction*> myActions;
-  QMap<QString, bool> myActionsState;
+  QMap<QString, QStringList> myNestedActions;
+  QList<QKeySequence> myShortcuts;
+
+  XGUI_Workshop* myWorkshop;
+  XGUI_OperationMgr* myOperationMgr;
 };
 
 #endif /* XGUI_ACTIONSMGR_H_ */
+