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

drop-object-get-object Function

Summary

Returns a dropped object in a given format.

Package

capi

Signature

drop-object-get-object drop-object pane format &rest args => object

Arguments
drop-object
A drop-object, as passed to the drop-callback.
pane
A CAPI pane.
format
A format keyword.
args
Other arguments, currently ignored.
Values
object
An object in the given format.
Description

The function drop-object-get-object returns the dropped object in the dropping operation for drop-object over pane with format format. See set-drop-object-supported-formats for information on format keywords.

Other arguments in args are currently ignored.

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 explicitly.
  2. drop-object-get-object should only be called within a drop-callback, passing the supplied drop-object and pane. It is not supported on X11/Motif. See simple-pane for information about drop callbacks.
Examples
(example-edit-file "capi/output-panes/drag-and-drop")
(example-edit-file "capi/choice/list-panel-drag-images")
See also

set-drop-object-supported-formats
simple-pane
17 Drag and Drop


CAPI User Guide and Reference Manual (Unix version) - 01 Dec 2021 19:32:42