wlr-data-control-unstable-v1

This protocol allows a privileged client to control data devices. In particular, the client will be able to manage the current selection and take the role of a clipboard manager.

Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the 'z' prefix and the version number in the protocol and interface names are removed and the interface version number is reset.

Note! This protocol is deprecated and not intended for production use. For clipboard management, use the ext-data-control-v1 protocol.

This interface is a manager that allows creating per-seat data device controls.

Create a new data source.

Create a data device that can be used to manage a seat's selection.

All objects created by the manager will still remain valid, until their appropriate destroy request has been called.

This interface allows a client to manage a seat's selection.

When the seat is destroyed, this object becomes inert.

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

The given source may not be used in any further set_selection or set_primary_selection requests. Attempting to use a previously used source is a protocol error.

To unset the selection, set the source to NULL.

Destroys the data device object.

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

The given source may not be used in any further set_selection or set_primary_selection requests. Attempting to use a previously used source is a protocol error.

To unset the primary selection, set the source to NULL.

The compositor will ignore this request if it does not support primary selection.

The data_offer event introduces a new wlr_data_control_offer object, which will subsequently be used in either the wlr_data_control_device.selection event (for the regular clipboard selections) or the wlr_data_control_device.primary_selection event (for the primary clipboard selections). Immediately following the wlr_data_control_device.data_offer event, the new data_offer object will send out wlr_data_control_offer.offer events to describe the MIME types it offers.

The selection event is sent out to notify the client of a new wlr_data_control_offer for the selection for this device. The wlr_data_control_device.data_offer and the wlr_data_control_offer.offer events are sent out immediately before this event to introduce the data offer object. The selection event is sent to a client when a new selection is set. The wlr_data_control_offer is valid until a new wlr_data_control_offer or NULL is received. The client must destroy the previous selection wlr_data_control_offer, if any, upon receiving this event.

The first selection event is sent upon binding the wlr_data_control_device object.

This data control object is no longer valid and should be destroyed by the client.

The primary_selection event is sent out to notify the client of a new wlr_data_control_offer for the primary selection for this device. The wlr_data_control_device.data_offer and the wlr_data_control_offer.offer events are sent out immediately before this event to introduce the data offer object. The primary_selection event is sent to a client when a new primary selection is set. The wlr_data_control_offer is valid until a new wlr_data_control_offer or NULL is received. The client must destroy the previous primary selection wlr_data_control_offer, if any, upon receiving this event.

If the compositor supports primary selection, the first primary_selection event is sent upon binding the wlr_data_control_device object.

The wlr_data_control_source object is the source side of a wlr_data_control_offer. It is created by the source client in a data transfer and provides a way to describe the offered data and a way to respond to requests to transfer the data.

This request adds a MIME type to the set of MIME types advertised to targets. Can be called several times to offer multiple types.

Calling this after wlr_data_control_device.set_selection is a protocol error.

Destroys the data source object.

Request for data from the client. Send the data as the specified MIME type over the passed file descriptor, then close it.

This data source is no longer valid. The data source has been replaced by another data source.

The client should clean up and destroy this data source.

A wlr_data_control_offer represents a piece of data offered for transfer by another client (the source client). 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.

To transfer the offered data, the client issues this request and indicates the MIME type it wants to receive. The transfer happens through the passed file descriptor (typically created with the pipe system call). The source client writes the data in the MIME type representation requested and then closes the file descriptor.

The receiving client reads from the read end of the pipe until EOF and then closes its end, at which point the transfer is complete.

This request may happen multiple times for different MIME types.

Destroys the data offer object.

Sent immediately after creating the wlr_data_control_offer object. One event per offered MIME type.