src/XGUI/XGUI_ActionsMgr.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 /*
   4  * XGUI_ActionsMgr.h
   5  */
   6
   7 #ifndef XGUI_ACTIONSMGR_H_
   8 #define XGUI_ACTIONSMGR_H_
   9
  10 #include "XGUI.h"
  11
  12 #include <Events_Listener.h>
  13 #include <ModelAPI_Feature.h>
  14
  15 #include <ModuleBase_ActionInfo.h>
  16
  17 #include <QObject>
  18 #include <QMap>
  19 #include <QList>
  20 #include <QStringList>
  21 #include <QKeySequence>
  22
  23 class XGUI_Workshop;
  24 class XGUI_OperationMgr;
  25 class ModuleBase_Operation;
  26 class QAction;
  27
  28 /**
  29 * \ingroup GUI
  30 * A class for management of actions (features) activation/deactivation
  31 */
  32 class XGUI_EXPORT XGUI_ActionsMgr : public QObject, public Events_Listener
  33 {
  34   Q_OBJECT
  35
  36  public:
  37   /// Constructor
  38   /// \param theWorkshop an instance of workshop
  39   XGUI_ActionsMgr(XGUI_Workshop* theWorkshop);
  40   virtual ~XGUI_ActionsMgr();
  41
  42   /// Actions on operations
  43   enum OperationStateActionId {
  44     Abort = 0,
  45     Accept = 1,
  46     Help = 2,
  47     AbortAll = 3,
  48     AcceptAll = 4,
  49     Preview = 5
  50   };
  51
  52   //! Add a command in the manager.
  53   //! Please note that nested commands in the Salome mode (No AppElements_Command, pure QActions)
  54   //! won't be extracted and should be added manually using the addNestedCommands method.
  55   void addCommand(QAction* theCmd);
  56
  57   //! Sets relation between the command (with given Id) and it's nested actions.
  58   void addNestedCommands(const QString& theId, const QStringList& theCommands);
  59
  60   //! Returns list of nested commands by parent command Id
  61   //! \param theId a parent command Id
  62   QStringList nestedCommands(const QString& theId) const;
  63
  64   /// Returns True if the given Id is an Id of nested command
  65   /// \param theId an Id to check
  66   bool isNested(const QString& theId) const;
  67
  68   /// Registers shortcut (key sequence) for the command triggering
  69   /// \param theKeySequence a key sequence to register
  70   QKeySequence registerShortcut(const QKeySequence& theKeySequence);
  71
  72   /// This is an overloaded function.
  73   /// Registers shortcut (key sequence) for the command triggering
  74   /// \param theKeySequence - string that contain a key sequence to register
  75   QKeySequence registerShortcut(const QString& theKeySequence);
  76
  77   //! Redefinition of Events_Listener method
  78   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
  79
  80   //! Return property panel's action like ok, cancel, help.
  81   //! If there is no such action, it will be created.
  82   QAction* operationStateAction(OperationStateActionId theId);
  83
  84   /// Return an action by the given id, if it was registered in the manager
  85   QAction* action(const QString& theId);
  86
  87   /// Return info (icon, text, etc) about the action by the given id,
  88   /// if it was registered in the manager
  89   ActionInfo actionInfoById(const QString& theId);
  90
  91  private:
  92   //! Update workbench actions according to OperationMgr state:
  93   //! No active operations: all actions but nested are available
  94   //! There is active operation: current operation + it's nested
  95   //! are enabled, all the rest is disabled. All active commands is checked.
  96   void updateCommandsStatus();
  97
  98   //! Sets all commands checked if it's operation is active.
  99   void updateCheckState();
 100
 101   //! Updates actions according to current selection in the viewer
 102   void updateOnViewSelection();
 103
 104   //! Sets all actions to enabled state.
 105   void setAllEnabled();
 106
 107   //! Sets all nested actions to isEnabled state for the command with given ID.
 108   //! If ID is empty - all nested actions will be affected.
 109   void setNestedCommandsEnabled(bool isEnabled, const QString& theParent = QString());
 110
 111   //! Sets to enabled state all siblings of the given operation and it's parents recursively
 112   void setNestedStackEnabled(ModuleBase_Operation* theOperation);
 113
 114   //! Sets the action with theId to theChecked state.
 115   void setActionChecked(const QString& theId, const bool theChecked);
 116
 117   //! Sets the action with theId to theEnabled state.
 118   void setActionEnabled(const QString& theId, const bool theEnabled);
 119
 120   //! Updates actions according to their "document" tag
 121   void updateByDocumentKind();
 122
 123   //! Asks plugins about their features state, using the Events system
 124   void updateByPlugins(FeaturePtr theActiveFeature);
 125
 126   QStringList allNestedCommands(ModuleBase_Operation* theOperation);
 127
 128  private:
 129
 130   QMap<QString, QAction*> myActions;
 131   QMap<QString, QStringList> myNestedActions;
 132   QMap<OperationStateActionId, QAction*> myOperationActions;
 133   QList<QKeySequence> myShortcuts;
 134
 135   XGUI_Workshop* myWorkshop;
 136   XGUI_OperationMgr* myOperationMgr;
 137
 138   friend class XGUI_Workshop;
 139 };
 140
 141 #endif /* XGUI_ACTIONSMGR_H_ */
 142