gdk4/auto/
pad_event.rs

1// This file was generated by gir (https://github.com/gtk-rs/gir)
2// from gir-files (https://github.com/gtk-rs/gir-files)
3// DO NOT EDIT
4
5use crate::ffi;
6use glib::{prelude::*, translate::*};
7
8glib::wrapper! {
9    /// An event related to a pad-based device.
10    #[doc(alias = "GdkPadEvent")]
11    pub struct PadEvent(Shared<ffi::GdkPadEvent>);
12
13    match fn {
14        ref => |ptr| ffi::gdk_event_ref(ptr as *mut ffi::GdkEvent),
15        unref => |ptr| ffi::gdk_event_unref(ptr as *mut ffi::GdkEvent),
16    }
17}
18
19impl StaticType for PadEvent {
20    fn static_type() -> glib::Type {
21        unsafe { from_glib(ffi::gdk_pad_event_get_type()) }
22    }
23}
24
25impl PadEvent {
26    /// Extracts the information from a pad strip or ring event.
27    ///
28    /// # Returns
29    ///
30    ///
31    /// ## `index`
32    /// Return location for the axis index
33    ///
34    /// ## `value`
35    /// Return location for the axis value
36    #[doc(alias = "gdk_pad_event_get_axis_value")]
37    #[doc(alias = "get_axis_value")]
38    pub fn axis_value(&self) -> (u32, f64) {
39        unsafe {
40            let mut index = std::mem::MaybeUninit::uninit();
41            let mut value = std::mem::MaybeUninit::uninit();
42            ffi::gdk_pad_event_get_axis_value(
43                self.to_glib_none().0,
44                index.as_mut_ptr(),
45                value.as_mut_ptr(),
46            );
47            (index.assume_init(), value.assume_init())
48        }
49    }
50
51    /// Extracts information about the pressed button from
52    /// a pad event.
53    ///
54    /// # Returns
55    ///
56    /// the button of @self
57    #[doc(alias = "gdk_pad_event_get_button")]
58    #[doc(alias = "get_button")]
59    pub fn button(&self) -> u32 {
60        unsafe { ffi::gdk_pad_event_get_button(self.to_glib_none().0) }
61    }
62
63    /// Extracts group and mode information from a pad event.
64    ///
65    /// # Returns
66    ///
67    ///
68    /// ## `group`
69    /// return location for the group
70    ///
71    /// ## `mode`
72    /// return location for the mode
73    #[doc(alias = "gdk_pad_event_get_group_mode")]
74    #[doc(alias = "get_group_mode")]
75    pub fn group_mode(&self) -> (u32, u32) {
76        unsafe {
77            let mut group = std::mem::MaybeUninit::uninit();
78            let mut mode = std::mem::MaybeUninit::uninit();
79            ffi::gdk_pad_event_get_group_mode(
80                self.to_glib_none().0,
81                group.as_mut_ptr(),
82                mode.as_mut_ptr(),
83            );
84            (group.assume_init(), mode.assume_init())
85        }
86    }
87}