Salome HOME
SetCurrentFeature call is moved to operation manager to perform it in the commit...
[modules/shaper.git] / src / XGUI / XGUI_OperationMgr.h
index 80c457b2b2823edeeddb36ae7c91c4ea85aeb682..4a9839b9a63865b8ff98e6ff75ede04a60892ee2 100644 (file)
@@ -10,6 +10,7 @@
 #include "XGUI.h"
 
 #include <ModuleBase_Operation.h>
+#include "ModelAPI_Feature.h"
 
 #include <QList>
 #include <QObject>
@@ -18,6 +19,7 @@
 class QKeyEvent;
 
 class ModuleBase_IWorkshop;
+class XGUI_Workshop;
 
 /**\class XGUI_OperationMgr
  * \ingroup GUI
@@ -34,10 +36,14 @@ Q_OBJECT
  public:
   /// Constructor
   /// \param theParent the parent
+  /// \param theWorkshop a reference to workshop
   XGUI_OperationMgr(QObject* theParent, ModuleBase_IWorkshop* theWorkshop);
+
   /// Destructor
   virtual ~XGUI_OperationMgr();
 
+  /// Set reference to workshop
+  /// \param theWorkshop reference to workshop
   void setWorkshop(ModuleBase_IWorkshop* theWorkshop)
   { myWorkshop = theWorkshop; };
 
@@ -55,8 +61,10 @@ Q_OBJECT
   /// Returns true is operation manager has an operation with given Id.
   bool hasOperation(const QString& theId) const;
 
-  /// Returns true if the operation can be aborted
-  bool canStopOperation();
+  /// Returns true if the operation can be aborted. If the operation is modified,
+  /// the warning message box is shown.
+  /// \param theOperation an operation which is checked on stop
+  bool canStopOperation(ModuleBase_Operation* theOperation);
 
   /// Find and return operation by its Id.
   ModuleBase_Operation* findOperation(const QString& theId) const;
@@ -82,7 +90,14 @@ Q_OBJECT
   /// Returns whether the operation can be started. Check if there is already started operation and
   /// the granted parameter of the launched operation
   /// \param theId id of the operation which is going to start
-  bool canStartOperation(QString theId);
+  /// \param isAdditionallyGranted a boolean flag whether the id operation is granted in the previous one
+  bool canStartOperation(const QString& theId, const bool isAdditionallyGranted = false);
+
+  /// Aborts the parameter operation if it is current, else abort operations from the stack
+  /// of operations until the operation is found. All operations upper the parameter one are
+  /// not aborted.
+  /// \param theOperation an aborted operation
+  void abortOperation(ModuleBase_Operation* theOperation);
 
   /// Blocking/unblocking enabling of Ok button in property panel.
   /// It is used when operation can not be validated even all attributes are valid
@@ -129,12 +144,6 @@ signals:
   /// Emitted when current operation is aborted
   void operationAborted(ModuleBase_Operation* theOperation);
 
-  /// Signal is emitted after the apply enable state changed.
-  void validationStateChanged(bool);
-
-  /// Signal is emitted after the apply enable state changed.
-  void nestedStateChanged(bool);
-
   /// Signal is emitted after the current operation is filled with existing preselection.
   void operationActivatedByPreselection();
 
@@ -146,13 +155,30 @@ signals:
   /// \param theEnabled the state value
   void setApplyEnabled(const bool theEnabled);
 
+public: // TEMPORARY, it should be protected and be performed automatically
+  /// Emits nestedStateChange for operations with an information about validity of the operation
+  /// \param theOperation the sent operation. If it is NULL, all operations in the stack are sent.
+  void updateApplyOfOperations(ModuleBase_Operation* theOperation = 0);
+
   /// Commits the current operatin if it is valid
   bool commitOperation();
 
+protected: // TEMPORARY
   /// Sets the current operation or NULL
   /// \param theOperation the started operation
   void resumeOperation(ModuleBase_Operation* theOperation);
 
+  /// Returns whether the parameter operation is granted in relation to the previous operation
+  /// in a stack of started operations. It is used in canStopOperation to avoid warning message
+  /// when granted operation is aborted, e.g. SketchLine in Sketch
+  /// \param theOperation the started operation
+  /// \return boolean result
+  bool isGrantedOperation(ModuleBase_Operation* theOperation);
+
+  /// Sets the feature as a current in the document
+  /// \param theFeature a feature
+  void setCurrentFeature(const FeaturePtr& theFeature);
+
  public slots:
   /// SLOT, that is called by the key in the property panel is clicked.
   /// \param theEvent the mouse event
@@ -163,20 +189,31 @@ signals:
   /// If there is a suspended operation, restart it.
   void onOperationStopped();
 
-  /// Slot called on operation start
+  /// Slot called before operation started. Stores the previous current feature, set the feature
+  /// of the operation as a current in the document. The previous current feature should be restored
+  /// by the operation abort/commit
+  void onBeforeOperationStarted();
+
+  /// Slot called after operation started
   void onOperationStarted();
 
-  /// Slot called on operation abort
+  /// Slot called before operation aborted. Restore the previous current operation
+  void onBeforeOperationAborted();
+
+  /// Slot called after operation aborted
   void onOperationAborted();
 
-  /// Slot called on operation commit
+  /// Slot called before operation committed. Restore the previous current operation
+  void onBeforeOperationCommitted();
+
+  /// Slot called after operation committed
   void onOperationCommitted();
 
   /// Slot called on operation resume
   void onOperationResumed();
 
-  /// Slot called on operation triggered
-  void onOperationTriggered(bool theState);
+private:
+  XGUI_Workshop* workshop() const;
 
  private:
   typedef QList<ModuleBase_Operation*> Operations;  ///< definition for a list of operations
@@ -186,7 +223,6 @@ signals:
   /// Current workshop
   ModuleBase_IWorkshop* myWorkshop;
 
-
   /// Lock/Unlock access to Ok button in property panel
   bool myIsValidationLock;
   /// Lock/Unlock access to Ok button in property panel