1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\class QButtonGroup
\brief The QButtonGroup class provides a container to organize groups of
button widgets.
\ingroup organizers
\ingroup geomanagement
QButtonGroup provides an abstract container into which button widgets can
be placed. It does not provide a visual representation of this container
(see QGroupBox for a container widget), but instead manages the states of
each of the buttons in the group.
An \l {QButtonGroup::exclusive} {exclusive} button group switches
off all checkable (toggle) buttons except the one that was
clicked. By default, a button group is exclusive. The buttons in a
button group are usually checkable QPushButton's, \l{QCheckBox}es
(normally for non-exclusive button groups), or \l{QRadioButton}s.
If you create an exclusive button group, you should ensure that
one of the buttons in the group is initially checked; otherwise,
the group will initially be in a state where no buttons are
checked.
A button is added to the group with addButton(). It can be removed
from the group with removeButton(). If the group is exclusive, the
currently checked button is available as checkedButton(). If a
button is clicked the buttonClicked() signal is emitted. For a
checkable button in an exclusive group this means that the button
was checked. The list of buttons in the group is returned by
buttons().
In addition, QButtonGroup can map between integers and buttons.
You can assign an integer id to a button with setId(), and
retrieve it with id(). The id of the currently checked button is
available with checkedId(), and there is an overloaded signal
buttonClicked() which emits the id of the button. The id \c {-1}
is reserved by QButtonGroup to mean "no such button". The purpose
of the mapping mechanism is to simplify the representation of enum
values in a user interface.
\sa QGroupBox QPushButton, QCheckBox, QRadioButton
*/
/*!
\fn QButtonGroup::QButtonGroup(QObject *parent)
Constructs a new, empty button group with the given \a parent.
\sa addButton() setExclusive()
*/
/*!
\fn QButtonGroup::~QButtonGroup()
Destroys the button group.
*/
/*!
\property QButtonGroup::exclusive
\brief whether the button group is exclusive
If this property is true then only one button in the group can be checked
at any given time. The user can click on any button to check it, and that
button will replace the existing one as the checked button in the group.
In an exclusive group, the user cannot uncheck the currently checked button
by clicking on it; instead, another button in the group must be clicked
to set the new checked button for that group.
By default, this property is true.
*/
/*!
\fn void QButtonGroup::buttonClicked(QAbstractButton *button)
This signal is emitted when the given \a button is clicked. A
button is clicked when it is first pressed and then released, when
its shortcut key is typed, or programmatically when
QAbstractButton::click() or QAbstractButton::animateClick() is
called.
\sa checkedButton(), QAbstractButton::clicked()
*/
/*!
\fn void QButtonGroup::buttonClicked(int id)
This signal is emitted when a button with the given \a id is
clicked.
\sa checkedButton(), QAbstractButton::clicked()
*/
/*!
\fn void QButtonGroup::buttonPressed(QAbstractButton *button)
\since 4.2
This signal is emitted when the given \a button is pressed down.
\sa QAbstractButton::pressed()
*/
/*!
\fn void QButtonGroup::buttonPressed(int id)
\since 4.2
This signal is emitted when a button with the given \a id is
pressed down.
\sa QAbstractButton::pressed()
*/
/*!
\fn void QButtonGroup::buttonReleased(QAbstractButton *button)
\since 4.2
This signal is emitted when the given \a button is released.
\sa QAbstractButton::released()
*/
/*!
\fn void QButtonGroup::buttonReleased(int id)
\since 4.2
This signal is emitted when a button with the given \a id is
released.
\sa QAbstractButton::released()
*/
/*!
\fn void QButtonGroup::addButton(QAbstractButton *button);
Adds the given \a button to the end of the group's internal list
of buttons. An id will be assigned to the button by this
QButtonGroup. Automatically assigned ids are guaranteed to be
negative, starting with -2. If you are also assigning your own
ids, use positive values to avoid conflicts.
\sa removeButton() buttons()
*/
/*!
\fn void QButtonGroup::addButton(QAbstractButton *button, int id);
Adds the given \a button to the button group, with the given \a
id. It is recommended to assign only positive ids.
\sa removeButton() buttons()
*/
/*!
\fn void QButtonGroup::removeButton(QAbstractButton *button);
Removes the given \a button from the button group.
\sa addButton() buttons()
*/
/*!
\fn QList<QAbstractButton*> QButtonGroup::buttons() const
Returns the list of this groups's buttons. This may be empty.
\sa addButton(), removeButton()
*/
/*!
\fn QAbstractButton *QButtonGroup::checkedButton() const;
Returns the button group's checked button, or 0 if no buttons are
checked.
\sa buttonClicked()
*/
/*!
\fn QAbstractButton *QButtonGroup::button(int id) const;
\since 4.1
Returns the button with the specified \a id, or 0 if no such button
exists.
*/
/*!
\fn void QButtonGroup::setId(QAbstractButton *button, int id)
\since 4.1
Sets the \a id for the specified \a button. Note that \a id can
not be -1.
\sa id()
*/
/*!
\fn int QButtonGroup::id(QAbstractButton *button) const;
\since 4.1
Returns the id for the specified \a button, or -1 if no such button
exists.
\sa setId()
*/
/*!
\fn int QButtonGroup::checkedId() const;
\since 4.1
Returns the id of the checkedButton(), or -1 if no button is checked.
\sa setId()
*/
/*! \fn void QButtonGroup::insert(QAbstractButton *b)
Use addButton() instead.
*/
/*! \fn void QButtonGroup::remove(QAbstractButton *b)
Use removeButton() instead.
*/
|
