Fix for the issue #2808 : Documentation on the "Groups" panel. Added description...

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

diff --git a/src/ModuleBase/ModuleBase_WidgetCreatorFactory.h b/src/ModuleBase/ModuleBase_WidgetCreatorFactory.h
index 6373eebba0b99b64b2bb4a5a635e1d8cce567aab..0f186bf074177eb8fa253c2073dd979d11b23a8f 100755 (executable)
--- a/src/ModuleBase/ModuleBase_WidgetCreatorFactory.h
+++ b/src/ModuleBase/ModuleBase_WidgetCreatorFactory.h
@@ -1,8 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        ModuleBase_WidgetCreatorFactory.cpp
-// Created:     03 Dec 2015
-// Author:      Natalia ERMOLAEVA
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef MODULEBASE_WIDGETCREATORFACTORY_H_
 #define MODULEBASE_WIDGETCREATORFACTORY_H_
@@ -16,6 +30,8 @@
 
 #include <ModuleBase_IWidgetCreator.h>
 
+#include <ModelAPI_Feature.h>
+
 class ModuleBase_ModelWidget;
 class ModuleBase_PageBase;
 class ModuleBase_IWorkshop;
@@ -24,19 +40,20 @@ class QWidget;
 
 /**
 * \ingroup GUI
-* A class for creation of widgets instances in for property panel using XML deskription of 
+* A class for creation of widgets instances in for property panel using XML deskription of
 * a feature
 */
 class MODULEBASE_EXPORT ModuleBase_WidgetCreatorFactory
 {
  public:
-  // Returns an singular instance of the class if it exists or create it
+  /// Returns an singular instance of the class if it exists or create it
   static std::shared_ptr<ModuleBase_WidgetCreatorFactory> get();
 
   /// Destructor
   virtual ~ModuleBase_WidgetCreatorFactory();
 
-  /// The creator is added to the internal container to be used when the createWidgetByType is called
+  /// The creator is added to the internal container
+  /// to be used when the createWidgetByType is called
   /// \param theCreator a new widget creator
   void registerCreator(const WidgetCreatorPtr& theCreator);
 
@@ -48,8 +65,10 @@ class MODULEBASE_EXPORT ModuleBase_WidgetCreatorFactory
   /// Create panel by its type
   /// \param theType a type
   /// \param theParent a parent widget
+  /// \param theFeature a feature to fill the panel
   /// \return a created panel or null
-  QWidget* createPanel(const std::string& theType, QWidget* theParent);
+  QWidget* createPanelByType(const std::string& theType, QWidget* theParent,
+                             const FeaturePtr& theFeature);
 
   /// Returns true if there is a creator, which can make a page by the type
   /// \param theType a type
@@ -59,6 +78,8 @@ class MODULEBASE_EXPORT ModuleBase_WidgetCreatorFactory
   /// Create page by its type
   /// \param theType a type
   /// \param theParent a parent widget
+  /// \param theWidgetApi the widget configuration.
+  ///                     The attribute of the model widget is obtained from XML
   /// \return a created page or null
   ModuleBase_PageBase* createPageByType(const std::string& theType,
                                         QWidget* theParent,
@@ -67,6 +88,9 @@ class MODULEBASE_EXPORT ModuleBase_WidgetCreatorFactory
   /// Create widget by its type
   /// \param theType a type
   /// \param theParent a parent widget
+  /// \param theWidgetApi the widget configuration.
+  ///                     The attribute of the model widget is obtained from XML
+  /// \param theWorkshop a workshop object instance
   /// \return a created widget or null
   ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
                                              QWidget* theParent,