https://github.com/tauri-apps/global-hotkey

Global hotkeys for Desktop Applications.
https://github.com/tauri-apps/global-hotkey

global-hotkeys gui hotkeys rust windowing

Last synced: about 1 month ago
JSON representation

Global hotkeys for Desktop Applications.

• Host: GitHub
• URL: https://github.com/tauri-apps/global-hotkey
• Owner: tauri-apps
• License: apache-2.0
• Created: 2022-12-12T22:09:56.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2024-04-08T20:42:39.000Z (7 months ago)
• Last Synced: 2024-04-14T04:54:08.009Z (7 months ago)
• Topics: global-hotkeys, gui, hotkeys, rust, windowing
• Language: Rust
• Homepage:
• Size: 152 KB
• Stars: 102
• Watchers: 12
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

• awesome-egui - global-hotkey

README

        
global_hotkey lets you register Global HotKeys for Desktop Applications.

## Platforms-supported:

- Windows

- macOS

- Linux (X11 Only)

## Platform-specific notes:

- On Windows a win32 event loop must be running on the thread. It doesn't need to be the main thread but you have to create the global hotkey manager on the same thread as the event loop.

- On macOS, an event loop must be running on the main thread so you also need to create the global hotkey manager on the main thread.

## Example

```rs

use global_hotkey::{GlobalHotKeyManager, hotkey::{HotKey, Modifiers, Code}};

// initialize the hotkeys manager

let manager = GlobalHotKeyManager::new().unwrap();

// construct the hotkey

let hotkey = HotKey::new(Some(Modifiers::SHIFT), Code::KeyD);

// register it

manager.register(hotkey);

```

## Processing global hotkey events

You can also listen for the menu events using `GlobalHotKeyEvent::receiver` to get events for the hotkey pressed events.

```rs

use global_hotkey::GlobalHotKeyEvent;

if let Ok(event) = GlobalHotKeyEvent::receiver().try_recv() {

    println!("{:?}", event);

}

```

## License

Apache-2.0/MIT