+ // 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
+#include <QMap>\r
\r
+#include <string>\r
+#include <map>\r
\r
class QAction;\r
class QMouseEvent;\r
class QKeyEvent;\r
+class QMenu;\r
class Config_WidgetAPI;\r
class ModuleBase_ModelWidget;\r
class ModuleBase_Operation;\r
class ModuleBase_IWorkshop;\r
+class ModuleBase_IDocumentDataModel;\r
\r
/**\r
+ * \ingroup GUI\r
* Interface to a module\r
*/\r
class MODULEBASE_EXPORT ModuleBase_IModule : public QObject\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() = 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
+ /// 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
+ /// 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
+ /// \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 addViewerMenu(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
+ virtual void addObjectBrowserMenu(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
- virtual QWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
- Config_WidgetAPI* theWidgetApi,\r
- QList<ModuleBase_ModelWidget*>& theModelWidgets)\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
-protected slots:\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. The default realization returns true.\r
+ /// \param theObject a model object\r
+ virtual bool canDisplayObject(const ObjectPtr& theObject) const;\r
\r
+ /// Returns true if selection for the object can be activate.\r
+ /// By default a result or feature of the current operation can not be activated\r
+ /// \param theObject a model object\r
+ virtual bool canActivateSelection(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
+ /// Returns data model object for representation of data tree in Object browser\r
+ virtual ModuleBase_IDocumentDataModel* dataModel() const = 0;\r
+\r
+ /// Returns a list of modes, where the AIS objects should be activated\r
+ /// \param theModes a list of modes\r
+ virtual void activeSelectionModes(QIntList& theModes) {}\r
+\r
+ /// This method is called on object browser creation for customisation of module specific features\r
+ /// \param theObjectBrowser a pinter on Object Browser widget\r
+ virtual void customizeObjectBrowser(QWidget* theObjectBrowser) {}\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
\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
+ virtual 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& theCmdId,\r
- const std::string& theFeatureKind = "") = 0;\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
