drop-object-drop-effect

drop-object-drop-effect Accessor

Summary

Reads or sets the current effect of a dropping operation.

Package

capi

Signature

drop-object-drop-effect drop-object => effect

(setf drop-object-drop-effect) effect drop-object => effect

Arguments

`drop-object`⇩	A `drop-object`, as passed to the `drop-callback`.
`effect`⇩	An effect keyword.

Values

effect⇩

An effect keyword.

Description

The accessor drop-object-drop-effect gets or sets the current effect of the dropping operation for drop-object. effect can be one of:

`:copy`	The object will be copied. This is the most common value for operations between applications.
`:move`	The object will be moved. This is usually triggered by the user dragging with a platform-specific modifier key pressed.
`:link`	A link to the object will be created. This is usually triggered by the user dragging with a platform-specific modifier key pressed.
`:none`	No dragging is possible.

Notes

drop-object-drop-effect should only be called within a drop-callback. 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")