X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_IModule.h;h=9420d1e74d8818724ca2547c8e02fb9a9a5213a4;hb=a2982d2108f929cf9e7f996cfd590c4ce59dc21c;hp=f6219675ce0679430ddbf3b878941ebd066d933d;hpb=24d4e1ff00e9d7fa972e06ed325122550a12d450;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h index f6219675c..9420d1e74 100644 --- a/src/ModuleBase/ModuleBase_IModule.h +++ b/src/ModuleBase/ModuleBase_IModule.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + #ifndef ModuleBase_IModule_H #define ModuleBase_IModule_H @@ -21,6 +23,7 @@ class ModuleBase_Operation; class ModuleBase_IWorkshop; /** + * \ingroup GUI * Interface to a module */ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject @@ -28,6 +31,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() {} @@ -38,17 +43,37 @@ 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 /// \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; + /// 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) {} /// Creates custom widgets for property panel + /// \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 QWidget* createWidgetByType(const std::string& theType, QWidget* theParent, Config_WidgetAPI* theWidgetApi, std::string theParentId, QList& theModelWidgets) @@ -56,56 +81,26 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject 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 whether the object can be displayed at the bounds of the active operation. + /// Display only current operation results + /// \param theObject a model object + virtual bool canDisplayObject(const ObjectPtr& theObject) const; + public slots: + /// Called on call of command corresponded to a feature void onFeatureTriggered(); protected slots: - /// SLOT, that is called after the operation is started. Connect on the focus activated signal - virtual void onOperationStarted(ModuleBase_Operation* theOperation) {} - - /// SLOT, that is called after the operation is stopped. Switched off the modfications performed - /// by the operation start - virtual void onOperationStopped(ModuleBase_Operation* theOperation) {} - - virtual void onOperationResumed(ModuleBase_Operation* theOperation) {} - - virtual void onOperationComitted(ModuleBase_Operation* theOperation) {} - - virtual void onOperationAborted(ModuleBase_Operation* theOperation) {} - - /// 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 @@ -113,8 +108,7 @@ protected slots: /// 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,7 +121,10 @@ protected slots: protected: + /// Reference to workshop ModuleBase_IWorkshop* myWorkshop; + + /// Map of features in XML std::map myFeaturesInFiles; };