Add tools

[modules/shaper.git] / src / ModuleBase / ModuleBase_IModule.h

diff --git a/src/ModuleBase/ModuleBase_IModule.h b/src/ModuleBase/ModuleBase_IModule.h
index ae8e4645f877febdc27d074d7573c9e303a6d379..327bb423072c080db38faa65f143eee9b2483c21 100644 (file)
--- a/src/ModuleBase/ModuleBase_IModule.h
+++ b/src/ModuleBase/ModuleBase_IModule.h
@@ -35,7 +35,7 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
  public:\r
 \r
    /// Constructor\r
-   /// \param theParent instance of workshop intrface\r
+   /// \param theParent instance of workshop interface\r
    ModuleBase_IModule(ModuleBase_IWorkshop* theParent);\r
 \r
   virtual ~ModuleBase_IModule() {}\r
@@ -82,13 +82,13 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   /// \param theOperation a started operation\r
   virtual ModuleBase_Operation* currentOperation() const = 0;\r
 \r
-  /// Add menu atems for viewer into the given menu\r
+  /// Add menu items for viewer into the given menu\r
   /// \param theMenu a popup menu to be shown in the viewer\r
   /// \param theStdActions a map of standard actions\r
   /// \return true if items are added and there is no necessity to provide standard menu\r
   virtual bool addViewerMenu(QMenu* theMenu, const QMap<QString, QAction*>& theStdActions) const { return false; }\r
 \r
-  /// Add menu atems for object browser into the given menu\r
+  /// Add menu items for object browser into the given menu\r
   /// \param theMenu a popup menu to be shown in the object browser\r
   virtual void addObjectBrowserMenu(QMenu* theMenu) const {};\r
 \r
@@ -98,7 +98,7 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   /// 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 theWidgetApi the widget configuration. 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 ModuleBase_ModelWidget* createWidgetByType(const std::string& theType, QWidget* theParent,\r
@@ -120,16 +120,20 @@ 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
+  /// Returns 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
+  /// \return the a boolean 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
@@ -143,8 +147,16 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   /// \returns true if the action is processed\r
   virtual bool deleteObjects() { return false; };\r
 \r
+#ifdef ModuleDataModel\r
   /// Returns data model object for representation of data tree in Object browser\r
   virtual ModuleBase_IDocumentDataModel* dataModel() const = 0;\r
+#endif\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
@@ -154,10 +166,12 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   * 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 immediately\r
+  * \returns true if the object is modified\r
   */\r
-  virtual void customizeObject(ObjectPtr theObject) {}\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
+  /// This method is called on object browser creation for customization of module specific features\r
   /// \param theObjectBrowser a pinter on Object Browser widget\r
   virtual void customizeObjectBrowser(QWidget* theObjectBrowser) {}\r
 \r
@@ -180,6 +194,11 @@ class MODULEBASE_EXPORT ModuleBase_IModule : public QObject
   /// \param theStdActions - a map of standard actions\r
   virtual void updateViewerMenu(const QMap<QString, QAction*>& theStdActions) {}\r
 \r
+  //! Returns the feature error if the current state of the feature in the module is not correct\r
+  //! If the feature is correct, it returns an empty value\r
+  //! \return string value\r
+  virtual QString getFeatureError(const FeaturePtr& theFeature);\r
+\r
 signals:\r
   void operationLaunched();\r
 \r
@@ -189,7 +208,7 @@ public slots:
   /// Called on call of command corresponded to a feature\r
   virtual void onFeatureTriggered();\r
 \r
-  /// Slolt called on object display\r
+  /// Slot called on object display\r
   /// \param theObject a data object\r
   /// \param theAIS a presentation object\r
   virtual void onObjectDisplayed(ObjectPtr theObject, AISObjectPtr theAIS) {}\r