keyflow 0.1.1

Cross-platform input simulation library for keyboard, mouse and hotkeys.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! # Keyflow - Cross-Platform Input Simulation
//!
//! Simulate keyboard and mouse input on Linux ([evdev](https://github.com/emberian/evdev))
//! and Windows ([SendInput](https://learn.microsoft.com/de-de/windows/win32/api/winuser/nf-winuser-sendinput))
//! with optional global hotkey support.
//!
//! ## Quick Start
//!
//! ```no_run
//! use keyflow::prelude::*;
//!
//! Keyflow::initialize()?;
//!
//! Keyflow::press_key(Key::A);
//! Keyflow::click_button(Button::Left);
//! Keyflow::move_to(500, 300);
//! # Ok(())
//! ```
//!
//! ## Features
//!
//! - **Keyboard simulation** - Press, release, and click keys
//! - **Mouse simulation** - Move, click, and scroll
//! - **Global hotkeys** - Optional hotkey registration (opt-in via builder)
//! - **Batch processing** - Send multiple events efficiently
//! - **Multi-monitor** - Full multi-monitor coordinate support
//!
//! ### Linux Permissions
//!
//! Add your user to the `input` group:
//!
//! ```bash
//! sudo usermod -aG input $USER
//! ```
//!
//! Then log out and back in, or run with `sudo`.
//!
//! ### Hotkeys
//!
//! ```no_run
//! use keyflow::prelude::*;
//!
//! Keyflow::builder()
//!     .with_hotkeys()  // Enable hotkey support
//!     .initialize()?;
//!
//! Keyflow::register_hotkey(
//!     "save",
//!     Hotkey::new(Key::S).with_ctrl(),
//!     || println!("Ctrl+S pressed!")
//! )?;
//! # Ok::<(), keyflow::KeyflowError>(())
//! ```
//!
//! ## Examples
//!
//! See the [examples directory](https://github.com/fenrir2775/keyflow/tree/main/examples):
//!
//! - `basic.rs` - Keyboard and mouse basics
//! - `hotkeys.rs` - Global hotkey registration
//! - `batch.rs` - Batch event processing
//! - `multi_monitor.rs` - Multi-monitor positioning
//! - `serde_config.rs` - Save/load automation scripts (requires `serde` feature)

mod builder;
mod error;
mod eventhandler;
mod hotkey;
mod keyflow;
mod platform;
mod types;

pub use error::*;
pub use hotkey::Hotkey;
pub use keyflow::Keyflow;
pub use types::*;
pub use builder::KeyflowBuilder;

/// Commonly used imports
///
/// ```
/// use keyflow::prelude::*;
/// ```
pub mod prelude {
    pub use crate::{
        Action, Button, Hotkey, InputEvent, Key, Keyflow, KeyflowError, Movement, Result, Screen,
        Scroll,
    };
}