Salome HOME
Merge remote-tracking branch 'remotes/origin/occ/19115' into fixes_for_950
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetFactory.h
index 05f3b7b8a2bba7c6fc1c8750ac3e109523047785..ae377bfcdfff904c78b7effbc3b8c49fcc5d8017 100644 (file)
@@ -1,11 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-/*
- * ModuleBase_WidgetFactory.h
- *
- *  Created on: Apr 3, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2020  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_WIDGETFACTORY_H_
 #define MODULEBASE_WIDGETFACTORY_H_
@@ -33,14 +43,27 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFactory
    /// Constructor
    /// \param theXmlRepresentation content of XML file
    /// \param theWorkshop reference to workshop instance
-  ModuleBase_WidgetFactory(const std::string& theXmlRepresentation,
-                           ModuleBase_IWorkshop* theWorkshop);
+   /// \param theAttributePrefix prefix that must be added to the attribute name
+   ModuleBase_WidgetFactory(const std::string& theXmlRepresentation,
+                           ModuleBase_IWorkshop* theWorkshop,
+                           const std::string theAttributePrefix = "");
   virtual ~ModuleBase_WidgetFactory();
 
   /// Creates content widget for property panel
-  /// \param theParent a parent widget
-  void createWidget(ModuleBase_PageBase* theParent);
+  /// \param thePage a parent page
+  /// \param alignToTop align to top flag (true by default)
+  void createWidget(ModuleBase_PageBase* thePage, bool alignToTop = true);
 
+  /// Creates property panel content for the feature
+  /// \param thePage a parent page
+  /// \param theFeature a feature to fill the panel
+  void createPanel(ModuleBase_PageBase* thePage, const FeaturePtr& theFeature);
+
+  /// Creates one widget for property panel for the widget with given index
+  /// \param thePage a parent widget
+  /// \param theWidgetId a widget index
+  void createWidget(ModuleBase_PageBase* thePage,
+                    const std::string& theWidgetId);
 
   /// Returns list of model widgets
   QList<ModuleBase_ModelWidget*> getModelWidgets() const
@@ -48,7 +71,20 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFactory
     return myModelWidgets;
   }
 
- protected:
+  /// Returns the value of the title key from XML definition of the attribute in the feature
+  /// \param theAttributeId a value of a kind of the attribute under the feature
+  /// \param theTitle the result title
+  void getAttributeTitle(const std::string& theAttributeId,
+                         std::string& theTitle);
+
+  /// Returns the identifier of the first found attribute where greed field value is set and true
+  /// \param theAttributeId an outpup parameter with  attribute
+  void getGreedAttribute(std::string& theAttributeId);
+
+  /// Returns widget API from XML
+  const Config_WidgetAPI* widgetAPI() const { return myWidgetApi; }
+
+protected:
   /// check if ModuleBase_Widget has expandable widgets in getControls
   bool hasExpandingControls(QWidget* theParent);
 
@@ -68,6 +104,12 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFactory
   /// \param theStdString is STD string
   static QString qs(const std::string& theStdString);
 
+  /// It updates internal config api to point in the structure to given id of widget
+  /// The method is recusive and it stops when the found flag is true
+  /// \param theWidgetId a widget id key value
+  /// \param theFound a flag about found windget and recursive search should be stopped
+  void moveToWidgetId(const std::string& theWidgetId, bool& theFound);
+
  private:
    /// API object for XML reading
   Config_WidgetAPI* myWidgetApi;
@@ -77,9 +119,6 @@ class MODULEBASE_EXPORT ModuleBase_WidgetFactory
 
   /// List of created model widgets
   QList<ModuleBase_ModelWidget*> myModelWidgets;
-
-  /// Id of current parent
-  std::string myParentId;
 };
 
 #endif /* ModuleBase_WidgetFactory_H_ */