X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModuleBase%2FModuleBase_WidgetChoice.h;h=3f13cc4afdbfdea772f9190c4835bd14a12515c0;hb=a2982d2108f929cf9e7f996cfd590c4ce59dc21c;hp=15a95054eb8662cc2ef192c7a2b3ee867ab99a31;hpb=b801d5f85aa3dc5786510acf87c8003f1d59eadd;p=modules%2Fshaper.git

diff --git a/src/ModuleBase/ModuleBase_WidgetChoice.h b/src/ModuleBase/ModuleBase_WidgetChoice.h
index 15a95054e..3f13cc4af 100644
--- a/src/ModuleBase/ModuleBase_WidgetChoice.h
+++ b/src/ModuleBase/ModuleBase_WidgetChoice.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModuleBase_WidgetChoice.h
 // Created:     03 Sept 2014
 // Author:      Vitaly Smetannikov
@@ -12,17 +14,31 @@ 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();
@@ -37,15 +53,21 @@ Q_OBJECT
   }
 
   /// Returns list of widget controls
-  /// \return a control list
+  /// \return a controls list
   virtual QList<QWidget*> getControls() const;
 
 private slots:
+  /// Slot called on combo box index change
   void onCurrentIndexChanged(int theIndex);
 
 private:
+  /// Container widget
   QWidget* myContainer;
+
+  /// The label
   QLabel* myLabel;
+
+  /// The control
   QComboBox* myCombo;
 };