keyhop 0.3.0

System-wide keyboard navigation overlay: drive your desktop without the mouse.
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

//! Public API for [keyhop](https://github.com/rsaz/keyhop).
//!
//! `keyhop` is a system-wide keyboard navigation overlay. Press a leader
//! chord, see hint labels on every interactable control on screen, type the
//! hint, done.
//!
//! The crate ships both:
//!
//! - **A binary** (`keyhop`) — an end-user tool that registers a global
//!   hotkey, walks the foreground window's accessibility tree, and renders
//!   the hint overlay.
//! - **A library** — the platform-agnostic core types and traits
//!   ([`Action`], [`Backend`], [`Element`], [`HintEngine`]), plus a Windows
//!   backend in [`windows`] (only compiled on `target_os = "windows"`).
//!
//! Other backends (Linux X11/Wayland, macOS) will land as future modules
//! gated behind their own `cfg`s.

#![warn(missing_docs)]

pub mod action;
pub mod backend;
pub mod config;
pub mod hint;
pub mod model;

#[cfg(windows)]
pub mod windows;

pub use action::Action;
pub use backend::Backend;
pub use config::Config;
pub use hint::{HintEngine, DEFAULT_ALPHABET};
pub use model::{Bounds, Element, ElementId, Role};