CheckBox QML Type

An option button that can be checked or unchecked. More...

Import Statement: import QtQuick.Controls 2.0
Since: Qt 5.7
Inherits:

AbstractButton

Properties

Detailed Description

CheckBox presents an option button that can be toggled on (checked) or off (unchecked). Check boxes are typically used to select one or more options from a set of options.

The state of the checkbox can be set with the checked property.

In addition to the checked and unchecked states, there is a third state: partially checked. The partially checked state can be enabled using the tristate property. This state indicates that the regular checked/unchecked state can not be determined; generally because of other states that affect the checkbox. This state is useful when several child nodes are selected in a treeview, for example.

A check box in its normal state.

A check box that is checked.

A check box that has active focus.

A check box that is disabled.

  ColumnLayout {
      CheckBox {
          checked: true
          text: qsTr("First")
      }
      CheckBox {
          text: qsTr("Second")
      }
      CheckBox {
          checked: true
          text: qsTr("Third")
      }
  }

See also Customizing CheckBox and Button Controls.

Property Documentation

checkState : enumeration

This property holds the check state of the checkbox.

Available states:

ConstantDescription
Qt.UncheckedThe checkbox is unchecked.
Qt.PartiallyCheckedThe checkbox is partially checked. This state is only used when tristate is enabled.
Qt.CheckedThe checkbox is checked.

See also tristate and checked.


tristate : bool

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

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