Struct wayland_server::protocol::wl_data_source::WlDataSource

pub struct WlDataSource(_);

Implementations

impl WlDataSource

pub fn target(&self, mime_type: Option<String>)

a target accepts an offered mime type

Sent when a target accepts pointer_focus or motion events. If a target does not accept any of the offered types, type is NULL.

Used for feedback during drag-and-drop.

pub fn send(&self, mime_type: String, fd: RawFd)

send the data

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

pub fn cancelled(&self)

selection was cancelled

This data source is no longer valid. There are several reasons why this could happen:

• The data source has been replaced by another data source.
• The drag-and-drop operation was performed, but the drop destination did not accept any of the mime types offered through wl_data_source.target.
• The drag-and-drop operation was performed, but the drop destination did not select any of the actions present in the mask offered through wl_data_source.action.
• The drag-and-drop operation was performed but didn't happen over a surface.
• The compositor cancelled the drag-and-drop operation (e.g. compositor dependent timeouts to avoid stale drag-and-drop transfers).

The client should clean up and destroy this data source.

For objects of version 2 or older, wl_data_source.cancelled will only be emitted if the data source was replaced by another data source.

pub fn dnd_drop_performed(&self)

the drag-and-drop operation physically finished

The user performed the drop action. This event does not indicate acceptance, wl_data_source.cancelled may still be emitted afterwards if the drop destination does not accept any mime type.

However, this event might however not be received if the compositor cancelled the drag-and-drop operation before this event could happen.

Note that the data_source may still be used in the future and should not be destroyed here.

Only available since version 3 of the interface.

pub fn dnd_finished(&self)

the drag-and-drop operation concluded

The drop destination finished interoperating with this data source, so the client is now free to destroy this data source and free all associated data.

If the action used to perform the operation was "move", the source can now delete the transferred data.

Only available since version 3 of the interface.

pub fn action(&self, dnd_action: u32)

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, mainly in response to destination side changes through wl_data_offer.set_actions, and as the data device enters/leaves surfaces.

It is only possible to receive this event after wl_data_source.dnd_drop_performed if the drag-and-drop operation ended in an "ask" action, in which case the final wl_data_source.action event will happen immediately before wl_data_source.dnd_finished.

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. The chosen action may change alongside negotiation (e.g. an "ask" action can turn into a "move" operation), so the effects of the final action must always be applied in wl_data_offer.dnd_finished.

Clients can trigger cursor surface changes from this point, so they reflect the current action.

Only available since version 3 of the interface.

Trait Implementations

impl AsRef<Resource<WlDataSource>> for WlDataSource

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

Performs the conversion.

impl Clone for WlDataSource

fn clone(&self) -> WlDataSource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WlDataSource

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

Formats the value using the given formatter.

impl Eq for WlDataSource

impl From<Resource<WlDataSource>> for WlDataSource

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

Performs the conversion.

impl From<WlDataSource> for Resource<WlDataSource>

fn from(value: WlDataSource) -> Self

Performs the conversion.

impl Interface for WlDataSource

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str

Name of this interface

const VERSION: u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<WlDataSource> for WlDataSource

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

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

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

This method tests for !=.

impl StructuralEq for WlDataSource

impl StructuralPartialEq for WlDataSource