Salome HOME
Abort operation correction, Cases are: 1. Deselect feature button in ToolBar, 2....
[modules/shaper.git] / src / ModuleBase / ModuleBase_IWorkshop.h
index 3679e30d2df1fbc5833f33b258db503739905dcc..9e8f1a28f3e1c01429d301a4a6565597064730a5 100644 (file)
@@ -9,6 +9,8 @@
 
 #include "ModuleBase.h"
 #include "ModuleBase_Definitions.h"
+#include <ModuleBase_FilterValidated.h>
+#include <ModuleBase_ViewerPrs.h>
 
 #include <ModelAPI_Object.h>
 #include <GeomAPI_AISObject.h>
 class ModuleBase_IModule;
 class ModuleBase_ISelection;
 class ModuleBase_IViewer;
+class ModuleBase_IPropertyPanel;
 class ModuleBase_Operation;
 class ModuleBase_FilterFactory;
 
 /**
- * Class which provides access to Workshop object serveces
+ * \ingroup GUI
+ * Class which provides access to Workshop object services
  */
 class MODULEBASE_EXPORT ModuleBase_IWorkshop : public QObject
 {
 Q_OBJECT
  public:
-  ModuleBase_IWorkshop(QObject* theParent)
-      : QObject(theParent)
-  {}
+   /// Constructor
+   /// \param theParent parent object
+  ModuleBase_IWorkshop(QObject* theParent);
 
   virtual ~ModuleBase_IWorkshop()
   {}
 
+  /// Return current selection instance
   virtual ModuleBase_ISelection* selection() const = 0;
 
   /// Activate sub-shapes selection (opens local context)
   /// Types has to be defined according to TopAbs_ShapeEnum
   virtual void activateSubShapesSelection(const QIntList& theTypes) = 0;
 
+  /// Activate objects in the module selection modes(opens local context)
+  virtual void activateModuleSelectionModes() = 0;
+
   /// Deactivate sub-shapes selection (closes local context)
   virtual void deactivateSubShapesSelection() = 0;
 
@@ -50,6 +58,13 @@ Q_OBJECT
   //! Returns current viewer
   virtual ModuleBase_IViewer* viewer() const = 0;
 
+  //! Returns property panel
+  virtual ModuleBase_IPropertyPanel* propertyPanel() const = 0;
+
+  /// A filter to process an attribute validators
+  /// \return a filter
+  Handle(ModuleBase_FilterValidated) validatorFilter();
+
   //! Returns the factory of selection filters : the only one instance per application
   ModuleBase_FilterFactory* selectionFilters() const;
   
@@ -59,7 +74,20 @@ Q_OBJECT
   //! Returns true if the operation with id theId can be started
   virtual bool canStartOperation(QString theId) = 0;
 
-  //! Returns AIS opbject by data object
+  //! Returns started operation by the operation identifier
+  //! \param theId an operation id
+  //! \return an operation instance or NULL
+  virtual ModuleBase_Operation* findStartedOperation(const QString& theId) = 0;
+
+  //! Returns true if the operation with id theId can be stopped
+  //! \return boolean result
+  virtual bool canStopOperation() = 0;
+
+  //! Aborts the operation.
+  //! \param theId an aborted operation
+  virtual void abortOperation(ModuleBase_Operation* theOperation) = 0;
+
+  //! Returns AIS object by data object
   virtual AISObjectPtr findPresentation(const ObjectPtr& theObject) const = 0;
 
   //! Returns data object by AIS
@@ -67,14 +95,18 @@ Q_OBJECT
 
   //! Select features clearing previous selection. 
   //! If the list is empty then selection will be cleared
-  virtual void setSelected(const QObjectPtrList& theFeatures) = 0;
+  virtual void setSelected(const QList<ModuleBase_ViewerPrs>& theValues) = 0;
 
 signals:
+  /// Signal selection changed.
   void selectionChanged();
 
   /// Signal which is emited after activation of property panel
   void propertyPanelActivated();
 
+protected:
+  /// A filter to process an attribute validators
+  Handle(ModuleBase_FilterValidated) myValidatorFilter;
 };
 
 #endif