X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_IModule.h;h=7ba5cfe1e09693d931618d6f73c189f268fdc02e;hb=687f0b60623e1ef3006415af90cc80ad642a2dbf;hp=3bea34002f32817fddaea37358746822060ccc83;hpb=e30796dab1aa68c01201b2b89d4292d3fcbbc4d4;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h index 3bea34002..7ba5cfe1e 100644 --- a/src/ModuleBase/ModuleBase_IModule.h +++ b/src/ModuleBase/ModuleBase_IModule.h @@ -1,71 +1,175 @@ + // Copyright (C) 2014-20xx CEA/DEN, EDF R&D + #ifndef ModuleBase_IModule_H #define ModuleBase_IModule_H -#include "ModuleBase.h" +#include "ModuleBase.h" #include "ModuleBase_IWorkshop.h" +#include + #include #include +#include +#include +#include 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 { + Q_OBJECT public: - ModuleBase_IModule(ModuleBase_IWorkshop* theParent): QObject(theParent), myWorkshop(theParent) {} + /// Constructor + /// \param theParent instance of workshop intrface + ModuleBase_IModule(ModuleBase_IWorkshop* theParent); virtual ~ModuleBase_IModule() {} /// Reads description of features from XML file - virtual void createFeatures() = 0; + virtual void createFeatures(); /// Called on creation of menu item in desktop - virtual void featureCreated(QAction*) = 0; + virtual void actionCreated(QAction*); + + /// 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 /// \param theCmdId the operation name virtual void launchOperation(const QString& theCmdId); + /// Realizes some functionality by an operation start + /// \param theOperation a started operation + virtual void operationStarted(ModuleBase_Operation* theOperation) {} + + /// Realizes some functionality by an operation resume + /// \param theOperation a resumed operation + virtual void operationResumed(ModuleBase_Operation* theOperation) {} + + /// Realizes some functionality by an operation stop + virtual void operationStopped(ModuleBase_Operation* theOperation) {} + + /// Realizes some functionality by an operation commit + virtual void operationCommitted(ModuleBase_Operation* theOperation) {} + + /// 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, - 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() {} + 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& theCmdId, - const std::string& theFeatureKind = "") = 0; + virtual ModuleBase_Operation* createOperation(const std::string& theCmdId); + + /// Register validators for this module + virtual void registerValidators() {} + + /// 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; }; + + //! This function must return a new module instance. extern "C" { typedef ModuleBase_IModule* (*CREATE_FUNC)(ModuleBase_IWorkshop*);