+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
/*
* XGUI_ActionsMgr.h
*/
#include "XGUI.h"
+#include <Events_Listener.h>
+#include <ModelAPI_Feature.h>
+
+#include <ModuleBase_ActionInfo.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
-public:
- XGUI_ActionsMgr(XGUI_Workshop* theParent);
+ public:
+ /// Constructor
+ /// \param theWorkshop an instance of workshop
+ XGUI_ActionsMgr(XGUI_Workshop* theWorkshop);
virtual ~XGUI_ActionsMgr();
+ /// Actions on operations
+ enum OperationStateActionId {
+ Abort = 0,
+ Accept = 1,
+ Help = 2,
+ AbortAll = 3,
+ AcceptAll = 4,
+ Preview = 5
+ };
+ //! 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);
- void saveCommandsState();
- void restoreCommandState();
+ //! 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;
+
+ /// Registers shortcut (key sequence) for the command triggering
+ /// \param theKeySequence a key sequence to register
+ QKeySequence registerShortcut(const QKeySequence& theKeySequence);
+
+ /// This is an overloaded function.
+ /// Registers shortcut (key sequence) for the command triggering
+ /// \param theKeySequence - string that contain 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);
+
+ //! Return property panel's action like ok, cancel, help.
+ //! If there is no such action, it will be created.
+ QAction* operationStateAction(OperationStateActionId theId);
+
+ /// Return an action by the given id, if it was registered in the manager
+ QAction* action(const QString& theId);
+
+ /// Return info (icon, text, etc) about the action by the given id,
+ /// if it was registered in the manager
+ ActionInfo actionInfoById(const QString& theId);
- /// Set the action is checked
- /// \param theId - string ID of the command
- /// \praram theChecked - the new checked state
+ private:
+ //! 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 updateCommandsStatus();
+
+ //! Sets all commands checked if it's operation is active.
+ void updateCheckState();
+
+ //! Updates actions according to current selection in the viewer
+ void updateOnViewSelection();
+
+ //! Sets all actions to enabled state.
+ void setAllEnabled();
+
+ //! 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);
- void updateAction(const QString&);
- void setNestedActionsEnabled(bool);
+ //! Sets the action with theId to theEnabled state.
+ void setActionEnabled(const QString& theId, const bool theEnabled);
-public slots:
- void setActionsDisabled(bool isEnabled);
+ //! Updates actions according to their "document" tag
+ void updateByDocumentKind();
+
+ //! Asks plugins about their features state, using the Events system
+ void updateByPlugins(FeaturePtr theActiveFeature);
+
+ QStringList allNestedCommands(ModuleBase_Operation* theOperation);
+
+ private:
-private:
- QStringList myNestedActions;
QMap<QString, QAction*> myActions;
- QMap<QString, bool> myActionsState;
+ QMap<QString, QStringList> myNestedActions;
+ QMap<OperationStateActionId, QAction*> myOperationActions;
+ QList<QKeySequence> myShortcuts;
XGUI_Workshop* myWorkshop;
+ XGUI_OperationMgr* myOperationMgr;
+
+ friend class XGUI_Workshop;
};
#endif /* XGUI_ACTIONSMGR_H_ */
+
