X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_Operation.h;h=46839253cc26e24efaaedb9df0632991831c2f33;hb=06e7f5859095193fc7f498bd89a7d28009794f53;hp=c453e6b0616196a613694f90c9cd55214308dc3e;hpb=872ac5e3e0196ad70c2a01a79bd070c9a7d4a2e6;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_Operation.h b/src/ModuleBase/ModuleBase_Operation.h index c453e6b06..46839253c 100644 --- a/src/ModuleBase/ModuleBase_Operation.h +++ b/src/ModuleBase/ModuleBase_Operation.h @@ -1,20 +1,26 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D - -/* - * ModuleBase_Operation.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_Operation_H #define ModuleBase_Operation_H #include -#include - -#include -#include #include #include @@ -23,8 +29,6 @@ class ModuleBase_ModelWidget; class ModuleBase_OperationDescription; class ModuleBase_IPropertyPanel; -class ModuleBase_ISelection; -class ModuleBase_IViewer; class QKeyEvent; @@ -50,13 +54,11 @@ class MODULEBASE_EXPORT ModuleBase_Operation : public QObject Q_OBJECT public: - - /// Appends to operation's history id, if it is an "edit" operation (myIsEditing == true) - static QString EditSuffix() { return "_E"; } /// Constructor /// \param theId the operation identifier /// \param theParent the QObject parent ModuleBase_Operation(const QString& theId = "", QObject* theParent = 0); + /// Destructor virtual ~ModuleBase_Operation(); @@ -64,53 +66,29 @@ Q_OBJECT /// /returns the instance of the description class ModuleBase_OperationDescription* getDescription() const { return myDescription; } - /** - * Must return true if this operation can be launched as nested for any current operation - * and it is not necessary to check this operation on validity. By default - * the operation is not granted. - * The method has to be redefined for granted operations. - */ - virtual bool isGranted(QString theId) const; - + /// Returns list of granted operation indices + const QStringList& grantedOperationIds() const; - /// Returns True if data of its feature was modified during operation - virtual bool isModified() const { return myIsModified; } - - /// Returns True id the current operation is launched in editing mode - bool isEditOperation() const { return myIsEditing; } + /// Sets list of operation indices, which can be started without the current operation stop + /// \param theList an ids + void setGrantedOperationIds(const QStringList& theList); - /// Returns list of nested features - QStringList nestedFeatures() const { return myNestedFeatures; } - - /// Sets list of nested features - void setNestedFeatures(const QStringList& theList) { myNestedFeatures = theList; } + /// Must return true if this operation can be launched as nested for any current operation + /// and it is not necessary to check this operation on validity. By default + /// the operation is not granted. + /// The method has to be redefined for granted operations. + virtual bool isGranted(QString theId) const; + /// Returns True if data of its feature was modified during operation + virtual bool isModified() const; /// Returns operations Id from it's description QString id() const; - /// Returns the operation feature - /// \return the feature - FeaturePtr feature() const; - - /** - * Must return True if the operation's feature is valid. - * Since IOperation does not have any feature returns false. - */ + /// Must return True if the operation's feature is valid. + /// Since IOperation does not have any feature returns false. virtual bool isValid() const; - /// Sets the operation feature - void setFeature(FeaturePtr theFeature); - - /// Returns True if the current operation works with the given object (feature or result) - virtual bool hasObject(ObjectPtr theObj) const; - - /// 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); - /// \brief Set property pane to the operation /// \param theProp a property panel instance virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp); @@ -118,42 +96,40 @@ Q_OBJECT /// \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(); + QString helpFileName() const { return myHelpFileName; } + + void setHelpFileName(QString theName) { + myHelpFileName = theName; + } - /// If the operation works with feature which is sub-feature of another one - /// then this variable has to be initialised by parent feature - /// before operation feature creating - void setParentFeature(CompositeFeaturePtr theParent); + void setHideFacesVisible(bool isVisible) { myHideFacesVisibilityState = isVisible; } - /// \return Installed parent feature (can be NULL) - CompositeFeaturePtr parentFeature() const; + bool isHideFacesVisible() const { return myHideFacesVisibilityState; } signals: /// The operation is started - void started(); + void beforeStarted(); + /// The operation is started + void started(); /// The operation is aborted - void aborted(); + void beforeAborted(); + /// The operation is aborted + void aborted(); /// The operation is committed - void committed(); + void beforeCommitted(); + /// The operation is committed + void committed(); /// The operation is aborted or committed - void stopped(); + void stopped(); /// The operation is resumed - void resumed(); + void resumed(); /// The operation is postponed - void postponed(); - - /// The operation is triggered - /// \param theState a new triggered state - void triggered(bool theState); - - /// The operation is filled with existing preselection - void activatedByPreselection(); + void postponed(); public slots: /// Starts operation @@ -162,10 +138,11 @@ 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(); /// Deactivates current operation which can be resumed later. - void postpone(); + virtual void postpone(); /// Resumes operation /// Public slot. Verifies whether operation can be started and starts operation. @@ -173,23 +150,24 @@ 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 resume(); + virtual void resume(); /// Aborts operation /// Public slot. Aborts operation. This slot is not virtual and cannot be redefined. /// Redefine abortOperation method to change behavior of operation instead - void abort(); + virtual void abort(); /// Commits operation /// Public slot. Commits operation. This slot is not virtual and cannot be redefined. /// Redefine commitOperation method to change behavior of operation instead - bool commit(); + virtual bool commit(); + + /// Changes the modified flag of the operation + void onValuesChanged(); - /// Alias for start/abort slots - /// Public slot. Aborts operation if false, else does nothing. - /// Provided for S/S compatibility with QAction's toggle(bool) - /// \param theState th flag to abort, if it is true, do nothing, overwise abort - void setRunning(bool theState); + /// Changes the modified flag of the operation if the current state of the widget is modified + /// \param thePreviousState the previous vlaue state of the widget + void onValueStateChanged(int thePreviousState); protected: /// Virtual method called when operation started (see start() method for more description) @@ -206,7 +184,7 @@ signals: virtual void abortOperation() {} /// Virtual method called when operation committed (see commit() method for more description) - virtual void commitOperation() {} + virtual void commitOperation() {}; /// Virtual method called after operation committed (see commit() method for more description) virtual void afterCommitOperation() {} @@ -214,56 +192,27 @@ signals: /// 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 - virtual FeaturePtr createFeature(const bool theFlushMessage = true); - /// Verifies whether this operator can be commited. /// \return Returns TRUE if current operation can be committed, e.g. all parameters are filled virtual bool canBeCommitted() const; - /// Return a widget value point by the selection and the viewer position - /// The default realization returns false - /// \param thePrs the presentation - /// \param theViewer a viewer to have the viewer the eye position - /// \param theX the horizontal coordinate - /// \param theY the vertical coordinate - /// \return true if the point exits in the selection - virtual bool getViewerPoint(ModuleBase_ViewerPrs thePrs, - ModuleBase_IViewer* theViewer, - double& theX, double& theY); - - /// Removes the preselection information and clears the map of preselection - void clearPreselection(); - - protected: - /// The operation feature to be handled - FeaturePtr myFeature; - +private: /// the container to have the operation description - ModuleBase_OperationDescription* myDescription; - - /// Editing feature flag - bool myIsEditing; + ModuleBase_OperationDescription* myDescription; /// Modified feature flag bool myIsModified; - /// List of nested operations IDs - QStringList myNestedFeatures; - - /// List of pre-selected object - QList myPreSelection; + /// List of operations IDs which are granted of the current operation + QStringList myGrantedIds; /// Access to property panel ModuleBase_IPropertyPanel* myPropertyPanel; - /// If the operation works with feature which is sub-feature of another one - /// then this variable has to be initialised by parent feature - /// before operation feature creating - CompositeFeaturePtr myParentFeature; + QString myHelpFileName; + /// Visibility state of HideFaces panel before the operation launch + bool myHideFacesVisibilityState; }; #endif