Salome HOME
Update copyrights
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetCreatorFactory.h
old mode 100755 (executable)
new mode 100644 (file)
index 98f4d21..66c229a
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        ModuleBase_WidgetCreatorFactory.cpp
-// Created:     03 Dec 2015
-// Author:      Natalia ERMOLAEVA
+// Copyright (C) 2014-2019  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
+//
 
 #ifndef MODULEBASE_WIDGETCREATORFACTORY_H_
 #define MODULEBASE_WIDGETCREATORFACTORY_H_
@@ -16,6 +29,8 @@
 
 #include <ModuleBase_IWidgetCreator.h>
 
+#include <ModelAPI_Feature.h>
+
 class ModuleBase_ModelWidget;
 class ModuleBase_PageBase;
 class ModuleBase_IWorkshop;
@@ -24,52 +39,75 @@ 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);
 
+  /// Returns true if there is a creator, which can make a panel by the type
+  /// \param theType a type
+  /// \return a boolean value
+  bool hasPanelWidget(const std::string& theType);
+
+  /// 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* 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
+  /// \return a boolean value
   bool hasPageWidget(const std::string& theType);
 
   /// 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,
-                                        Config_WidgetAPI* theWidgetApi,
-                                        std::string theParentId);
+                                        Config_WidgetAPI* theWidgetApi);
 
   /// 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,
                                              Config_WidgetAPI* theWidgetApi,
-                                             std::string theParentId,
                                              ModuleBase_IWorkshop* theWorkshop);
 
 private:
   /// Constructor is hidden
   ModuleBase_WidgetCreatorFactory();
 
-  /// Map of widget type in XML to creator
-  QMap<std::string, WidgetCreatorPtr> myCreators;
+  /// Map of widget panel in XML to creator
+  QMap<std::string, WidgetCreatorPtr> myPanelToCreator;
 
   /// Map of widget page in XML to creator
   QMap<std::string, WidgetCreatorPtr> myPageToCreator;
+
+  /// Map of widget type in XML to creator
+  QMap<std::string, WidgetCreatorPtr> myCreators;
 };
 
 typedef std::shared_ptr<ModuleBase_WidgetCreatorFactory> WidgetCreatorFactoryPtr;