Salome HOME
Make ModuleBase_ModelWidget::restoreValue() non-virtual and create virtual ModuleBase...
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
index 6d3437fe18c91f703c4a5087cab1539f059c60c1..cad3f174ca4166c214b8571c2c3f58b31d409789 100644 (file)
@@ -17,6 +17,7 @@
 #include <memory>
 
 class Config_WidgetAPI;
+class ModuleBase_IWorkshop;
 class QKeyEvent;
 
 /**\class ModuleBase_ModelWidget
@@ -34,7 +35,7 @@ Q_OBJECT
  public:
   /// Constructor
   /// \param theParent the parent object
-  /// \param theData the widget configuation. The attribute of the model widget is obtained from
+  /// \param theData the widget configuration. The attribute of the model widget is obtained from
   /// \param theParentId is Id of a parent of the current attribute
   ModuleBase_ModelWidget(QWidget* theParent, const Config_WidgetAPI* theData,
                          const std::string& theParentId);
@@ -43,8 +44,12 @@ Q_OBJECT
   {
   }
 
+  //TODO: nds stabilization hotfix
+  virtual void disconnectSignals() {};
+
   /// Fills the widget with default values
-  virtual void reset() {};
+  /// \return true if the widget current value is reset
+  virtual bool reset() { return false; };
 
   /// Returns the state whether the attribute of the feature is initialized
   /// \param theObject a model feature to be checked
@@ -64,6 +69,10 @@ Q_OBJECT
   /// \return the boolean result
   bool isObligatory() const { return myIsObligatory; }
 
+  /// Returns this parameter value in the xml file
+  /// \return the boolean result
+  bool isUseReset() const { return myUseReset; }
+
   /// Defines if it is supposed that the widget should interact with the viewer.
   virtual bool isViewerSelector() { return false; }
 
@@ -73,24 +82,27 @@ Q_OBJECT
 
   /// Set the given wrapped value to the current widget
   /// This value should be processed in the widget according to the needs
-  /// \param theValue the wrapped widget value
-  virtual bool setSelection(ModuleBase_ViewerPrs theValue)
+  /// \param theValues the wrapped selection values
+  /// \param toValidate the boolean value whether the value should be checked by filters
+  virtual bool setSelection(QList<ModuleBase_ViewerPrs>& theValues,
+                            const bool theToValidate)
   {
     return false;
   }
 
-  /// Restore value from attribute data to the widget's control
-  virtual bool restoreValue() = 0;
+  /// Restore value from attribute data to the widget's control. Emits signals before and after store
+  /// \return True in success
+  bool restoreValue();
 
   /// Set focus to the first control of the current widget. The focus policy of the control is checked.
   /// If the widget has the NonFocus focus policy, it is skipped.
   /// \return the state whether the widget can accept the focus
   virtual bool focusTo();
 
-  /// The methiod called when widget is activated
+  /// The method called when widget is activated
   void activate();
 
-  /// The methiod called when widget is deactivated
+  /// The method called when widget is deactivated
   virtual void deactivate() {}
 
   /// Returns list of widget controls
@@ -137,6 +149,14 @@ Q_OBJECT
   /// \return Current Editing mode
   bool isEditingMode() const { return myIsEditing; }
 
+  /// Sends Update and Redisplay for the given object
+  /// \param theObj is updating object
+  static void updateObject(ObjectPtr theObj);
+
+  /// Sends Move event for the given object
+  /// \param theObj is object for moving
+  static void moveObject(ObjectPtr theObj);
+
 signals:
   /// The signal about widget values are to be changed
   void beforeValuesChanged();
@@ -145,6 +165,11 @@ signals:
   /// The signal about widget values are to be changed
   void afterValuesChanged();
 
+  /// The signal about widget values are to be restored
+  void beforeValuesRestored();
+  /// The signal about widget values are to be restored
+  void afterValuesRestored();
+
   /// The signal about key release on the control, that corresponds to the attribute
   /// \param theEvent key release event
   void keyReleased(QKeyEvent* theEvent);
@@ -157,7 +182,10 @@ signals:
   /// \param theWidget the model base widget
   void focusOutWidget(ModuleBase_ModelWidget* theWidget);
 
- protected:
+protected:
+  /// Sets default value of widget. Normally, widget should fetch this value
+  /// from the xml. However, some widgets derived widgets could define it
+  void setDefaultValue(const std::string& theValue);
   /// \brief Set the attribute name
   /// \param theAttribute the string value with attribute name
   void setAttributeID(const std::string& theAttribute)
@@ -173,16 +201,11 @@ signals:
   /// \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;
+  /// Restore value from attribute data to the widget's control
+  virtual bool restoreValueCustom() = 0;
 
-  /// Sends Move event for the given object
-  /// \param theObj is object for moving
-  void moveObject(ObjectPtr theObj) const;
+  /// The method called when widget is activated
+  virtual void activateCustom() {};
 
 protected slots:
   /// Processing of values changed in model widget by store the current value to the feature
@@ -212,6 +235,9 @@ private:
                         
   /// the default value, which is defined in the XML for this attribute    
   std::string myDefaultValue; 
+
+  /// the reset state. If it is false, the reset method of the widget is not performed
+  bool myUseReset;
 };
 
 #endif