PySide6.QtWidgets.QButtonGroup¶

class QButtonGroup¶

The QButtonGroup class provides a container to organize groups of button widgets. More…

Synopsis¶

Properties¶

exclusiveᅟ - Whether the button group is exclusive

Methods¶

def __init__()
def addButton()
def button()
def buttons()
def checkedButton()
def checkedId()
def exclusive()
def id()
def removeButton()
def setExclusive()
def setId()

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

QGroupBox QPushButton QCheckBox QRadioButton

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property 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()

__init__([parent=None])¶

Parameters:: parent – QObject

Constructs a new, empty button group with the given parent.

See also

addButton() setExclusive()

addButton(button[, id=-1])¶

Parameters:

button – 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

removeButton() buttons()

button(id)¶

Parameters:: id – int
Return type:: QAbstractButton

Returns the button with the specified id, or None if no such button exists.

buttonClicked(button)¶

Parameters:: button – 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

checkedButton() clicked()

buttonPressed(button)¶

Parameters:: button – QAbstractButton

This signal is emitted when the given button is pressed down.

See also

pressed()

buttonReleased(button)¶

Parameters:: button – QAbstractButton

This signal is emitted when the given button is released.

See also

released()

buttonToggled(button, checked)¶

Parameters:

button – QAbstractButton
checked – 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

toggled()

buttons()¶

Return type:: .list of QAbstractButton

Returns the button group’s list of buttons. This may be empty.

See also

addButton() removeButton()

checkedButton()¶

Return type:: QAbstractButton

Returns the button group’s checked button, or None if no buttons are checked.

See also

buttonClicked()

checkedId()¶

Return type:: int

Returns the id of the checkedButton() , or -1 if no button is checked.

See also

setId()

exclusive()¶

Return type:: bool