5.13 The checklist Widget

Syntax:

TYPE ::= (checklist [KEYWORD ARGUMENT]...  TYPE ... )

The type arguments represents each checklist item. The widget’s value will be a list containing the values of all ticked type arguments. The checklist widget will match a list whose elements all match at least one of the specified type arguments.

The following extra properties are recognized.

:entry-format

This string will be inserted for each entry in the list. The following ‘%’ escapes are available:

‘%v’

Replaced with the buffer representation of the type widget.

‘%b’

Replace with the checkbox.

‘%%’

Insert a literal ‘%’.

:greedy

Usually a checklist will only match if the items are in the exact sequence given in the specification. By setting :greedy to non-nil, it will allow the items to appear in any sequence. However, if you extract the values they will be in the sequence given in the checklist. I.e. the original sequence is forgotten.

button-args

A list of keywords to pass to the checkboxes. Useful for setting e.g. the ‘:help-echo’ for each checkbox.

:buttons

The widgets representing the checkboxes.

:children

The widgets representing each type.

:args

The list of types.