Merge branch 'Dev_0.7.1' of newgeom:newgeom into Dev_0.7.1

[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetLabel.h

diff --git a/src/ModuleBase/ModuleBase_WidgetLabel.h b/src/ModuleBase/ModuleBase_WidgetLabel.h
index 81c7be59239fa714ae81ed2c170a6eb335392a55..8d7d4281f9e490cadf1808040be4ad266d3480c5 100644 (file)
--- a/src/ModuleBase/ModuleBase_WidgetLabel.h
+++ b/src/ModuleBase/ModuleBase_WidgetLabel.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModuleBase_WidgetLabel.h
 // Created:     03 Dec 2014
 // Author:      Vitaly SMETANNIKOV
@@ -10,15 +12,27 @@
 
 class QLabel;
 
+/**
+* \ingroup GUI
+* Implementation of model widget for a label control
+*/
 class MODULEBASE_EXPORT ModuleBase_WidgetLabel : 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_WidgetLabel(QWidget* theParent, const Config_WidgetAPI* theData,
                             const std::string& theParentId);
 
   virtual ~ModuleBase_WidgetLabel();
 
+  /// Defines if it is supported to set the value in this widget
+  /// It returns false because this is an info widget
+  virtual bool canSetValue() const { return false; };
+
   virtual bool storeValue() const
   {
     return true;
@@ -37,6 +51,7 @@ Q_OBJECT
   virtual bool focusTo() { return false; }
 
 private:
+  /// A label control
   QLabel* myLabel;
 };