Struct wayland_server::protocol::wl_data_offer::WlDataOffer

pub struct WlDataOffer { /* fields omitted */ }

Methods

impl WlDataOffer

fn offer(&self, mime_type: String) -> EventResult<()>

advertise offered mime type

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

fn source_actions(&self, source_actions: u32) -> EventResult<()>

notify the source-side available actions

This event indicates the actions offered by the data source. It will be sent right after wl_data_device.enter, or anytime the source side changes its offered actions through wl_data_source.set_actions.

fn action(&self, dnd_action: u32) -> EventResult<()>

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.

Trait Implementations

impl Send for WlDataOffer

impl Sync for WlDataOffer

impl Resource for WlDataOffer

fn ptr(&self) -> *mut wl_resource

Pointer to the underlying wayland proxy object

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

Create an instance from a wayland pointer

unsafe fn from_ptr_initialized(ptr: *mut wl_resource) -> 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) -> i32

Current version of the interface this resource is instanciated with

fn is_alive(&self) -> bool

Check if the resource 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 resource

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

Get the pointer associated as user data on this resource

fn post_error(&self, error_code: u32, msg: String)

Posts a protocol error to this resource