+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
+\r
#ifndef ModuleBase_IModule_H\r
#define ModuleBase_IModule_H\r
\r
+#include "ModuleBase.h"\r
+#include "ModuleBase_IWorkshop.h"\r
+\r
+#include <ModelAPI_Feature.h>\r
+\r
#include <QString>\r
#include <QObject>\r
\r
+#include <string>\r
+#include <map>\r
+\r
class QAction;\r
-class XGUI_Workshop;\r
+class QMouseEvent;\r
+class QKeyEvent;\r
class Config_WidgetAPI;\r
class ModuleBase_ModelWidget;\r
+class ModuleBase_Operation;\r
+class ModuleBase_IWorkshop;\r
\r
/**\r
* Interface to a module\r
*/\r
-class ModuleBase_IModule : public QObject\r
+class MODULEBASE_EXPORT ModuleBase_IModule : public QObject\r
{\r
+ Q_OBJECT\r
public:\r
+\r
+ ModuleBase_IModule(ModuleBase_IWorkshop* theParent);\r
+\r
+ virtual ~ModuleBase_IModule() {}\r
+\r
/// Reads description of features from XML file \r
- virtual void createFeatures() = 0;\r
+ virtual void createFeatures();\r
\r
/// Called on creation of menu item in desktop\r
- virtual void featureCreated(QAction*) = 0;\r
+ virtual void actionCreated(QAction*);\r
+\r
+ /// Called when user selects feature for editing\r
+ virtual void editFeature(FeaturePtr theFeature);\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
+ virtual void launchOperation(const QString& theCmdId);\r
+\r
+ /// Realizes some functionality by an operation start\r
+ /// \param theOperation a started operation\r
+ virtual void operationStarted(ModuleBase_Operation* theOperation) {}\r
+\r
+ /// Realizes some functionality by an operation resume\r
+ /// \param theOperation a resumed operation\r
+ virtual void operationResumed(ModuleBase_Operation* theOperation) {}\r
+\r
+ /// Realizes some functionality by an operation stop\r
+ virtual void operationStopped(ModuleBase_Operation* theOperation) {}\r
+\r
+ /// Realizes some functionality by an operation commit\r
+ virtual void operationCommitted(ModuleBase_Operation* theOperation) {}\r
+\r
+ /// Realizes some functionality by an operation abort\r
+ virtual void operationAborted(ModuleBase_Operation* theOperation) {}\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
+ Config_WidgetAPI* theWidgetApi, std::string theParentId,\r
QList<ModuleBase_ModelWidget*>& theModelWidgets)\r
{\r
return 0;\r
}\r
\r
- virtual ~ModuleBase_IModule()\r
- {\r
- }\r
- ;\r
+ ModuleBase_IWorkshop* workshop() const { return myWorkshop; }\r
+\r
+ /// Call back forlast tuning of property panel before operation performance\r
+ /// It is called as on clearing of property panel as on filling with new widgets\r
+ virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {}\r
+\r
+public slots:\r
+ void onFeatureTriggered();\r
+\r
+protected slots:\r
+ /// Called on selection changed event\r
+ virtual void onSelectionChanged() {}\r
+\r
+ /// 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
+ /// 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
+ /// 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
+ /// 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
+\r
+ protected:\r
+ /// Sends the operation for launching\r
+ /// \param theOperation the operation\r
+ void sendOperation(ModuleBase_Operation* theOperation);\r
+\r
+ /// Creates a new operation\r
+ /// \param theCmdId the operation name\r
+ /// \param theFeatureKind a kind of feature to get the feature xml description\r
+ virtual ModuleBase_Operation* createOperation(const std::string& theFeatureId);\r
+\r
+ /// Register validators for this module\r
+ virtual void registerValidators() {}\r
+\r
+ /// Register selection filters for this module\r
+ virtual void registerFilters() {}\r
+\r
+ /// Returns new instance of operation object (used in createOperation for customization)\r
+ virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId);\r
+\r
+protected:\r
+\r
+ ModuleBase_IWorkshop* myWorkshop;\r
+ std::map<std::string, std::string> myFeaturesInFiles;\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
+typedef ModuleBase_IModule* (*CREATE_FUNC)(ModuleBase_IWorkshop*);\r
}\r
\r
#define CREATE_MODULE "createModule"\r
