Salome HOME
Preparations for Split operation. It includes:
[modules/shaper.git] / src / XGUI / XGUI_OperationMgr.cpp
index 6732dec511a34cbedd16cb6d121ca6f5a22b965e..1fb45442d3784107e2e64a645d1d1d0930059844 100644 (file)
@@ -8,6 +8,9 @@
 #include "XGUI_ModuleConnector.h"
 #include "XGUI_Workshop.h"
 #include "XGUI_ErrorMgr.h"
+#include "XGUI_Tools.h"
+#include "XGUI_ObjectsBrowser.h"
+#include "XGUI_ContextMenuMgr.h"
 
 #include <ModuleBase_IPropertyPanel.h>
 #include <ModuleBase_ModelWidget.h>
 #include <ModuleBase_IViewer.h>
 #include "ModuleBase_OperationDescription.h"
 #include "ModuleBase_OperationFeature.h"
+#include "ModuleBase_Tools.h"
 
 #include "ModelAPI_CompositeFeature.h"
 #include "ModelAPI_Session.h"
 
+#include <XGUI_PropertyPanel.h>
+#include <QToolButton>
+
 #include <QMessageBox>
 #include <QApplication>
 #include <QKeyEvent>
 
+//#define DEBUG_CURRENT_FEATURE
+
+/// Processes "Delete" key event of application. This key is used by several application actions.
+/// There is a logical order of the actions processing. So the key can not be set for actions
+/// as a shortcut. The class listens the key event and call operation manager processor.
+class XGUI_ShortCutListener : public QObject
+{
+public:
+  /// Constructor
+  /// \param theParent the parent to be deleted when the parent is deleted
+  /// \param theOperationMgr the class to perform deletion
+  XGUI_ShortCutListener(QObject* theParent, XGUI_OperationMgr* theOperationMgr)
+    : QObject(theParent), myOperationMgr(theOperationMgr)
+  {
+    qApp->installEventFilter(this);
+  }
+  ~XGUI_ShortCutListener() {}
+
+  /// Switch on short cut listener
+  void setActive(const bool theIsActive) { myIsActive = theIsActive; }
+
+  /// Redefinition of virtual function to process Delete key release
+  virtual bool eventFilter(QObject *theObject, QEvent *theEvent)
+  {
+    bool isAccepted = false;
+    if (myIsActive && theEvent->type() == QEvent::KeyRelease) {
+      QKeyEvent* aKeyEvent = dynamic_cast<QKeyEvent*>(theEvent);
+      if(aKeyEvent) {
+        switch (aKeyEvent->key()) {
+          case Qt::Key_Delete: {
+            isAccepted = myOperationMgr->onProcessDelete(theObject);
+          }
+        }
+      }
+    }
+    if (!isAccepted)
+      isAccepted = QObject::eventFilter(theObject, theEvent);
+    return isAccepted;
+  }
+
+private:
+  XGUI_OperationMgr* myOperationMgr; /// processor for key event
+  bool myIsActive; /// boolean state whether the event filter perform own signal processing
+};
+
 XGUI_OperationMgr::XGUI_OperationMgr(QObject* theParent,
                                      ModuleBase_IWorkshop* theWorkshop)
-: QObject(theParent), myIsValidationLock(false), myIsApplyEnabled(false),
-  myWorkshop(theWorkshop)
+: QObject(theParent), myWorkshop(theWorkshop)
 {
+  /// we need to install filter to the application in order to react to 'Delete' key button
+  /// this key can not be a short cut for a corresponded action because we need to set
+  /// the actions priority
+  myShortCutListener = new XGUI_ShortCutListener(theParent, this);
 }
 
 XGUI_OperationMgr::~XGUI_OperationMgr()
 {
 }
 
