Struct wayland_server::protocol::wl_data_device::WlDataDevice

pub struct WlDataDevice { /* private fields */ }

data transfer device

There is one wl_data_device per seat which can be obtained from the global wl_data_device_manager singleton.

A wl_data_device provides access to inter-client data transfer mechanisms such as copy-and-paste and drag-and-drop.

See also the Request enum for this interface.

Implementations

impl WlDataDevice

pub fn data_offer(&self, id: &WlDataOffer)

introduce a new wl_data_offer

The data_offer event introduces a new wl_data_offer object, which will subsequently be used in either the data_device.enter event (for drag-and-drop) or the data_device.selection event (for selections). Immediately following the data_device_data_offer event, the new data_offer object will send out data_offer.offer events to describe the mime types it offers.

pub fn enter(
    &self,
    serial: u32,
    surface: &WlSurface,
    x: f64,
    y: f64,
    id: Option<&WlDataOffer>
)

initiate drag-and-drop session

This event is sent when an active drag-and-drop pointer enters a surface owned by the client. The position of the pointer at enter time is provided by the x and y arguments, in surface-local coordinates.

pub fn leave(&self)

end drag-and-drop session

This event is sent when the drag-and-drop pointer leaves the surface and the session ends. The client must destroy the wl_data_offer introduced at enter time at this point.

pub fn motion(&self, time: u32, x: f64, y: f64)

drag-and-drop session motion

This event is sent when the drag-and-drop pointer moves within the currently focused surface. The new position of the pointer is provided by the x and y arguments, in surface-local coordinates.

pub fn drop(&self)

end drag-and-drop session successfully

The event is sent when a drag-and-drop operation is ended because the implicit grab is removed.

The drag-and-drop destination is expected to honor the last action received through wl_data_offer.action, if the resulting action is “copy” or “move”, the destination can still perform wl_data_offer.receive requests, and is expected to end all transfers with a wl_data_offer.finish request.

If the resulting action is “ask”, the action will not be considered final. The drag-and-drop destination is expected to perform one last wl_data_offer.set_actions request, or wl_data_offer.destroy in order to cancel the operation.

pub fn selection(&self, id: Option<&WlDataOffer>)

advertise new selection

The selection event is sent out to notify the client of a new wl_data_offer for the selection for this device. The data_device.data_offer and the data_offer.offer events are sent out immediately before this event to introduce the data offer object. The selection event is sent to a client immediately before receiving keyboard focus and when a new selection is set while the client has keyboard focus. The data_offer is valid until a new data_offer or NULL is received or until the client loses keyboard focus. Switching surface with keyboard focus within the same client doesn’t mean a new selection will be sent. The client must destroy the previous selection data_offer, if any, upon receiving this event.

Trait Implementations

impl Clone for WlDataDevice

fn clone(&self) -> WlDataDevice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WlDataDevice

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

Formats the value using the given formatter.

impl PartialEq<WlDataDevice> for WlDataDevice

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

impl Resource for WlDataDevice

type Request = Request

type Event = Event

fn interface() -> &'static Interface

fn id(&self) -> ObjectId

fn version(&self) -> u32

fn data<U: 'static>(&self) -> Option<&U>

fn object_data(&self) -> Option<&Arc<dyn Any + Send + Sync>>

fn handle(&self) -> &WeakHandle

fn from_id(conn: &DisplayHandle, id: ObjectId) -> Result<Self, InvalidId>

fn send_event(&self, evt: Self::Event) -> Result<(), InvalidId>

fn parse_request(
    conn: &DisplayHandle,
    msg: Message<ObjectId>
) -> Result<(Self, Self::Request), DispatchError>

fn write_event(
    &self,
    conn: &DisplayHandle,
    msg: Self::Event
) -> Result<Message<ObjectId>, InvalidId>

fn post_error(
    &self,
    dh: &DisplayHandle,
    code: impl Into<u32>,
    error: impl Into<String>
)

impl Eq for WlDataDevice