src/XGUI/XGUI_OperationMgr.h

   1 // File:        XGUI_OperationMgr.h
   2 // Created:     20 Apr 2014
   3 // Author:      Natalia ERMOLAEVA
   4
   5 #ifndef XGUI_OperationMgr_H
   6 #define XGUI_OperationMgr_H
   7
   8 #include "XGUI.h"
   9
  10 #include <ModuleBase_Operation.h>
  11
  12 #include <QList>
  13 #include <QObject>
  14 #include <QStringList>
  15
  16 class QKeyEvent;
  17
  18 /**\class XGUI_OperationMgr
  19  * \ingroup GUI
  20  * \brief Operation manager. Servers to manipulate to the workshop operations. Contains a stack
  21  * of started operations. In simple case, if only one operation is started, the stack contains
  22  * one operation. It is possible for some kind of operations to start them above already
  23  * started one. In that case, the previous active operation becomes suspended, a new one - active.
  24  * The new operation is added to the top of the stack. Then it is finished, it is removed from
  25  * the stack and the previous operation is activated.
  26  */
  27 class XGUI_EXPORT XGUI_OperationMgr : public QObject
  28 {
  29 Q_OBJECT
  30  public:
  31   /// Constructor
  32   /// \param theParent the parent
  33   XGUI_OperationMgr(QObject* theParent);
  34   /// Destructor
  35   virtual ~XGUI_OperationMgr();
  36
  37   /// Returns the current operation or NULL
  38   /// \return the current operation
  39   ModuleBase_Operation* currentOperation() const;
  40   /// Check if the given operation is active operation.
  41   /// Also, returns false is ther is no active operation.
  42   bool isCurrentOperation(ModuleBase_Operation* theOperation);
  43   /// Returns true is operation manager has at least one non-null operation.
  44   bool hasOperation() const;
  45   /// Returns number of operations in the stack
  46   int operationsCount() const;
  47   /// Returns list of all operations IDs
  48   QStringList operationList() const;
  49
  50   /// Returns previous (parent) operation if given operation started.
  51   /// else, or if there is no parent - returns NULL
  52   ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
  53
  54   virtual bool eventFilter(QObject *theObject, QEvent *theEvent);
  55
  56   /// Start the operation and append it to the stack of operations
  57   /// \param theOperation the started operation
  58   /// \return the state whether the current operation is started
  59   bool startOperation(ModuleBase_Operation* theOperation);
  60
  61   bool abortAllOperations();
  62
  63  public slots:
  64   /// Slot that commits the current operation.
  65   void onCommitOperation();
  66   /// Slot that aborts the current operation.
  67   void onAbortOperation();
  68   /// Slot that validates the current operation using the validateOperation method.
  69   void onValidateOperation();
  70
  71 signals:
  72   /// Signal about an operation is started. It is emitted after the start() of operation is done.
  73   void operationStarted(ModuleBase_Operation* theOperation);
  74   /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
  75   /// \param theOperation a stopped operation
  76   void operationStopped(ModuleBase_Operation* theOperation);
  77   /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
  78   void operationResumed();
  79   /// Signal is emitted after the validate methods calls.
  80   void operationValidated(bool);
  81
  82  protected:
  83
  84   /// Commits the current operatin if it is valid
  85   bool commitOperation();
  86   /// Sets the current operation or NULL
  87   /// \param theOperation the started operation
  88   /// \param isCheckBeforeStart the flag whether to check whether the operation can be started
  89   /// \return the state whether the operation is resumed
  90   void resumeOperation(ModuleBase_Operation* theOperation);
  91
  92   /// Returns whether the operation can be started. Check if there is already started operation and
  93   /// the granted parameter of the launched operation
  94   /// \param theOperation an operation to check
  95   bool canStartOperation(ModuleBase_Operation* theOperation);
  96
  97   bool canStopOperation();
  98
  99   /// Returns true if the operation can be aborted
 100   bool canAbortOperation();
 101
 102  public slots:
 103   /// SLOT, that is called by the key in the property panel is clicked.
 104   /// \param theName the attribute name
 105   /// \param theEvent the mouse event
 106   bool onKeyReleased(QKeyEvent* theEvent);
 107
 108   protected slots:
 109   /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
 110   /// If there is a suspended operation, restart it.
 111   void onOperationStopped();
 112   void onOperationStarted();
 113
 114  private:
 115   typedef QList<ModuleBase_Operation*> Operations;  ///< definition for a list of operations
 116   Operations myOperations;  ///< a stack of started operations. The active operation is on top,
 117                             // others are suspended and started by the active is finished
 118 };
 119
 120 #endif