Next Prev Up Top Contents Index

choice-selected-items

Generic Function
Summary

The function choice-selected-items returns the currently selected items in a choice as a list of the items.

Syntax

choice-selected-items choice

Description

The function choice-selected-items returns the currently selected items in a choice as a list of the items. A setf method is provided as a means of setting the currently selected items. In the case of single-selection choices, it is usually easier to use the complementary function choice-selected-item , which returns the selected item as its result.

Compatibility Note

In LispWorks 3.1, choice-selected-items returned a single item for single-selection list panels but this was considered to cause problems and so it was changed to always return a list, and the alternative function choice-selected-item was provided for single selection panes.

Examples

First we set up a multiple selection choice -- in this case, a list panel.

(setq list (capi:contain
            (make-instance
             'capi:list-panel
             :items '(a b c d e)
             :visible-min-height '(:character 5)
             :interaction :multiple-selection
             :selection '(1 3))
            :process nil))

The following code line returns the selections of the list.

(capi:choice-selected-items list)

The selections of the list panel can be changed and redisplayed using the following code.

(setf (capi:choice-selected-items list) '(a c e))
(capi:choice-selected-items list)
See also

choice
choice-selected-item


LispWorks CAPI Reference Manual - 14 Dec 2001

Next Prev Up Top Contents Index