+void XGUI_OperationMgr::activate()
+{
+  myShortCutListener->setActive(true);
+}
+
+void XGUI_OperationMgr::deactivate()
+{
+  myShortCutListener->setActive(false);
+}
+
 ModuleBase_Operation* XGUI_OperationMgr::currentOperation() const
 {
   return myOperations.count() > 0 ? myOperations.last() : 0;
@@ -103,13 +168,16 @@ ModuleBase_Operation* XGUI_OperationMgr::previousOperation(ModuleBase_Operation*
 
 bool XGUI_OperationMgr::eventFilter(QObject *theObject, QEvent *theEvent)
 {
+  bool isAccepted = false;
   if (theEvent->type() == QEvent::KeyRelease) {
     QKeyEvent* aKeyEvent = dynamic_cast<QKeyEvent*>(theEvent);
-    if(aKeyEvent) {
-      return onKeyReleased(aKeyEvent);
-    }
+    if(aKeyEvent)
+      isAccepted = onKeyReleased(theObject, aKeyEvent);
   }
-  return QObject::eventFilter(theObject, theEvent);
+  if (!isAccepted)
+    isAccepted = QObject::eventFilter(theObject, theEvent);
+
+  return isAccepted;
 }
 
 bool XGUI_OperationMgr::startOperation(ModuleBase_Operation* theOperation)
@@ -128,15 +196,11 @@ bool XGUI_OperationMgr::startOperation(ModuleBase_Operation* theOperation)
 
   connect(theOperation, SIGNAL(stopped()), SLOT(onOperationStopped()));
   connect(theOperation, SIGNAL(resumed()), SLOT(onOperationResumed()));
-  ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
-                                                                        (theOperation);
-  if (aFOperation)
-    connect(aFOperation, SIGNAL(activatedByPreselection()),
-            SIGNAL(operationActivatedByPreselection()));
 
-  theOperation->start();
-  onValidateOperation();
-  return true;
+  bool isStarted = theOperation->start();
+  if (isStarted)
+    onValidateOperation();
+  return isStarted;
 }
 
 bool XGUI_OperationMgr::abortAllOperations()
@@ -168,13 +232,14 @@ bool XGUI_OperationMgr::abortAllOperations()
 
 bool XGUI_OperationMgr::commitAllOperations()
 {
-  bool isCompositeCommitted = false;
+  bool isCompositeCommitted = false, anOperationProcessed = false;
   while (hasOperation()) {
     ModuleBase_Operation* anOperation = currentOperation();
-    if (isApplyEnabled()) {
-      onCommitOperation();
+    if (XGUI_Tools::workshop(myWorkshop)->errorMgr()->isApplyEnabled()) {
+      anOperationProcessed = onCommitOperation();
     } else {
       abortOperation(anOperation);
+      anOperationProcessed = true;
     }
     ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
                                                                             (anOperation);
@@ -186,6 +251,12 @@ bool XGUI_OperationMgr::commitAllOperations()
       if (isCompositeCommitted)
         break;
     }
+    // not processed[committed] operation might be used in composite feature,
+    // so the while will be stopped by the previous check.
+    // this code is not necessary, but logically should be done when the processing will not
+    // be done for not composite feature by some reasons
+    if (!anOperationProcessed)
+      break;
   }
   return true;
 }
@@ -197,67 +268,25 @@ void XGUI_OperationMgr::onValidateOperation()
   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
                                                                           (currentOperation());
   if(aFOperation && aFOperation->feature().get())
-    setApplyEnabled(myWorkshop->module()->getFeatureError(aFOperation->feature()).isEmpty());
-}
-
-void XGUI_OperationMgr::setLockValidating(bool toLock)
-{
-  myIsValidationLock = toLock;
-  onValidateOperation();
-}
-
-void XGUI_OperationMgr::setApplyEnabled(const bool theEnabled)
-{
-  myIsApplyEnabled = theEnabled;
-  ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>
-                                                                          (currentOperation());
-  if (aFOperation) {
-    workshop()->errorMgr()->updateActions(aFOperation->feature());
-  }
-  //emit validationStateChanged(theEnabled);
+    XGUI_Tools::workshop(myWorkshop)->errorMgr()->updateActions(aFOperation->feature());
 }
 
 void XGUI_OperationMgr::updateApplyOfOperations(ModuleBase_Operation* theOperation)
 {
-  XGUI_ErrorMgr* anErrorMgr = workshop()->errorMgr();
+  XGUI_ErrorMgr* anErrorMgr = XGUI_Tools::workshop(myWorkshop)->errorMgr();
   if (theOperation) {
     ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>(theOperation);
     if (aFOperation)
       anErrorMgr->updateAcceptAllAction(aFOperation->feature());
-    //emit nestedStateChanged(theOperation->getDescription()->operationId().toStdString(),
-    //                        theOperation->isValid());
   }
   else {
     foreach(ModuleBase_Operation* anOperation, myOperations) {
       if (anOperation)
         updateApplyOfOperations(anOperation);
-      //emit nestedStateChanged(anOperation->getDescription()->operationId().toStdString(),
-      //                        anOperation->isValid());
     }
   }
-}
-
-bool XGUI_OperationMgr::isApplyEnabled() const
-{
-  return myIsApplyEnabled;
-}
-
-bool XGUI_OperationMgr::isParentOperationValid() const
-{
-  bool isValid = false;
-  // the enable state of the parent operation of the nested one is defined by the rules that
-  // firstly there are nested operations and secondly the parent operation is valid
-  ModuleBase_Operation* aPrevOp = 0;
-  Operations::const_iterator anIt = myOperations.end();
-  if (anIt != myOperations.begin()) { // there are items in the operations list
-    --anIt;
-    aPrevOp = *anIt; // the last top operation, the operation which is started
-    if (anIt != myOperations.begin()) { // find the operation where the started operation is nested
-      --anIt;
-      aPrevOp = *anIt;
-    }
-  }
-  return aPrevOp && aPrevOp->isValid();
+  // Apply button of the current operation should also be updated
+  onValidateOperation();
 }
 
 bool XGUI_OperationMgr::canStopOperation(ModuleBase_Operation* theOperation)
