Struct wayland_server::protocol::wl_data_offer::WlDataOffer

pub struct WlDataOffer(_);

Implementations

impl WlDataOffer

pub fn offer(&self, mime_type: String)

advertise offered mime type

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

pub fn source_actions(&self, source_actions: DndAction)

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.

Only available since version 3 of the interface.

pub fn action(&self, dnd_action: 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.

Only available since version 3 of the interface.

Trait Implementations

impl AsRef<Resource<WlDataOffer>> for WlDataOffer

fn as_ref(&self) -> &Resource<Self>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for WlDataOffer

fn clone(&self) -> WlDataOffer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WlDataOffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Resource<WlDataOffer>> for WlDataOffer

fn from(value: Resource<Self>) -> Self

Converts to this type from the input type.

impl From<WlDataOffer> for Resource<WlDataOffer>

fn from(value: WlDataOffer) -> Self

Converts to this type from the input type.

impl Interface for WlDataOffer

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str = "wl_data_offer"

Name of this interface

const VERSION: u32 = 3u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<WlDataOffer> for WlDataOffer

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WlDataOffer

impl StructuralEq for WlDataOffer

impl StructuralPartialEq for WlDataOffer