Struct Mouse

pub struct Mouse { /* private fields */ }

The Mouse struct that implements the MouseActions

Example usage

use std::thread;
use std::time::Duration;

use mouce::{Mouse, MouseActions};

fn main() {
    let mouse_manager = Mouse::new();

    let mut x = 0;
    while x < 1920 {
        let _ = mouse_manager.move_to(x, 540);
        x += 1;
        thread::sleep(Duration::from_millis(2));
    }
}

Implementations

impl Mouse

pub fn new() -> Self

Trait Implementations

impl Clone for Mouse

fn clone(&self) -> Mouse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Mouse

fn default() -> Self

Returns the “default value” for a type.

impl MouseActions for Mouse

fn move_to(&self, x: i32, y: i32) -> Result<(), Error>

Move the mouse to the given x, y coordinates in logical pixel space

fn move_relative(&self, x_offset: i32, y_offset: i32) -> Result<(), Error>

Move the mouse relative to the current position in logical pixel space

fn get_position(&self) -> Result<(i32, i32), Error>

Get the current position of the mouse in logical pixel space

fn press_button(&self, button: MouseButton) -> Result<(), Error>

Press down the given mouse button

fn release_button(&self, button: MouseButton) -> Result<(), Error>

Release the given mouse button

fn click_button(&self, button: MouseButton) -> Result<(), Error>

Click the given mouse button

fn scroll_wheel( &self, direction: ScrollDirection, scroll_unit: ScrollUnit, distance: u32, ) -> Result<(), Error>

Scroll the mouse wheel towards to the given direction

fn hook( &mut self, callback: Box<dyn Fn(&MouseEvent) + Send>, ) -> Result<CallbackId, Error>

Attach a callback function to mouse events

fn unhook(&mut self, callback_id: CallbackId) -> Result<(), Error>

Remove the callback function with the given CallbackId

fn unhook_all(&mut self) -> Result<(), Error>

Remove all callback functions