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

output-pane-cached-display-user-info Accessor

Summary

Gets and sets the user-info in the current cached display of an output pane.

Package

capi

Signature

output-pane-cached-display-user-info pane => user-info

(setf output-pane-cached-display-user-info) user-info pane => user-info

Arguments
pane
user-info
A Lisp object.
Values
user-info
A Lisp object.
Description

The accessor output-pane-cached-display-user-info gets and sets the user-info in the current cached display of the output pane pane.

If pane does not have a cached display, the getter returns nil and the setter has no effect (but returns the new user-info as per normal Common Lisp conventions).

A value that is set by the setter will be returned by the getter until the cached display is freed by a call to output-pane-free-cached-display, either explicitly or implicitly. Note that this means that calls to start-drawing-with-cached-display and output-pane-cache-display also reset the user-info.

See also

output-pane-free-cached-display
start-drawing-with-cached-display
12.5 Transient display on output-pane and subclasses


CAPI User Guide and Reference Manual (Macintosh version) - 01 Dec 2021 19:31:27