@@ -279,11 +308,12 @@ bool XGUI_OperationMgr::canStopOperation(ModuleBase_Operation* theOperation)
 
 bool XGUI_OperationMgr::commitOperation()
 {
-  if (hasOperation() && currentOperation()->isValid()) {
-    onCommitOperation();
-    return true;
-  }
-  return false;
+  //if (hasOperation() && currentOperation()->isValid()) {
+  //  onCommitOperation();
+  //  return true;
+  //}
+  //return false;
+  return onCommitOperation();
 }
 
 void XGUI_OperationMgr::resumeOperation(ModuleBase_Operation* theOperation)
@@ -298,7 +328,7 @@ bool XGUI_OperationMgr::isGrantedOperation(const QString& theId)
   QListIterator<ModuleBase_Operation*> anIt(myOperations);
   anIt.toBack();
   ModuleBase_Operation* aPreviousOperation = 0;
-  while (anIt.hasPrevious()) {
+  while (anIt.hasPrevious() && !isGranted) {
     ModuleBase_Operation* anOp = anIt.previous();
     if (anOp)
       isGranted = anOp->isGranted(theId);
@@ -312,7 +342,7 @@ void XGUI_OperationMgr::setCurrentFeature(const FeaturePtr& theFeature)
   DocumentPtr aDoc = aMgr->activeDocument();
   bool aIsOp = aMgr->isOperation();
   if (!aIsOp)
-    aMgr->startOperation();
+    aMgr->startOperation(QString("Set current feature: %1").arg(theFeature->getKind().c_str()).toStdString());
   aDoc->setCurrentFeature(theFeature, false);
   if (!aIsOp)
     aMgr->finishOperation();
@@ -338,10 +368,7 @@ bool XGUI_OperationMgr::canStartOperation(const QString& theId)
       else if (canStopOperation(aCurrentOp)) {
         // the started operation is granted in the parrent operation,
         // e.g. current - Line in Sketch, started Circle 
-        if (myIsApplyEnabled && aCurrentOp->isModified())
-          aCurrentOp->commit();
-        else
-          abortOperation(aCurrentOp);
+        stopOperation(aCurrentOp);
       } else {
         aCanStart = false;
       }
@@ -350,6 +377,14 @@ bool XGUI_OperationMgr::canStartOperation(const QString& theId)
   return aCanStart;
 }
 
+void XGUI_OperationMgr::stopOperation(ModuleBase_Operation* theOperation)
+{
+  if (XGUI_Tools::workshop(myWorkshop)->errorMgr()->isApplyEnabled() && theOperation->isModified())
+    theOperation->commit();
+  else
+    abortOperation(theOperation);
+}
+
 void XGUI_OperationMgr::abortOperation(ModuleBase_Operation* theOperation)
 {
   ModuleBase_Operation* aCurrentOperation = currentOperation();
@@ -368,11 +403,13 @@ void XGUI_OperationMgr::abortOperation(ModuleBase_Operation* theOperation)
   }
 }
 
