src/ParametersPlugin/ParametersPlugin_WidgetCreator.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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 ParametersPlugin_WidgetCreator_H
  21 #define ParametersPlugin_WidgetCreator_H
  22
  23 #include "ParametersPlugin.h"
  24
  25 #include <ModuleBase_IWidgetCreator.h>
  26
  27 #include <string>
  28 #include <set>
  29
  30 /**
  31 * \ingroup GUI
  32 * Interface to WidgetCreator which can create specific widgets by type
  33 */
  34 class ParametersPlugin_WidgetCreator : public ModuleBase_IWidgetCreator
  35 {
  36 public:
  37   /// Default constructor
  38   ParametersPlugin_WidgetCreator();
  39
  40   /// Returns a container of possible widget types, which this creator can process
  41   /// \param theTypes a list of type names
  42   virtual void widgetTypes(std::set<std::string>& theTypes);
  43
  44   /// Create widget by its type
  45   /// The default implementation is empty
  46   /// \param theType a type
  47   /// \param theParent a parent widget
  48   /// \param theWidgetApi a low-level API for reading xml definitions of widgets
  49   /// \param theWorkshop a current workshop
  50   /// \return a created model widget or null
  51   virtual ModuleBase_ModelWidget* createWidgetByType(const std::string& theType,
  52                                                      QWidget* theParent,
  53                                                      Config_WidgetAPI* theWidgetApi,
  54                                                      ModuleBase_IWorkshop* theWorkshop);
  55 };
  56
  57 #endif