src/XGUI/XGUI_OperationMgr.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        XGUI_OperationMgr.h
   4 // Created:     20 Apr 2014
   5 // Author:      Natalia ERMOLAEVA
   6
   7 #ifndef XGUI_OperationMgr_H
   8 #define XGUI_OperationMgr_H
   9
  10 #include "XGUI.h"
  11
  12 #include <ModuleBase_Operation.h>
  13
  14 #include <QList>
  15 #include <QObject>
  16 #include <QStringList>
  17
  18 class QKeyEvent;
  19
  20 /**\class XGUI_OperationMgr
  21  * \ingroup GUI
  22  * \brief Operation manager. Servers to manipulate to the workshop operations. Contains a stack
  23  * of started operations. In simple case, if only one operation is started, the stack contains
  24  * one operation. It is possible for some kind of operations to start them above already
  25  * started one. In that case, the previous active operation becomes suspended, a new one - active.
  26  * The new operation is added to the top of the stack. Then it is finished, it is removed from
  27  * the stack and the previous operation is activated.
  28  */
  29 class XGUI_EXPORT XGUI_OperationMgr : public QObject
  30 {
  31 Q_OBJECT
  32  public:
  33   /// Constructor
  34   /// \param theParent the parent
  35   XGUI_OperationMgr(QObject* theParent);
  36   /// Destructor
  37   virtual ~XGUI_OperationMgr();
  38
  39   /// Returns the current operation or NULL
  40   /// \return the current operation
  41   ModuleBase_Operation* currentOperation() const;
  42
  43   /// Check if the given operation is active operation.
  44   /// Also, returns false is ther is no active operation.
  45   bool isCurrentOperation(ModuleBase_Operation* theOperation);
  46
  47   /// Returns true is operation manager has at least one non-null operation.
  48   bool hasOperation() const;
  49
  50   /// Returns true is operation manager has an operation with given Id.
  51   bool hasOperation(const QString& theId) const;
  52
  53   /// Find and return operation by its Id.
  54   ModuleBase_Operation* findOperation(const QString& theId) const;
  55
  56   /// Returns number of operations in the stack
  57   int operationsCount() const;
  58
  59   /// Returns list of all operations IDs
  60   QStringList operationList() const;
  61
  62   /// Returns previous (parent) operation if given operation started.
  63   /// else, or if there is no parent - returns NULL
  64   ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
  65
  66   virtual bool eventFilter(QObject *theObject, QEvent *theEvent);
  67
  68   /// Start the operation and append it to the stack of operations
  69   /// \param theOperation the started operation
  70   /// \return the state whether the current operation is started
  71   bool startOperation(ModuleBase_Operation* theOperation);
  72
  73   bool abortAllOperations();
  74
  75   /// Returns whether the operation can be started. Check if there is already started operation and
  76   /// the granted parameter of the launched operation
  77   /// \param theId id of the operation which is going to start
  78   bool canStartOperation(QString theId);
  79
  80   /// Blocking/unblocking enabling of Ok button in property panel.
  81   /// It is used when operation can not be validated even all attributes are valid
  82   void setLockValidating(bool toLock) { myIsValidationLock = toLock; }
  83
  84   /// Returns state of validation locking
  85   bool isValidationLocked() const { return myIsValidationLock; }
  86
  87   /// Sets apply state to the value and emit signal about this state is changed
  88   /// \param theEnabled the state value
  89   void setApplyEnabled(const bool theEnabled);
  90
  91   /// Returns enable apply state
  92   /// \return theEnabled a boolean value
  93   bool isApplyEnabled() const;
  94
  95   public slots:
  96   /// Slot that commits the current operation.
  97   void onCommitOperation();
  98   /// Slot that aborts the current operation.
  99   void onAbortOperation();
 100   /// Slot that validates the current operation using the validateOperation method.
 101   void onValidateOperation();
 102
 103 signals:
 104   /// Signal about an operation is started. It is emitted after the start() of operation is done.
 105   void operationStarted(ModuleBase_Operation* theOperation);
 106
 107   /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
 108   /// \param theOperation a stopped operation
 109   void operationStopped(ModuleBase_Operation* theOperation);
 110
 111   /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
 112   void operationResumed(ModuleBase_Operation* theOperation);
 113
 114   /// Emitted when current operation is Committed
 115   void operationCommitted(ModuleBase_Operation* theOperation);
 116
 117   /// Emitted when current operation is aborted
 118   void operationAborted(ModuleBase_Operation* theOperation);
 119
 120   /// Signal is emitted after the apply enable state changed.
 121   void applyEnableChanged(bool);
 122
 123   /// Signal is emitted after the current operation is filled with existing preselection.
 124   void operationActivatedByPreselection();
 125
 126   /// Signal is emitted after the key released click.
 127   void keyEnterReleased();
 128
 129
 130  protected:
 131   /// Returns true if the operation can be aborted
 132   bool canStopOperation();
 133
 134   /// Commits the current operatin if it is valid
 135   bool commitOperation();
 136   /// Sets the current operation or NULL
 137   /// \param theOperation the started operation
 138   /// \param isCheckBeforeStart the flag whether to check whether the operation can be started
 139   /// \return the state whether the operation is resumed
 140   void resumeOperation(ModuleBase_Operation* theOperation);
 141
 142  public slots:
 143   /// SLOT, that is called by the key in the property panel is clicked.
 144   /// \param theName the attribute name
 145   /// \param theEvent the mouse event
 146   bool onKeyReleased(QKeyEvent* theEvent);
 147
 148   protected slots:
 149   /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
 150   /// If there is a suspended operation, restart it.
 151   void onOperationStopped();
 152   void onOperationStarted();
 153   void onOperationAborted();
 154   void onOperationCommitted();
 155   void onOperationResumed();
 156
 157  private:
 158   typedef QList<ModuleBase_Operation*> Operations;  ///< definition for a list of operations
 159   Operations myOperations;  ///< a stack of started operations. The active operation is on top,
 160                             // others are suspended and started by the active is finished
 161
 162   /// Lock/Unlock access to Ok button in property panel
 163   bool myIsValidationLock;
 164   /// Lock/Unlock access to Ok button in property panel
 165   bool myIsApplyEnabled;
 166 };
 167
 168 #endif