Trait wayland_client::protocol::wl_data_device::EventHandler

pub trait EventHandler {
    fn data_offer(&mut self, object: WlDataDevice, id: NewProxy<WlDataOffer>) { ... }
    fn enter(
        &mut self, 
        object: WlDataDevice, 
        serial: u32, 
        surface: WlSurface, 
        x: f64, 
        y: f64, 
        id: Option<WlDataOffer>
    ) { ... }
    fn leave(&mut self, object: WlDataDevice) { ... }
    fn motion(&mut self, object: WlDataDevice, time: u32, x: f64, y: f64) { ... }
    fn drop(&mut self, object: WlDataDevice) { ... }
    fn selection(&mut self, object: WlDataDevice, id: Option<WlDataOffer>) { ... }
}

An interface for handling events.

Provided methods

fn data_offer(&mut self, object: WlDataDevice, id: NewProxy<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.

fn enter(
    &mut self,
    object: WlDataDevice,
    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.

fn leave(&mut self, object: WlDataDevice)

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.

fn motion(&mut self, object: WlDataDevice, 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.

fn drop(&mut self, object: WlDataDevice)

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.

fn selection(&mut self, object: WlDataDevice, 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. The client must destroy the previous selection data_offer, if any, upon receiving this event.

Loading content...

Implementors

Loading content...