X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_Operation.h;h=c453e6b0616196a613694f90c9cd55214308dc3e;hb=5fd2e5839ff05612b8258e55f1eaa8f1bf0d92ae;hp=0a5e1a54db084bdc52072512f008d0368a5427d8;hpb=fb96bfa1fc8d030bb5fc8c8642384bb5bdc28676;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_Operation.h b/src/ModuleBase/ModuleBase_Operation.h index 0a5e1a54d..c453e6b06 100644 --- a/src/ModuleBase/ModuleBase_Operation.h +++ b/src/ModuleBase/ModuleBase_Operation.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + /* * ModuleBase_Operation.h * @@ -9,22 +11,26 @@ #define ModuleBase_Operation_H #include -#include +#include -#include "ModelAPI_Feature.h" +#include +#include #include #include +#include -#include - -class ModelAPI_Document; class ModuleBase_ModelWidget; +class ModuleBase_OperationDescription; +class ModuleBase_IPropertyPanel; +class ModuleBase_ISelection; +class ModuleBase_IViewer; class QKeyEvent; /*! - \class ModuleBase_Operation + * \class ModuleBase_Operation + * \ingroup GUI * \brief Base class for all operations * * Base class for all operations. If you perform an action it is reasonable to create @@ -39,11 +45,14 @@ class QKeyEvent; * - virtual void commitOperation(); */ -class MODULEBASE_EXPORT ModuleBase_Operation : public ModuleBase_IOperation +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 @@ -51,74 +60,210 @@ Q_OBJECT /// Destructor virtual ~ModuleBase_Operation(); - // Returns operations Id from it's description + /// Returns the operation description + /// /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 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; } + + /// Returns list of nested features + QStringList nestedFeatures() const { return myNestedFeatures; } + + /// Sets list of nested features + void setNestedFeatures(const QStringList& theList) { myNestedFeatures = theList; } + + + /// Returns operations Id from it's description QString id() const; + /// Returns the operation feature /// \return the feature FeaturePtr feature() const; - /// Returns whether the nested operations are enabled. - /// The state can depend on the operation current state. - /// \return enabled state - virtual bool isNestedOperationsEnabled() const; - - // Data model methods. - /// Stores a custom value in model. - void storeCustomValue(); + /** + * 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 setEditingFeature(FeaturePtr theFeature); + void setFeature(FeaturePtr theFeature); /// Returns True if the current operation works with the given object (feature or result) virtual bool hasObject(ObjectPtr theObj) const; - virtual void keyReleased(const int theKey) {}; + /// 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); - virtual void activateNextToCurrentWidget() {}; + /// \brief Set property pane to the operation + /// \param theProp a property panel instance + virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp); - public slots: - /// Slots which listen the mode widget activation - /// \param theWidget the model widget - virtual void onWidgetActivated(ModuleBase_ModelWidget* theWidget); + /// \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(); + + /// 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); + + /// \return Installed parent feature (can be NULL) + CompositeFeaturePtr parentFeature() const; signals: - /// Signals about the activating of the next widget - /// \param theWidget the previous active widget - void activateNextWidget(ModuleBase_ModelWidget* theWidget); + /// The operation is started + void started(); + + /// The operation is aborted + void aborted(); + + /// The operation is committed + void committed(); + + /// The operation is aborted or committed + void stopped(); + + /// The operation is 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(); + + public slots: + /// Starts operation + /// Public slot. Verifies whether operation can be started and starts operation. + /// This slot is not virtual and cannot be redefined. Redefine startOperation method + /// 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(); + + /// Deactivates current operation which can be resumed later. + void postpone(); + + /// Resumes operation + /// Public slot. Verifies whether operation can be started and starts operation. + /// This slot is not virtual and cannot be redefined. Redefine startOperation method + /// 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(); + + /// 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(); + + /// 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(); + + /// 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); protected: /// Virtual method called when operation started (see start() method for more description) /// Default impl calls corresponding slot and commits immediately. - virtual void startOperation(); + virtual void startOperation() {} + + /// Implementation of specific steps on postpone operation + virtual void postponeOperation() {} + /// Virtual method called when operation stopped - committed or aborted. - virtual void stopOperation(); + virtual void stopOperation() {} + /// Virtual method called when operation aborted (see abort() method for more description) - virtual void abortOperation(); + 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(); + virtual void afterCommitOperation() {} - /// Send update message by loop - void flushUpdated(); - /// Send created message by loop - void flushCreated(); + /// 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); - protected: - /// Sets the operation feature - void setFeature(FeaturePtr theFeature); - /// 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: - FeaturePtr myFeature; /// the operation feature to be handled + /// The operation feature to be handled + FeaturePtr myFeature; + + /// the container to have the operation description + ModuleBase_OperationDescription* myDescription; + + /// Editing feature flag + bool myIsEditing; + + /// Modified feature flag + bool myIsModified; + + /// List of nested operations IDs + QStringList myNestedFeatures; + + /// List of pre-selected object + QList myPreSelection; + + /// 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; + }; #endif