X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_IModule.h;h=7ba5cfe1e09693d931618d6f73c189f268fdc02e;hb=687f0b60623e1ef3006415af90cc80ad642a2dbf;hp=5703bb3c068b09a228f3475cf0ca058a1e6fc380;hpb=f1cd93fd02a54259f72e3191d037323a496b2bef;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h index 5703bb3c0..7ba5cfe1e 100644 --- a/src/ModuleBase/ModuleBase_IModule.h +++ b/src/ModuleBase/ModuleBase_IModule.h @@ -1,4 +1,4 @@ -// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // Copyright (C) 2014-20xx CEA/DEN, EDF R&D #ifndef ModuleBase_IModule_H #define ModuleBase_IModule_H @@ -10,6 +10,7 @@ #include #include +#include #include #include @@ -17,12 +18,14 @@ class QAction; class QMouseEvent; class QKeyEvent; +class QMenu; class Config_WidgetAPI; class ModuleBase_ModelWidget; class ModuleBase_Operation; class ModuleBase_IWorkshop; /** + * \ingroup GUI * Interface to a module */ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject @@ -30,6 +33,8 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject Q_OBJECT public: + /// Constructor + /// \param theParent instance of workshop intrface ModuleBase_IModule(ModuleBase_IWorkshop* theParent); virtual ~ModuleBase_IModule() {} @@ -40,7 +45,8 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// Called on creation of menu item in desktop virtual void actionCreated(QAction*); - /// Called when user selects feature for editing + /// Launching of a edit operation on the feature + /// \param theFeature feature for editing virtual void editFeature(FeaturePtr theFeature); /// Creates an operation and send it to loop @@ -64,62 +70,82 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// Realizes some functionality by an operation abort virtual void operationAborted(ModuleBase_Operation* theOperation) {} + /// Realizes some functionality by an operation start + /// \param theOperation a started operation + virtual ModuleBase_Operation* currentOperation() const = 0; + + /// Add menu atems for viewer into the given menu + /// \param theMenu a popup menu to be shown in the viewer + /// \param theStdActions a map of standard actions + /// \return true if items are added and there is no necessity to provide standard menu + virtual bool addViewerItems(QMenu* theMenu, const QMap& theStdActions) const { return false; } + + /// Add menu atems for object browser into the given menu + /// \param theMenu a popup menu to be shown in the object browser + virtual void addObjectBrowserItems(QMenu* theMenu) const {}; + /// 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, std::string theParentId, - QList& theModelWidgets) + /// \param theType a type of widget + /// \param theParent the parent object + /// \param theWidgetApi the widget configuation. The attribute of the model widget is obtained from + /// \param theParentId is Id of a parent of the current attribute + /// \param theModelWidgets list of widget objects + virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent, + Config_WidgetAPI* theWidgetApi, std::string theParentId) { return 0; } + /// Returns current workshop ModuleBase_IWorkshop* workshop() const { return myWorkshop; } /// Call back forlast tuning of property panel before operation performance /// It is called as on clearing of property panel as on filling with new widgets virtual void propertyPanelDefined(ModuleBase_Operation* theOperation) {} + //! Returns True if there are available Undos and there is not an active operation + virtual bool canUndo() const; + + //! Returns True if there are available Redos and there is not an active operation + virtual bool canRedo() const; + + /// Returns whether the object can be displayed. The default realization returns true. + /// \param theObject a model object + virtual bool canDisplayObject(const ObjectPtr& theObject) const; + + /// Reacts to the delete action in module + /// \returns true if the action is processed + virtual bool deleteObjects() { return false; }; + public slots: + /// Called on call of command corresponded to a feature void onFeatureTriggered(); + /// Slolt called on object display + /// \param theObject a data object + /// \param theAIS a presentation object + virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS) {} + + /// Slot called on before object erase + /// \param theObject a data object + /// \param theAIS a presentation object + virtual void onBeforeObjectErase(ObjectPtr theObject, AISObjectPtr theAIS) {} + protected slots: /// Called on selection changed event virtual void onSelectionChanged() {} - /// SLOT, that is called by mouse press in the viewer. - /// The mouse released point is sent to the current operation to be processed. - /// \param theEvent the mouse event - //virtual void onMousePressed(QMouseEvent* theEvent) {} - - /// SLOT, that is called by mouse release in the viewer. - /// The mouse released point is sent to the current operation to be processed. - /// \param theEvent the mouse event - //virtual void onMouseReleased(QMouseEvent* theEvent) {} - - /// SLOT, that is called by mouse move in the viewer. - /// The mouse moved point is sent to the current operation to be processed. - /// \param theEvent the mouse event - //virtual void onMouseMoved(QMouseEvent* theEvent) {} - - /// SLOT, that is called by the mouse double click in the viewer. - /// \param theEvent the mouse event - //virtual void onMouseDoubleClick(QMouseEvent* theEvent) {} - - /// SLOT, that is called by the key in the viewer is clicked. - /// \param theEvent the mouse event - //virtual void onKeyRelease(QKeyEvent* theEvent) {} - protected: /// Sends the operation for launching /// \param theOperation the operation - void sendOperation(ModuleBase_Operation* theOperation); + virtual 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& theFeatureId); + virtual ModuleBase_Operation* createOperation(const std::string& theCmdId); /// Register validators for this module virtual void registerValidators() {} @@ -127,12 +153,18 @@ protected slots: /// Register selection filters for this module virtual void registerFilters() {} + /// Register properties of this module + virtual void registerProperties() {} + /// Returns new instance of operation object (used in createOperation for customization) virtual ModuleBase_Operation* getNewOperation(const std::string& theFeatureId); protected: + /// Reference to workshop ModuleBase_IWorkshop* myWorkshop; + + /// Map of features in XML std::map myFeaturesInFiles; };