Struct enigo::Enigo

pub struct Enigo;

The main struct for handling the event emitting

Implementations

impl Enigo

pub fn new() -> Self

Constructs a new Enigo instance.

Example

use enigo::*;
let mut enigo = Enigo::new();

Trait Implementations

impl Debug for Enigo

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

Formats the value using the given formatter.

impl Default for Enigo

fn default() -> Enigo

Returns the “default value” for a type.

impl KeyboardControllable for Enigo

fn key_sequence(&mut self, sequence: &str)

Enter the text. You can use unicode here like: ❤️. This works regardless of the current keyboardlayout. You cannot use this function for entering shortcuts or something similar. For shortcuts, use the KeyboardControllable::key_click method instead.

fn key_click(&mut self, key: Key)

Press and release the key. It is the same as calling the KeyboardControllable::key_down and KeyboardControllable::key_up functions consecutively

fn key_down(&mut self, key: Key)

Press down the given key

fn key_up(&mut self, key: Key)

Release a pressed down key

fn key_sequence_parse(&mut self, sequence: &str)where Self: Sized,

Type the string parsed with DSL.

fn key_sequence_parse_try(&mut self, sequence: &str) -> Result<(), ParseError>where Self: Sized,

Same as KeyboardControllable::key_sequence_parse except returns any errors

impl MouseControllable for Enigo

fn mouse_move_to(&mut self, x: i32, y: i32)

Move the mouse cursor to the specified x and y coordinates.

fn mouse_move_relative(&mut self, x: i32, y: i32)

Move the mouse cursor the specified amount in the x and y direction. A positive x value moves the mouse cursor x pixels to the right. A negative value for x moves the mouse cursor to the left. A positive value of y moves the mouse cursor down, a negative one moves the mouse cursor up.

fn mouse_down(&mut self, button: MouseButton)

Push down the mouse button specified by the parameter button of type MouseButton and hold it until it is released by MouseControllable::mouse_up. Calls to MouseControllable::mouse_move_to or MouseControllable::mouse_move_relative will work like expected and will e.g. drag widgets or highlight text.

fn mouse_up(&mut self, button: MouseButton)

Release a pushed down mouse button

fn mouse_click(&mut self, button: MouseButton)

Click a mouse button

fn mouse_scroll_x(&mut self, length: i32)

Scroll the mouse (wheel) left or right

fn mouse_scroll_y(&mut self, length: i32)

Scroll the mouse (wheel) up or down

fn main_display_size(&self) -> (i32, i32)

Get the (width, height) of the main display in screen coordinates (pixels). This currently only works on the main display

fn mouse_location(&self) -> (i32, i32)

Get the location of the mouse in screen coordinates (pixels).