XGUI_OperationMgr.h

// Copyright (C) 2014-2026  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef XGUI_OperationMgr_H
#define XGUI_OperationMgr_H
 
#include "XGUI.h"
 
#include <ModuleBase_Operation.h>
#include "ModelAPI_Feature.h"
 
#include <QList>
#include <QObject>
#include <QStringList>
 
class QKeyEvent;
class QMessageBox;
 
class ModuleBase_IWorkshop;
class XGUI_Workshop;
class XGUI_ShortCutListener;
 
class XGUI_EXPORT XGUI_OperationMgr : public QObject
{
Q_OBJECT
public:
  enum XGUI_MessageKind
  {
    XGUI_AbortOperationMessage, 
    XGUI_InformationMessage 
  };
 
public:
  XGUI_OperationMgr(QObject* theParent, ModuleBase_IWorkshop* theWorkshop);
 
  virtual ~XGUI_OperationMgr();
 
  void activate();
  void deactivate();
 
  void setWorkshop(ModuleBase_IWorkshop* theWorkshop)
  { myWorkshop = theWorkshop; };
 
  ModuleBase_IWorkshop* workshop() const { return myWorkshop; }
 
  XGUI_Workshop* xworkshop() const;
 
  ModuleBase_Operation* currentOperation() const;
 
  bool isCurrentOperation(ModuleBase_Operation* theOperation);
 
  bool hasOperation() const;
 
  bool hasOperation(const QString& theId) const;
 
  bool canStopOperation(ModuleBase_Operation* theOperation,
                        const XGUI_MessageKind& theMessageKind = XGUI_AbortOperationMessage);
 
  ModuleBase_Operation* findOperation(const QString& theId) const;
 
  int operationsCount() const;
 
  QStringList operationList() const;
 
  ModuleBase_Operation* previousOperation(ModuleBase_Operation* theOperation) const;
 
  ModuleBase_ModelWidget* activeWidget() const;
 
  bool startOperation(ModuleBase_Operation* theOperation);
 
  bool canStartOperation(const QString& theId, bool& isCommitted);
 
  void stopOperation(ModuleBase_Operation* theOperation, bool& isCommitted);
 
  void abortOperation(ModuleBase_Operation* theOperation);
 
  bool abortAllOperations(const XGUI_MessageKind& theMessageKind = XGUI_AbortOperationMessage);
 
  bool commitOperation();
 
  void setSHIFTPressed(const bool thePressed) { mySHIFTPressed = thePressed; }
 
  bool hasSHIFTPressed() const { return mySHIFTPressed; }
 
public slots:
  void onAbortOperation();
  void onAbortAllOperation();
  void onValidateOperation();
  bool commitAllOperations();
 
signals:
  void operationStopped(ModuleBase_Operation* theOperation);
 
  void operationResumed(ModuleBase_Operation* theOperation);
 
  void operationCommitted(ModuleBase_Operation* theOperation);
 
  void operationAborted(ModuleBase_Operation* theOperation);
 
  void keyEnterReleased();
 
public: // TEMPORARY, it should be protected and be performed automatically
  void updateApplyOfOperations(ModuleBase_Operation* theOperation = 0);
 
protected: // TEMPORARY
  void resumeOperation(ModuleBase_Operation* theOperation);
 
  bool isGrantedOperation(const QString& theId);
 
  void setCurrentFeature(const FeaturePtr& theFeature);
 
 public slots:
  bool onKeyReleased(QObject *theObject, QKeyEvent* theEvent);
 
  bool onKeyPressed(QObject *theObject, QKeyEvent* theEvent);
 
  bool onProcessDelete(QObject* theObject);
 
  protected slots:
  bool onProcessEnter(QObject *theObject);
 
  void onOperationStopped();
 
  void onBeforeOperationStarted();
 
  void onOperationStarted();
 
  void onBeforeOperationAborted();
 
  void onOperationAborted();
 
  void onBeforeOperationCommitted();
 
  void onOperationCommitted();
 
  void onOperationResumed();
 
private:
  static bool isChildObject(const QObject* theObject, const QObject* theParent);
 
  static QMessageBox* createMessageBox(const QString& theMessage);
 
  static QMessageBox* createInformationBox(const QString& theMessage);
 
 private:
  typedef QList<ModuleBase_Operation*> Operations;  
  Operations myOperations;  
                            // others are suspended and started by the active is finished
 
  ModuleBase_IWorkshop* myWorkshop;
  QMessageBox* myActiveMessageBox;
  XGUI_ShortCutListener* myShortCutListener;
  bool mySHIFTPressed;
};
 
#endif