vtimofei
/
smithay
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Mention where keyboard key code constants may be found

This commit is contained in:
i509VCB 2021-10-23 22:59:01 -05:00
parent 63f9a713ce
commit e1400a1926
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/backend/input/mod.rs
View File

@ -87,10 +87,17 @@ pub enum KeyState {
/// Trait for keyboard event
pub trait KeyboardKeyEvent<B: InputBackend>: Event<B> {
/// Code of the pressed key. See `linux/input-event-codes.h`
/// Returns the numerical button code of the keyboard button.
///
/// The value will correspond to one `KEY_` constants from the Linux [input event codes] inside
/// `input-event-codes.h`.
///
/// [input event codes]: https://gitlab.freedesktop.org/libinput/libinput/-/blob/main/include/linux/linux/input-event-codes.h
fn key_code(&self) -> u32;
/// State of the key
fn state(&self) -> KeyState;
/// Total number of keys pressed on all devices on the associated [`Seat`](crate::wayland::seat::Seat)
fn count(&self) -> u32;
}