ModuleBase_OperationFeature.h

// Copyright (C) 2014-2023  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_OperationFeature_H
#define ModuleBase_OperationFeature_H
 
#include <ModuleBase.h>
#include <ModuleBase_Operation.h>
 
#include <ModelAPI_Object.h>
#include <ModelAPI_CompositeFeature.h>
 
#include <QObject>
#include <QString>
#include <QStringList>
 
#include <set>
 
class ModuleBase_ModelWidget;
class ModuleBase_ISelection;
class ModuleBase_IViewer;
class ModuleBase_IWorkshop;
class ModuleBase_ViewerPrs;
 
class QKeyEvent;
 
class MODULEBASE_EXPORT ModuleBase_OperationFeature : public ModuleBase_Operation
{
Q_OBJECT
 
 public:
 
  static QString EditSuffix() { return "_E"; }
  ModuleBase_OperationFeature(const QString& theId = "", QObject* theParent = 0);
  virtual ~ModuleBase_OperationFeature();
 
  bool isEditOperation() const { return myIsEditing; }
 
  // \param theRestartTransaction if true, the current model transaction is committed and
  void setEditOperation(const bool& isEditState/*const bool theRestartTransaction*/);
 
  FeaturePtr feature() const;
 
  virtual bool isValid() const;
 
  void setFeature(FeaturePtr theFeature);
 
  virtual bool hasObject(ObjectPtr theObj) const;
 
  virtual bool isDisplayedOnStart(ObjectPtr theObject);
 
  virtual void initSelection(
                  const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& thePreSelected);
 
  void setPreselection(const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
 
  virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp);
 
  // \return Currently installed property panel
  //ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; }
 
  virtual ModuleBase_ModelWidget* activateByPreselection(const std::string& theGreedAttributeId);
 
  void setParentFeature(CompositeFeaturePtr theParent);
 
  CompositeFeaturePtr parentFeature() const;
 
  void setPreviousCurrentFeature(const FeaturePtr& theFeature);
 
  FeaturePtr previousCurrentFeature();
 
  void setNeedToBeAborted(const bool theState)  { myNeedToBeAborted = theState; }
 
  bool isNeedToBeAborted() const { return myNeedToBeAborted; }
 
  void openTransactionOnResume() { myRestartTransactionOnResume = true; }
 
 public slots:
  virtual bool start();
 
  void abort();
 
  bool commit();
 
 protected:
  virtual void startOperation();
 
  virtual void stopOperation();
 
  virtual void resumeOperation();
 
  virtual FeaturePtr createFeature(const bool theFlushMessage = true);
 
  void clearPreselection();
 
 protected:
  FeaturePtr myFeature;
 
  std::set<ObjectPtr> myVisualizedObjects;
 
  bool myIsEditing;
 
  bool myNeedToBeAborted;
 
  QList<std::shared_ptr<ModuleBase_ViewerPrs>> myPreSelection;
 
  CompositeFeaturePtr myParentFeature;
 
  FeaturePtr myPreviousCurrentFeature;
 
  bool myRestartTransactionOnResume;
};
 
#endif