Struct wayland_client::protocol::wl_data_device::WlDataDevice

pub struct WlDataDevice(_);

Implementations

impl WlDataDevice

pub fn start_drag(
    &self,
    source: Option<&WlDataSource>,
    origin: &WlSurface,
    icon: Option<&WlSurface>,
    serial: u32
)

start drag-and-drop operation

This request asks the compositor to start a drag-and-drop operation on behalf of the client.

The source argument is the data source that provides the data for the eventual data transfer. If source is NULL, enter, leave and motion events are sent only to the client that initiated the drag and the client is expected to handle the data passing internally. If source is destroyed, the drag-and-drop session will be cancelled.

The origin surface is the surface where the drag originates and the client must have an active implicit grab that matches the serial.

The icon surface is an optional (can be NULL) surface that provides an icon to be moved around with the cursor. Initially, the top-left corner of the icon surface is placed at the cursor hotspot, but subsequent wl_surface.attach request can move the relative position. Attach requests must be confirmed with wl_surface.commit as usual. The icon surface is given the role of a drag-and-drop icon. If the icon surface already has another role, it raises a protocol error.

The current and pending input regions of the icon wl_surface are cleared, and wl_surface.set_input_region is ignored until the wl_surface is no longer used as the icon surface. When the use as an icon ends, the current and pending input regions become undefined, and the wl_surface is unmapped.

pub fn set_selection(&self, source: Option<&WlDataSource>, serial: u32)

copy data to the selection

This request asks the compositor to set the selection to the data from the source on behalf of the client.

To unset the selection, set the source to NULL.

pub fn release(&self)

destroy data device

This request destroys the data device.

This is a destructor, you cannot send requests to this object any longer once this method is called. Only available since version 2 of the interface.

Trait Implementations

impl AsRef<Proxy<WlDataDevice>> for WlDataDevice

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

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

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 From<Proxy<WlDataDevice>> for WlDataDevice

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

Converts to this type from the input type.

impl From<WlDataDevice> for Proxy<WlDataDevice>

fn from(value: WlDataDevice) -> Self

Converts to this type from the input type.

impl Interface for WlDataDevice

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_device"

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<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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WlDataDevice

impl StructuralEq for WlDataDevice

impl StructuralPartialEq for WlDataDevice