org.freedesktop.wayland.client

Class WlDataDeviceProxy

java.lang.Object

org.freedesktop.wayland.client.Proxy<WlDataDeviceEvents>

org.freedesktop.wayland.client.WlDataDeviceProxy

All Implemented Interfaces:

org.freedesktop.wayland.util.WaylandObject

public class WlDataDeviceProxy
extends Proxy<WlDataDeviceEvents>

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 and Description
static String	INTERFACE_NAME

Fields inherited from class org.freedesktop.wayland.client.Proxy

pointer

Constructor Summary

Constructors

Constructor and Description
WlDataDeviceProxy(long pointer)
WlDataDeviceProxy(long pointer, WlDataDeviceEvents implementation, int version)

Method Summary

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

Methods inherited from class org.freedesktop.wayland.client.Proxy

destroy, equals, getId, getImplementation, getPointer, getVersion, hashCode, marshal, marshal, marshalConstructor, setQueue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

Constant Field Values

Constructor Detail

WlDataDeviceProxy

public WlDataDeviceProxy(long pointer,
                         WlDataDeviceEvents implementation,
                         int version)

WlDataDeviceProxy

public WlDataDeviceProxy(long pointer)

Method Detail

startDrag

public void startDrag(@Nullable
                      WlDataSourceProxy source,
                      @Nonnull
                      WlSurfaceProxy origin,
                      @Nullable
                      WlSurfaceProxy 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.

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.attach request 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 current and pending input regions of the icon wl_surface are cleared, and wl_surface.set_input_region is ignored until the wl_surface is no longer used as the icon surface. When the use as an icon ends, the current and pending input regions become undefined, and the wl_surface is unmapped.

Parameters:

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

public void setSelection(@Nullable
                         WlDataSourceProxy 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.

Parameters:

source - data source for the selection

serial - serial number of the event that triggered this request

release

public void release()

destroy data device

This request destroys the data device.