Struct XDo 

pub struct XDo { /* private fields */ }

The main handle type which provides access to the various operations.

Implementations

impl XDo

pub fn new(display: Option<&str>) -> Result<XDo, CreationError>

Creates a new XDo instance.

Parameters

display - An optional string display name, such as ":0". If None, uses $DISPLAY.

Returns

Returns a new XDo instance, or a CreationError on error.

Examples found in repository

examples/mousemove.rs (line 6)

fn main() {
    let xdo = XDo::new(None).unwrap();
    xdo.move_mouse(0, 0, 0).unwrap();
}

examples/typehello.rs (line 6)

fn main() {
    let xdo = XDo::new(None).unwrap();
    xdo.enter_text("Hello, World!", 250_000).unwrap();
}

examples/autoclicker.rs (line 7)

fn main() {
    let xdo = XDo::new(None).unwrap();

    for _ in 0..5 {
        xdo.click(1).unwrap();
        std::thread::sleep(Duration::from_secs(1));
    }
}

examples/drag_drop.rs (line 6)

fn main() {
    let xdo = XDo::new(None).unwrap();
    xdo.mouse_down(1).unwrap();
    xdo.move_mouse_relative(150, 150).unwrap();
    xdo.mouse_up(1).unwrap();
}

examples/mousesquare.rs (line 14)

fn main() {
    let xdo = XDo::new(None).unwrap();
    move_it(&xdo, 10, 0, 20);
    move_it(&xdo, 0, 10, 20);
    move_it(&xdo, -10, 0, 20);
    move_it(&xdo, 0, -10, 20);
}

examples/yes.rs (line 7)

fn main() {
    let xdo = XDo::new(None).unwrap();
    for _ in 0..10 {
        xdo.send_keysequence("y", 0).unwrap();
        xdo.send_keysequence("Return", 0).unwrap();
        std::thread::sleep(Duration::from_millis(100));
    }
}

pub fn move_mouse(&self, x: i32, y: i32, screen: i32) -> OpResult

Moves the mouse to the specified position.

Examples found in repository

examples/mousemove.rs (line 7)

fn main() {
    let xdo = XDo::new(None).unwrap();
    xdo.move_mouse(0, 0, 0).unwrap();
}

pub fn move_mouse_relative(&self, x: i32, y: i32) -> OpResult

Moves the mouse relative to the current position.

Examples found in repository

examples/drag_drop.rs (line 8)

fn main() {
    let xdo = XDo::new(None).unwrap();
    xdo.mouse_down(1).unwrap();
    xdo.move_mouse_relative(150, 150).unwrap();
    xdo.mouse_up(1).unwrap();
}

examples/mousesquare.rs (line 8)

fn move_it(xdo: &XDo, rel_x: i32, rel_y: i32, times: i32) {
    for _ in 0..times {
        xdo.move_mouse_relative(rel_x, rel_y).unwrap();
        std::thread::sleep(Duration::from_millis(10));
    }
}

pub fn click(&self, button: i32) -> OpResult

Does a mouse click.

Examples found in repository

examples/autoclicker.rs (line 10)

fn main() {
    let xdo = XDo::new(None).unwrap();

    for _ in 0..5 {
        xdo.click(1).unwrap();
        std::thread::sleep(Duration::from_secs(1));
    }
}

pub fn mouse_down(&self, button: i32) -> OpResult

Holds a mouse button down.

Examples found in repository

examples/drag_drop.rs (line 7)

fn main() {
    let xdo = XDo::new(None).unwrap();
    xdo.mouse_down(1).unwrap();
    xdo.move_mouse_relative(150, 150).unwrap();
    xdo.mouse_up(1).unwrap();
}

pub fn mouse_up(&self, button: i32) -> OpResult

Releases a mouse button.

Examples found in repository

examples/drag_drop.rs (line 9)

fn main() {
    let xdo = XDo::new(None).unwrap();
    xdo.mouse_down(1).unwrap();
    xdo.move_mouse_relative(150, 150).unwrap();
    xdo.mouse_up(1).unwrap();
}

pub fn enter_text(&self, text: &str, delay_microsecs: u32) -> OpResult

Types the specified text.

Examples found in repository

examples/typehello.rs (line 7)

fn main() {
    let xdo = XDo::new(None).unwrap();
    xdo.enter_text("Hello, World!", 250_000).unwrap();
}

pub fn send_keysequence(&self, sequence: &str, delay_microsecs: u32) -> OpResult

Does the specified key sequence.

Examples found in repository

examples/yes.rs (line 9)

fn main() {
    let xdo = XDo::new(None).unwrap();
    for _ in 0..10 {
        xdo.send_keysequence("y", 0).unwrap();
        xdo.send_keysequence("Return", 0).unwrap();
        std::thread::sleep(Duration::from_millis(100));
    }
}

pub fn send_keysequence_up( &self, sequence: &str, delay_microsecs: u32, ) -> OpResult

Releases the specified key sequence.

pub fn send_keysequence_down( &self, sequence: &str, delay_microsecs: u32, ) -> OpResult

Presses the specified key sequence down.

Trait Implementations

impl Drop for XDo

fn drop(&mut self)

Executes the destructor for this type.