Salome HOME
Issue #1368: Creation of a Qt panel. Widget creator interface correction to manage...
[modules/shaper.git] / src / ModuleBase / ModuleBase_WidgetFactory.h
index b29fba9eb6543470af9724e800c6dfb147410f09..180c265b8279b9ec0fcd6bfff3369236c1a44e0a 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * ModuleBase_WidgetFactory.h
  *
@@ -5,11 +7,11 @@
  *      Author: sbh
  */
 
-#ifndef ModuleBase_WidgetFactory_H_
-#define ModuleBase_WidgetFactory_H_
+#ifndef MODULEBASE_WIDGETFACTORY_H_
+#define MODULEBASE_WIDGETFACTORY_H_
 
-#include "ModuleBase.h"
-#include "ModuleBase_ModelWidget.h"
+#include <ModuleBase.h>
+#include <ModuleBase_ModelWidget.h>
 
 #include <QString>
 #include <QList>
@@ -18,44 +20,88 @@ class QObject;
 class QWidget;
 class Config_WidgetAPI;
 class ModuleBase_IWorkshop;
+class ModuleBase_PageBase;
 
+/**
+* \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:
-  ModuleBase_WidgetFactory(const std::string& theXmlRepresentation, ModuleBase_IWorkshop* theWorkshop);
+ 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();
 
-  void createWidget(QWidget* theParent);
+  /// Creates content widget for property panel
+  /// \param thePage a parent page
+  void createWidget(ModuleBase_PageBase* thePage);
+
+  /// Creates one widget for property panel for the widget with given index
+  /// \param theParent 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
   {
     return myModelWidgets;
   }
 
+  /// 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);
+
 protected:
-  //Widgets
-  QWidget* createWidgetByType(const std::string& theType, QWidget* theParent = NULL);
-  QWidget* labelControl(QWidget* theParent);
-  QWidget* doubleSpinBoxControl(QWidget* theParent);
-  QWidget* pointSelectorControl(QWidget* theParent);
-  QWidget* featureSelectorControl(QWidget* theParent);
-  QWidget* doubleValueEditor(QWidget* theParent);
-  QWidget* createContainer(const std::string& theType, QWidget* theParent = NULL);
-  QWidget* selectorControl(QWidget* theParent);
-  QWidget* booleanControl(QWidget* theParent);
-  QWidget* point2dDistanceControl(QWidget* theParent);
-
-  /// Check whether the XML definition for the given type contains internal property
-  /// \param theType the widget type
-  /// \return the boolean result
-  bool isInternalWidget(const std::string& theType);
-
-  QString qs(const std::string& theStdString) const;
-
-private:
+  /// check if ModuleBase_Widget has expandable widgets in getControls
+  bool hasExpandingControls(QWidget* theParent);
+
+  /// creates panel control, if the corresponded parameter is provided by feature
+  /// \param theParent a parent widget
+  /// \return true if the panel is created
+  QWidget* createPanel(QWidget* theParent);
+
+  /// Create page by its type
+  /// \param theType a type
+  /// \param theParent a parent widget
+  ModuleBase_PageBase* createPageByType(const std::string& theType,
+                                        QWidget* theParent);
+
+  /// Create widget by its type
+  /// \param theType a type
+  /// \param theParent a parent widget
+  ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
+                                             QWidget* theParent = NULL);
+
+  /// Convert STD string to QT string
+  /// \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;
-  ModuleBase_IWorkshop*   myWorkshop;
 
+  /// Reference to workshop
+  ModuleBase_IWorkshop* myWorkshop;
+
+  /// List of created model widgets
   QList<ModuleBase_ModelWidget*> myModelWidgets;
 };