Salome HOME
Set empty text if double value is set in editor
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetChoice.h
index 99bd281f9505ac5e8a1ee1e4663841551f6832f3..412821d2c475ef3865f089b2bda411f99a93cfb5 100644 (file)
@@ -14,40 +14,53 @@ class QWidget;
 class QLabel;
 class QComboBox;
 
+/**
+* \ingroup GUI
+* Implementation of model widget for choice widget definition (combo box)
+* It can be defined as following:
+* \code
+*   <choice id="bool_type" 
+*     label="Type" 
+*     tooltip="Type of boolean operation"
+*     string_list="Cut Fuse Common"
+*   />
+* \endcode
+*/
 class MODULEBASE_EXPORT ModuleBase_WidgetChoice : public ModuleBase_ModelWidget
 {
 Q_OBJECT
  public:
+  /// Constructor
+  /// \param theParent the parent object
+  /// \param theData the widget configuation. The attribute of the model widget is obtained from
+  /// \param theParentId is Id of a parent of the current attribute
   ModuleBase_WidgetChoice(QWidget* theParent, const Config_WidgetAPI* theData, 
                           const std::string& theParentId);
 
   virtual ~ModuleBase_WidgetChoice();
   
-  /// Saves the internal parameters to the given feature
-  /// \param theObject a model feature to be changed
-  virtual bool storeValue() const;
-
   virtual bool restoreValue();
 
   virtual bool focusTo();
 
-  /// Returns the internal parent wiget control, that can be shown anywhere
-  /// \returns the widget
-  QWidget* getControl() const
-  {
-    return myContainer;
-  }
-
   /// Returns list of widget controls
-  /// \return a control list
+  /// \return a controls list
   virtual QList<QWidget*> getControls() const;
 
+protected:
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom() const;
+
 private slots:
+  /// Slot called on combo box index change
   void onCurrentIndexChanged(int theIndex);
 
 private:
-  QWidget* myContainer;
+  /// The label
   QLabel* myLabel;
+
+  /// The control
   QComboBox* myCombo;
 };