-void XGUI_OperationMgr::onCommitOperation()
+bool XGUI_OperationMgr::onCommitOperation()
 {
+  bool isCommitted = false;
   ModuleBase_Operation* anOperation = currentOperation();
-  if (anOperation)
-    anOperation->commit();
+  if (anOperation && myWorkshop->module()->canCommitOperation())
+    isCommitted = anOperation->commit();
+  return isCommitted;
 }
 
 void XGUI_OperationMgr::onAbortOperation()
@@ -403,9 +440,36 @@ void XGUI_OperationMgr::onBeforeOperationStarted()
     // is disabled, sketch entity is disabled as extrusion cut is created earliest then sketch.
     // As a result the sketch disappears from the viewer. However after commit it is displayed back.
     aFOperation->setPreviousCurrentFeature(aDoc->currentFeature(false));
-    if (aFOperation->isEditOperation()) // it should be performed by the feature edit only
+
+#ifdef DEBUG_CURRENT_FEATURE
+    FeaturePtr aFeature = aFOperation->feature();
+    QString aKind = aFeature ? aFeature->getKind().c_str() : "";
+    qDebug(QString("onBeforeOperationStarted(), edit operation = %1, feature = %2")
+            .arg(aFOperation->isEditOperation())
+            .arg(ModuleBase_Tools::objectInfo(aFeature)).toStdString().c_str());
+
+    qDebug(QString("\tdocument->currentFeature(false) = %1").arg(
+            ModuleBase_Tools::objectInfo(ModelAPI_Session::get()->activeDocument()->currentFeature(false))).toStdString().c_str());
+#endif
+
+    if (aFOperation->isEditOperation()) {// it should be performed by the feature edit only
       // in create operation, the current feature is changed by addFeature()
       aDoc->setCurrentFeature(aFOperation->feature(), false);
+      // this is the only place where flushes must be called after setCurrentFeature for the current
+      // moment: after this the opertion is not finished, so, the ObjectBrowser state may be corrupted
+      // (issue #1457)
+      static Events_Loop* aLoop = Events_Loop::loop();
+      static Events_ID aCreateEvent = aLoop->eventByName(EVENT_OBJECT_CREATED);
+      aLoop->flush(aCreateEvent);
+      static Events_ID aDeleteEvent = aLoop->eventByName(EVENT_OBJECT_DELETED);
+      aLoop->flush(aDeleteEvent);
+    }
+
+#ifdef DEBUG_CURRENT_FEATURE
+    qDebug("\tdocument->setCurrentFeature");
+    qDebug(QString("\tdocument->currentFeature(false) = %1").arg(
+            ModuleBase_Tools::objectInfo(ModelAPI_Session::get()->activeDocument()->currentFeature(false))).toStdString().c_str());
+#endif
   }
 }
 
@@ -413,7 +477,8 @@ void XGUI_OperationMgr::onOperationStarted()
 {
   ModuleBase_Operation* aSenderOperation = dynamic_cast<ModuleBase_Operation*>(sender());
   updateApplyOfOperations(aSenderOperation);
-  emit operationStarted(aSenderOperation);
+  XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myWorkshop);
+  aWorkshop->operationStarted(aSenderOperation);
 }
 
 void XGUI_OperationMgr::onBeforeOperationAborted()
