| Allegro CL version 8.2 Unrevised from 8.1 to 8.2. 8.1 version |
Arguments: clipboard-format
This generic function returns (or sets with setf) the value of the Windows clipboard for a
specified format. The argument may be either :text
,
:rich-text
, or :pixmap
to
indicate the format. When using the setf, the value should match the specified
format, where :text
indicates a regular Lisp
string, :rich-text
indicates a regular Lisp string
that happens to be in rich text format (such as can be retrieved by
calling rich-edit-range on a rich-edit
widget or
rich-edit-pane
), and
:pixmap
indicates a Common Graphics pixmap
object. (Common Graphics uses the "device-independent bitmap" Windows
clipboard format to pass pixmaps on the Windows clipboard to and from
other applications.)
The setf of this function has an additional keyword parameter called
empty-clipboard, which defaults to t. When true,
this causes the clipboard to be completely cleared before placing the
new value onto the clipboard. This ensures that no values of other
data formats are left on the clipboard along with the new value. If it
is desired to place data of multiple formats onto the clipboard, then
specify this argument as nil
when adding
successive formats, as in:
(setf (clipboard-object :text :empty-clipboard nil) "foo")
Note that the setf of this function does not modify the Lisp clipboard
stack. To modify both the Windows clipboard and the Lisp clipboard
stack, use a function such as push-lisp-clipboard or copy-command rather than
(setf clipboard-object)
.
The older functions clipboard-string and clipboard-pixmap are deprecated in favor of this newer single function.
See cg-clipboard.htm.
Only the :text
format is supported for passing
information on the system clipboard between Lisp and other
applications. The :pixmap
format may be
supportable in the future, but the :rich-text
format (or formated text in general) does not appear to be
supportable. Arbitrary lisp objects may still be passed on the lisp
clipboard within a lisp application by calling push-lisp-clipboard and pop-lisp-clipboard.
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.
| Allegro CL version 8.2 Unrevised from 8.1 to 8.2. 8.1 version |