PySide6.QtWidgets.QGroupBox

class QGroupBox

The QGroupBox widget provides a group box frame with a title. More…

Inheritance diagram of PySide6.QtWidgets.QGroupBox

Synopsis

Properties

  • alignmentᅟ - The alignment of the group box title

  • checkableᅟ - Whether the group box has a checkbox in its title

  • checkedᅟ - Whether the group box is checked

  • flatᅟ - Whether the group box is painted flat or has a frame

  • titleᅟ - The group box title text

Methods

Virtual methods

Slots

Signals

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

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

../../_images/fusion-groupbox.png

A group box provides a frame, a title on top, a keyboard shortcut, and displays various other widgets inside itself. The keyboard shortcut moves keyboard focus to one of the group box’s child widgets.

QGroupBox also lets you set the title (normally set in the constructor) and the title’s alignment . Group boxes can be checkable . Child widgets in checkable group boxes are enabled or disabled depending on whether or not the group box is checked .

You can minimize the space consumption of a group box by enabling the flat property. In most styles , enabling this property results in the removal of the left, right and bottom edges of the frame.

QGroupBox doesn’t automatically lay out the child widgets (which are often QCheckBox es or QRadioButton s but can be any widgets). The following example shows how we can set up a QGroupBox with a layout:

groupBox = QGroupBox(tr("Group Box with Layout"))
radio1 = QRadioButton(tr("Radio button 1"))
radio2 = QRadioButton(tr("Radio button 2"))
radio3 = QRadioButton(tr("Radio button 3"))
radio1.setChecked(True)
vbox = QVBoxLayout()
vbox.addWidget(radio1)
vbox.addWidget(radio2)
vbox.addWidget(radio3)
vbox.addStretch(1)
groupBox.setLayout(vbox)

See also

QButtonGroup

Note

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

property alignmentᅟ: Combination of Qt.AlignmentFlag

This property holds the alignment of the group box title..

Most styles place the title at the top of the frame. The horizontal alignment of the title can be specified using single values from the following list:

  • Qt::AlignLeft aligns the title text with the left-hand side of the group box.

  • Qt::AlignRight aligns the title text with the right-hand side of the group box.

  • Qt::AlignHCenter aligns the title text with the horizontal center of the group box.

The default alignment is Qt::AlignLeft.

See also

Alignment

Access functions:
property checkableᅟ: bool

This property holds whether the group box has a checkbox in its title.

If this property is true, the group box displays its title using a checkbox in place of an ordinary label. If the checkbox is checked, the group box’s children are enabled; otherwise, they are disabled and inaccessible.

By default, group boxes are not checkable.

If this property is enabled for a group box, it will also be initially checked to ensure that its contents are enabled.

See also

checked

Access functions:
property checkedᅟ: bool

This property holds whether the group box is checked.

If the group box is checkable, it is displayed with a check box. If the check box is checked, the group box’s children are enabled; otherwise, the children are disabled and are inaccessible to the user.

By default, checkable group boxes are also checked.

See also

checkable

Access functions:
property flatᅟ: bool

This property holds whether the group box is painted flat or has a frame.

A group box usually consists of a surrounding frame with a title at the top. If this property is enabled, only the top part of the frame is drawn in most styles; otherwise, the whole frame is drawn.

By default, this property is disabled, i.e., group boxes are not flat unless explicitly specified.

Note

In some styles, flat and non-flat group boxes have similar representations and may not be as distinguishable as they are in other styles.

See also

title

Access functions:
property titleᅟ: str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

This property holds the group box title text.

The group box title text will have a keyboard shortcut if the title contains an ampersand (’&’) followed by a letter.

g.setTitle("User information")

In the example above, Alt+U moves the keyboard focus to the group box. See the QShortcut documentation for details (to display an actual ampersand, use ‘&&’).

There is no default title text.

See also

alignment

Access functions:
__init__([parent=None])
Parameters:

parent – QWidget

Constructs a group box widget with the given parent but with no title.

__init__(title[, parent=None])
Parameters:

Constructs a group box with the given title and parent.

alignment()
Return type:

Combination of AlignmentFlag

See also

setAlignment()

Getter of property alignmentᅟ .

clicked([checked=false])
Parameters:

checked – bool

This signal is emitted when the check box is activated (i.e., pressed down then released while the mouse cursor is inside the button), or when the shortcut key is typed. Notably, this signal is not emitted if you call setChecked() .

If the check box is checked, checked is true; it is false if the check box is unchecked.

See also

checkable toggled() checked

initStyleOption(option)
Parameters:

option – QStyleOptionGroupBox

Initialize option with the values from this QGroupBox . This method is useful for subclasses when they need a QStyleOptionGroupBox , but don’t want to fill in all the information themselves.

See also

initFrom()

isCheckable()
Return type:

bool

Getter of property checkableᅟ .

isChecked()
Return type:

bool

Getter of property checkedᅟ .

isFlat()
Return type:

bool

Getter of property flatᅟ .

setAlignment(alignment)
Parameters:

alignment – int

See also

alignment()

setCheckable(checkable)
Parameters:

checkable – bool

See also

isCheckable()

Setter of property checkableᅟ .

setChecked(checked)
Parameters:

checked – bool

See also

isChecked()

Setter of property checkedᅟ .

setFlat(flat)
Parameters:

flat – bool

See also

isFlat()

Setter of property flatᅟ .

setTitle(title)
Parameters:

title – str

See also

title()

Setter of property titleᅟ .

title()
Return type:

str

See also

setTitle()

Getter of property titleᅟ .

toggled(on)
Parameters:

on – bool

If the group box is checkable, this signal is emitted when the check box is toggled. on is true if the check box is checked; otherwise, it is false.

See also

checkable

Notification signal of property checkedᅟ .