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   /// Returns true if the operation can be aborted
  54   bool canStopOperation();
  55
  56   /// Find and return operation by its Id.
  57   ModuleBase_Operation* findOperation(const QString& theId) const;
  58
  59   /// Returns number of operations in the stack
  60   int operationsCount() const;
  61
  62   /// Returns list of all operations IDs
  63   QStringList operationList() const;
  64
  65   /// Returns previous (parent) operation if given operation started.
  66   /// else, or if there is no parent - returns NULL
  67   ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
  68
  69   /// Redefinition of virtual function
  70   virtual bool eventFilter(QObject *theObject, QEvent *theEvent);
  71
  72   /// Start the operation and append it to the stack of operations
  73   /// \param theOperation the started operation
  74   /// \return the state whether the current operation is started
  75   bool startOperation(ModuleBase_Operation* theOperation);
  76
  77   /// Abort all operations
  78   bool abortAllOperations();
  79
  80   /// Returns whether the operation can be started. Check if there is already started operation and
  81   /// the granted parameter of the launched operation
  82   /// \param theId id of the operation which is going to start
  83   bool canStartOperation(QString theId);
  84
  85   /// Blocking/unblocking enabling of Ok button in property panel.
  86   /// It is used when operation can not be validated even all attributes are valid
  87   void setLockValidating(bool toLock) { myIsValidationLock = toLock; }
  88
  89   /// Returns state of validation locking
  90   bool isValidationLocked() const { return myIsValidationLock; }
  91
  92   /// Sets apply state to the value and emit signal about this state is changed
  93   /// \param theEnabled the state value
  94   void setApplyEnabled(const bool theEnabled);
  95
  96   /// Returns enable apply state
  97   /// \return theEnabled a boolean value
  98   bool isApplyEnabled() const;
  99
 100   public slots:
 101   /// Slot that commits the current operation.
 102   void onCommitOperation();
 103   /// Slot that aborts the current operation.
 104   void onAbortOperation();
 105   /// Slot that validates the current operation using the validateOperation method.
 106   void onValidateOperation();
 107
 108 signals:
 109   /// Signal about an operation is started. It is emitted after the start() of operation is done.
 110   void operationStarted(ModuleBase_Operation* theOperation);
 111
 112   /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
 113   /// \param theOperation a stopped operation
 114   void operationStopped(ModuleBase_Operation* theOperation);
 115
 116   /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
 117   void operationResumed(ModuleBase_Operation* theOperation);
 118
 119   /// Emitted when current operation is Committed
 120   void operationCommitted(ModuleBase_Operation* theOperation);
 121
 122   /// Emitted when current operation is aborted
 123   void operationAborted(ModuleBase_Operation* theOperation);
 124
 125   /// Signal is emitted after the apply enable state changed.
 126   void applyEnableChanged(bool);
 127
 128   /// Signal is emitted after the current operation is filled with existing preselection.
 129   void operationActivatedByPreselection();
 130
 131   /// Signal is emitted after the key released click.
 132   void keyEnterReleased();
 133
 134
 135  protected:
 136   /// Commits the current operatin if it is valid
 137   bool commitOperation();
 138
 139   /// Sets the current operation or NULL
 140   /// \param theOperation the started operation
 141   void resumeOperation(ModuleBase_Operation* theOperation);
 142
 143  public slots:
 144   /// SLOT, that is called by the key in the property panel is clicked.
 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
 153   /// Slot called on operation start
 154   void onOperationStarted();
 155
 156   /// Slot called on operation abort
 157   void onOperationAborted();
 158
 159   /// Slot called on operation commit
 160   void onOperationCommitted();
 161
 162   /// Slot called on operation resume
 163   void onOperationResumed();
 164
 165  private:
 166   typedef QList<ModuleBase_Operation*> Operations;  ///< definition for a list of operations
 167   Operations myOperations;  ///< a stack of started operations. The active operation is on top,
 168                             // others are suspended and started by the active is finished
 169
 170   /// Lock/Unlock access to Ok button in property panel
 171   bool myIsValidationLock;
 172   /// Lock/Unlock access to Ok button in property panel
 173   bool myIsApplyEnabled;
 174 };
 175
 176 #endif