Struct Mouse 

pub struct Mouse<'a> { /* private fields */ }

A struct for controlling a virtual mouse.

It holds a reference to a Device which is used to send the mouse commands.

Implementations

impl<'a> Mouse<'a>

pub const fn new(device: &'a Device) -> Self

Creates a new Mouse.

pub fn click(&self, button: MouseButton, millis: u64)

Performs a click and release action with a specified button.

The button is pressed, held for millis milliseconds, and then released.

Arguments

• button - The MouseButton to click.
• millis - The duration, in milliseconds, to hold the button down.

pub fn move_absolute(&self, button: MouseButton, x: u16, y: u16, millis: u64)

Moves the mouse cursor to an absolute screen coordinate (x, y) with a simulated smooth movement.

The movement is broken down into smaller steps, with a delay between each step.

Arguments

• button - The MouseButton to hold down during the movement (e.g., for dragging). Use MouseButton::Release for no buttons.
• x - The target horizontal coordinate.
• y - The target vertical coordinate.
• millis - The delay, in milliseconds, between each small movement step.

pub fn move_relative(&self, button: MouseButton, x: i8, y: i8)

Moves the mouse cursor by a relative offset from its current position.

Arguments

• button - The MouseButton to hold down during the movement.
• x - The horizontal offset. Positive values move right, negative move left.
• y - The vertical offset. Positive values move down, negative move up.

pub fn press(&self, button: MouseButton)

Presses and holds a specified mouse button.

This method only presses the button; you must call release() to release it.

Arguments

• button - The MouseButton to press.

pub fn release(&self)

Releases any currently pressed mouse buttons.

This should be called after a press() action to release the button.

pub fn wheel(&self, button: MouseButton, wheel: i8)

Scrolls the mouse wheel.

Arguments

• button - The MouseButton to hold down during the scroll.
• wheel - The scroll amount. Positive values scroll up, negative values scroll down.