-/*
- * ModuleBase_WidgetToolbox.h
- *
- * Created on: Feb 27, 2015
- * Author: sbh
- */
+// Copyright (C) 2014-2023 CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
#ifndef MODULEBASE_WIDGETTOOLBOX_H_
#define MODULEBASE_WIDGETTOOLBOX_H_
class ModuleBase_PageBase;
class ModuleBase_ToolBox;
+/**
+* \ingroup GUI
+* Implements a model widget for switch as a container widget. It can be defined in XML with "toolbox" keyword
+*/
class MODULEBASE_EXPORT ModuleBase_WidgetToolbox : public ModuleBase_PagedContainer
{
Q_OBJECT
public:
- ModuleBase_WidgetToolbox(QWidget* theParent, const Config_WidgetAPI* theData,
- const std::string& theParentId);
+ /// Constructor
+ /// \param theParent the parent object
+ /// \param theData the widget configuration. The attribute of the model widget is obtained from
+ ModuleBase_WidgetToolbox(QWidget* theParent, const Config_WidgetAPI* theData);
virtual ~ModuleBase_WidgetToolbox();
/// Defines if it is supported to set the value in this widget
- /// It returns false because this is an info widget
- virtual bool canSetValue() const { return false; };
+ /// \return false because this is an info widget
+ virtual bool canAcceptFocus() const { return false; };
- /// Overrides ModuleBase_PagedContainer
+ /// Add a page to the widget
+ /// \param theWidget a page widget
+ /// \param theName a name of page
+ /// \param theCaseId an Id of the page
+ /// \param theIcon an icon of the page
virtual int addPage( ModuleBase_PageBase* theWidget,
const QString& theName,
const QString& theCaseId,
- const QPixmap& theIcon );
+ const QPixmap& theIcon,
+ const QString& theTooltip);
protected:
/// Implements ModuleBase_PagedContainer
virtual int currentPageIndex() const;
+
/// Implements ModuleBase_PagedContainer
virtual void setCurrentPageIndex(int);