# Keysymdefs

This crate provides a mapping from the keysym code to a string representation
of the keysym and vice versa.

## Installation

```bash
cargo add keysymdefs
```

### Record Item

```rust
pub struct Item {
    name: &str,
    cleared_name: &str,
    keysym: u32,
    unicode: Option<u32>,
    desc: &str,
}
```

#### Get Record by KeySym

```rust
use keysymdefs::get_item_by_keysym;

fn get_item_by_keysym(keysym: u32) -> Option<&Item>

// e.g.
if let Some(key) = get_item_by_keysym(keys::XF86XK_AudioPlay) {
    println!("{}", key.keysym());       // 269025044
    println!("{}", key.name());         // XF86XK_AudioPlay
    println!("{}", key.cleared_name()); // AudioPlay
    println!("{}", key.desc());         // Start playing of audio
    println!("{}", key.unicode());      // None
    println!("{}", key.unicode_char()); // None

    assert_eq!(keys::XF86XK_AudioPlay, 269025044);
}
```

#### Get Record by canonical name

```rust
fn get_item_by_name(name: &str) -> Option<&Item>
```

#### Get Record by cleared name

_truncated canonical name, no "XK\_" or "XF86XK\_" prefixes and "\_" in the middle_

```rust
fn get_item_by_cleared_name(name: &str) -> Option<&Item>
```

#### Get Record by unicode

!WARN!: Please note that not all keys have a unicode value

```rust
fn get_item_by_unicode(unicode: u32) -> Option<&Item>
```

### Module keysymdefs::keys

```rust
use keysymdefs::{keys, get_item_by_keysym};

println!("Keysym: {:x}", keys::XF86XK_AudioPlay);   // `0x1008ff14`

let item = get_item_by_keysym(keys::XF86XK_AudioPlay).unwrap();
println!("{}", item.name());                        // `XF86XK_AudioPlay`
println!("{}", item.cleared_name());                // `AudioPlay`
```