Salome HOME
The flushCreated/flushUpdated are obsolete and nobody uses them.
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetBoolValue.h
index 9d0246c1156fa3b3043c85001e6706ca6b9d8ad2..f5c3f494f91eeae10b00df4e649f3915c78a89bf 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModuleBase_WidgetBoolValue.h
 // Created:     04 June 2014
 // Author:      Vitaly Smetannikov
@@ -12,33 +14,34 @@ class Config_WidgetAPI;
 class QWidget;
 class QCheckBox;
 
+/**
+* \ingroup GUI
+* Implementation of widget for boolean input (check box)
+*/ 
 class MODULEBASE_EXPORT ModuleBase_WidgetBoolValue : public ModuleBase_ModelWidget
 {
 Q_OBJECT
  public:
   /// Constructor
-  /// \theParent the parent object
-  /// \theData the widget configuation. The attribute of the model widget is obtained from
+  /// \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_WidgetBoolValue(QWidget* theParent, const Config_WidgetAPI* theData,
                              const std::string& theParentId);
 
   virtual ~ModuleBase_WidgetBoolValue();
 
-  /// Saves the internal parameters to the given feature
-  /// \param theObject a model feature to be changed
-  virtual bool storeValue() const;
-
   virtual bool restoreValue();
 
-  /// 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;
+protected:
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom() const;
 
  private:
+   /// The check box
   QCheckBox* myCheckBox;
 };