src/ModuleBase/ModuleBase_WidgetToolbox.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 MODULEBASE_WIDGETTOOLBOX_H_
  21 #define MODULEBASE_WIDGETTOOLBOX_H_
  22
  23 #include <ModuleBase.h>
  24 #include <ModuleBase_PagedContainer.h>
  25
  26 class ModuleBase_PageBase;
  27 class ModuleBase_ToolBox;
  28
  29 /**
  30 * \ingroup GUI
  31 * Implements a model widget for switch as a container widget. It can be defined in XML with "toolbox" keyword
  32 */
  33 class MODULEBASE_EXPORT ModuleBase_WidgetToolbox : public ModuleBase_PagedContainer
  34 {
  35   Q_OBJECT
  36  public:
  37   /// Constructor
  38   /// \param theParent the parent object
  39   /// \param theData the widget configuration. The attribute of the model widget is obtained from
  40   ModuleBase_WidgetToolbox(QWidget* theParent, const Config_WidgetAPI* theData);
  41   virtual ~ModuleBase_WidgetToolbox();
  42
  43   /// Defines if it is supported to set the value in this widget
  44   /// \return false because this is an info widget
  45   virtual bool canAcceptFocus() const { return false; };
  46
  47   /// Add a page to the widget
  48   /// \param theWidget a page widget
  49   /// \param theName a name of page
  50   /// \param theCaseId an Id of the page
  51   /// \param theIcon an icon of the page
  52   virtual int addPage( ModuleBase_PageBase* theWidget,
  53                        const QString& theName,
  54                        const QString& theCaseId,
  55                        const QPixmap& theIcon,
  56                        const QString& theTooltip);
  57
  58  protected:
  59   /// Implements ModuleBase_PagedContainer
  60   virtual int currentPageIndex() const;
  61
  62   /// Implements ModuleBase_PagedContainer
  63   virtual void setCurrentPageIndex(int);
  64
  65  private:
  66   ModuleBase_ToolBox* myToolBox;
  67 };
  68
  69 #endif /* MODULEBASE_WIDGETTOOLBOX_H_ */