QCheckBox

The QCheckBox widget provides a checkbox with a text label. More

Inheritance diagram of PySide2.QtWidgets.QCheckBox

Synopsis

Functions

Signals

Detailed Description

../../_images/windows-checkbox.png

A QCheckBox is an option button that can be switched on (checked) or off (unchecked). Checkboxes are typically used to represent features in an application that can be enabled or disabled without affecting others. Different types of behavior can be implemented. For example, a QButtonGroup can be used to group check buttons logically, allowing exclusive checkboxes. However, QButtonGroup does not provide any visual representation.

The image below further illustrates the differences between exclusive and non-exclusive checkboxes.

checkboxes-exclusive1

checkboxes-non-exclusive2

Whenever a checkbox is checked or cleared, it emits the signal stateChanged() . Connect to this signal if you want to trigger an action each time the checkbox changes state. You can use isChecked() to query whether or not a checkbox is checked.

In addition to the usual checked and unchecked states, QCheckBox optionally provides a third state to indicate “no change”. This is useful whenever you need to give the user the option of neither checking nor unchecking a checkbox. If you need this third state, enable it with setTristate() , and use checkState() to query the current toggle state.

Just like QPushButton , a checkbox displays text, and optionally a small icon. The icon is set with setIcon() . The text can be set in the constructor or with setText() . A shortcut key can be specified by preceding the preferred character with an ampersand. For example:

checkbox = QCheckBox("C&ase sensitive", self)

In this example, the shortcut is Alt+A . See the QShortcut documentation for details. To display an actual ampersand, use ‘&&’.

Important inherited functions: text() , setText() , text() , pixmap(), setPixmap(), accel(), setAccel(), isToggleButton(), setDown() , isDown() , isOn(), checkState() , autoRepeat() , isExclusiveToggle(), group() , setAutoRepeat() , toggle() , pressed() , released() , clicked() , toggled() , checkState() , and stateChanged() .

class PySide2.QtWidgets.QCheckBox([parent=None])

PySide2.QtWidgets.QCheckBox(text[, parent=None])

param parent

PySide2.QtWidgets.QWidget

param text

str

Constructs a checkbox with the given parent , but with no text.

parent is passed on to the QAbstractButton constructor.

Constructs a checkbox with the given parent and text .

parent is passed on to the QAbstractButton constructor.

PySide2.QtWidgets.QCheckBox.checkState()
Return type

CheckState

Returns the checkbox’s check state. If you do not need tristate support, you can also use isChecked() , which returns a boolean.

See also

setCheckState() CheckState

PySide2.QtWidgets.QCheckBox.initStyleOption(option)
Parameters

optionPySide2.QtWidgets.QStyleOptionButton

Initializes option with the values from this QCheckBox . This method is useful for subclasses that require a QStyleOptionButton , but do not want to fill in all the information themselves.

See also

initFrom()

PySide2.QtWidgets.QCheckBox.isTristate()
Return type

bool

This property holds whether the checkbox is a tri-state checkbox.

The default is false, i.e., the checkbox has only two states.

PySide2.QtWidgets.QCheckBox.setCheckState(state)
Parameters

stateCheckState

Sets the checkbox’s check state to state . If you do not need tristate support, you can also use setChecked() , which takes a boolean.

See also

checkState() CheckState

PySide2.QtWidgets.QCheckBox.setTristate([y=true])
Parameters

y – bool

This property holds whether the checkbox is a tri-state checkbox.

The default is false, i.e., the checkbox has only two states.

PySide2.QtWidgets.QCheckBox.stateChanged(arg__1)
Parameters

arg__1 – int