Package org.freedesktop.wayland.server

Class WlDataDeviceResource

java.lang.Object

org.freedesktop.wayland.server.Resource<WlDataDeviceRequests>

org.freedesktop.wayland.server.WlDataDeviceResource

All Implemented Interfaces:

WaylandObject

public class WlDataDeviceResource
extends Resource<WlDataDeviceRequests>

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 String	INTERFACE_NAME

Fields inherited from class org.freedesktop.wayland.server.Resource

wlResourcePtr

Constructor Summary

Constructors

Constructor	Description
WlDataDeviceResource(MemorySegment pointer)
WlDataDeviceResource(Client client, int version, int id, WlDataDeviceRequests implementation)

Method Summary

Modifier and Type	Method	Description
void	dataOffer(int id)	introduce a new wl_data_offer
void	drop()	end drag-and-drop session successfully
void	enter(int serial, WlSurfaceResource surface, Fixed x, Fixed y, WlDataOfferResource id)	initiate drag-and-drop session
void	leave()	end drag-and-drop session
void	motion(int time, Fixed x, Fixed y)	drag-and-drop session motion
void	selection(WlDataOfferResource id)	advertise new selection

Methods inherited from class org.freedesktop.wayland.server.Resource

addDestroyListener, destroy, equals, getClient, getId, getImplementation, getPointer, getVersion, hashCode, postError, postEvent, postEvent, register, unregister

Methods inherited from class java.lang.Object

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

Field Details

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

• Constant Field Values

Constructor Details

WlDataDeviceResource

public WlDataDeviceResource(Client client,
 int version,
 int id,
 WlDataDeviceRequests implementation)

WlDataDeviceResource

public WlDataDeviceResource(MemorySegment pointer)

Method Details

dataOffer

public void dataOffer(int id)

introduce a new wl_data_offer

The data_offer event introduces a new wl_data_offer object, which will subsequently be used in either the data_device.enter event (for drag-and-drop) or the data_device.selection event (for selections). Immediately following the data_device.data_offer event, the new data_offer object will send out data_offer.offer events to describe the mime types it offers.

Parameters:

id - the new data_offer object

enter

public void enter(int serial,
 @Nonnull
 WlSurfaceResource surface,
 @Nonnull
 Fixed x,
 @Nonnull
 Fixed y,
 @Nullable
 WlDataOfferResource id)

initiate drag-and-drop session

This event is sent when an active drag-and-drop pointer enters a surface owned by the client. The position of the pointer at enter time is provided by the x and y arguments, in surface-local coordinates.

Parameters:

serial - serial number of the enter event

surface - client surface entered

x - surface-local x coordinate

y - surface-local y coordinate

id - source data_offer object

leave

public void leave()

end drag-and-drop session

This event is sent when the drag-and-drop pointer leaves the surface and the session ends. The client must destroy the wl_data_offer introduced at enter time at this point.

motion

public void motion(int time,
 @Nonnull
 Fixed x,
 @Nonnull
 Fixed y)

drag-and-drop session motion

This event is sent when the drag-and-drop pointer moves within the currently focused surface. The new position of the pointer is provided by the x and y arguments, in surface-local coordinates.

Parameters:

time - timestamp with millisecond granularity

x - surface-local x coordinate

y - surface-local y coordinate

drop

public void drop()

end drag-and-drop session successfully

The event is sent when a drag-and-drop operation is ended because the implicit grab is removed.

The drag-and-drop destination is expected to honor the last action received through wl_data_offer.action, if the resulting action is "copy" or "move", the destination can still perform wl_data_offer.receive requests, and is expected to end all transfers with a wl_data_offer.finish request.

If the resulting action is "ask", the action will not be considered final. The drag-and-drop destination is expected to perform one last wl_data_offer.set_actions request, or wl_data_offer.destroy in order to cancel the operation.

selection

public void selection(@Nullable
 WlDataOfferResource id)

advertise new selection

The selection event is sent out to notify the client of a new wl_data_offer for the selection for this device. The data_device.data_offer and the data_offer.offer events are sent out immediately before this event to introduce the data offer object. The selection event is sent to a client immediately before receiving keyboard focus and when a new selection is set while the client has keyboard focus. The data_offer is valid until a new data_offer or NULL is received or until the client loses keyboard focus. Switching surface with keyboard focus within the same client doesn't mean a new selection will be sent. The client must destroy the previous selection data_offer, if any, upon receiving this event.

Parameters:

id - selection data_offer object