Struct smithay::wayland::seat::PointerHandle
source · pub struct PointerHandle { /* private fields */ }
Expand description
An handle to a pointer handler
It can be cloned and all clones manipulate the same internal state. Clones can also be sent across threads.
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§
source§impl PointerHandle
impl PointerHandle
sourcepub fn set_grab<G: PointerGrab + 'static>(&self, grab: G, serial: u32)
pub fn set_grab<G: PointerGrab + 'static>(&self, grab: G, serial: u32)
Change the current grab on this pointer to the provided grab
Overwrites any current grab.
sourcepub fn unset_grab(&self)
pub fn unset_grab(&self)
Remove any current grab on this pointer, reseting it to the default behavior
sourcepub fn has_grab(&self, serial: u32) -> bool
pub fn has_grab(&self, serial: u32) -> bool
Check if this pointer is currently grabbed with this serial
sourcepub fn is_grabbed(&self) -> bool
pub fn is_grabbed(&self) -> bool
Check if this pointer is currently being grabbed
sourcepub fn motion(
&self,
location: (f64, f64),
focus: Option<(Resource<WlSurface>, (f64, f64))>,
serial: u32,
time: u32
)
pub fn motion(
&self,
location: (f64, f64),
focus: Option<(Resource<WlSurface>, (f64, f64))>,
serial: u32,
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.
Notify that a button was pressed
This will internally send the appropriate button event to the client objects matching with the currently focused surface.
Trait Implementations§
source§impl Clone for PointerHandle
impl Clone for PointerHandle
source§fn clone(&self) -> PointerHandle
fn clone(&self) -> PointerHandle
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more