@@ -436,6 +501,16 @@ void XGUI_OperationMgr::onBeforeOperationCommitted()
   /// Restore the previous current feature
   ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>(aCurrentOperation);
   if (aFOperation) {
+#ifdef DEBUG_CURRENT_FEATURE
+    QString aKind = aFOperation->feature()->getKind().c_str();
+    qDebug(QString("onBeforeOperationCommitted(), edit operation = %1, feature = %2")
+            .arg(aFOperation->isEditOperation())
+            .arg(ModuleBase_Tools::objectInfo(aFOperation->feature())).toStdString().c_str());
+
+    qDebug(QString("\tdocument->currentFeature(false) = %1").arg(
+            ModuleBase_Tools::objectInfo(ModelAPI_Session::get()->activeDocument()->currentFeature(false))).toStdString().c_str());
+#endif
+
     if (aFOperation->isEditOperation()) {
       /// Restore the previous current feature
       setCurrentFeature(aFOperation->previousCurrentFeature());
@@ -447,6 +522,14 @@ void XGUI_OperationMgr::onBeforeOperationCommitted()
       if (myOperations.front() != aFOperation)
         setCurrentFeature(aFOperation->previousCurrentFeature());
     }
+#ifdef DEBUG_CURRENT_FEATURE
+    qDebug("\tdocument->setCurrentFeature");
+    qDebug(QString("\tdocument->currentFeature(false) = %1").arg(
+            ModuleBase_Tools::objectInfo(ModelAPI_Session::get()->activeDocument()->currentFeature(false))).toStdString().c_str());
+#endif
+    ModuleBase_IModule* aModule = myWorkshop->module();
+    if (aModule)
+      aModule->beforeOperationStopped(aFOperation);
   }
 }
 
@@ -496,28 +579,15 @@ void XGUI_OperationMgr::onOperationStopped()
   }
 }
 
-bool XGUI_OperationMgr::onKeyReleased(QKeyEvent* theEvent)
+bool XGUI_OperationMgr::onKeyReleased(QObject *theObject, QKeyEvent* theEvent)
 {
-  QObject* aSender = sender();
-
   // Let the manager decide what to do with the given key combination.
   ModuleBase_Operation* anOperation = currentOperation();
-  bool isAccepted = true;
+  bool isAccepted = false;
   switch (theEvent->key()) {
     case Qt::Key_Return:
     case Qt::Key_Enter: {
-      ModuleBase_Operation* aOperation = currentOperation();
-      ModuleBase_IPropertyPanel* aPanel = aOperation->propertyPanel();
-      ModuleBase_ModelWidget* aActiveWgt = aPanel->activeWidget();
-      if (!aActiveWgt || !aActiveWgt->processEnter()) {
-        ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>(currentOperation());
-        if (!aFOperation || myWorkshop->module()->getFeatureError(aFOperation->feature()).isEmpty()) {
-          emit keyEnterReleased();
-          commitOperation();
-        }
-        else
-          isAccepted = false;
-      }
+      isAccepted = onProcessEnter(theObject);
     }
     break;
     case Qt::Key_N:
@@ -535,7 +605,7 @@ bool XGUI_OperationMgr::onKeyReleased(QKeyEvent* theEvent)
         }
       }
     }
-
+    break;
     break;
     default:
       isAccepted = false;
@@ -547,9 +617,114 @@ bool XGUI_OperationMgr::onKeyReleased(QKeyEvent* theEvent)
   return isAccepted;
 }
 
