Salome HOME
Doxygen warning fixes
[modules/shaper.git] / 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 theParent a parent widget
42   void createWidget(ModuleBase_PageBase* theParent);
43
44
45   /// Returns list of model widgets
46   QList<ModuleBase_ModelWidget*> getModelWidgets() const
47   {
48     return myModelWidgets;
49   }
50
51  protected:
52   /// check if ModuleBase_Widget has expandable widgets in getControls
53   bool hasExpandingControls(QWidget* theParent);
54    /// Create widget by its type
55    /// \param theType a type
56    /// \param theParent a parent widget
57   ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
58                                              QWidget* theParent = NULL);
59
60   /// Convert STD string to QT string
61   /// \param theStdString is STD string
62   static QString qs(const std::string& theStdString);
63
64  private:
65    /// API object for XML reading
66   Config_WidgetAPI* myWidgetApi;
67
68   /// Reference to workshop
69   ModuleBase_IWorkshop* myWorkshop;
70
71   /// List of created model widgets
72   QList<ModuleBase_ModelWidget*> myModelWidgets;
73
74   /// Id of current parent
75   std::string myParentId;
76 };
77
78 #endif /* ModuleBase_WidgetFactory_H_ */