-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * ModuleBase_OperationFeature.h
- *
- * Created on: Apr 2, 2014
- * Author: sbh
- */
+// 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
virtual ModuleBase_ModelWidget* activateByPreselection(const std::string& theGreedAttributeId);
/// If the operation works with feature which is sub-feature of another one
- /// then this variable has to be initialised by parent feature
+ /// then this variable has to be initialised by parent feature
/// before operation feature creating
void setParentFeature(CompositeFeaturePtr theParent);
/// \return theFeature a feature
FeaturePtr previousCurrentFeature();
+ /// Set whether the operation should be aborted. By default the state is false in operation
+ /// \param theState abort state
+ void setNeedToBeAborted(const bool theState) { myNeedToBeAborted = theState; }
+
+ /// Returns valid state of the operation
+ /// \return custom validity state (it is almost always true)
+ bool isNeedToBeAborted() const { return myNeedToBeAborted; }
+
+ /// Call this function on launch of a nested operation
+ /// when transaction has to be reopened on resume of main operation
+ /// By default transaction is not reopened on resuming
+ void openTransactionOnResume() { myRestartTransactionOnResume = true; }
+
public slots:
/// Starts operation
/// Public slot. Verifies whether operation can be started and starts operation.
/// Hide feature/results if they were hided on start
virtual void stopOperation();
+ /// Virtual method called after operation resume (see resume() method for more description)
+ virtual void resumeOperation();
+
/// Creates an operation new feature
/// \param theFlushMessage the flag whether the create message should be flushed
/// \returns the created feature
/// Editing feature flag
bool myIsEditing;
- /// List of pre-selected object
+ /// State used only if the operation should not be commited
+ bool myNeedToBeAborted;
+
+ /// List of pre-selected object
QList<std::shared_ptr<ModuleBase_ViewerPrs>> myPreSelection;
/// If the operation works with feature which is sub-feature of another one
- /// then this variable has to be initialised by parent feature
+ /// then this variable has to be initialised by parent feature
/// before operation feature creating
CompositeFeaturePtr myParentFeature;
/// Last current feature before editing operation. It is cashed when Edit operation is started
/// in order to restore the document current feature on commit/abort this operation.
FeaturePtr myPreviousCurrentFeature;
+
+ bool myRestartTransactionOnResume;
};
#endif
