ModuleBase_Operation.h

// Copyright (C) 2014-2025  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 ModuleBase_Operation_H
#define ModuleBase_Operation_H
 
#include <ModuleBase.h>
 
#include <QObject>
#include <QString>
#include <QStringList>
 
class ModuleBase_ModelWidget;
class ModuleBase_OperationDescription;
class ModuleBase_IPropertyPanel;
 
class QKeyEvent;
 
class MODULEBASE_EXPORT ModuleBase_Operation : public QObject
{
Q_OBJECT
 
 public:
  ModuleBase_Operation(const QString& theId = "", QObject* theParent = 0);
 
  virtual ~ModuleBase_Operation();
 
  ModuleBase_OperationDescription* getDescription() const { return myDescription; }
 
  const QStringList& grantedOperationIds() const;
 
  void setGrantedOperationIds(const QStringList& theList);
 
  virtual bool isGranted(QString theId) const;
 
  virtual bool isModified() const;
 
  QString id() const;
 
  virtual bool isValid() const;
 
  virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp);
 
  ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; }
 
  QString helpFileName() const { return myHelpFileName; }
 
  void setHelpFileName(QString theName) {
    myHelpFileName = theName;
  }
 
  void setHideFacesVisible(bool isVisible) { myHideFacesVisibilityState = isVisible; }
 
  bool isHideFacesVisible() const { return myHideFacesVisibilityState; }
 
signals:
  void beforeStarted();
  void started();
 
  void beforeAborted();
  void aborted();
 
  void beforeCommitted();
  void committed();
 
  void stopped();
 
  void resumed();
 
  void postponed();
 
 public slots:
  virtual bool start();
 
  virtual void postpone();
 
  virtual void resume();
 
  virtual void abort();
 
  virtual bool commit();
 
  void onValuesChanged();
 
  void onValueStateChanged(int thePreviousState);
 
 protected:
   virtual void startOperation() {}
 
  virtual void postponeOperation() {}
 
  virtual void stopOperation() {}
 
  virtual void abortOperation() {}
 
  virtual void commitOperation() {};
 
  virtual void afterCommitOperation() {}
 
  virtual void resumeOperation() {}
 
  virtual bool canBeCommitted() const;
 
private:
  ModuleBase_OperationDescription* myDescription;
 
  bool myIsModified;
 
  QStringList myGrantedIds;
 
  ModuleBase_IPropertyPanel* myPropertyPanel;
 
  QString myHelpFileName;
 
  bool myHideFacesVisibilityState;
};
 
#endif