Salome HOME
Issue #390 Selection restore problems during edit operation
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
index 35bd1632026d91a530505880b3f41c2c47746121..3db67b661888ca9cd9abc755228f0b0636aab492 100644 (file)
@@ -20,6 +20,7 @@ class Config_WidgetAPI;
 class QKeyEvent;
 
 /**\class ModuleBase_ModelWidget
+ * \ingroup GUI
  * \brief An abstract custom widget class. This class realization is assumed to create some controls.
  * The controls values modification should send signal about values change.
  *
@@ -42,6 +43,9 @@ Q_OBJECT
   {
   }
 
+  /// Fills the widget with default values
+  virtual void reset() {};
+
   /// Returns the state whether the attribute of the feature is initialized
   /// \param theObject a model feature to be checked
   /// \return the boolean result
@@ -49,7 +53,12 @@ Q_OBJECT
 
   /// Returns true, if default value of the widget should be computed
   /// on operation's execute, like radius for circle's constraint (can not be zero)
-  bool isComputedDefault() { return myIsComputedDefault; }
+  bool isComputedDefault() const { return myIsComputedDefault; }
+
+  /// Returns true, if default value of the widget is defined in the XML and it is not the
+  /// computed value
+  /// \return the boolean result
+  std::string getDefaultValue() const { return myDefaultValue; }
 
   /// Defines if it is supposed that the widget should interact with the viewer.
   virtual bool isViewerSelector() { return false; }
@@ -66,9 +75,6 @@ Q_OBJECT
     return false;
   }
 
-  /// Saves the internal parameters to the given feature
-  virtual bool storeValue() const = 0;
-
   /// Restore value from attribute data to the widget's control
   virtual bool restoreValue() = 0;
 
@@ -78,7 +84,7 @@ Q_OBJECT
   virtual bool focusTo();
 
   /// The methiod called when widget is activated
-  virtual void activate() {}
+  void activate();
 
   /// The methiod called when widget is deactivated
   virtual void deactivate() {}
@@ -121,10 +127,8 @@ Q_OBJECT
   }
 
   /// Set feature which is processing by active operation
-  void setFeature(const FeaturePtr& theFeature)
-  {
-    myFeature = theFeature;
-  }
+  /// \param theToStoreValue a value about necessity to store the widget value to the feature
+  void setFeature(const FeaturePtr& theFeature, const bool theToStoreValue = false);
 
   /// Editing mode depends on mode of current operation. This value is defined by it.
   void setEditingMode(bool isEditing) { myIsEditing = isEditing; }
@@ -133,8 +137,12 @@ Q_OBJECT
   bool isEditingMode() const { return myIsEditing; }
 
 signals:
+  /// The signal about widget values are to be changed
+  void beforeValuesChanged();
   /// The signal about widget values changed
   void valuesChanged();
+  /// The signal about widget values are to be changed
+  void afterValuesChanged();
 
   /// The signal about key release on the control, that corresponds to the attribute
   /// \param theEvent key release event
@@ -156,6 +164,17 @@ signals:
     myAttributeID = theAttribute;
   }
 
+  /// Saves the internal parameters to the given feature. Emits signals before and after store
+  /// \return True in success
+  bool storeValue();
+
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom() const = 0;
+
+  /// The methiod called when widget is activated
+  virtual void activateCustom() {};
+
   /// Sends Update and Redisplay for the given object
   /// \param theObj is updating object
   void updateObject(ObjectPtr theObj) const;
@@ -164,6 +183,10 @@ signals:
   /// \param theObj is object for moving
   void moveObject(ObjectPtr theObj) const;
 
+protected slots:
+  /// Processing of values changed in model widget by store the current value to the feature
+  void onWidgetValuesChanged();
+
  protected:
 
   /// The attribute name of the model feature
@@ -175,11 +198,15 @@ signals:
   /// A feature which is processing by active operation
   FeaturePtr myFeature;      
 
-  /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
-  bool myIsComputedDefault; 
-                            
   /// Flag which shows that current operation is in editing mode
   bool myIsEditing; 
+
+private:
+  /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
+  bool myIsComputedDefault; 
+                        
+  /// the default value, which is defined in the XML for this attribute    
+  std::string myDefaultValue; 
 };
 
 #endif