-XGUI_Workshop* XGUI_OperationMgr::workshop() const
-{
-  XGUI_ModuleConnector* aConnector = dynamic_cast<XGUI_ModuleConnector*>(myWorkshop);
-  return aConnector->workshop();
+bool XGUI_OperationMgr::onProcessEnter(QObject* theObject)
+{
+  bool isAccepted = false;
+  ModuleBase_Operation* aOperation = currentOperation();
+  // to avoid enter processing when operation has not been started yet
+  if (!aOperation)
+    return isAccepted;
+  ModuleBase_IPropertyPanel* aPanel = aOperation->propertyPanel();
+  // only property panel enter is processed in order to do not process enter in application dialogs
+  bool isPPChild = isChildObject(theObject, aPanel);
+  if (!isPPChild)
+    return isAccepted;
+
+  ModuleBase_ModelWidget* anActiveWgt = aPanel->activeWidget();
+  bool isAborted = false;
+  if (!anActiveWgt) {
+    QWidget* aFocusWidget = aPanel->focusWidget();
+    QToolButton* aCancelBtn = dynamic_cast<XGUI_PropertyPanel*>(aPanel)->findButton(PROP_PANEL_CANCEL);
+    if (aFocusWidget && aCancelBtn && aFocusWidget == aCancelBtn) {
+      abortOperation(aOperation);
+      isAccepted = true;
+      isAborted = true;
+    }
+  }
+  if (!isAborted) {
+    isAccepted = anActiveWgt && anActiveWgt->processEnter();
+    if (!isAccepted) {
+      isAccepted = myWorkshop->module()->processEnter(anActiveWgt ? anActiveWgt->attributeID() : "");
+      if (!isAccepted) {
+        /// functionality is similar to Apply click
+        ModuleBase_OperationFeature* aFOperation = dynamic_cast<ModuleBase_OperationFeature*>(currentOperation());
+        if (!aFOperation || myWorkshop->module()->getFeatureError(aFOperation->feature()).isEmpty()) {
+          // key released is emitted to apply the current value to the model if it was modified in PP
+          emit keyEnterReleased();
+          commitOperation();
+          isAccepted = true;
+        }
+        else
+          isAccepted = false;
+      }
+    }
+  }
+  return isAccepted;
 }
 
+bool XGUI_OperationMgr::onProcessDelete(QObject* theObject)
+{
+  bool isAccepted = false;
+  ModuleBase_Operation* aOperation = currentOperation();
+  ModuleBase_ModelWidget* anActiveWgt = 0;
+  // firstly the widget should process Delete action
+  ModuleBase_IPropertyPanel* aPanel;
+  bool isPPChildObject = false;
+  if (aOperation) {
+    aPanel = aOperation->propertyPanel();
+    if (aPanel) {
+      isPPChildObject = isChildObject(theObject, aPanel);
+      // process delete in active widget only if delete sender is child of property panel
+      // it is necessary for the case when OB is shown, user perform selection and click Delete
+      if (isPPChildObject) {
+        anActiveWgt = aPanel->activeWidget();
+        if (anActiveWgt) {
+          isAccepted = anActiveWgt->processDelete();
+        }
+      }
+    }
+  }
+  if (!isAccepted) {
+    // after widget, object browser and viewer should process delete
+    /// other widgets such as line edit controls should not lead to
+    /// processing delete by workshop
+    XGUI_ObjectsBrowser* aBrowser = XGUI_Tools::workshop(myWorkshop)->objectBrowser();
+    QWidget* aViewPort = myWorkshop->viewer()->activeViewPort();
+    bool isToDeleteObject = false;
+    XGUI_Workshop* aWorkshop = XGUI_Tools::workshop(myWorkshop);
+    XGUI_ContextMenuMgr* aContextMenuMgr = aWorkshop->contextMenuMgr();
+    if (theObject == aBrowser->treeView()) {
+      aContextMenuMgr->updateObjectBrowserMenu();
+      isToDeleteObject = aContextMenuMgr->action("DELETE_CMD")->isEnabled();
+    }
+    else if (isChildObject(theObject, aViewPort)) {
+      aContextMenuMgr->updateViewerMenu();
+      isToDeleteObject = aContextMenuMgr->action("DELETE_CMD")->isEnabled();
+    }
+    else if (isPPChildObject) {
+      // property panel child object is processed to process delete performed on Apply button of PP
+      isToDeleteObject = true;
+    }
+    if (isToDeleteObject) {
+      aWorkshop->deleteObjects();
+      isAccepted = true;
+    }
+  }
+
+  return isAccepted;
+}
+
+bool XGUI_OperationMgr::isChildObject(const QObject* theObject, const QObject* theParent)
+{
+  bool isPPChild = false;
+  if (theParent && theObject) {
+    QObject* aParent = (QObject*)theObject;
+    while (aParent ) {
+      isPPChild = aParent == theParent;
+      if (isPPChild)
+        break;
+      aParent = aParent->parent();
+    }
+  }
+  return isPPChild;
+}