Function

Summary

Returns the contents of the system clipboard.

Package

capi

Signature

clipboard self &optional format => result

Arguments

self

A displayed CAPI pane or interface.

format

A keyword.

Values

result

A string, an image, a Lisp object, or nil .

Description

The function clipboard returns the contents of the system clipboard as a string, or nil if the clipboard is empty.

format controls what kind of object is read. The following values of format are recognized:

:string

The object is a string. This the default value.

:image

The object is of type image, converted from whatever format the platform supports.

:value

The object is the Lisp value.

:metafile

The object is a Windows metafile.

When format is :image , the image returned by clipboard is associated with self , so you can free it explicitly with free-image or it will be freed automatically when the pane is destroyed.

format can be :metafile only on MS Windows. The object is a metafile which should be freed using free-metafile when no longer needed. See also draw-metafile and draw-metafile-to-image.

The Windows clipboard is usually set by the user with the Ctrl+C and Ctrl+X gestures. Note that LispWorks uses these gestures when in Windows emulation mode.

On X11/Motif, various gestures may set the clipboard. The X clipboard can be accessed by running the program xclipboard or the Emacs function x-get-clipboard .

The Mac OS X clipboard is usually set by the user with the Command+C and Command+X gestures.

See also

clipboard-empty
draw-metafile
draw-metafile-to-image
free-image
free-metafile
image
selection
set-clipboard