]> SALOME platform Git repositories - modules/shaper.git/blob - src/CollectionPlugin/CollectionPlugin_WidgetCreator.h
Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / CollectionPlugin / CollectionPlugin_WidgetCreator.h
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
18 //
19
20 #ifndef CollectionPlugin_WidgetCreator_H
21 #define CollectionPlugin_WidgetCreator_H
22
23
24 #include "CollectionPlugin.h"
25 #include <ModuleBase_IWidgetCreator.h>
26
27 #include <string>
28 #include <set>
29
30 class QWidget;
31
32 /** 
33 * \ingroup GUI
34 * Interface to WidgetCreator which can create specific widgets by type
35 */
36 class CollectionPlugin_WidgetCreator : public ModuleBase_IWidgetCreator
37 {
38 public:
39   /// Default constructor
40   CollectionPlugin_WidgetCreator();
41
42   /// Virtual destructor
43   ~CollectionPlugin_WidgetCreator() {}
44
45   /// Returns a container of possible page types, which this creator can process
46   /// \param theTypes a list of type names
47   virtual void widgetTypes(std::set<std::string>& theTypes);
48
49   /// Create widget by its type
50   /// The default implementation is empty
51   /// \param theType a type
52   /// \param theParent a parent widget
53   /// \param theData a low-level API for reading xml definitions of widgets
54   /// \param theWorkshop a current workshop
55   /// \return a created model widget or null
56   virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
57                                                      QWidget* theParent,
58                                                      Config_WidgetAPI* theWidgetApi,
59                                                      ModuleBase_IWorkshop* /*theWorkshop*/);
60 private:
61   std::set<std::string> myPanelTypes; ///< types of panels
62 };
63
64 #endif