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