|  | Home · All Classes · Modules

# QCheckBox Class Reference
[QtGui module]

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

Inherits QAbstractButton.

### Methods

- __init__ (self, QWidget parent = None)
- __init__ (self, QString text, QWidget parent = None)
- Qt.CheckState checkState (self)
- checkStateSet (self)
- bool event (self, QEvent e)
- bool hitButton (self, QPoint pos)
- initStyleOption (self, QStyleOptionButton option)
- bool isTristate (self)
- mouseMoveEvent (self, QMouseEvent)
- nextCheckState (self)
- paintEvent (self, QPaintEvent)
- setCheckState (self, Qt.CheckState state)
- setTristate (self, bool on = True)
- QSize sizeHint (self)

### Qt Signals

- void stateChanged (int)

## Detailed Description

The QCheckBox widget provides a checkbox with a text label.

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, but 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.

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:

     QCheckBox *checkbox = new QCheckBox("C&ase sensitive", this);

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

| A checkbox shown in the Macintosh widget style.
| A checkbox shown in the Windows XP widget style.
| A checkbox shown in the Plastique widget style.

## Method Documentation

### QCheckBox.__init__ (self, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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

parent is passed on to the QAbstractButton constructor.

### QCheckBox.__init__ (self, QString text, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a checkbox with the given parent and text.

parent is passed on to the QAbstractButton constructor.

### Qt.CheckState QCheckBox.checkState (self)

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

See also setCheckState() and Qt.CheckState.

### QCheckBox.checkStateSet (self)

Reimplemented from QAbstractButton.checkStateSet().

### bool QCheckBox.event (self, QEvent e)

Reimplemented from QObject.event().

### bool QCheckBox.hitButton (self, QPoint pos)

Reimplemented from QAbstractButton.hitButton().

### QCheckBox.initStyleOption (self, QStyleOptionButton option)

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 QStyleOption.initFrom().

### bool QCheckBox.isTristate (self)

### QCheckBox.mouseMoveEvent (self, QMouseEvent)

Reimplemented from QWidget.mouseMoveEvent().

### QCheckBox.nextCheckState (self)

Reimplemented from QAbstractButton.nextCheckState().

### QCheckBox.paintEvent (self, QPaintEvent)

Reimplemented from QWidget.paintEvent().

### QCheckBox.setCheckState (self, Qt.CheckState state)

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

See also checkState() and Qt.CheckState.

### QCheckBox.setTristate (self, bool on = True)

### QSize QCheckBox.sizeHint (self)

Reimplemented from QWidget.sizeHint().

## Qt Signal Documentation

### void stateChanged (int)

This is the default overload of this signal.

This signal is emitted whenever the check box's state changes, i.e. whenever the user checks or unchecks it.

state contains the check box's new Qt.CheckState.