CheckBox QML Type

A checkbox with a text label. More...

• List of all members, including inherited members

Properties

• activeFocusOnPress : bool
• checked : bool
• checkedState : int
• exclusiveGroup : ExclusiveGroup
• hovered : bool
• partiallyCheckedEnabled : bool
• pressed : bool
• style : Component
• text : string
• tooltip : string

Signals

• clicked()

Detailed Description

A CheckBox is an option button that can be toggled on (checked) or off (unchecked). Checkboxes are typically used to represent features in an application that can be enabled or disabled without affecting others.

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

The partially checked state can be made available to the user by setting partiallyCheckedEnabled to true, or set directly by setting checkedState to Qt.PartiallyChecked. checkedState behaves identically to checked when partiallyCheckedEnabled is false; setting one will appropriately set the other.

The label is shown next to the checkbox, and you can set the label text using its text property.

  Column {
      CheckBox {
          text: qsTr("Breakfast")
          checked: true
      }
      CheckBox {
          text: qsTr("Lunch")
      }
      CheckBox {
          text: qsTr("Dinner")
          checked: true
      }
  }

Whenever a CheckBox is clicked, it emits the clicked() signal.

You can create a custom appearance for a CheckBox by assigning a CheckBoxStyle.

Property Documentation

Signal Documentation