QButtonGroup#
The QButtonGroup
class provides a container to organize groups of button widgets. More…
Synopsis#
Properties#
exclusive
- Whether the button group is exclusive
Functions#
def
addButton
(arg__1[, id=-1])def
button
(id)def
buttons
()def
checkedButton
()def
checkedId
()def
exclusive
()def
id
(button)def
removeButton
(arg__1)def
setExclusive
(arg__1)def
setId
(button, id)
Signals#
def
buttonClicked
(arg__1)def
buttonPressed
(arg__1)def
buttonReleased
(arg__1)def
buttonToggled
(arg__1, arg__2)def
idClicked
(arg__1)def
idPressed
(arg__1)def
idReleased
(arg__1)def
idToggled
(arg__1, arg__2)
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description#
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 exclusive
button group switches off all checkable (toggle) buttons except the one that has been clicked. By default, a button group is exclusive. The buttons in a button group are usually checkable QPushButton
s, QCheckBox
es (normally for non-exclusive button groups), or 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 can be added to the group with addButton()
and removed with removeButton()
. If the group is exclusive, the currently checked button is available with checkedButton()
. If a button is clicked, the buttonClicked()
signal is emitted; for a checkable button in an exclusive group this means that the button has been 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 a signal idClicked()
that emits the id of the button. The id -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.
See also
- class PySide6.QtWidgets.QButtonGroup([parent=None])#
- Parameters:
parent –
PySide6.QtCore.QObject
Constructs a new, empty button group with the given parent
.
See also
Note
Properties can be used directly when from __feature__ import true_property
is used or via accessor functions otherwise.
- property PᅟySide6.QtWidgets.QButtonGroup.exclusive: bool#
This property holds 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
.
- Access functions:
exclusive
()setExclusive
(arg__1)
- PySide6.QtWidgets.QButtonGroup.addButton(arg__1[, id=-1])#
- Parameters:
arg__1 –
PySide6.QtWidgets.QAbstractButton
id – int
Adds the given button
to the button group. If id
is -1, an id will be assigned to the button. Automatically assigned ids are guaranteed to be negative, starting with -2. If you are assigning your own ids, use positive values to avoid conflicts.
See also
- PySide6.QtWidgets.QButtonGroup.button(id)#
- Parameters:
id – int
- Return type:
Returns the button with the specified id
, or None
if no such button exists.
- PySide6.QtWidgets.QButtonGroup.buttonClicked(arg__1)#
- Parameters:
arg__1 –
PySide6.QtWidgets.QAbstractButton
This signal is emitted when the given button
is clicked. A button is clicked when it is first pressed and then released, when its shortcut key is typed, or when click()
or animateClick()
is programmatically called.
See also
- PySide6.QtWidgets.QButtonGroup.buttonPressed(arg__1)#
- Parameters:
arg__1 –
PySide6.QtWidgets.QAbstractButton
This signal is emitted when the given button
is pressed down.
See also
- PySide6.QtWidgets.QButtonGroup.buttonReleased(arg__1)#
- Parameters:
arg__1 –
PySide6.QtWidgets.QAbstractButton
This signal is emitted when the given button
is released.
See also
- PySide6.QtWidgets.QButtonGroup.buttonToggled(arg__1, arg__2)#
- Parameters:
arg__1 –
PySide6.QtWidgets.QAbstractButton
arg__2 – bool
This signal is emitted when the given button
is toggled. checked
is true if the button is checked, or false if the button is unchecked.
See also
- PySide6.QtWidgets.QButtonGroup.buttons()#
- Return type:
.list of QAbstractButton
Returns the button group’s list of buttons. This may be empty.
See also
- PySide6.QtWidgets.QButtonGroup.checkedButton()#
- Return type:
Returns the button group’s checked button, or None
if no buttons are checked.
See also
- PySide6.QtWidgets.QButtonGroup.checkedId()#
- Return type:
int
Returns the id of the checkedButton()
, or -1 if no button is checked.
See also
- PySide6.QtWidgets.QButtonGroup.exclusive()#
- Return type:
bool
See also
Getter of property exclusive
.
- PySide6.QtWidgets.QButtonGroup.id(button)#
- Parameters:
button –
PySide6.QtWidgets.QAbstractButton
- Return type:
int
Returns the id for the specified button
, or -1 if no such button exists.
See also
- PySide6.QtWidgets.QButtonGroup.idClicked(arg__1)#
- Parameters:
arg__1 – int
This signal is emitted when a button with the given id
is clicked.
See also
- PySide6.QtWidgets.QButtonGroup.idPressed(arg__1)#
- Parameters:
arg__1 – int
This signal is emitted when a button with the given id
is pressed down.
See also
- PySide6.QtWidgets.QButtonGroup.idReleased(arg__1)#
- Parameters:
arg__1 – int
This signal is emitted when a button with the given id
is released.
See also
- PySide6.QtWidgets.QButtonGroup.idToggled(arg__1, arg__2)#
- Parameters:
arg__1 – int
arg__2 – bool
This signal is emitted when a button with the given id
is toggled. checked
is true if the button is checked, or false if the button is unchecked.
See also
- PySide6.QtWidgets.QButtonGroup.removeButton(arg__1)#
- Parameters:
arg__1 –
PySide6.QtWidgets.QAbstractButton
Removes the given button
from the button group.
See also
- PySide6.QtWidgets.QButtonGroup.setExclusive(arg__1)#
- Parameters:
arg__1 – bool
See also
Setter of property exclusive
.
- PySide6.QtWidgets.QButtonGroup.setId(button, id)#
- Parameters:
button –
PySide6.QtWidgets.QAbstractButton
id – int
Sets the id
for the specified button
. Note that id
cannot be -1.
See also