gdk4/auto/
key_event.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{ffi, ModifierType};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// An event related to a key-based device.
    #[doc(alias = "GdkKeyEvent")]
    pub struct KeyEvent(Shared<ffi::GdkKeyEvent>);

    match fn {
        ref => |ptr| ffi::gdk_event_ref(ptr as *mut ffi::GdkEvent),
        unref => |ptr| ffi::gdk_event_unref(ptr as *mut ffi::GdkEvent),
    }
}

impl StaticType for KeyEvent {
    fn static_type() -> glib::Type {
        unsafe { from_glib(ffi::gdk_key_event_get_type()) }
    }
}

impl KeyEvent {
    /// Extracts the consumed modifiers from a key event.
    ///
    /// # Returns
    ///
    /// the consumed modifiers or @self
    #[doc(alias = "gdk_key_event_get_consumed_modifiers")]
    #[doc(alias = "get_consumed_modifiers")]
    pub fn consumed_modifiers(&self) -> ModifierType {
        unsafe {
            from_glib(ffi::gdk_key_event_get_consumed_modifiers(
                self.to_glib_none().0,
            ))
        }
    }

    /// Extracts the keycode from a key event.
    ///
    /// # Returns
    ///
    /// the keycode of @self
    #[doc(alias = "gdk_key_event_get_keycode")]
    #[doc(alias = "get_keycode")]
    pub fn keycode(&self) -> u32 {
        unsafe { ffi::gdk_key_event_get_keycode(self.to_glib_none().0) }
    }

    /// Extracts the layout from a key event.
    ///
    /// # Returns
    ///
    /// the layout of @self
    #[doc(alias = "gdk_key_event_get_layout")]
    #[doc(alias = "get_layout")]
    pub fn layout(&self) -> u32 {
        unsafe { ffi::gdk_key_event_get_layout(self.to_glib_none().0) }
    }

    /// Extracts the shift level from a key event.
    ///
    /// # Returns
    ///
    /// the shift level of @self
    #[doc(alias = "gdk_key_event_get_level")]
    #[doc(alias = "get_level")]
    pub fn level(&self) -> u32 {
        unsafe { ffi::gdk_key_event_get_level(self.to_glib_none().0) }
    }

    /// Extracts whether the key event is for a modifier key.
    ///
    /// # Returns
    ///
    /// [`true`] if the @self is for a modifier key
    #[doc(alias = "gdk_key_event_is_modifier")]
    pub fn is_modifier(&self) -> bool {
        unsafe { from_glib(ffi::gdk_key_event_is_modifier(self.to_glib_none().0)) }
    }
}