src/SamplePanelPlugin/SamplePanelPlugin_ModelWidgetCreator.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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef SamplePanelPlugin_ModelWidgetCreator_H
  22 #define SamplePanelPlugin_ModelWidgetCreator_H
  23
  24 #include "SamplePanelPlugin.h"
  25
  26 #include <ModuleBase_IWidgetCreator.h>
  27
  28 #include <string>
  29 #include <set>
  30
  31 class ModuleBase_IWorkshop;
  32 class Config_WidgetAPI;
  33 class QWidget;
  34
  35 /**
  36 * \ingroup GUI
  37 * Interface to WidgetCreator which can create specific widgets by type
  38 */
  39 class SamplePanelPlugin_ModelWidgetCreator : public ModuleBase_IWidgetCreator
  40 {
  41 public:
  42   /// Default constructor
  43   SamplePanelPlugin_ModelWidgetCreator();
  44
  45   /// Virtual destructor
  46   ~SamplePanelPlugin_ModelWidgetCreator() {}
  47
  48   /// Returns a container of possible widget types, which this creator can process
  49   /// \param a list of type names
  50   virtual void widgetTypes(std::set<std::string>& theTypes);
  51
  52   /// Create widget by its type
  53   /// The default implementation is empty
  54   /// \param theType a type
  55   /// \param theParent a parent widget
  56   /// \param theData a low-level API for reading xml definitions of widgets
  57   /// \param theWorkshop a current workshop
  58   /// \return a created model widget or null
  59   virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
  60                                                      QWidget* theParent,
  61                                                      Config_WidgetAPI* theWidgetApi,
  62                                                      ModuleBase_IWorkshop* /*theWorkshop*/);
  63 private:
  64   std::set<std::string> myModelWidgetTypes; /// types of widgets
  65 };
  66
  67 #endif