Issue #339: Set document filter before any other filters

[modules/shaper.git] / src / ModuleBase / ModuleBase_IModule.h

diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h
index 88fa049d45e5549396bffe806882ffa4b77b1530..7ba5cfe1e09693d931618d6f73c189f268fdc02e 100644 (file)
--- a/src/ModuleBase/ModuleBase_IModule.h
+++ b/src/ModuleBase/ModuleBase_IModule.h
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
+ // Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
 \r
 #ifndef ModuleBase_IModule_H\r
 #define ModuleBase_IModule_H\r
@@ -10,6 +10,7 @@
 \r
 #include <QString>\r
 #include <QObject>\r
+#include <QMap>\r
 \r
 #include <string>\r
 #include <map>\r
@@ -69,9 +70,15 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   /// Realizes some functionality by an operation abort\r
   virtual void operationAborted(ModuleBase_Operation* theOperation) {}\r
 \r
+  /// Realizes some functionality by an operation start\r
+  /// \param theOperation a started operation\r
+  virtual ModuleBase_Operation* currentOperation() const = 0;\r
+\r
   /// Add menu atems for viewer into the given menu\r
   /// \param theMenu a popup menu to be shown in the viewer\r
-  virtual void addViewerItems(QMenu* theMenu) const {}\r
+  /// \param theStdActions a map of standard actions\r
+  /// \return true if items are added and there is no necessity to provide standard menu\r
+  virtual bool addViewerItems(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const { return false; }\r
 \r
   /// Add menu atems for object browser into the given menu\r
   /// \param theMenu a popup menu to be shown in the object browser\r
@@ -86,9 +93,8 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   /// \param theWidgetApi the widget configuation. The attribute of the model widget is obtained from\r
   /// \param theParentId is Id of a parent of the current attribute\r
   /// \param theModelWidgets list of widget objects\r
-  virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
-                                      Config_WidgetAPI* theWidgetApi, std::string theParentId,\r
-                                      QList<ModuleBase_ModelWidget*>& theModelWidgets)\r
+  virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
+                                      Config_WidgetAPI* theWidgetApi, std::string theParentId)\r
   {\r
     return 0;\r
   }\r
@@ -100,15 +106,34 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   /// It is called as on clearing of property panel as on filling with new widgets\r
   virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {}\r
 \r
-  /// Returns whether the object can be displayed at the bounds of the active operation.\r
-  /// Display only current operation results\r
+  //! Returns True if there are available Undos and there is not an active operation\r
+  virtual bool canUndo() const;\r
+\r
+  //! Returns True if there are available Redos and there is not an active operation\r
+  virtual bool canRedo() const;\r
+\r
+  /// Returns whether the object can be displayed. The default realization returns true.\r
   /// \param theObject a model object\r
   virtual bool canDisplayObject(const ObjectPtr& theObject) const;\r
 \r
+  /// Reacts to the delete action in module\r
+  /// \returns true if the action is processed\r
+  virtual bool deleteObjects() { return false; };\r
+\r
 public slots:\r
   /// Called on call of command corresponded to a feature\r
   void onFeatureTriggered();\r
 \r
+  /// Slolt called on object display\r
+  /// \param theObject a data object\r
+  /// \param theAIS a presentation object\r
+  virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS) {}\r
+\r
+  /// Slot called on before object erase\r
+  /// \param theObject a data object\r
+  /// \param theAIS a presentation object\r
+  virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS) {}\r
+\r
 protected slots:\r
   /// Called on selection changed event\r
   virtual void onSelectionChanged() {}\r
@@ -116,7 +141,7 @@ protected slots:
  protected:\r
   /// Sends the operation for launching\r
   /// \param theOperation the operation\r
-  void sendOperation(ModuleBase_Operation* theOperation);\r
+  virtual void sendOperation(ModuleBase_Operation* theOperation);\r
 \r
   /// Creates a new operation\r
   /// \param theCmdId the operation name\r
@@ -128,6 +153,9 @@ protected slots:
   /// Register selection filters for this module\r
   virtual void registerFilters() {}\r
 \r
+  /// Register properties of this module\r
+  virtual void registerProperties() {}\r
+\r
   /// Returns new instance of operation object (used in createOperation for customization)\r
   virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);\r
 \r