+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D\r
+\r
#ifndef ModuleBase_IModule_H\r
#define ModuleBase_IModule_H\r
\r
class ModuleBase_IWorkshop;\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
/// Called on creation of menu item in desktop\r
virtual void actionCreated(QAction*);\r
\r
- /// Called when user selects feature for editing\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
- /// Called when it is necessary to update a command state (enable or disable it)\r
- //virtual bool isFeatureEnabled(const QString& theCmdId) const = 0;\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
/// Creates custom widgets for property panel\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 QWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
Config_WidgetAPI* theWidgetApi, std::string theParentId,\r
QList<ModuleBase_ModelWidget*>& theModelWidgets)\r
return 0;\r
}\r
\r
+ /// Returns current workshop\r
ModuleBase_IWorkshop* workshop() const { return myWorkshop; }\r
\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 whether the object can be displayed at the bounds of the active operation.\r
+ /// Display only current operation results\r
+ /// \param theObject a model object\r
+ virtual bool canDisplayObject(const ObjectPtr& theObject) const;\r
+\r
public slots:\r
+ /// Called on call of command corresponded to a feature\r
void onFeatureTriggered();\r
\r
protected slots:\r
- /// SLOT, that is called after the operation is started. Connect on the focus activated signal\r
- virtual void onOperationStarted(ModuleBase_Operation* theOperation) {}\r
- \r
- /// SLOT, that is called after the operation is stopped. Switched off the modfications performed\r
- /// by the operation start\r
- virtual void onOperationStopped(ModuleBase_Operation* theOperation) {}\r
-\r
- virtual void onOperationResumed(ModuleBase_Operation* theOperation) {}\r
-\r
- virtual void onOperationComitted(ModuleBase_Operation* theOperation) {}\r
-\r
- virtual void onOperationAborted(ModuleBase_Operation* theOperation) {}\r
-\r
-\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
\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& theFeatureId);\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
+
+ /// Register properties of this module
+ virtual void registerProperties() {}
+\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