-// 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
\r
#include <QString>\r
#include <QObject>\r
+#include <QMap>\r
\r
#include <string>\r
#include <map>\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
\r
virtual ~ModuleBase_IModule() {}\r
\r
+ // Add default selection filters of the module to the current viewer\r
+ virtual void activateSelectionFilters() {};\r
+\r
+ // Remove default selection filters of the module from the current viewer\r
+ virtual void deactivateSelectionFilters() {};\r
+\r
/// Reads description of features from XML file \r
virtual void createFeatures();\r
\r
\r
/// Realizes some functionality by an operation start\r
/// \param theOperation a started operation\r
- virtual void operationStarted(ModuleBase_Operation* theOperation) {}\r
+ virtual void onOperationStarted(ModuleBase_Operation* theOperation) {}\r
\r
/// Realizes some functionality by an operation resume\r
+ /// By default it emits operationResumed signal\r
/// \param theOperation a resumed operation\r
- virtual void operationResumed(ModuleBase_Operation* theOperation) {}\r
+ virtual void onOperationResumed(ModuleBase_Operation* theOperation);\r
\r
/// Realizes some functionality by an operation stop\r
- virtual void operationStopped(ModuleBase_Operation* theOperation) {}\r
+ virtual void onOperationStopped(ModuleBase_Operation* theOperation) {}\r
\r
/// Realizes some functionality by an operation commit\r
- virtual void operationCommitted(ModuleBase_Operation* theOperation) {}\r
+ virtual void onOperationCommitted(ModuleBase_Operation* theOperation) {}\r
\r
/// Realizes some functionality by an operation abort\r
- virtual void operationAborted(ModuleBase_Operation* theOperation) {}\r
+ virtual void onOperationAborted(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
/// \param theType a type of widget\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 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
/// 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
+ /// Returnas true if the action can be applyed to the object\r
+ /// \param theObject a checked object\r
+ /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"\r
+ /// \return the a booean result\r
+ virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const = 0;\r
+\r
+ /// Returns True if the current operation can be committed. By default it is true.\r
+ /// \return a boolean value\r
+ virtual bool canCommitOperation() const;\r
+\r
+ /// Returns whether the object can be erased. The default realization returns true.\r
+ /// \param theObject a model object\r
+ virtual bool canEraseObject(const ObjectPtr& theObject) 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
+ /// Performs functionality on closing document\r
+ virtual void closeDocument() = 0;\r
+\r
+ /// Clears specific presentations in the viewer\r
+ virtual void clearViewer() = 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
+ /** Update the object presentable properties such as color, lines width and other\r
+ * If the object is result with the color attribute value set, it is used,\r
+ * otherwise the customize is applyed to the object's feature if it is a custom prs\r
+ * \param theObject an object instance\r
+ * \param theUpdateViewer the parameter whether the viewer should be update immediatelly\r
+ * \returns true if the object is modified\r
+ */\r
+ virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer);\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
+ /// Creates a new operation\r
+ /// \param theCmdId the operation name\r
+ virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);\r
+\r
+ /// Sends the operation for launching\r
+ /// \param theOperation the operation\r
+ virtual void sendOperation(ModuleBase_Operation* theOperation);\r
+\r
+ //! Returns data object by AIS\r
+ virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;\r
+\r
+ /// Update state of pop-up menu items in object browser\r
+ /// \param theStdActions - a map of standard actions\r
+ virtual void updateObjectBrowserMenu(const QMap<QString, QAction*>& theStdActions) {}\r
+\r
+ /// Update state of pop-up menu items in viewer\r
+ /// \param theStdActions - a map of standard actions\r
+ virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions) {}\r
+\r
+signals:\r
+ void operationLaunched();\r
+\r
+ void operationResumed(ModuleBase_Operation* theOp);\r
+\r
public slots:\r
/// Called on call of command corresponded to a feature\r
- void onFeatureTriggered();\r
+ virtual 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
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
