Struct pc_keyboard::EventDecoder

pub struct EventDecoder<L>
where
    L: KeyboardLayout,
{ /* private fields */ }

Converts KeyEvents into Unicode, according to the current Keyboard Layout

Implementations

impl<L> EventDecoder<L>

where L: KeyboardLayout,

pub const fn new(layout: L, handle_ctrl: HandleControl) -> EventDecoder<L>

Construct a new event decoder.

Examples found in repository

examples/layout.rs (lines 7-10)

fn main() {
    let mut decoder = EventDecoder::new(
        AnyLayout::Uk105Key(Uk105Key),
        pc_keyboard::HandleControl::Ignore,
    );

    // User presses 'A' on their UK keyboard, gets a lower-case 'a'.
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::A,
        state: KeyState::Down,
    });
    assert_eq!(Some(DecodedKey::Unicode('a')), decoded_key);
    println!("Got {:?}", decoded_key);

    // User releases 'A' on their UK keyboard
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::A,
        state: KeyState::Up,
    });
    assert_eq!(None, decoded_key);

    // User presses 'Shift' on their UK keyboard
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::LShift,
        state: KeyState::Down,
    });
    assert_eq!(None, decoded_key);

    // User presses 'A' on their UK keyboard, now gets a Capital A
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::A,
        state: KeyState::Down,
    });
    assert_eq!(Some(DecodedKey::Unicode('A')), decoded_key);
    println!("Got {:?}", decoded_key);

    // User releases 'A' on their UK keyboard
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::A,
        state: KeyState::Up,
    });
    assert_eq!(None, decoded_key);

    // User releases 'Shift' on their UK keyboard
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::LShift,
        state: KeyState::Up,
    });
    assert_eq!(None, decoded_key);
}

pub fn set_ctrl_handling(&mut self, new_value: HandleControl)

Change the Ctrl key mapping.

pub const fn get_ctrl_handling(&self) -> HandleControl

Get the current Ctrl key mapping.

pub fn process_keyevent(&mut self, ev: KeyEvent) -> Option<DecodedKey>

Processes a KeyEvent returned from add_bit, add_byte or add_word and produces a decoded key.

For example, the KeyEvent for pressing the ‘5’ key on your keyboard gives a DecodedKey of unicode character ‘5’, unless the shift key is held in which case you get the unicode character ‘%’.

Examples found in repository

examples/layout.rs (lines 13-16)

fn main() {
    let mut decoder = EventDecoder::new(
        AnyLayout::Uk105Key(Uk105Key),
        pc_keyboard::HandleControl::Ignore,
    );

    // User presses 'A' on their UK keyboard, gets a lower-case 'a'.
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::A,
        state: KeyState::Down,
    });
    assert_eq!(Some(DecodedKey::Unicode('a')), decoded_key);
    println!("Got {:?}", decoded_key);

    // User releases 'A' on their UK keyboard
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::A,
        state: KeyState::Up,
    });
    assert_eq!(None, decoded_key);

    // User presses 'Shift' on their UK keyboard
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::LShift,
        state: KeyState::Down,
    });
    assert_eq!(None, decoded_key);

    // User presses 'A' on their UK keyboard, now gets a Capital A
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::A,
        state: KeyState::Down,
    });
    assert_eq!(Some(DecodedKey::Unicode('A')), decoded_key);
    println!("Got {:?}", decoded_key);

    // User releases 'A' on their UK keyboard
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::A,
        state: KeyState::Up,
    });
    assert_eq!(None, decoded_key);

    // User releases 'Shift' on their UK keyboard
    let decoded_key = decoder.process_keyevent(KeyEvent {
        code: KeyCode::LShift,
        state: KeyState::Up,
    });
    assert_eq!(None, decoded_key);
}

pub fn change_layout(&mut self, new_layout: L)

Change the keyboard layout.

Only useful with layouts::AnyLayout, otherwise you can only change a layout for exactly the same layout.

Trait Implementations

impl<L> Debug for EventDecoder<L>

where L: KeyboardLayout + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.