Salome HOME
Copyright update 2022
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
index 0c0dddece67bee7c6eda485f2c4ea15a589013e7..f0be30a30f128be25c204c009aeb28e9eed8bdd1 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+// Copyright (C) 2014-2022  CEA/DEN, EDF R&D
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 //
 // You should have received a copy of the GNU Lesser General Public
 // License along with this library; if not, write to the Free Software
-// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-// See http://www.salome-platform.org/ or
-// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef MODULEBASE_MODELWIDGET_H
 
 #include <memory>
 
+#ifdef _MSC_VER
+#pragma warning(disable: 4100)
+#endif
+
 class Config_WidgetAPI;
 class Events_InfoMessage;
 class ModuleBase_IPropertyPanel;
@@ -151,7 +154,7 @@ Q_OBJECT
   //! If the feature is correct, it returns an empty value
   //! \param theValueStateChecked the boolean flag if the state of the widget should be checked
   //! \return string value
-  QString getError(const bool theValueStateChecked = true) const;
+  virtual QString getError(const bool theValueStateChecked = true) const;
 
   /// Set the given wrapped value to the current widget
   /// This value should be processed in the widget according to the needs
@@ -200,8 +203,13 @@ Q_OBJECT
   /// The method called when widget is deactivated
   virtual void deactivate();
 
+  /// Opportunity to do something after the active widget of the property panel changed
+  virtual void updateAfterDeactivation() {}
+  /// Opportunity to do something after the active widget of the property panel changed
+  virtual void updateAfterActivation() {}
+
   /// The method called if widget should be activated always
-  virtual bool needToBeActiated() { return false; }
+  virtual bool needToBeActivated() { return false; }
 
   /// Returns list of widget controls
   /// \return a control list
@@ -237,12 +245,19 @@ Q_OBJECT
 
   /// \return Context for translation
   virtual std::string context() const {
-
+    bool isAppendAttr = true;
     std::string aContext = myFeatureId;
     if(!aContext.empty() && !myAttributeID.empty()) {
-      aContext += ":";
+      // workaround for ModelAPI_Filter's attributes:
+      // do not keep attribute name, because it may be changed
+      // if the same filter is selected twice or more.
+      if (myAttributeID.find(aContext + "__") != std::string::npos)
+        isAppendAttr = false;
+      else
+        aContext += ":";
     }
-    aContext += myAttributeID;
+    if (isAppendAttr)
+      aContext += myAttributeID;
 
     return aContext;
   }
@@ -251,8 +266,8 @@ Q_OBJECT
   /// \param theFeature a feature object
   /// \param theToStoreValue a value about necessity to store the widget value to the feature
   /// \param isUpdateFlushed a flag if update should be flushed on store value
-  void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false,
-                  const bool isUpdateFlushed = true);
+  virtual void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false,
+                          const bool isUpdateFlushed = true);
 
   /// Editing mode depends on mode of current operation. This value is defined by it.
   virtual void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
@@ -290,6 +305,32 @@ Q_OBJECT
   /// \return a model widget or NULL
   static ModuleBase_ModelWidget* findModelWidget(ModuleBase_IPropertyPanel* theProp,
                                                  QWidget* theWidget);
+
+  /// Returns True if the widget uses feature attribute.
+  /// If not then it means that the widget do not need attribute at all.
+  virtual bool usesAttribute() const { return true; }
+
+  /// It is called when user press Ok or OkPlus buttons in the parent property panel
+  /// By default this slot does nothing
+  virtual void onFeatureAccepted() {}
+
+  /// Returns True in case if the widget contains useful information for inspection tool
+  virtual bool isInformative() const { return true; }
+
+  /// If widgets has several panels then this method has to show a page which contains information
+  /// for current feature. By default does nothing
+  virtual void showInformativePage() {}
+
+  /// Returns True if data of its attribute was modified
+  virtual bool isModified() const { return false; }
+
+  virtual void setReadOnly(bool isReadOnly) { setEnabled(!isReadOnly); }
+
+  virtual bool isReadOnly() const { return !isEnabled(); }
+
+  /// Returns true if the widget should have access to external parts
+  bool canUseExternalParts() const { return myUseExternalParts; }
+
 signals:
   /// The signal about widget values are to be changed
   void beforeValuesChanged();
@@ -400,9 +441,6 @@ protected:
   /// A feature ID
   std::string myFeatureId;
 
-  /// Flag which shows that current operation is in editing mode
-  bool myIsEditing;
-
   /// Flag which shows whether current widget is obligatory
   /// The non-obligatory widgets should not accept the focus in the property panel
   bool myIsObligatory;
@@ -414,6 +452,9 @@ protected:
   ValueState myState;
 
 private:
+  /// Flag which shows that current operation is in editing mode
+  bool myIsEditing;
+
   /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
   bool myIsComputedDefault;
 
@@ -432,6 +473,11 @@ private:
   bool myIsValueStateBlocked;
   /// do not flush updated signal
   bool myFlushUpdateBlocked;
+
+  bool myUpdateVisualAttributes;
+
+  /// A flag which indicates that current widget should have access to external parts
+  bool myUseExternalParts;
 };
 
 #endif