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

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

diff --git a/src/ModuleBase/ModuleBase_WidgetFactory.h b/src/ModuleBase/ModuleBase_WidgetFactory.h
index 7d40f5b7215f1d1ee8667ac2fc1b424d16eba615..1292cec57fdd47a674a2d7121e596c3233f0baef 100644 (file)
--- a/src/ModuleBase/ModuleBase_WidgetFactory.h
+++ b/src/ModuleBase/ModuleBase_WidgetFactory.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * ModuleBase_WidgetFactory.h
  *
@@ -19,44 +21,93 @@ class QWidget;
 class Config_WidgetAPI;
 class ModuleBase_IWorkshop;
 
+/**
+* \ingroup GUI
+* A class for creation of widgets instances in for property panel using XML deskription of 
+* a feature
+*/
 class MODULEBASE_EXPORT ModuleBase_WidgetFactory
 {
  public:
+   /// Constructor
+   /// \param theXmlRepresentation content of XML file
+   /// \param theWorkshop reference to workshop instance
   ModuleBase_WidgetFactory(const std::string& theXmlRepresentation,
                            ModuleBase_IWorkshop* theWorkshop);
   virtual ~ModuleBase_WidgetFactory();
 
+  /// Creates content widget for property panel
+  /// \param theParent a parent widget
   void createWidget(QWidget* theParent);
 
+  /// Returns list of model widgets
   QList<ModuleBase_ModelWidget*> getModelWidgets() const
   {
     return myModelWidgets;
   }
 
  protected:
-  //Widgets
+   /// Create widget by its type
+   /// \param theType a type
+   /// \param theParent a parent widget
   QWidget* createWidgetByType(const std::string& theType, QWidget* theParent = NULL);
+
+   /// Create a widget of container type
+   /// \param theType a type
+   /// \param theParent a parent widget
   QWidget* createContainer(const std::string& theType, QWidget* theParent = NULL);
+
+  /// Create label widget
+  /// \param theParent a parent widget
   QWidget* labelControl(QWidget* theParent);
+
+  /// Create double spin box widget
+  /// \param theParent a parent widget
   QWidget* doubleSpinBoxControl(QWidget* theParent);
-  //QWidget* featureSelectorControl(QWidget* theParent);
-  //QWidget* featureOrAttributeSelectorControl(QWidget* theParent);
+
+  /// Create double value editor widget
+  /// \param theParent a parent widget
   QWidget* doubleValueEditor(QWidget* theParent);
+
+  /// Create shape selector widget
+  /// \param theParent a parent widget
   QWidget* shapeSelectorControl(QWidget* theParent);
+
+  /// Create boolean input widget
+  /// \param theParent a parent widget
   QWidget* booleanControl(QWidget* theParent);
+
+  /// Create file selector widget
+  /// \param theParent a parent widget
   QWidget* fileSelectorControl(QWidget* theParent);
+
+  /// Create choice widget (combo box)
+  /// \param theParent a parent widget
   QWidget* choiceControl(QWidget* theParent);
+
+  /// Create line edit widget
+  /// \param theParent a parent widget
   QWidget* lineEditControl(QWidget* theParent);
-  QWidget* multiSelectorControl(QWidget* theParent);
 
+  /// Create multi selector widget
+  /// \param theParent a parent widget
+  QWidget* multiSelectorControl(QWidget* theParent);
 
-  QString qs(const std::string& theStdString) const;
+  /// Convert STD string to QT string
+  /// \param theStdString is STD string
+  static QString qs(const std::string& theStdString);
 
  private:
+   /// API object for XML reading
   Config_WidgetAPI* myWidgetApi;
+
+  /// Reference to workshop
   ModuleBase_IWorkshop* myWorkshop;
 
+  /// List of created model widgets
   QList<ModuleBase_ModelWidget*> myModelWidgets;
+
+  /// Id of current parent
   std::string myParentId;
 };