Skip to content

The checkbox Widget ​

Syntax:

bash
type ::= (checkbox [keyword argument]...)

A widget to represent a toggle widget, with a checkbox. Its super is the toggle widget.

This widget has two possible states, ‘selected’ and ‘unselected’, which corresponds to a t or nil value, respectively.

It either overrides or adds the following properties:

:button-prefix ​

The empty string.

:button-suffix ​

The empty string.

:format ​

By default, buttonizes the value.

:on ​

By default, the string “[X]”.

:off ​

By default, the string “[ ]”.

:on-glyph ​

The name of the image to use when the state is ‘on’.

:off-glyph ​

The name of the image to use when the state is ‘off’.

:action ​

A function that toggles the checkbox, notifies the parents and in the ‘on’ state, activates its siblings.