Salome HOME
1. Correction for perfomance problem by Apply button state update: do not listen...
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetDoubleValue.h
index 20afafbe18f9862e7a43b15c0287660334f79ed7..de2a9acef60451751a8bbddc69c306d480ed367c 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModuleBase_WidgetDoubleValue.h
 // Created:     04 June 2014
 // Author:      Vitaly Smetannikov
 #include "ModuleBase.h"
 #include "ModuleBase_ModelWidget.h"
 
-class ModuleBase_DoubleSpinBox;
+class ModuleBase_ParamSpinBox;
 class Config_WidgetAPI;
 class QWidget;
 class QLabel;
 class QTimer;
 
+/**
+* \ingroup GUI
+* A class of property panel widget for double value input
+* It can be defined with "doublevalue" keyword. For example:
+* \code
+* <doublevalue id="x" label="X:" icon=":pictures/x_point.png" tooltip="X coordinate"/>
+* \endcode
+*/
 class MODULEBASE_EXPORT ModuleBase_WidgetDoubleValue : public ModuleBase_ModelWidget
 {
 Q_OBJECT
  public:
   /// Constructor
-  /// \theParent the parent object
-  /// \theData the widget configuation. The attribute of the model widget is obtained from
-  ModuleBase_WidgetDoubleValue(QWidget* theParent, const Config_WidgetAPI* theData,
-                               const std::string& theParentId);
+  /// \param theParent the parent object
+  /// \param theData the widget configuation. The attribute of the model widget is obtained from
+  ModuleBase_WidgetDoubleValue(QWidget* theParent, const Config_WidgetAPI* theData);
 
   virtual ~ModuleBase_WidgetDoubleValue();
 
-  /// Saves the internal parameters to the given feature
-  /// \param theObject a model feature to be changed
-  virtual bool storeValue() const;
+  /// The methiod called when widget is activated
+  virtual void activateCustom();
 
-  virtual bool restoreValue();
+  /// Select the internal content if it can be selected. It is empty in the default realization
+  virtual void selectContent();
 
   /// Returns list of widget controls
   /// \return a control list
   virtual QList<QWidget*> getControls() const;
 
-  /// Returns the internal parent wiget control, that can be shown anywhere
-  /// \returns the widget
-  QWidget* getControl() const
-  {
-    return myContainer;
-  }
+  /// Returns true if the event is processed.
+  virtual bool processEnter();
 
  public slots:
- /// Delayed value chnged: when user starts typing something,
+ // Delayed value chnged: when user starts typing something,
  // it gives him a 0,5 second to finish typing, when sends valueChnaged() signal
 //  void onValueChanged();
 
- protected:
-  QWidget* myContainer;
+protected:
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom();
+
+  //! Read value of corresponded attribute from data model to the input control
+  // \return True in success
+  virtual bool restoreValueCustom();
+
+  /// Fills the widget with default values
+  /// \return true if the widget current value is reset
+  virtual bool resetCustom();
+
+protected:
+  /// Label of the widget
   QLabel* myLabel;
-  ModuleBase_DoubleSpinBox* mySpinBox;
+
+  /// Input value control
+  ModuleBase_ParamSpinBox* mySpinBox;
 };
 
 #endif