pixmap-alist

Arguments: object

Returns an association list that maps arbitrary application values to pixmaps that represent those values visually. The value may be set at creation time by passing the pixmap-alist initarg, or any time later by calling (setf pixmap-alist). This is a property of the static-picture widget and the pixmap-column-mixin class. The default value is nil.

The value should be a list where each element is a list of an application value and a pixmap name. For a static-picture, each application value should be something that the application might place into the value property of the widget. For a grid-column of the pixmap-column-mixin class, each application value should be something that might be returned when read-cell-value is called. For either type of object, each pixmap name should be the name of a pixmap that has been cached by calling cache-pixmap.

When the interface object is given an application value to display, the pixmap-alist will be searched for the value, using the pixmap-value-test function to test when two application values are equivalent. If the application value is found in the alist and a pixmap is found for the corresponding pixmap name, then the pixmap is displayed; otherwise the interface object will be blank. The pixmap will fill the available area if the stretching property is true, and the user may cycle through the available pixmaps and values interactively if the user-modifiable property is true.

A pixmap value may also be nil. The interface object will be blank in this case just as it is for values that are not included in the association list, but an explicit nil can be useful to allow the user to interactively select an application value that should be represented by blankness.

Example

With the following pixmap-alist, the application value :none would result in a blank interface object, the application value :partial would draw the pixmap named :key, and the application value :full would draw the pixmap named :key-special.

((:none nil)
 (:partial :key)
 (:full :key-special)

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.