1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtWidgets module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39
40 #ifndef QTOOLBOX_H
41 #define QTOOLBOX_H
42
43 #include <QtWidgets/qtwidgetsglobal.h>
44 #include <QtWidgets/qframe.h>
45 #include <QtGui/qicon.h>
46
47 QT_REQUIRE_CONFIG(toolbox);
48
49 QT_BEGIN_NAMESPACE
50
51 class QToolBoxPrivate;
52
53 class Q_WIDGETS_EXPORT QToolBox : public QFrame
54 {
55 Q_OBJECT
56 Q_PROPERTY(int currentIndex READ currentIndex WRITE setCurrentIndex NOTIFY currentChanged)
57 Q_PROPERTY(int count READ count)
58
59 public:
60 explicit QToolBox(QWidget *parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags());
61 ~QToolBox();
62
63 int addItem(QWidget *widget, const QString &text);
64 int addItem(QWidget *widget, const QIcon &icon, const QString &text);
65 int insertItem(int index, QWidget *widget, const QString &text);
66 int insertItem(int index, QWidget *widget, const QIcon &icon, const QString &text);
67
68 void removeItem(int index);
69
70 void setItemEnabled(int index, bool enabled);
71 bool isItemEnabled(int index) const;
72
73 void setItemText(int index, const QString &text);
74 QString itemText(int index) const;
75
76 void setItemIcon(int index, const QIcon &icon);
77 QIcon itemIcon(int index) const;
78
79 #ifndef QT_NO_TOOLTIP
80 void setItemToolTip(int index, const QString &toolTip);
81 QString itemToolTip(int index) const;
82 #endif
83
84 int currentIndex() const;
85 QWidget *currentWidget() const;
86 QWidget *widget(int index) const;
87 int indexOf(QWidget *widget) const;
88 int count() const;
89
90 public Q_SLOTS:
91 void setCurrentIndex(int index);
92 void setCurrentWidget(QWidget *widget);
93
94 Q_SIGNALS:
95 void currentChanged(int index);
96
97 protected:
98 bool event(QEvent *e) override;
99 virtual void itemInserted(int index);
100 virtual void itemRemoved(int index);
101 void showEvent(QShowEvent *e) override;
102 void changeEvent(QEvent *) override;
103
104
105 private:
106 Q_DECLARE_PRIVATE(QToolBox)
107 Q_DISABLE_COPY(QToolBox)
108 Q_PRIVATE_SLOT(d_func(), void _q_buttonClicked())
109 Q_PRIVATE_SLOT(d_func(), void _q_widgetDestroyed(QObject*))
110 };
111
112
addItem(QWidget * item,const QString & text)113 inline int QToolBox::addItem(QWidget *item, const QString &text)
114 { return insertItem(-1, item, QIcon(), text); }
addItem(QWidget * item,const QIcon & iconSet,const QString & text)115 inline int QToolBox::addItem(QWidget *item, const QIcon &iconSet,
116 const QString &text)
117 { return insertItem(-1, item, iconSet, text); }
insertItem(int index,QWidget * item,const QString & text)118 inline int QToolBox::insertItem(int index, QWidget *item, const QString &text)
119 { return insertItem(index, item, QIcon(), text); }
120
121 QT_END_NAMESPACE
122
123 #endif // QTOOLBOX_H
124