CheckDelegate QML Type

An item delegate that can be checked or unchecked. More...

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

ItemDelegate

Properties

Detailed Description

CheckDelegate presents an item delegate that can be toggled on (checked) or off (unchecked). Check delegates are typically used to select one or more options from a set of options.

The state of the check delegate 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 check delegate. This state is useful when several child nodes are selected in a treeview, for example.


  ListView {
      model: ["Option 1", "Option 2", "Option 3"]
      delegate: CheckDelegate {
          text: modelData
      }
  }

See also Customizing CheckDelegate and Delegate Controls.

Property Documentation

checkState : enumeration

This property determines the check state of the check delegate.

Available states:

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

See also tristate and checked.


tristate : bool

This property determines whether the check delegate has three states.

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