Salome HOME
Spell-checking
[modules/shaper.git] / src / ModuleBase / ModuleBase_IModule.h
index 1b3081dd976012fba8772e83870c09b9500b76f7..a482586078a557b85c3f94bdac403013e1377155 100644 (file)
@@ -40,6 +40,12 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
 \r
   virtual ~ModuleBase_IModule() {}\r
 \r
+  // Add default selection filters of the module to the current viewer\r
+  virtual void activateSelectionFilters() {};\r
+\r
+  // Remove default selection filters of the module from the current viewer\r
+  virtual void deactivateSelectionFilters() {};\r
+\r
   /// Reads description of features from XML file \r
   virtual void createFeatures();\r
 \r
@@ -56,20 +62,21 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
 \r
   /// Realizes some functionality by an operation start\r
   /// \param theOperation a started operation\r
-  virtual void operationStarted(ModuleBase_Operation* theOperation) {}\r
+  virtual void onOperationStarted(ModuleBase_Operation* theOperation) {}\r
 \r
   /// Realizes some functionality by an operation resume\r
+  /// By default it emits operationResumed signal\r
   /// \param theOperation a resumed operation\r
-  virtual void operationResumed(ModuleBase_Operation* theOperation) {}\r
+  virtual void onOperationResumed(ModuleBase_Operation* theOperation);\r
 \r
   /// Realizes some functionality by an operation stop\r
-  virtual void operationStopped(ModuleBase_Operation* theOperation) {}\r
+  virtual void onOperationStopped(ModuleBase_Operation* theOperation) {}\r
 \r
   /// Realizes some functionality by an operation commit\r
-  virtual void operationCommitted(ModuleBase_Operation* theOperation) {}\r
+  virtual void onOperationCommitted(ModuleBase_Operation* theOperation) {}\r
 \r
   /// Realizes some functionality by an operation abort\r
-  virtual void operationAborted(ModuleBase_Operation* theOperation) {}\r
+  virtual void onOperationAborted(ModuleBase_Operation* theOperation) {}\r
 \r
   /// Realizes some functionality by an operation start\r
   /// \param theOperation a started operation\r
@@ -113,10 +120,29 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   //! Returns True if there are available Redos and there is not an active operation\r
   virtual bool canRedo() const;\r
 \r
+  /// Returnas true if the action can be applyed to the object\r
+  /// \param theObject a checked object\r
+  /// \param theActionId an identifier of action, to be found in the menu manager like "DELETE_CMD"\r
+  /// \return the a booean result\r
+  virtual bool canApplyAction(const ObjectPtr& theObject, const QString& theActionId) const = 0;\r
+\r
+  /// Returns True if the current operation can be committed. By default it is true.\r
+  /// \return a boolean value\r
+  virtual bool canCommitOperation() const;\r
+\r
+  /// Returns whether the object can be erased. The default realization returns true.\r
+  /// \param theObject a model object\r
+  virtual bool canEraseObject(const ObjectPtr& theObject) const;\r
+\r
   /// Returns whether the object can be displayed. The default realization returns true.\r
   /// \param theObject a model object\r
   virtual bool canDisplayObject(const ObjectPtr& theObject) const;\r
 \r
+  /// Returns true if selection for the object can be activate.\r
+  /// By default a result or feature of the current operation can not be activated\r
+  /// \param theObject a model object\r
+  virtual bool canActivateSelection(const ObjectPtr& theObject) const;\r
+\r
   /// Reacts to the delete action in module\r
   /// \returns true if the action is processed\r
   virtual bool deleteObjects() { return false; };\r
@@ -124,17 +150,56 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   /// Returns data model object for representation of data tree in Object browser\r
   virtual ModuleBase_IDocumentDataModel* dataModel() const = 0;\r
 \r
+  /// Performs functionality on closing document\r
+  virtual void closeDocument() = 0;\r
+\r
+  /// Clears specific presentations in the viewer\r
+  virtual void clearViewer() = 0;\r
+\r
   /// Returns a list of modes, where the AIS objects should be activated\r
   /// \param theModes a list of modes\r
   virtual void activeSelectionModes(QIntList& theModes) {}\r
 \r
+  /** Update the object presentable properties such as color, lines width and other\r
+  * If the object is result with the color attribute value set, it is used,\r
+  * otherwise the customize is applyed to the object's feature if it is a custom prs\r
+  * \param theObject an object instance\r
+  * \param theUpdateViewer the parameter whether the viewer should be update immediatelly\r
+  * \returns true if the object is modified\r
+  */\r
+  virtual bool customizeObject(ObjectPtr theObject, const bool theUpdateViewer);\r
+\r
   /// This method is called on object browser creation for customisation of module specific features\r
   /// \param theObjectBrowser a pinter on Object Browser widget\r
   virtual void customizeObjectBrowser(QWidget* theObjectBrowser) {}\r
 \r
+  /// Creates a new operation\r
+  /// \param theCmdId the operation name\r
+  virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);\r
+\r
+  /// Sends the operation for launching\r
+  /// \param theOperation the operation\r
+  virtual void sendOperation(ModuleBase_Operation* theOperation);\r
+\r
+  //! Returns data object by AIS\r
+  virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;\r
+\r
+  /// Update state of pop-up menu items in object browser\r
+  /// \param theStdActions - a map of standard actions\r
+  virtual void updateObjectBrowserMenu(const QMap<QString, QAction*>& theStdActions) {}\r
+\r
+  /// Update state of pop-up menu items in viewer\r
+  /// \param theStdActions - a map of standard actions\r
+  virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions) {}\r
+\r
+signals:\r
+  void operationLaunched();\r
+\r
+  void operationResumed(ModuleBase_Operation* theOp);\r
+\r
 public slots:\r
   /// Called on call of command corresponded to a feature\r
-  void onFeatureTriggered();\r
+  virtual void onFeatureTriggered();\r
 \r
   /// Slolt called on object display\r
   /// \param theObject a data object\r
@@ -151,14 +216,6 @@ protected slots:
   virtual void onSelectionChanged() {}\r
 \r
  protected:\r
-  /// Sends the operation for launching\r
-  /// \param theOperation the operation\r
-  virtual void sendOperation(ModuleBase_Operation* theOperation);\r
-\r
-  /// Creates a new operation\r
-  /// \param theCmdId the operation name\r
-  virtual ModuleBase_Operation* createOperation(const std::string& theCmdId);\r
-\r
   /// Register validators for this module\r
   virtual void registerValidators() {}\r
 \r