Salome HOME
Disable sketch input fields unconditionally.
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
index 6face1021aa63407a48ea59e124b4014f97e5a25..4c677a1f34f9d74a258359208db09f9dc305ae20 100644 (file)
@@ -40,15 +40,17 @@ Q_OBJECT
                      ModifiedInViewer, /// modification performed by viewer events
                      Reset }; /// the value is reset
 
+   enum EnableState { On,  /// the widget value is always enabled
+                      Off, /// the widget value is always disabled
+                      DefinedInPreferences }; /// the widget value enable state is defined in preferences
+
   /// Constructor
   /// \param theParent the parent object
   /// \param theData the widget configuration. The attribute of the model widget is obtained from
-  /// \param theData a low-level API for reading xml definitions of widgets
+  /// a low-level API for reading xml definitions of widgets
   ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData);
   /// Destructor
-  virtual ~ModuleBase_ModelWidget()
-  {
-  }
+  virtual ~ModuleBase_ModelWidget();
 
   /// Fills the widget with default values. It calls the resetCustom method and change
   /// the widget state to Reset if the reset is performed.
@@ -77,6 +79,11 @@ Q_OBJECT
   /// \return the boolean result
   bool isObligatory() const { return myIsObligatory; }
 
+  /// Returns true, if the widget value is enabled and might be modified manualy. It returns false if
+  /// the application preferences allow having disabled value and the internal state tells to disable
+  /// \return the boolean result
+  virtual bool isValueEnabled() const;
+
   /// Returns this parameter value in the xml file
   /// \return the boolean result
   bool isUseReset() const { return myUseReset; }
@@ -85,6 +92,9 @@ Q_OBJECT
   /// \return the enumeration result
   ValueState getValueState() const { return myState; }
 
+  /// Stores the widget value if it is modified
+  void processValueState();
+
   /// Returns an attribute error according to the value state
   /// It exists in all cases excepring the "Store" case
   QString getValueStateError() const;
@@ -98,8 +108,9 @@ Q_OBJECT
 
   //! Returns the widget error, get it from the attribute validator and state of the widget
   //! 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;
+  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
@@ -282,6 +293,8 @@ protected:
   /// The method called when widget is activated
   virtual void activateCustom() {};
 
+  QString translateString(const QString& theMsg) const;
+
 protected slots:
   /// Processing of values changed in model widget by store the current value to the feature
   void onWidgetValuesChanged();
@@ -290,7 +303,8 @@ protected slots:
   void onWidgetValuesModified();
 
  protected:
-   ModuleBase_WidgetValidator* myWidgetValidator; /// own validator, by default it is zero
+    /// own validator, by default it is zero
+   ModuleBase_WidgetValidator* myWidgetValidator;
 
   /// The attribute name of the model feature
   std::string myAttributeID;
@@ -305,6 +319,9 @@ protected slots:
   /// The non-obligatory widgets should not accept the focus in the property panel
   bool myIsObligatory;
 
+  /// Flag about value of the control is enabled (can be modified)
+  EnableState myIsValueEnabled;
+
   /// The widget value state
   ValueState myState;