Salome HOME
Make ModuleBase_ModelWidget::restoreValue() non-virtual and create virtual ModuleBase...
[modules/shaper.git] / src / ModuleBase / ModuleBase_ModelWidget.h
index 44b43e4620d47749a322ad3b23e4f6c4175eb81a..cad3f174ca4166c214b8571c2c3f58b31d409789 100644 (file)
 
 #include <ModelAPI_Feature.h>
 
-#include <QObject>
+#include <QWidget>
 
 #include <memory>
 
 class Config_WidgetAPI;
+class ModuleBase_IWorkshop;
 class QKeyEvent;
 
 /**\class ModuleBase_ModelWidget
@@ -28,13 +29,13 @@ class QKeyEvent;
  * Every widget are able to save/restore data from the model and/or to contain other widgets.
  *
  */
-class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QObject
+class MODULEBASE_EXPORT ModuleBase_ModelWidget : public QWidget
 {
 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,6 +44,13 @@ Q_OBJECT
   {
   }
 
+  //TODO: nds stabilization hotfix
+  virtual void disconnectSignals() {};
+
+  /// Fills the widget with default values
+  /// \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
   /// \return the boolean result
@@ -50,12 +58,20 @@ 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
-  bool isValueDefault() { return myIsValueDefault; }
+  std::string getDefaultValue() const { return myDefaultValue; }
+
+  /// Returns true, if the obligatory value of the widget is not defined in the XML or has true value
+  /// \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; }
@@ -66,33 +82,29 @@ 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;
   }
 
-  /// 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;
+  /// 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 the internal parent wiget control, that can be shown anywhere
-  /// \returns the widget
-  virtual QWidget* getControl() const = 0;
-
   /// Returns list of widget controls
   /// \return a control list
   virtual QList<QWidget*> getControls() const = 0;
@@ -100,11 +112,12 @@ Q_OBJECT
   /// FocusIn events processing
   virtual bool eventFilter(QObject* theObject, QEvent *theEvent);
 
-  //! \brief Enables processing of focus event on all controls by the widget
-  void enableFocusProcessing();
+  /// \brief Enables processing of focus event on all controls by the widget
+  /// if this widget is not obligatory and set no-focus policy otherwise
+  virtual void enableFocusProcessing();
 
   //! Switch On/Off highlighting of the widget
-  void setHighlighted(bool isHighlighted);
+  virtual void setHighlighted(bool isHighlighted);
 
   /// Returns the attribute name
   /// \returns the string value
@@ -127,10 +140,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; }
@@ -138,9 +149,26 @@ 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();
   /// The signal about widget values changed
   void valuesChanged();
+  /// 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
@@ -154,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)
@@ -162,16 +193,23 @@ signals:
     myAttributeID = theAttribute;
   }
 
-  /// The methiod called when widget is activated
-  virtual void activateCustom() {};
+  /// Saves the internal parameters to the given feature. Emits signals before and after store
+  /// \return True in success
+  bool storeValue();
 
-  /// Sends Update and Redisplay for the given object
-  /// \param theObj is updating object
-  void updateObject(ObjectPtr theObj) const;
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom() const = 0;
 
-  /// Sends Move event for the given object
-  /// \param theObj is object for moving
-  void moveObject(ObjectPtr theObj) const;
+  /// Restore value from attribute data to the widget's control
+  virtual bool restoreValueCustom() = 0;
+
+  /// 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
+  void onWidgetValuesChanged();
 
  protected:
 
@@ -184,13 +222,22 @@ signals:
   /// A feature which is processing by active operation
   FeaturePtr myFeature;      
 
+  /// 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;
+
+private:
   /// Value should be computed on execute, like radius for circle's constraint (can not be zero)
   bool myIsComputedDefault; 
                         
-  /// the default value is defined in the XML for this attribute    
-  bool myIsValueDefault;
-  /// Flag which shows that current operation is in editing mode
-  bool myIsEditing; 
+  /// 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