win-hotkeys 0.1.1

A simple thread safe rust library for system-wide hotkey management on Windows
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

# win-hotkeys

[![Crates.io](https://img.shields.io/crates/v/win-hotkeys.svg)](https://crates.io/crates/win-hotkeys)
[![License](https://img.shields.io/crates/l/win-hotkeys.svg)](https://crates.io/crates/win-hotkeys)
[![Documentation](https://docs.rs/win-hotkeys/badge.svg)](https://docs.rs/win-hotkeys)
> A lightweight, thread-safe Rust library for managing system-wide hotkeys on Windows

The `win-hotkeys` crate simplifies working with the Windows API by abstracting and managing 
all interactions related to registering hotkeys and handling their events. Unlike many other 
solutions, this crate does not rely on the `RegisterHotKey` Windows function. Instead, it 
leverages a low-level keyboard hook to provide a more flexible and powerful way to monitor 
global hotkeys. This approach, allows for additional functionality (i.e. WIN key as modifier) and 
bypasses limitations of RegisterHotKey.

---

```toml
[dependencies]
win-hotkeys = "0.1.0"
```

## Usage

```rust
use win_hotkeys::keys::{ModKey, VKey};
use win_hotkeys::HotkeyManager;

fn main() {
    let mut manager = HotkeyManager::new();

    manager.register_hotkey(VKey::A, &[ModKey::Ctrl], || {
        println!("Hotkey CTRL + A was pressed");
    }).unwrap();

    hkm.event_loop();
}
```

## Examples

Up-to-date examples can always be found in the [examples directory](https://github.com/iholston/win-hotkeys/tree/main/examples)

## License


This project is licensed under the [MIT License](https://crates.io/crates/win-hotkeys).
See the [`LICENSE`](./LICENSE) file for details