-#ifndef ModuleBase_IModule_H
-#define ModuleBase_IModule_H
-
-#include "ModuleBase.h"
-#include "ModuleBase_IWorkshop.h"
-
-#include <QString>
-#include <QObject>
-
-
-class QAction;
+// 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 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
- /// 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
-
- 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
+class QMenu;\r
+class Config_WidgetAPI;\r
+class ModuleBase_ModelWidget;\r
+class ModuleBase_Operation;\r
+class ModuleBase_IWorkshop;\r
+\r
+/**\r
+ * \ingroup GUI\r
+ * Interface to a module\r
+ */\r
+class MODULEBASE_EXPORT ModuleBase_IModule : public QObject\r
+{\r
+ Q_OBJECT\r
+ public:\r
+\r
+ /// Constructor\r
+ /// \param theParent instance of workshop intrface\r
+ ModuleBase_IModule(ModuleBase_IWorkshop* theParent);\r
+\r
+ virtual ~ModuleBase_IModule() {}\r
+\r
+ /// Reads description of features from XML file \r
+ virtual void createFeatures();\r
+\r
+ /// Called on creation of menu item in desktop\r
+ virtual void actionCreated(QAction*);\r
+\r
+ /// Launching of a edit operation on the feature \r
+ /// \param theFeature 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);\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
+ /// 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
+\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
+ virtual void addObjectBrowserItems(QMenu* theMenu) const {};\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
+ /// \param theType a type of widget\r
+ /// \param theParent the parent object\r
+ /// \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 ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
+ Config_WidgetAPI* theWidgetApi, std::string theParentId)\r
+ {\r
+ return 0;\r
+ }\r
+\r
+ /// Returns current workshop\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
+ //! 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 at the bounds of the active operation.\r
+ /// Display only current operation results\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
+protected slots:\r
+ /// Called on selection changed event\r
+ virtual void onSelectionChanged() {}\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
+ virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);\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
+ /// 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
+protected:\r
+\r
+ /// Reference to workshop\r
+ ModuleBase_IWorkshop* myWorkshop;\r
+\r
+ /// Map of features in XML\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)(ModuleBase_IWorkshop*);\r
+}\r
+\r
+#define CREATE_MODULE "createModule"\r
+\r
+#endif //ModuleBase_IModule\r
