X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_IModule.h;h=ac70964372e9bc16625a6602e8d3bb868a4fcbbf;hb=3205d0f18200948632155bbe7b640bc1e482243d;hp=5703bb3c068b09a228f3475cf0ca058a1e6fc380;hpb=7bf19255421b34594c7b0a76d0ce28166d0ce895;p=modules%2Fshaper.git diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h old mode 100644 new mode 100755 index 5703bb3c0..ac7096437 --- 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,17 +33,26 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject Q_OBJECT public: + /// Constructor + /// \param theParent instance of workshop interface ModuleBase_IModule(ModuleBase_IWorkshop* theParent); virtual ~ModuleBase_IModule() {} + /// Add default selection filters of the module to the current viewer + virtual void activateSelectionFilters() {}; + + /// Remove default selection filters of the module from the current viewer + virtual void deactivateSelectionFilters() {}; + /// Reads description of features from XML file virtual void createFeatures(); /// 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 @@ -52,8 +64,9 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject virtual void operationStarted(ModuleBase_Operation* theOperation) {} /// Realizes some functionality by an operation resume + /// By default it emits operationResumed signal /// \param theOperation a resumed operation - virtual void operationResumed(ModuleBase_Operation* theOperation) {} + virtual void operationResumed(ModuleBase_Operation* theOperation); /// Realizes some functionality by an operation stop virtual void operationStopped(ModuleBase_Operation* theOperation) {} @@ -64,75 +77,189 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject /// Realizes some functionality by an operation abort virtual void operationAborted(ModuleBase_Operation* theOperation) {} - /// 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 + virtual ModuleBase_Operation* currentOperation() const = 0; + + /// Add menu items 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 addViewerMenu(QMenu* theMenu, const QMap& theStdActions) const { return false; } + + /// Add menu items for object browser into the given menu + /// \param theMenu a popup menu to be shown in the object browser + virtual void addObjectBrowserMenu(QMenu* theMenu) const {}; /// 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 configuration. The attribute of the model widget is obtained from + /// \param theParentId is Id of a parent of the current attribute + virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent, + Config_WidgetAPI* theWidgetApi, std::string theParentId) { return 0; } + /// Returns the active widget, by default it is the property panel active widget + virtual ModuleBase_ModelWidget* activeWidget() const = 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) {} -public slots: - void onFeatureTriggered(); + //! Returns True if there are available Undos and there is not an active operation + virtual bool canUndo() const; -protected slots: - /// Called on selection changed event - virtual void onSelectionChanged() {} + //! Returns True if there are available Redos and there is not an active operation + virtual bool canRedo() const; - /// 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) {} + /// Returns true if the action can be applyed to the object + /// \param theObject a checked object + /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD" + /// \return the a boolean result + virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const = 0; - protected: - /// Sends the operation for launching - /// \param theOperation the operation - void sendOperation(ModuleBase_Operation* theOperation); + /// Returns True if the current operation can be committed. By default it is true. + /// \return a boolean value + //virtual bool canCommitOperation() const; + + /// Returns whether the object can be erased. The default realization returns true. + /// \param theObject a model object + virtual bool canEraseObject(const ObjectPtr& theObject) 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; + + /// Returns true if selection for the object can be activate. + /// By default a result or feature of the current operation can not be activated + /// \param theObject a model object + virtual bool canActivateSelection(const ObjectPtr& theObject) const; + + /// Reacts to the delete action in module + /// \returns true if the action is processed + virtual bool deleteObjects() { return false; }; + + /// Performs functionality on closing document + virtual void closeDocument() = 0; + + /// Clears specific presentations in the viewer + virtual void clearViewer() = 0; + + /// Returns a list of modes, where the AIS objects should be activated + /// \param theModes a list of modes + virtual void activeSelectionModes(QIntList& theModes) {} + + /** Update the object presentable properties such as color, lines width and other + * If the object is result with the color attribute value set, it is used, + * otherwise the customize is applyed to the object's feature if it is a custom prs + * \param theObject an object instance + * \param theUpdateViewer the parameter whether the viewer should be update immediately + * \returns true if the object is modified + */ + virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer); + + /// This method is called on object browser creation for customization of module specific features + /// \param theObjectBrowser a pinter on Object Browser widget + virtual void customizeObjectBrowser(QWidget* theObjectBrowser) {} /// 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); + + /// Sends the operation for launching + /// \param theOperation the operation + virtual void sendOperation(ModuleBase_Operation* theOperation); + + //! Returns data object by AIS + virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0; + + /// Update state of pop-up menu items in object browser + /// \param theStdActions - a map of standard actions + virtual void updateObjectBrowserMenu(const QMap& theStdActions) {} + + /// Update state of pop-up menu items in viewer + /// \param theStdActions - a map of standard actions + virtual void updateViewerMenu(const QMap& theStdActions) {} + + //! Returns the feature error if the current state of the feature in the module is not correct + //! If the feature is correct, it returns an empty value + //! \return string value + virtual QString getFeatureError(const FeaturePtr& theFeature); + + /// Returns list of granted operation indices + virtual void grantedOperationIds(ModuleBase_Operation* theOperation, QStringList& theIds) const; + + /// Connects or disconnects to the value changed signal of the property panel widgets + /// \param theWidget a property contol widget + /// \param isToConnect a boolean value whether connect or disconnect + virtual void connectToPropertyPanel(ModuleBase_ModelWidget* theWidget, const bool isToConnect) {}; + + /// Validates the operation to change the "Apply" button state. + /// \param thePreviousState the previous state of the widget + virtual void widgetStateChanged(int thePreviousState) {}; + + /// Returns true if the event is processed. + /// \param thePreviousAttributeID an index of the previous active attribute + virtual bool processEnter(const std::string& thePreviousAttributeID) { return false; }; + + /// Performs some GUI actions after an operation transaction is opened + /// Default realization is empty + virtual void beforeOperationStarted(ModuleBase_Operation* theOperation) {}; + + /// Performs some GUI actions before an operation transaction is stopped + /// Default realization is empty + virtual void beforeOperationStopped(ModuleBase_Operation* theOperation) {}; + +signals: + /// Signal which is emitted when operation is launched + void operationLaunched(); + /// Segnal emitted when an operation is resumed + /// \param theOp a resumed operation + void resumed(ModuleBase_Operation* theOp); + +public slots: + /// Called on call of command corresponded to a feature + virtual void onFeatureTriggered(); + + /// Slot 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: /// 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; };