Struct smithay_client_toolkit::data_device_manager::data_offer::DragOffer

pub struct DragOffer {
    pub(crate) data_offer: WlDataOffer,
    pub serial: u32,
    pub surface: WlSurface,
    pub x: f64,
    pub y: f64,
    pub time: Option<u32>,
    pub source_actions: DndAction,
    pub selected_action: DndAction,
    pub dropped: bool,
    pub left: bool,
}

Fields

data_offer: WlDataOffer

the wl_data offer if it exists

serial: u32

the serial for this data offer’s enter event

surface: WlSurface

the surface that this DnD is active on

x: f64

the x position on the surface

y: f64

the y position on this surface

time: Option<u32>

the timestamp a motion event was received in millisecond granularity

source_actions: DndAction

the advertised drag actions

selected_action: DndAction

the compositor selected drag action

dropped: bool

whether or not the drag has been dropped

left: bool

whether or not the drag has left

Implementations

impl DragOffer

pub fn finish(&self)

pub fn with_mime_types<T, F: Fn(&[String]) -> T>(&self, callback: F) -> T

Inspect the mime types available on the given offer.

pub fn set_actions(&self, actions: DndAction, preferred_action: DndAction)

Set the accepted and preferred drag and drop actions. 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_data_source.cancelled.

pub fn receive(&self, mime_type: String) -> Result<ReadPipe>

Receive data with the given mime type. 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.

pub fn accept_mime_type(&self, serial: u32, mime_type: Option<String>)

Accept the given mime type, or None to reject the offer. In version 2, this request is used for feedback, but doesn’t affect the final result of the drag-and-drop operation. In version 3, this request determines the final result of the drag-and-drop operation.

pub fn destroy(&self)

Destroy the data offer.

pub fn inner(&self) -> &WlDataOffer

Retrieve a reference to the inner wl_data_offer.

Trait Implementations

impl Clone for DragOffer

fn clone(&self) -> DragOffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DragOffer

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

Formats the value using the given formatter.

impl PartialEq for DragOffer

fn eq(&self, other: &Self) -> 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.