Table of Contents

Class CheckBox

A button that represents a binary choice.

Inheritance
CheckBox

Remarks

CheckBox allows the user to choose one of only two possible options. It's similar to CheckButton in functionality, but it has a different appearance. To follow established UX patterns, it's recommended to use CheckBox when toggling it has no immediate effect on something. For example, it could be used when toggling it will only do something once a confirmation button is pressed.

See also BaseButton which contains common properties and methods associated with this node.

When button_group specifies a ButtonGroup, CheckBox changes its appearance to that of a radio button and uses the various radio_* theme properties.

Properties

check_v_offset

Theme Property

The vertical offset used when rendering the check icons (in pixels).

 = ``0``

Property Value

int

checked

Theme Property

The check icon to display when the CheckBox is checked.

Texture2D checked

Property Value

Texture2D

checked_disabled

Theme Property

The check icon to display when the CheckBox is checked and is disabled.

Texture2D checked_disabled

Property Value

Texture2D

radio_checked

Theme Property

The check icon to display when the CheckBox is configured as a radio button and is checked.

Texture2D radio_checked

Property Value

Texture2D

radio_checked_disabled

Theme Property

The check icon to display when the CheckBox is configured as a radio button, is disabled, and is unchecked.

Texture2D radio_checked_disabled

Property Value

Texture2D

radio_unchecked

Theme Property

The check icon to display when the CheckBox is configured as a radio button and is unchecked.

Texture2D radio_unchecked

Property Value

Texture2D

radio_unchecked_disabled

Theme Property

The check icon to display when the CheckBox is configured as a radio button, is disabled, and is unchecked.

Texture2D radio_unchecked_disabled

Property Value

Texture2D

unchecked

Theme Property

The check icon to display when the CheckBox is unchecked.

Texture2D unchecked

Property Value

Texture2D

unchecked_disabled

Theme Property

The check icon to display when the CheckBox is unchecked and is disabled.

Texture2D unchecked_disabled

Property Value

Texture2D