src/ModuleBase/ModuleBase_WidgetFactory.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_WidgetFactory.h
   5  *
   6  *  Created on: Apr 3, 2014
   7  *      Author: sbh
   8  */
   9
  10 #ifndef MODULEBASE_WIDGETFACTORY_H_
  11 #define MODULEBASE_WIDGETFACTORY_H_
  12
  13 #include <ModuleBase.h>
  14 #include <ModuleBase_ModelWidget.h>
  15
  16 #include <QString>
  17 #include <QList>
  18
  19 class QObject;
  20 class QWidget;
  21 class Config_WidgetAPI;
  22 class ModuleBase_IWorkshop;
  23 class ModuleBase_PageBase;
  24
  25 /**
  26 * \ingroup GUI
  27 * A class for creation of widgets instances in for property panel using XML deskription of
  28 * a feature
  29 */
  30 class MODULEBASE_EXPORT ModuleBase_WidgetFactory
  31 {
  32  public:
  33    /// Constructor
  34    /// \param theXmlRepresentation content of XML file
  35    /// \param theWorkshop reference to workshop instance
  36   ModuleBase_WidgetFactory(const std::string& theXmlRepresentation,
  37                            ModuleBase_IWorkshop* theWorkshop);
  38   virtual ~ModuleBase_WidgetFactory();
  39
  40   /// Creates content widget for property panel
  41   /// \param thePage a parent page
  42   void createWidget(ModuleBase_PageBase* thePage, bool alignToTop = true);
  43
  44   /// Creates property panel content for the feature
  45   /// \param thePage a parent page
  46   /// \param theFeature a feature to fill the panel
  47   void createPanel(ModuleBase_PageBase* thePage, const FeaturePtr& theFeature);
  48
  49   /// Creates one widget for property panel for the widget with given index
  50   /// \param theParent a parent widget
  51   /// \param theWidgetId a widget index
  52   void createWidget(ModuleBase_PageBase* thePage,
  53                     const std::string& theWidgetId);
  54
  55   /// Returns list of model widgets
  56   QList<ModuleBase_ModelWidget*> getModelWidgets() const
  57   {
  58     return myModelWidgets;
  59   }
  60
  61   /// Returns the value of the title key from XML definition of the attribute in the feature
  62   /// \param theAttributeId a value of a kind of the attribute under the feature
  63   /// \param theTitle the result title
  64   void getAttributeTitle(const std::string& theAttributeId,
  65                          std::string& theTitle);
  66
  67   /// Returns the identifier of the first found attribute where greed field value is set and true
  68   /// \param theAttributeId an outpup parameter with  attribute
  69   void getGreedAttribute(std::string& theAttributeId);
  70
  71 protected:
  72   /// check if ModuleBase_Widget has expandable widgets in getControls
  73   bool hasExpandingControls(QWidget* theParent);
  74
  75   /// Create page by its type
  76   /// \param theType a type
  77   /// \param theParent a parent widget
  78   ModuleBase_PageBase* createPageByType(const std::string& theType,
  79                                         QWidget* theParent);
  80
  81   /// Create widget by its type
  82   /// \param theType a type
  83   /// \param theParent a parent widget
  84   ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
  85                                              QWidget* theParent = NULL);
  86
  87   /// Convert STD string to QT string
  88   /// \param theStdString is STD string
  89   static QString qs(const std::string& theStdString);
  90
  91   /// It updates internal config api to point in the structure to given id of widget
  92   /// The method is recusive and it stops when the found flag is true
  93   /// \param theWidgetId a widget id key value
  94   /// \param theFound a flag about found windget and recursive search should be stopped
  95   void moveToWidgetId(const std::string& theWidgetId, bool& theFound);
  96
  97  private:
  98    /// API object for XML reading
  99   Config_WidgetAPI* myWidgetApi;
 100
 101   /// Reference to workshop
 102   ModuleBase_IWorkshop* myWorkshop;
 103
 104   /// List of created model widgets
 105   QList<ModuleBase_ModelWidget*> myModelWidgets;
 106 };
 107
 108 #endif /* ModuleBase_WidgetFactory_H_ */