Trait runa_wayland_protocols::wayland::wl_pointer::v9::RequestDispatch

pub trait RequestDispatch<Ctx> {
    type Error;
    type SetCursorFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;
    type ReleaseFut<'a>: Future<Output = Result<(), Self::Error>> + 'a
       where Ctx: 'a;

    // Required methods
    fn set_cursor<'a>(
        ctx: &'a mut Ctx,
        object_id: u32,
        serial: u32,
        surface: Object,
        hotspot_x: i32,
        hotspot_y: i32
    ) -> Self::SetCursorFut<'a>;
    fn release<'a>(ctx: &'a mut Ctx, object_id: u32) -> Self::ReleaseFut<'a>;
}

Required Associated Types

type Error

type SetCursorFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by set_cursor

type ReleaseFut<'a>: Future<Output = Result<(), Self::Error>> + 'a where Ctx: 'a

Type of future returned by release

Required Methods

fn set_cursor<'a>( ctx: &'a mut Ctx, object_id: u32, serial: u32, surface: Object, hotspot_x: i32, hotspot_y: i32 ) -> Self::SetCursorFut<'a>

set the pointer surface

Set the pointer surface, i.e., the surface that contains the pointer image (cursor). This request gives the surface the role of a cursor. If the surface already has another role, it raises a protocol error.

The cursor actually changes only if the pointer focus for this device is one of the requesting client’s surfaces or the surface parameter is the current pointer surface. If there was a previous surface set with this request it is replaced. If surface is NULL, the pointer image is hidden.

The parameters hotspot_x and hotspot_y define the position of the pointer surface relative to the pointer location. Its top-left corner is always at (x, y) - (hotspot_x, hotspot_y), where (x, y) are the coordinates of the pointer location, in surface-local coordinates.

On surface.attach requests to the pointer surface, hotspot_x and hotspot_y are decremented by the x and y parameters passed to the request. Attach must be confirmed by wl_surface.commit as usual.

The hotspot can also be updated by passing the currently set pointer surface to this request with new values for hotspot_x and hotspot_y.

The input region is ignored for wl_surfaces with the role of a cursor. When the use as a cursor ends, the wl_surface is unmapped.

The serial parameter must match the latest wl_pointer.enter serial number sent to the client. Otherwise the request will be ignored.

fn release<'a>(ctx: &'a mut Ctx, object_id: u32) -> Self::ReleaseFut<'a>

release the pointer object

Using this request a client can tell the server that it is not going to use the pointer object anymore.

This request destroys the pointer proxy object, so clients must not call wl_pointer_destroy() after using this request.

Implementors