Salome HOME
Merge branch 'master' of newgeom:newgeom
[modules/shaper.git] / src / ModuleBase / ModuleBase_IModule.h
index df599f4164206b737eda23c0387b74f14cc1e11b..5787ccfb09989d5aa62afee6753a0117fc91b384 100644 (file)
-#ifndef ModuleBase_IModule_H\r
-#define ModuleBase_IModule_H\r
+#ifndef ModuleBase_IModule_H
+#define ModuleBase_IModule_H
+
+#include "ModuleBase.h"
+#include "ModuleBase_IWorkshop.h"
+
+#include <QString>
+#include <QObject>
+
+
+class QAction;
+class QMouseEvent;\r
+class QKeyEvent;\r
+class Config_WidgetAPI;
+class ModuleBase_ModelWidget;
+class ModuleBase_Operation;
+class ModuleBase_IWorkshop;
+
+/**
+ * Interface to a module
+ */
+class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
+{
+  Q_OBJECT
+ public:
+
+   ModuleBase_IModule(ModuleBase_IWorkshop* theParent);
+
+  virtual ~ModuleBase_IModule() {}
+
+  /// Reads description of features from XML file 
+  virtual void createFeatures() = 0;
+
+  /// Called on creation of menu item in desktop
+  virtual void featureCreated(QAction*) = 0;
+
+  /// Creates an operation and send it to loop
+  /// \param theCmdId the operation name
+  virtual void launchOperation(const QString& theCmdId);
+
+  /// Called when it is necessary to update a command state (enable or disable it)
+  //virtual bool isFeatureEnabled(const QString& theCmdId) const = 0;
+
+  /// Creates custom widgets for property panel
+  virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent,
+                                      Config_WidgetAPI* theWidgetApi,
+                                      QList<ModuleBase_ModelWidget*>& theModelWidgets)
+  {
+    return 0;
+  }
+
+  ModuleBase_IWorkshop* workshop() const { return myWorkshop; }
+
+protected slots:
+
+  /// Called on selection changed event
+  virtual void onSelectionChanged() {}
+
+  /// SLOT, that is called by mouse press in the viewer.\r
+  /// The mouse released point is sent to the current operation to be processed.\r
+  /// \param theEvent the mouse event\r
+  virtual void onMousePressed(QMouseEvent* theEvent) {}\r
 \r
-#include <QString>\r
-#include <QObject>\r
+  /// SLOT, that is called by mouse release in the viewer.\r
+  /// The mouse released point is sent to the current operation to be processed.\r
+  /// \param theEvent the mouse event\r
+  virtual void onMouseReleased(QMouseEvent* theEvent) {}\r
+  \r
+  /// SLOT, that is called by mouse move in the viewer.\r
+  /// The mouse moved point is sent to the current operation to be processed.\r
+  /// \param theEvent the mouse event\r
+  virtual void onMouseMoved(QMouseEvent* theEvent) {}\r
 \r
-class QAction;\r
-class XGUI_Workshop;\r
-class Config_WidgetAPI;\r
-class ModuleBase_ModelWidget;\r
+  /// SLOT, that is called by the mouse double click in the viewer.\r
+  /// \param theEvent the mouse event\r
+  virtual void onMouseDoubleClick(QMouseEvent* theEvent) {}\r
 \r
-/**\r
- * Interface to a module\r
- */\r
-class ModuleBase_IModule : public QObject\r
-{\r
- public:\r
-  /// Reads description of features from XML file \r
-  virtual void createFeatures() = 0;\r
-\r
-  /// Called on creation of menu item in desktop\r
-  virtual void featureCreated(QAction*) = 0;\r
-\r
-  /// Creates an operation and send it to loop\r
-  /// \param theCmdId the operation name\r
-  virtual void launchOperation(const QString& theCmdId) = 0;\r
-\r
-  /// Called when it is necessary to update a command state (enable or disable it)\r
-  //virtual bool isFeatureEnabled(const QString& theCmdId) const = 0;\r
-\r
-  /// Creates custom widgets for property panel\r
-  virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
-                                      Config_WidgetAPI* theWidgetApi,\r
-                                      QList<ModuleBase_ModelWidget*>& theModelWidgets)\r
-  {\r
-    return 0;\r
-  }\r
-\r
-  virtual ~ModuleBase_IModule()\r
-  {\r
-  }\r
-  ;\r
-};\r
-\r
-//! This function must return a new module instance.\r
-extern "C" {\r
-typedef ModuleBase_IModule* (*CREATE_FUNC)(XGUI_Workshop*);\r
-}\r
-\r
-#define CREATE_MODULE "createModule"\r
-\r
-#endif //ModuleBase_IModule\r
+  /// SLOT, that is called by the key in the viewer is clicked.\r
+  /// \param theEvent the mouse event\r
+  virtual void onKeyRelease(QKeyEvent* theEvent) {}\r
+
+ protected:
+  /// Sends the operation for launching
+  /// \param theOperation the operation
+  void sendOperation(ModuleBase_Operation* theOperation);
+
+  /// Creates a new operation
+  /// \param theCmdId the operation name
+  /// \param theFeatureKind a kind of feature to get the feature xml description
+  virtual ModuleBase_Operation* createOperation(const std::string& theCmdId,
+                                        const std::string& theFeatureKind = "") = 0;
+
+
+protected:
+
+  ModuleBase_IWorkshop* myWorkshop;
+
+};
+
+//! This function must return a new module instance.
+extern "C" {
+typedef ModuleBase_IModule* (*CREATE_FUNC)(ModuleBase_IWorkshop*);
+}
+
+#define CREATE_MODULE "createModule"
+
+#endif //ModuleBase_IModule