X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_OperationFeature.h;h=7fba6c45a58383c0fd959e344543b63efed36c62;hb=06e7f5859095193fc7f498bd89a7d28009794f53;hp=11de99701c7756b512baa1be04422c5418a9e4dd;hpb=902ee072b1eb3122ee3a3b8ce8c9722b5a671e0b;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_OperationFeature.h b/src/ModuleBase/ModuleBase_OperationFeature.h old mode 100755 new mode 100644 index 11de99701..7fba6c45a --- a/src/ModuleBase/ModuleBase_OperationFeature.h +++ b/src/ModuleBase/ModuleBase_OperationFeature.h @@ -1,18 +1,27 @@ -// 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 #include #include -#include #include #include @@ -26,6 +35,8 @@ class ModuleBase_ModelWidget; class ModuleBase_ISelection; class ModuleBase_IViewer; +class ModuleBase_IWorkshop; +class ModuleBase_ViewerPrs; class QKeyEvent; @@ -64,6 +75,14 @@ Q_OBJECT /// Returns True id the current operation is launched in editing mode bool isEditOperation() const { return myIsEditing; } + /// Change the operation mode from create to edit. + /// The transaction and the operation name in the model history of transaction are the same. + /// It updates the edit state in the widgets of property panel + /// \param isEditState boolean state whether the operation should become editing or creating + // \param theRestartTransaction if true, the current model transaction is committed and + /// the new one is started + void setEditOperation(const bool& isEditState/*const bool theRestartTransaction*/); + /// Returns the operation feature /// \return the feature FeaturePtr feature() const; @@ -84,23 +103,28 @@ Q_OBJECT virtual bool isDisplayedOnStart(ObjectPtr theObject); /// Initialisation of operation with preliminary selection - /// \param theSelection an instance of Selection class - /// \param theViewer a viewer to have the viewer the eye position - virtual void initSelection(ModuleBase_ISelection* theSelection, - ModuleBase_IViewer* theViewer); + /// \param thePreSelected a container of selected presentations + virtual void initSelection( + const QList>& thePreSelected); + + /// Fill internal map by preselection + /// \param theValues a list of preselection + void setPreselection(const QList>& theValues); /// \brief Set property pane to the operation /// \param theProp a property panel instance virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp); - /// \return Currently installed property panel + // \return Currently installed property panel //ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; } - /// Activates widgets by preselection if it is accepted. Emits signal if the activation is correct - virtual void activateByPreselection(); + /// Activates widgets by preselection if it is accepted. + /// \param theGreedAttributeId a greed attribute id if there is in the current feature + /// \return last filled widget + 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); @@ -115,9 +139,18 @@ Q_OBJECT /// \return theFeature a feature FeaturePtr previousCurrentFeature(); -signals: - /// The operation is filled with existing preselection - void activatedByPreselection(); + /// 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 @@ -126,7 +159,8 @@ signals: /// to change behavior of operation. There is no point in using this method. It would /// be better to inherit own operator from base one and redefine startOperation method /// instead. - void start(); + /// \return true if the start is successful + virtual bool start(); /// Aborts operation /// Public slot. Aborts operation. This slot is not virtual and cannot be redefined. @@ -145,6 +179,9 @@ signals: /// 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 @@ -164,17 +201,22 @@ signals: /// Editing feature flag bool myIsEditing; - /// List of pre-selected object - QList myPreSelection; + /// State used only if the operation should not be commited + bool myNeedToBeAborted; + + /// List of pre-selected object + QList> 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