All Manuals > CAPI Reference Manual > 1 CAPI Reference Entries

NextPrevUpTopContentsIndex

drop-object-get-object

Function
Summary

Returns a dropped object in a given format

Package

capi

Signature

drop-object-get-object drop-object format => object

Arguments

drop-object

A drop-object , as passed to the drop-callback .

format

A format keyword

Values

object

An object in the given format

Description

The function drop-object-get-object returns the dropped object in the given format. See set-drop-object-supported-formats for information on format keywords.

Notes
  1. When receiving an image (by calling drop-object-get-object with the :image format), the received image should also be freed when you finish with it. However, it will be freed automatically when the pane supplied to drop-object-get-object is destroyed, so normally you do not need to free it explictly.
  2. drop-object-get-object should only be called within a drop-callback . It is not supported on X11/Motif. See simple-pane for information about drop callbacks.
Example

See
examples/capi/output-panes/drag-and-drop.lisp
and
examples/capi/choice/list-panel-drag-images.lisp .

See also

set-drop-object-supported-formats
simple-pane


CAPI Reference Manual - 15 Dec 2011

NextPrevUpTopContentsIndex