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 ModuleBase_IWorkshop;
  21
  22 /**\class XGUI_OperationMgr
  23  * \ingroup GUI
  24  * \brief Operation manager. Servers to manipulate to the workshop operations. Contains a stack
  25  * of started operations. In simple case, if only one operation is started, the stack contains
  26  * one operation. It is possible for some kind of operations to start them above already
  27  * started one. In that case, the previous active operation becomes suspended, a new one - active.
  28  * The new operation is added to the top of the stack. Then it is finished, it is removed from
  29  * the stack and the previous operation is activated.
  30  */
  31 class XGUI_EXPORT XGUI_OperationMgr : public QObject
  32 {
  33 Q_OBJECT
  34  public:
  35   /// Constructor
  36   /// \param theParent the parent
  37   XGUI_OperationMgr(QObject* theParent, ModuleBase_IWorkshop* theWorkshop);
  38   /// Destructor
  39   virtual ~XGUI_OperationMgr();
  40
  41   void setWorkshop(ModuleBase_IWorkshop* theWorkshop)
  42   { myWorkshop = theWorkshop; };
  43
  44   /// Returns the current operation or NULL
  45   /// \return the current operation
  46   ModuleBase_Operation* currentOperation() const;
  47
  48   /// Check if the given operation is active operation.
  49   /// Also, returns false is ther is no active operation.
  50   bool isCurrentOperation(ModuleBase_Operation* theOperation);
  51
  52   /// Returns true is operation manager has at least one non-null operation.
  53   bool hasOperation() const;
  54
  55   /// Returns true is operation manager has an operation with given Id.
  56   bool hasOperation(const QString& theId) const;
  57
  58   /// Returns true if the operation can be aborted
  59   bool canStopOperation();
  60
  61   /// Find and return operation by its Id.
  62   ModuleBase_Operation* findOperation(const QString& theId) const;
  63
  64   /// Returns number of operations in the stack
  65   int operationsCount() const;
  66
  67   /// Returns list of all operations IDs
  68   QStringList operationList() const;
  69
  70   /// Returns previous (parent) operation if given operation started.
  71   /// else, or if there is no parent - returns NULL
  72   ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
  73
  74   /// Redefinition of virtual function
  75   virtual bool eventFilter(QObject *theObject, QEvent *theEvent);
  76
  77   /// Start the operation and append it to the stack of operations
  78   /// \param theOperation the started operation
  79   /// \return the state whether the current operation is started
  80   bool startOperation(ModuleBase_Operation* theOperation);
  81
  82   /// Returns whether the operation can be started. Check if there is already started operation and
  83   /// the granted parameter of the launched operation
  84   /// \param theId id of the operation which is going to start
  85   bool canStartOperation(QString theId);
  86
  87   /// Aborts the parameter operation if it is current, else abort operations from the stack
  88   /// of operations until the operation is found. All operations upper the parameter one are
  89   /// not aborted.
  90   /// \param theOperation an aborted operation
  91   void abortOperation(ModuleBase_Operation* theOperation);
  92
  93   /// Blocking/unblocking enabling of Ok button in property panel.
  94   /// It is used when operation can not be validated even all attributes are valid
  95   void setLockValidating(bool toLock);
  96
  97   /// Returns state of validation locking
  98   bool isValidationLocked() const { return myIsValidationLock; }
  99
 100   /// Returns enable apply state
 101   /// \return theEnabled a boolean value
 102   bool isApplyEnabled() const;
 103
 104   /// Returns valid state of the parent operation. If the current operation is the last one
 105   /// it returns the valid state of the operation
 106   /// \return boolean value
 107   bool isParentOperationValid() const;
 108
 109 public slots:
 110   /// Slot that commits the current operation.
 111   void onCommitOperation();
 112   /// Slot that aborts the current operation.
 113   void onAbortOperation();
 114   /// Slot that validates the current operation using the validateOperation method.
 115   void onValidateOperation();
 116   /// Commit all operations
 117   bool commitAllOperations();
 118   /// Abort all operations
 119   bool abortAllOperations();
 120
 121 signals:
 122   /// Signal about an operation is started. It is emitted after the start() of operation is done.
 123   void operationStarted(ModuleBase_Operation* theOperation);
 124
 125   /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
 126   /// \param theOperation a stopped operation
 127   void operationStopped(ModuleBase_Operation* theOperation);
 128
 129   /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
 130   void operationResumed(ModuleBase_Operation* theOperation);
 131
 132   /// Emitted when current operation is Committed
 133   void operationCommitted(ModuleBase_Operation* theOperation);
 134
 135   /// Emitted when current operation is aborted
 136   void operationAborted(ModuleBase_Operation* theOperation);
 137
 138   /// Signal is emitted after the apply enable state changed.
 139   void validationStateChanged(bool);
 140
 141   /// Signal is emitted after the apply enable state changed.
 142   void nestedStateChanged(bool);
 143
 144   /// Signal is emitted after the current operation is filled with existing preselection.
 145   void operationActivatedByPreselection();
 146
 147   /// Signal is emitted after the key released click.
 148   void keyEnterReleased();
 149
 150  protected:
 151   /// Sets apply state to the value and emit signal about this state is changed
 152   /// \param theEnabled the state value
 153   void setApplyEnabled(const bool theEnabled);
 154
 155   /// Commits the current operatin if it is valid
 156   bool commitOperation();
 157
 158   /// Sets the current operation or NULL
 159   /// \param theOperation the started operation
 160   void resumeOperation(ModuleBase_Operation* theOperation);
 161
 162  public slots:
 163   /// SLOT, that is called by the key in the property panel is clicked.
 164   /// \param theEvent the mouse event
 165   bool onKeyReleased(QKeyEvent* theEvent);
 166
 167   protected slots:
 168   /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
 169   /// If there is a suspended operation, restart it.
 170   void onOperationStopped();
 171
 172   /// Slot called on operation start
 173   void onOperationStarted();
 174
 175   /// Slot called on operation abort
 176   void onOperationAborted();
 177
 178   /// Slot called on operation commit
 179   void onOperationCommitted();
 180
 181   /// Slot called on operation resume
 182   void onOperationResumed();
 183
 184  private:
 185   typedef QList<ModuleBase_Operation*> Operations;  ///< definition for a list of operations
 186   Operations myOperations;  ///< a stack of started operations. The active operation is on top,
 187                             // others are suspended and started by the active is finished
 188
 189   /// Current workshop
 190   ModuleBase_IWorkshop* myWorkshop;
 191
 192
 193   /// Lock/Unlock access to Ok button in property panel
 194   bool myIsValidationLock;
 195   /// Lock/Unlock access to Ok button in property panel
 196   bool myIsApplyEnabled;
 197 };
 198
 199 #endif