X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FXGUI%2FXGUI_OperationMgr.h;h=25a155617e1558996221e6e5c00facc2a590b954;hb=61da4e89d2ec63daa429d304f928482a0e6fa0b7;hp=4fabac82118e340dbf2c05d223a7a71716969e06;hpb=11fca61445a4c008b1b703bfd4bb512fcac65135;p=modules%2Fshaper.git

diff --git a/src/XGUI/XGUI_OperationMgr.h b/src/XGUI/XGUI_OperationMgr.h
index 4fabac821..25a155617 100644
--- a/src/XGUI/XGUI_OperationMgr.h
+++ b/src/XGUI/XGUI_OperationMgr.h
@@ -1,3 +1,7 @@
+// File:        XGUI_OperationMgr.h
+// Created:     20 Apr 2014
+// Author:      Natalia ERMOLAEVA
+
 #ifndef XGUI_OperationMgr_H
 #define XGUI_OperationMgr_H
 
@@ -7,37 +11,110 @@
 
 #include <QList>
 #include <QObject>
+#include <QStringList>
+
+class QKeyEvent;
 
 /**\class XGUI_OperationMgr
  * \ingroup GUI
- * \brief Operation manager. Servers to manupulate to the workshop operations. Contains a stack
- *   of started operations and uses the upper one as a current.
+ * \brief Operation manager. Servers to manipulate to the workshop operations. Contains a stack
+ * of started operations. In simple case, if only one operation is started, the stack contains
+ * one operation. It is possible for some kind of operations to start them above already
+ * started one. In that case, the previous active operation becomes suspended, a new one - active.
+ * The new operation is added to the top of the stack. Then it is finished, it is removed from
+ * the stack and the previous operation is activated.
  */
 class XGUI_EXPORT XGUI_OperationMgr : public QObject
 {
-  Q_OBJECT
-public:
+Q_OBJECT
+ public:
+  /// Constructor
+  /// \param theParent the parent
   XGUI_OperationMgr(QObject* theParent);
+  /// Destructor
   virtual ~XGUI_OperationMgr();
 
+  /// Returns the current operation or NULL
+  /// \return the current operation
   ModuleBase_Operation* currentOperation() const;
+  /// Check if the given operation is active operation.
+  /// Also, returns false is ther is no active operation.
+  bool isCurrentOperation(ModuleBase_Operation* theOperation);
+  /// Returns true is operation manager has at least one non-null operation.
+  bool hasOperation() const;
+  /// Returns number of operations in the stack
+  int operationsCount() const;
+  /// Returns list of all operations IDs
+  QStringList operationList() const;
+
+  /// Returns previous (parent) operation if given operation started.
+  /// else, or if there is no parent - returns NULL
+  ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
+
+  virtual bool eventFilter(QObject *theObject, QEvent *theEvent);
+
+  /// Start the operation and append it to the stack of operations
+  /// \param theOperation the started operation
+  /// \return the state whether the current operation is started
   bool startOperation(ModuleBase_Operation* theOperation);
 
-  void commitCurrentOperation();
+  bool abortAllOperations();
+
+ public slots:
+  /// Slot that commits the current operation.
+  void onCommitOperation();
+  /// Slot that aborts the current operation.
+  void onAbortOperation();
+  /// Slot that validates the current operation using the validateOperation method.
+  void onValidateOperation();
 
 signals:
-  void beforeOperationStart();
-  void afterOperationStart();
+  /// Signal about an operation is started. It is emitted after the start() of operation is done.
+  void operationStarted(ModuleBase_Operation* theOperation);
+  /// Signal about an operation is stopped. It is emitted after the stop() of operation is done.
+  /// \param theOperation a stopped operation
+  void operationStopped(ModuleBase_Operation* theOperation);
+  /// Signal about an operation is resumed. It is emitted after the resume() of operation is done.
+  void operationResumed();
+  /// Signal is emitted after the validate methods calls.
+  void operationValidated(bool);
 
-protected:
+ protected:
+
+  /// Commits the current operatin if it is valid
+  bool commitOperation();
+  /// Sets the current operation or NULL
+  /// \param theOperation the started operation
+  /// \param isCheckBeforeStart the flag whether to check whether the operation can be started
+  /// \return the state whether the operation is resumed
+  void resumeOperation(ModuleBase_Operation* theOperation);
+
+  /// Returns whether the operation can be started. Check if there is already started operation and
+  /// the granted parameter of the launched operation
+  /// \param theOperation an operation to check
   bool canStartOperation(ModuleBase_Operation* theOperation);
 
-protected slots:
+  bool canStopOperation();
+
+  /// Returns true if the operation can be aborted
+  bool canAbortOperation();
+
+ public slots:
+  /// SLOT, that is called by the key in the property panel is clicked.
+  /// \param theName the attribute name
+  /// \param theEvent the mouse event
+  bool onKeyReleased(QKeyEvent* theEvent);
+
+  protected slots:
+  /// Slot that is called by an operation stop. Removes the stopped operation form the stack.
+  /// If there is a suspended operation, restart it.
   void onOperationStopped();
+  void onOperationStarted();
 
-private:
-  typedef QList<ModuleBase_Operation*> Operations;
-  Operations myOperations;
+ private:
+  typedef QList<ModuleBase_Operation*> Operations;  ///< definition for a list of operations
+  Operations myOperations;  ///< a stack of started operations. The active operation is on top,
+                            // others are suspended and started by the active is finished
 };
 
 #endif