QGroupBox

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

Inheritance diagram of PySide2.QtWidgets.QGroupBox

Synopsis

Functions

Slots

Signals

Detailed Description

../../_images/windows-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("Exclusive Radio Buttons")

radio1 = QRadioButton("&Radio button 1")
radio2 = QRadioButton("R&adio button 2")
radio3 = QRadioButton("Ra&dio button 3")

radio1.setChecked(True)


vbox = QVBoxLayout()
vbox.addWidget(radio1)
vbox.addWidget(radio2)
vbox.addWidget(radio3)
vbox.addStretch(1)
groupBox.setLayout(vbox)
class PySide2.QtWidgets.QGroupBox([parent=None])

PySide2.QtWidgets.QGroupBox(title[, parent=None])

param parent

PySide2.QtWidgets.QWidget

param title

str

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

Constructs a group box with the given title and parent .

PySide2.QtWidgets.QGroupBox.alignment()
Return type

Alignment

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:

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

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

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

The default alignment is AlignLeft .

See also

Alignment

PySide2.QtWidgets.QGroupBox.clicked([checked=false])
Parameters

checked – bool

PySide2.QtWidgets.QGroupBox.initStyleOption(option)
Parameters

optionPySide2.QtWidgets.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()

PySide2.QtWidgets.QGroupBox.isCheckable()
Return type

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

PySide2.QtWidgets.QGroupBox.isChecked()
Return type

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

PySide2.QtWidgets.QGroupBox.isFlat()
Return type

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

PySide2.QtWidgets.QGroupBox.setAlignment(alignment)
Parameters

alignment – int

See also

alignment()

PySide2.QtWidgets.QGroupBox.setCheckable(checkable)
Parameters

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

PySide2.QtWidgets.QGroupBox.setChecked(checked)
Parameters

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

PySide2.QtWidgets.QGroupBox.setFlat(flat)
Parameters

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

PySide2.QtWidgets.QGroupBox.setTitle(title)
Parameters

title – str

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

PySide2.QtWidgets.QGroupBox.title()
Return type

str

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

PySide2.QtWidgets.QGroupBox.toggled(arg__1)
Parameters

arg__1 – bool