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 QBUTTONGROUP_H
41 #define QBUTTONGROUP_H
42 
43 #include <QtWidgets/qtwidgetsglobal.h>
44 #include <QtCore/qobject.h>
45 
46 QT_REQUIRE_CONFIG(buttongroup);
47 
48 QT_BEGIN_NAMESPACE
49 
50 class QAbstractButton;
51 class QAbstractButtonPrivate;
52 class QButtonGroupPrivate;
53 
54 class Q_WIDGETS_EXPORT QButtonGroup : public QObject
55 {
56     Q_OBJECT
57 
58     Q_PROPERTY(bool exclusive READ exclusive WRITE setExclusive)
59 public:
60     explicit QButtonGroup(QObject *parent = nullptr);
61     ~QButtonGroup();
62 
63     void setExclusive(bool);
64     bool exclusive() const;
65 
66     void addButton(QAbstractButton *, int id = -1);
67     void removeButton(QAbstractButton *);
68 
69     QList<QAbstractButton*> buttons() const;
70 
71     QAbstractButton * checkedButton() const;
72     // no setter on purpose!
73 
74     QAbstractButton *button(int id) const;
75     void setId(QAbstractButton *button, int id);
76     int id(QAbstractButton *button) const;
77     int checkedId() const;
78 
79 Q_SIGNALS:
80     void buttonClicked(QAbstractButton *);
81     void buttonPressed(QAbstractButton *);
82     void buttonReleased(QAbstractButton *);
83     void buttonToggled(QAbstractButton *, bool);
84     void idClicked(int);
85     void idPressed(int);
86     void idReleased(int);
87     void idToggled(int, bool);
88 #if QT_DEPRECATED_SINCE(5, 15)
89     QT_DEPRECATED_VERSION_X_5_15("Use QButtonGroup::idClicked(int) instead")
90     void buttonClicked(int);
91     QT_DEPRECATED_VERSION_X_5_15("Use QButtonGroup::idPressed(int) instead")
92     void buttonPressed(int);
93     QT_DEPRECATED_VERSION_X_5_15("Use QButtonGroup::idReleased(int) instead")
94     void buttonReleased(int);
95     QT_DEPRECATED_VERSION_X_5_15("Use QButtonGroup::idToggled(int, bool) instead")
96     void buttonToggled(int, bool);
97 #endif
98 
99 private:
100     Q_DISABLE_COPY(QButtonGroup)
101     Q_DECLARE_PRIVATE(QButtonGroup)
102     friend class QAbstractButton;
103     friend class QAbstractButtonPrivate;
104 };
105 
106 QT_END_NAMESPACE
107 
108 #endif // QBUTTONGROUP_H
109