outline-item-closed-pixmap

Arguments: outline item kind

This generic function returns a pixmap to display for outline-items when they are in closed state. Though individual outline-items or outline widgets can be assigned their own pixmaps via their closed-pixmap property, an application can alternately assign pixmaps in a more general way by adding methods on this generic function that specialize on the application's outline and/or outline-item subclasses.

The default method returns the value of the closed-pixmap property of the individual outline-item if this is non-nil, otherwise returning the value of the closed-pixmap property of the outline itself if this is non-nil, and otherwise returning the value returned by the function default-closed-pixmap.

The kind argument receives the value of the kind property of the outline-item. The kind property is not used internally, but an application can assign arbitrary values to this property in order to specialize methods of this and other generic functions on it. For example, each outline-item that happens to represent a person could be given a "kind" property of :person. Then an outline-item-closed-pixmap method that uses an (eql :person) specializer for the kind argument would cause each of these outline-items to use a particular pixmap when in closed state.

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.