All Manuals > CAPI User Guide and Reference Manual > 21 CAPI Reference Entries

image-list Class

Summary

An object used to manage the images displayed by tree views and list views.

Package

capi

Superclasses

capi-object

Initargs
:image-width
The width of the images in this image list.
:image-height
The height of the images in this image list.
:image-sets
A list of images or image sets.
Description

The class image-list is used to manage the images displayed by tree-view and list-view.

The initarg :image-sets specifies a list. Each item in the list image-sets may be one of the following:

A pathname or string

This specifies the filename of a file suitable for loading with load-image.

A symbol

The symbol must be a predefined image identifier, or have been registered by means of a call to register-image-translation.

An image object
For example, as returned by load-image.
An image-set object

See image-set for further details.

Note that image sets are added in their entirety; it is not possible to use image-locators to extract a single image from an image set.

The images added to the image list are numbered in order, starting from zero. An image-set containing n images contributes n images to the image list, and hence consumes n consecutive integer indices.

Examples
(example-edit-file "capi/choice/tree-view")
(example-edit-file "capi/choice/extended-selection-tree-view")
See also

image-set
load-image
register-image-translation
5.10.4 image-list, image-set and image-locator


CAPI User Guide and Reference Manual (Unix version) - 01 Dec 2021 19:32:42