Struct smithay::wayland::seat::PointerHandle

pub struct PointerHandle { /* fields omitted */ }

An handle to a pointer handler

It can be cloned and all clones manipulate the same internal state.

This handle gives you access to an interface to send pointer events to your clients.

When sending events using this handle, they will be intercepted by a pointer grab if any is active. See the PointerGrab trait for details.

Implementations

impl PointerHandle

pub fn set_grab<G: PointerGrab + 'static>(&self, grab: G, serial: Serial)

Change the current grab on this pointer to the provided grab

Overwrites any current grab.

pub fn unset_grab(&self)

Remove any current grab on this pointer, resetting it to the default behavior

pub fn has_grab(&self, serial: Serial) -> bool

Check if this pointer is currently grabbed with this serial

pub fn is_grabbed(&self) -> bool

Check if this pointer is currently being grabbed

pub fn grab_start_data(&self) -> Option<GrabStartData>

Returns the start data for the grab, if any.

pub fn motion(
    &self,
    location: Point<f64, Logical>,
    focus: Option<(WlSurface, Point<i32, Logical>)>,
    serial: Serial,
    time: u32
)

Notify that the pointer moved

You provide the new location of the pointer, in the form of:

• The coordinates of the pointer in the global compositor space
• The surface on top of which the cursor is, and the coordinates of its origin in the global compositor space (or None of the pointer is not on top of a client surface).

This will internally take care of notifying the appropriate client objects of enter/motion/leave events.

pub fn button(&self, button: u32, state: ButtonState, serial: Serial, time: u32)

Notify that a button was pressed

This will internally send the appropriate button event to the client objects matching with the currently focused surface.

pub fn axis(&self, details: AxisFrame)

Start an axis frame

A single frame will group multiple scroll events as if they happened in the same instance.

pub fn current_location(&self) -> Point<f64, Logical>

Access the current location of this pointer in the global space

Trait Implementations

impl Clone for PointerHandle

fn clone(&self) -> PointerHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PointerHandle

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

Formats the value using the given formatter.