Struct tfc::Context

pub struct Context;

The main context used for generating events (Windows).

The most useful methods are on the traits.

Implementations

impl Context

pub fn new() -> Result<Self, GenericError<PlatformError>>

Examples found in repository

examples/ascii.rs (line 14)

fn main() -> Result<(), Error> {
    let delay = Duration::from_millis(50);

    let mut ctx = Context::new()?;

    for c in b' '..=b'~' {
        thread::sleep(delay);
        ctx.unicode_char(c as char)?;
        ctx.ascii_char(b' ')?;
        ctx.ascii_char(c)?;
        ctx.ascii_char(b'\n')?;
    }

    Ok(())
}

examples/rotate-mouse.rs (line 10)

fn main() -> Result<(), Error> {
    let radius = 100.0;
    let steps = 200;
    let revolutions = 3;
    let delay = Duration::from_millis(10);

    let mut ctx = Context::new()?;
    let center = ctx.cursor_location()?;
    let center = (center.0 as f64 - radius, center.1 as f64);

    for step in 0..steps * revolutions {
        thread::sleep(delay);
        let angle = step as f64 * 2.0 * PI / steps as f64;
        let x = (center.0 + radius * angle.cos()).round() as i32;
        let y = (center.1 + radius * angle.sin()).round() as i32;
        ctx.mouse_move_abs(x, y)?;
    }

    Ok(())
}

Trait Implementations

impl FallibleContext for Context

type PlatformError = PlatformError

impl KeyboardContext for Context

fn key_down(&mut self, key: Key) -> Result<(), GenericError<PlatformError>>

Press down a key.

fn key_up(&mut self, key: Key) -> Result<(), GenericError<PlatformError>>

Release a key.

fn key_click(&mut self, key: Key) -> Result<(), GenericError<PlatformError>>

Press and release a key.

impl MouseContext for Context

fn mouse_move_rel( &mut self, dx: i32, dy: i32 ) -> Result<(), GenericError<PlatformError>>

Move the mouse relative to its current location.

fn mouse_move_abs( &mut self, x: i32, y: i32 ) -> Result<(), GenericError<PlatformError>>

Move the mouse to an absolute location.

fn mouse_scroll( &mut self, dx: i32, dy: i32 ) -> Result<(), GenericError<PlatformError>>

Scroll the mouse horizontally and vertically in pixels.

fn mouse_down( &mut self, button: MouseButton ) -> Result<(), GenericError<PlatformError>>

Press down a mouse button.

fn mouse_up( &mut self, button: MouseButton ) -> Result<(), GenericError<PlatformError>>

Release a mouse button.

fn mouse_click( &mut self, button: MouseButton ) -> Result<(), GenericError<PlatformError>>

Press and release a mouse button.

impl ScreenContext for Context

fn cursor_location(&self) -> Result<(i32, i32), GenericError<PlatformError>>

Get the location of the cursor in pixels.

fn screen_size(&self) -> Result<(i32, i32), GenericError<PlatformError>>

Get the size of the main screen in pixels.

impl UnicodeKeyboardContext for Context

fn unicode_char_down( &mut self, ch: char ) -> Result<(), GenericError<PlatformError>>

Generate a key press event (possibly including modifiers) for a Unicode character.

fn unicode_char_up( &mut self, ch: char ) -> Result<(), GenericError<PlatformError>>

Generate a key release event (possibly including modifiers) for a Unicode character.

fn unicode_char(&mut self, ch: char) -> Result<(), GenericError<PlatformError>>

Generate a key press and release event along with the necessary modifiers to type a unicode character.

fn unicode_string(&mut self, s: &str) -> Result<(), GenericError<PlatformError>>

Generate key presses and releases such that a Unicode string is typed.