/win_event_hook

A safe rust API for using SetWinEventHook, powered by the windows crate. 👀🪝👌

Primary LanguageRust

win_event_hook

Crates.io Documentation MIT licensed Build Status

A safe Rust API for using SetWinEventHook, powered by the windows crate.

Usage

To use win_event_hook, add the following to your Cargo.toml:

[dependencies]
win_event_hook = "0.1"

Then create a configuration and install a hook, for example:

use win_event_hook::events::{Event, NamedEvent};

// create our hook config
let config = win_event_hook::Config::builder()
    .skip_own_process()
    .with_dedicated_thread()
    .with_events(vec![
        // to see these, try right clicking
        Event::Named(NamedEvent::ObjectShow),
        Event::Named(NamedEvent::ObjectHide),
        // to see this, try moving around the cursor
        Event::Named(NamedEvent::ObjectLocationChange),
    ])
    .finish();

// and our handler
let handler = |ev, _, _, _, _, _| {
    println!("got event: {:?}", ev);
};

// install the hook
let hook = win_event_hook::WinEventHook::install(config, handler)?;

When hook is dropped, an uninstall is attempted automatically. Uninstallation may fail - to handle failures, instead call uninstall yourself, for example:

// building on the above example

// uninstall the hook
hook.uninstall()?;

For more information, see the generated documentation.

LICENSE

This project is licensed under the MIT license.