Issue #1701 Preselecting before calling constraints does not put objects in the input...

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

diff --git a/src/ModuleBase/ModuleBase_WidgetLabel.h b/src/ModuleBase/ModuleBase_WidgetLabel.h
index f7511396ba8d1271c652be626ebd5f4b999133bf..4812f29b60adee8a41b051c92eae777d2f948836 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,31 +12,42 @@
 
 class QLabel;
 
+/**
+* \ingroup GUI
+* Implementation of model widget for a label control
+*/
 class MODULEBASE_EXPORT ModuleBase_WidgetLabel : public ModuleBase_ModelWidget
 {
 Q_OBJECT
  public:
-  ModuleBase_WidgetLabel(QWidget* theParent, const Config_WidgetAPI* theData,
-                            const std::string& theParentId);
+  /// Constructor
+  /// \param theParent the parent object
+  /// \param theData the widget configuation. The attribute of the model widget is obtained from
+  ModuleBase_WidgetLabel(QWidget* theParent, const Config_WidgetAPI* theData);
 
   virtual ~ModuleBase_WidgetLabel();
 
-  virtual bool storeValue() const
-  {
-    return true;
-  }
+  /// Defines if it is supported to set the value in this widget
+  /// It returns false because this is an info widget
+  virtual bool canAcceptFocus() const { return false; };
 
-  virtual bool restoreValue()
-  {
-    return true;
-  }
+  virtual bool restoreValueCustom();
 
   virtual QList<QWidget*> getControls() const;
 
-  QWidget* getControl() const;
+  /// This control doesn't accept focus
+  virtual bool focusTo();
+
+protected:
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValueCustom()
+  {
+    return true;
+  }
 
-private:
+  /// A label control
   QLabel* myLabel;
 };
 
-#endif
\ No newline at end of file
+#endif