-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * ModuleBase_Operation.h
- *
- * Created on: Apr 2, 2014
- * Author: sbh
- */
+// Copyright (C) 2014-2019 CEA/DEN, EDF R&D
+//
+// 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 <ModuleBase.h>
-#include <ModuleBase_ViewerPrs.h>
-
-#include <ModelAPI_CompositeFeature.h>
-#include <ModelAPI_Document.h>
#include <QObject>
#include <QString>
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
/// \param theId the operation identifier
/// \param theParent the QObject parent
ModuleBase_Operation(const QString& theId = "", QObject* theParent = 0);
+
/// Destructor
virtual ~ModuleBase_Operation();
/// /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;
+
+ /// Sets list of operation indices, which can be started without the current operation stop
+ /// \param theList an ids
+ void setGrantedOperationIds(const QStringList& theList);
- /// Sets a list of model widgets, according to the operation feature xml definition
- /// \param theXmlRepresentation an xml feature definition
- /// \param theWidgets a list of widgets
- //void setModelWidgets(const std::string& theXmlRepresentation,
- // QList<ModuleBase_ModelWidget*> theWidgets);
+ /// 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; }
-
+ /// Change the modified state of the operation
+ void setIsModified(const bool theIsModified) { myIsModified = theIsModified; }
- // Returns operations Id from it's description
+ /// 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;
- /// Returns whether the nested operations are enabled.
- /// The state can depend on the operation current state.
- /// \return enabled state
- virtual bool isNestedOperationsEnabled() const;
-
- /// Sets the operation feature
- void setFeature(FeaturePtr theFeature);
+ /// \brief Set property pane to the operation
+ /// \param theProp a property panel instance
+ virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp);
- /// Returns True if the current operation works with the given object (feature or result)
- virtual bool hasObject(ObjectPtr theObj) const;
+ /// \return Currently installed property panel
+ ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; }
- //virtual void keyReleased(const int theKey) {};
+ QString helpFileName() const { return myHelpFileName; }
- /// If operation needs to redisplay its result during operation
- /// then this method has to return True
- //virtual bool hasPreview() const { return false; }
+ void setHelpFileName(QString theName) {
+ myHelpFileName = theName;
+ }
- /// Initialisation of operation with preliminary selection
- /// \param theSelected the list of selected presentations
- /// \param theHighlighted the list of highlighted presentations
- /// \param theViewer a viewer to have the viewer the eye position
- virtual void initSelection(ModuleBase_ISelection* theSelection,
- ModuleBase_IViewer* /* theViewer*/);
+signals:
+ /// The operation is started
+ void beforeStarted();
+ /// The operation is started
+ void started();
- virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp);
+ /// The operation is aborted
+ void beforeAborted();
+ /// The operation is aborted
+ void aborted();
- ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; }
+ /// The operation is committed
+ void beforeCommitted();
+ /// The operation is committed
+ void committed();
- /// Activates widgets by preselection if it is accepted
- virtual bool activateByPreselection();
+ /// The operation is aborted or committed
+ void stopped();
- /// 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) { myParentFeature = theParent; }
- CompositeFeaturePtr parentFeature() const { return myParentFeature; }
+ /// The operation is resumed
+ void resumed();
-signals:
- void started(); /// the operation is started
- void aborted(); /// the operation is aborted
- void committed(); /// the operation is committed
- void stopped(); /// the operation is aborted or committed
- void resumed(); /// the operation is resumed
- void postponed(); /// the operation is postponed
- void activatedByPreselection(); /// the operation is filled with existing preselection
+ /// The operation is postponed
+ void postponed();
public slots:
/// Starts operation
/// 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.
/// 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();
-
- /// 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);
+ virtual bool commit();
- // Data model methods.
- /// Stores a custom value in model.
- //virtual void storeCustomValue();
+ /// Changes the modified flag of the operation
+ void onValuesChanged();
- /// Slots which listen the mode widget activation
- /// \param theWidget the model widget
- //virtual void onWidgetActivated(ModuleBase_ModelWidget* theWidget);
+ /// 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)
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() {}
- /// Send update message by loop
- void flushUpdated();
-
- /// Send created message by loop
- void flushCreated();
-
- /// Creates an operation new feature
- /// \param theFlushMessage the flag whether the create message should be flushed
- /// \param theCompositeFeature the feature that must be used for adding the created object or null
- /// \returns the created
- virtual FeaturePtr createFeature(const bool theFlushMessage = true);
+ /// Virtual method called after operation resume (see resume() method for more description)
+ virtual void resumeOperation() {}
/// 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;
- /// Returns pointer to the root document.
- std::shared_ptr<ModelAPI_Document> document() const;
-
- /// Set value to the active widget
- /// \param theFeature the feature
- /// \param theX the horizontal coordinate
- /// \param theY the vertical coordinate
- /// \return true if the point is set
- //virtual bool setWidgetValue(ObjectPtr theFeature, double theX, double theY);
-
- /// 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
-
+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<ModuleBase_ViewerPrs> 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;
};
#endif
