gdk/
event_key.rs

1// Take a look at the license at the top of the repository in the LICENSE file.
2
3use crate::ffi;
4use glib::translate::*;
5
6/// Describes a key press or key release event.
7#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
8pub struct EventKey(crate::Event);
9
10event_wrapper!(EventKey, GdkEventKey);
11event_subtype!(EventKey, ffi::GDK_KEY_PRESS | ffi::GDK_KEY_RELEASE);
12
13impl EventKey {
14    #[doc(alias = "get_time")]
15    pub fn time(&self) -> u32 {
16        self.as_ref().time
17    }
18
19    #[doc(alias = "get_state")]
20    pub fn state(&self) -> crate::ModifierType {
21        unsafe { from_glib(self.as_ref().state) }
22    }
23
24    #[doc(alias = "get_keyval")]
25    pub fn keyval(&self) -> crate::keys::Key {
26        unsafe { from_glib(self.as_ref().keyval) }
27    }
28
29    #[doc(alias = "get_length")]
30    pub fn length(&self) -> u32 {
31        let length = self.as_ref().length;
32        assert!(length >= 0, "Unexpected negative value");
33        length as u32
34    }
35
36    #[doc(alias = "get_hardware_keycode")]
37    pub fn hardware_keycode(&self) -> u16 {
38        self.as_ref().hardware_keycode
39    }
40
41    #[doc(alias = "get_group")]
42    pub fn group(&self) -> u8 {
43        self.as_ref().group
44    }
45
46    #[doc(alias = "get_is_modifier")]
47    pub fn is_modifier(&self) -> bool {
48        self.as_ref().is_modifier & 1 != 0
49    }
50}
gdk/event_key.rs

gdk/
event_key.rs
