Issue #394 Undo-ing a Sketch element

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

diff --git a/src/ModuleBase/ModuleBase_WidgetLabel.h b/src/ModuleBase/ModuleBase_WidgetLabel.h
index 3fbf7e883411325fe921c9279f0910e3f6023a26..fd0112ff19b88c3b24a4ec8cd0d8e3a07daf0050 100644 (file)
--- a/src/ModuleBase/ModuleBase_WidgetLabel.h
+++ b/src/ModuleBase/ModuleBase_WidgetLabel.h
@@ -12,10 +12,18 @@
 
 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);
 
@@ -25,11 +33,6 @@ Q_OBJECT
   /// It returns false because this is an info widget
   virtual bool canSetValue() const { return false; };
 
-  virtual bool storeValue() const
-  {
-    return true;
-  }
-
   virtual bool restoreValue()
   {
     return true;
@@ -42,7 +45,16 @@ Q_OBJECT
   /// This control doesn't accept focus
   virtual bool focusTo() { return false; }
 
+protected:
+  /// Saves the internal parameters to the given feature
+  /// \return True in success
+  virtual bool storeValue() const
+  {
+    return true;
+  }
+
 private:
+  /// A label control
   QLabel* myLabel;
 };