Package org.freedesktop.wayland.server

Class WlDataOfferResource

java.lang.Object

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

org.freedesktop.wayland.server.WlDataOfferResource

All Implemented Interfaces:

WaylandObject

public class WlDataOfferResource
extends Resource<WlDataOfferRequests>

offer to transfer data

A wl_data_offer represents a piece of data offered for transfer by another client (the source client). It is used by the copy-and-paste and drag-and-drop mechanisms. The offer describes the different mime types that the data can be converted to and provides the mechanism for transferring the data directly from the source client.

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
WlDataOfferResource(MemorySegment pointer)
WlDataOfferResource(Client client, int version, int id, WlDataOfferRequests implementation)

Method Summary

Modifier and Type	Method	Description
void	action(int dndAction)	notify the selected action
void	offer(String mimeType)	advertise offered mime type
void	sourceActions(int sourceActions)	notify the source-side available actions

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

WlDataOfferResource

public WlDataOfferResource(Client client,
 int version,
 int id,
 WlDataOfferRequests implementation)

WlDataOfferResource

public WlDataOfferResource(MemorySegment pointer)

Method Details

offer

public void offer(@Nonnull
 String mimeType)

advertise offered mime type

Sent immediately after creating the wl_data_offer object. One event per offered mime type.

Parameters:

mimeType - offered mime type

sourceActions

public void sourceActions(int sourceActions)

notify the source-side available actions

This event indicates the actions offered by the data source. It will be sent immediately after creating the wl_data_offer object, or anytime the source side changes its offered actions through wl_data_source.set_actions.

Parameters:

sourceActions - actions offered by the data source

action

public void action(int dndAction)

notify the selected action

This event indicates the action selected by the compositor after matching the source/destination side actions. Only one action (or none) will be offered here.

This event can be emitted multiple times during the drag-and-drop operation in response to destination side action changes through wl_data_offer.set_actions.

This event will no longer be emitted after wl_data_device.drop happened on the drag-and-drop destination, the client must honor the last action received, or the last preferred one set through wl_data_offer.set_actions when handling an "ask" action.

Compositors may also change the selected action on the fly, mainly in response to keyboard modifier changes during the drag-and-drop operation.

The most recent action received is always the valid one. Prior to receiving wl_data_device.drop, the chosen action may change (e.g. due to keyboard modifiers being pressed). At the time of receiving wl_data_device.drop the drag-and-drop destination must honor the last action received.

Action changes may still happen after wl_data_device.drop, especially on "ask" actions, where the drag-and-drop destination may choose another action afterwards. Action changes happening at this stage are always the result of inter-client negotiation, the compositor shall no longer be able to induce a different action.

Upon "ask" actions, it is expected that the drag-and-drop destination may potentially choose a different action and/or mime type, based on wl_data_offer.source_actions and finally chosen by the user (e.g. popping up a menu with the available options). The final wl_data_offer.set_actions and wl_data_offer.accept requests must happen before the call to wl_data_offer.finish.

Parameters:

dndAction - action selected by the compositor