Struct wayland_client::protocol::wl_data_offer::WlDataOffer

pub struct WlDataOffer { /* fields omitted */ }

Methods

impl WlDataOffer

fn accept(&self, serial: u32, mime_type: Option<String>) -> RequestResult<()>

accept one of the offered mime types

Indicate that the client can accept the given mime type, or NULL for not accepted.

For objects of version 2 or older, this request is used by the client to give feedback whether the client can receive the given mime type, or NULL if none is accepted; the feedback does not determine whether the drag-and-drop operation succeeds or not.

For objects of version 3 or newer, this request determines the final result of the drag-and-drop operation. If the end result is that no mime types were accepted, the drag-and-drop operation will be cancelled and the corresponding drag source will receive wl_data_source.cancelled. Clients may still use this event in conjunction with wl_data_source.action for feedback.

fn receive(&self, mime_type: String, fd: RawFd) -> RequestResult<()>

request that the data is transferred

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, both before and after wl_data_device.drop. Drag-and-drop destination clients may preemptively fetch data or examine it more closely to determine acceptance.

fn destroy(&self) -> RequestResult<()>

destroy data offer

Destroy the data offer.

This is a destructor, you cannot send requests to this object once this method is called.

fn finish(&self) -> RequestResult<()>

the offer will no longer be used

Notifies the compositor that the drag destination successfully finished the drag-and-drop operation.

Upon receiving this request, the compositor will emit wl_data_source.dnd_finished on the drag source client.

It is a client error to perform other requests than wl_data_offer.destroy after this one. It is also an error to perform this request after a NULL mime type has been set in wl_data_offer.accept or no action was received through wl_data_offer.action.

fn set_actions(&self,
               dnd_actions: u32,
               preferred_action: u32)
               -> RequestResult<()>

set the available/preferred drag-and-drop actions

Sets the actions that the destination side client supports for this operation. This request may trigger the emission of wl_data_source.action and wl_data_offer.action events if the compositor needs to change the selected action.

This request can be called multiple times throughout the drag-and-drop operation, typically in response to wl_data_device.enter or wl_data_device.motion events.

This request determines the final result of the drag-and-drop operation. If the end result is that no action is accepted, the drag source will receive wl_drag_source.cancelled.

The dnd_actions argument must contain only values expressed in the wl_data_device_manager.dnd_actions enum, and the preferred_action argument must only contain one of those values set, otherwise it will result in a protocol error.

While managing an "ask" action, the destination drag-and-drop client may perform further wl_data_offer.receive requests, and is expected to perform one last wl_data_offer.set_actions request with a preferred action other than "ask" (and optionally wl_data_offer.accept) before requesting wl_data_offer.finish, in order to convey the action selected by the user. If the preferred action is not in the wl_data_offer.source_actions mask, an error will be raised.

If the "ask" action is dismissed (e.g. user cancellation), the client is expected to perform wl_data_offer.destroy right away.

This request can only be made on drag-and-drop offers, a protocol error will be raised otherwise.

Trait Implementations

impl Send for WlDataOffer

impl Sync for WlDataOffer

impl Proxy for WlDataOffer

fn ptr(&self) -> *mut wl_proxy

Pointer to the underlying wayland proxy object

unsafe fn from_ptr_new(ptr: *mut wl_proxy) -> WlDataOffer

Create an instance from a wayland pointer

unsafe fn from_ptr_initialized(ptr: *mut wl_proxy) -> WlDataOffer

Create an instance from a wayland pointer

fn interface_ptr() -> *const wl_interface

Pointer to the interface representation

fn interface_name() -> &'static str

Internal wayland name of this interface

fn supported_version() -> u32

Max version of this interface supported

fn version(&self) -> u32

Current version of the interface this proxy is instanciated with

fn is_alive(&self) -> bool

Check if the proxt behind this handle is actually still alive

fn equals(&self, other: &WlDataOffer) -> bool

Check of two handles are actually the same wayland object

fn set_user_data(&self, ptr: *mut ())

Set a pointer associated as user data on this proxy

fn get_user_data(&self) -> *mut ()

Get the pointer associated as user data on this proxy