src/ModuleBase/ModuleBase_IWidgetCreator.h

   1 // Copyright (C) 2014-2022  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
  18 //
  19
  20 #ifndef ModuleBase_IWidgetCreator_H
  21 #define ModuleBase_IWidgetCreator_H
  22
  23 #include "ModuleBase.h"
  24
  25 #include "ModelAPI_Feature.h"
  26
  27 #include <set>
  28 #include <string>
  29 #include <memory>
  30
  31 #ifdef _MSC_VER
  32 #pragma warning(disable: 4100)
  33 #endif
  34
  35 class ModuleBase_ModelWidget;
  36 class ModuleBase_PageBase;
  37 class ModuleBase_IWorkshop;
  38
  39 class Config_WidgetAPI;
  40
  41 class QWidget;
  42
  43 /**
  44 * \ingroup GUI
  45 * Interface to WidgetCreator which can create specific widgets by type
  46 */
  47 class MODULEBASE_EXPORT ModuleBase_IWidgetCreator
  48 {
  49 public:
  50   /// Default constructor
  51   ModuleBase_IWidgetCreator();
  52
  53   /// Virtual destructor
  54   ~ModuleBase_IWidgetCreator();
  55
  56   /// Returns a container of possible page types, which this creator can process
  57   /// The default implementation is empty
  58   /// \param theTypes a list of type names
  59   virtual void panelTypes(std::set<std::string>& /*theTypes*/) {}
  60
  61   /// Returns a container of possible page types, which this creator can process
  62   /// The default implementation is empty
  63   /// \param theTypes a list of type names
  64   virtual void pageTypes(std::set<std::string>& theTypes) {}
  65
  66   /// Returns a container of possible widget types, which this creator can process
  67   /// \param theTypes a list of type names
  68   virtual void widgetTypes(std::set<std::string>& theTypes) {}
  69
  70   /// Create panel control by its type.
  71   /// The default implementation is empty
  72   /// \param theType a panel type
  73   /// \param theParent a parent widget
  74   /// \param theFeature a feature modified in the panel
  75   /// \param theWidgetApi a low-level API for reading xml definitions of widget
  76   /// \return created widget or null
  77   virtual QWidget* createPanelByType(const std::string& theType,
  78                                      QWidget* theParent,
  79                                      const FeaturePtr& theFeature,
  80                                      Config_WidgetAPI* theWidgetApi = 0);
  81
  82   /// Create page by its type
  83   /// The default implementation is empty
  84   /// \param theType a type
  85   /// \param theParent a parent widget
  86   /// \param theWidgetApi a low-level API for reading xml definitions of widgets
  87   virtual ModuleBase_PageBase* createPageByType(const std::string& theType,
  88                                                 QWidget* theParent,
  89                                                 Config_WidgetAPI* theWidgetApi);
  90
  91   /// Create widget by its type
  92   /// The default implementation is empty
  93   /// \param theType a type
  94   /// \param theParent a parent widget
  95   /// \param theWidgetApi a low-level API for reading xml definitions of widgets
  96   /// \param theWorkshop a workshop class instance
  97   virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
  98                                                      QWidget* theParent,
  99                                                      Config_WidgetAPI* theWidgetApi,
 100                                                      ModuleBase_IWorkshop* theWorkshop);
 101 };
 102
 103 typedef std::shared_ptr<ModuleBase_IWidgetCreator> WidgetCreatorPtr;
 104
 105
 106 #endif