Package org.freedesktop.wayland.server

Interface WlDataDeviceRequestsV3

All Superinterfaces:

WlDataDeviceRequests, WlDataDeviceRequestsV2

public interface WlDataDeviceRequestsV3
extends WlDataDeviceRequestsV2

data transfer device

There is one wl_data_device per seat which can be obtained from the global wl_data_device_manager singleton.

A wl_data_device provides access to inter-client data transfer mechanisms such as copy-and-paste and drag-and-drop.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION

Method Summary

Modifier and Type	Method	Description
void	release(WlDataDeviceResource requester)	destroy data device
void	setSelection(WlDataDeviceResource requester, WlDataSourceResource source, int serial)	copy data to the selection
void	startDrag(WlDataDeviceResource requester, WlDataSourceResource source, WlSurfaceResource origin, WlSurfaceResource icon, int serial)	start drag-and-drop operation

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

startDrag

void startDrag(WlDataDeviceResource requester,
 @Nullable
 WlDataSourceResource source,
 @Nonnull
 WlSurfaceResource origin,
 @Nullable
 WlSurfaceResource icon,
 int serial)

start drag-and-drop operation

This request asks the compositor to start a drag-and-drop operation on behalf of the client.

The source argument is the data source that provides the data for the eventual data transfer. If source is NULL, enter, leave and motion events are sent only to the client that initiated the drag and the client is expected to handle the data passing internally. If source is destroyed, the drag-and-drop session will be cancelled.

The origin surface is the surface where the drag originates and the client must have an active implicit grab that matches the serial.

The icon surface is an optional (can be NULL) surface that provides an icon to be moved around with the cursor. Initially, the top-left corner of the icon surface is placed at the cursor hotspot, but subsequent wl_surface.offset requests can move the relative position. Attach requests must be confirmed with wl_surface.commit as usual. The icon surface is given the role of a drag-and-drop icon. If the icon surface already has another role, it raises a protocol error.

The input region is ignored for wl_surfaces with the role of a drag-and-drop icon.

The given source may not be used in any further set_selection or start_drag requests. Attempting to reuse a previously-used source may send a used_source error.

Specified by:

startDrag in interface WlDataDeviceRequests

Specified by:

startDrag in interface WlDataDeviceRequestsV2

Parameters:

requester - The protocol object that made the request.

source - data source for the eventual transfer

origin - surface where the drag originates

icon - drag-and-drop icon surface

serial - serial number of the implicit grab on the origin

setSelection

void setSelection(WlDataDeviceResource requester,
 @Nullable
 WlDataSourceResource source,
 int serial)

copy data to the selection

This request asks the compositor to set the selection to the data from the source on behalf of the client.

To unset the selection, set the source to NULL.

The given source may not be used in any further set_selection or start_drag requests. Attempting to reuse a previously-used source may send a used_source error.

Specified by:

setSelection in interface WlDataDeviceRequests

Specified by:

setSelection in interface WlDataDeviceRequestsV2

Parameters:

requester - The protocol object that made the request.

source - data source for the selection

serial - serial number of the event that triggered this request

release

void release(WlDataDeviceResource requester)

destroy data device

This request destroys the data device.

Specified by:

release in interface WlDataDeviceRequestsV2

Parameters:

requester - The protocol object that made the request.