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 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
// 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::{EventController, IMContext, PropagationLimit, PropagationPhase, Widget};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// [`EventControllerKey`][crate::EventControllerKey] is an event controller that provides access
/// to key events.
///
/// ## Signals
///
///
/// #### `im-update`
/// Emitted whenever the input method context filters away
/// a keypress and prevents the @controller receiving it.
///
/// See [`EventControllerKey::set_im_context()`][crate::EventControllerKey::set_im_context()] and
/// [`IMContextExt::filter_keypress()`][crate::prelude::IMContextExt::filter_keypress()].
///
///
///
///
/// #### `key-pressed`
/// Emitted whenever a key is pressed.
///
///
///
///
/// #### `key-released`
/// Emitted whenever a key is released.
///
///
///
///
/// #### `modifiers`
/// Emitted whenever the state of modifier keys and pointer buttons change.
///
///
///
/// # Implements
///
/// [`EventControllerExt`][trait@crate::prelude::EventControllerExt], [`trait@glib::ObjectExt`]
#[doc(alias = "GtkEventControllerKey")]
pub struct EventControllerKey(Object<ffi::GtkEventControllerKey, ffi::GtkEventControllerKeyClass>) @extends EventController;
match fn {
type_ => || ffi::gtk_event_controller_key_get_type(),
}
}
impl EventControllerKey {
/// Creates a new event controller that will handle key events.
///
/// # Returns
///
/// a new [`EventControllerKey`][crate::EventControllerKey]
#[doc(alias = "gtk_event_controller_key_new")]
pub fn new() -> EventControllerKey {
assert_initialized_main_thread!();
unsafe {
EventController::from_glib_full(ffi::gtk_event_controller_key_new()).unsafe_cast()
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`EventControllerKey`] objects.
///
/// This method returns an instance of [`EventControllerKeyBuilder`](crate::builders::EventControllerKeyBuilder) which can be used to create [`EventControllerKey`] objects.
pub fn builder() -> EventControllerKeyBuilder {
EventControllerKeyBuilder::new()
}
/// Forwards the current event of this @self to a @widget.
///
/// This function can only be used in handlers for the
/// [`key-pressed`][struct@crate::EventControllerKey#key-pressed],
/// [`key-released`][struct@crate::EventControllerKey#key-released]
/// or [`modifiers`][struct@crate::EventControllerKey#modifiers] signals.
/// ## `widget`
/// a [`Widget`][crate::Widget]
///
/// # Returns
///
/// whether the @widget handled the event
#[doc(alias = "gtk_event_controller_key_forward")]
pub fn forward(&self, widget: &impl IsA<Widget>) -> bool {
unsafe {
from_glib(ffi::gtk_event_controller_key_forward(
self.to_glib_none().0,
widget.as_ref().to_glib_none().0,
))
}
}
/// Gets the key group of the current event of this @self.
///
/// See `Gdk::KeyEvent::get_layout()`.
///
/// # Returns
///
/// the key group
#[doc(alias = "gtk_event_controller_key_get_group")]
#[doc(alias = "get_group")]
pub fn group(&self) -> u32 {
unsafe { ffi::gtk_event_controller_key_get_group(self.to_glib_none().0) }
}
/// Gets the input method context of the key @self.
///
/// # Returns
///
/// the [`IMContext`][crate::IMContext]
#[doc(alias = "gtk_event_controller_key_get_im_context")]
#[doc(alias = "get_im_context")]
pub fn im_context(&self) -> Option<IMContext> {
unsafe {
from_glib_none(ffi::gtk_event_controller_key_get_im_context(
self.to_glib_none().0,
))
}
}
/// Sets the input method context of the key @self.
/// ## `im_context`
/// a [`IMContext`][crate::IMContext]
#[doc(alias = "gtk_event_controller_key_set_im_context")]
pub fn set_im_context(&self, im_context: Option<&impl IsA<IMContext>>) {
unsafe {
ffi::gtk_event_controller_key_set_im_context(
self.to_glib_none().0,
im_context.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Emitted whenever the input method context filters away
/// a keypress and prevents the @controller receiving it.
///
/// See [`set_im_context()`][Self::set_im_context()] and
/// [`IMContextExt::filter_keypress()`][crate::prelude::IMContextExt::filter_keypress()].
#[doc(alias = "im-update")]
pub fn connect_im_update<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn im_update_trampoline<F: Fn(&EventControllerKey) + 'static>(
this: *mut ffi::GtkEventControllerKey,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"im-update\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
im_update_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// Emitted whenever the state of modifier keys and pointer buttons change.
/// ## `keyval`
/// the released key.
#[doc(alias = "modifiers")]
pub fn connect_modifiers<F: Fn(&Self, gdk::ModifierType) -> glib::signal::Inhibit + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn modifiers_trampoline<
F: Fn(&EventControllerKey, gdk::ModifierType) -> glib::signal::Inhibit + 'static,
>(
this: *mut ffi::GtkEventControllerKey,
keyval: gdk::ffi::GdkModifierType,
f: glib::ffi::gpointer,
) -> glib::ffi::gboolean {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this), from_glib(keyval)).into_glib()
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"modifiers\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
modifiers_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for EventControllerKey {
fn default() -> Self {
Self::new()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`EventControllerKey`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct EventControllerKeyBuilder {
builder: glib::object::ObjectBuilder<'static, EventControllerKey>,
}
impl EventControllerKeyBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The name for this controller, typically used for debugging purposes.
pub fn name(self, name: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("name", name.into()),
}
}
/// The limit for which events this controller will handle.
pub fn propagation_limit(self, propagation_limit: PropagationLimit) -> Self {
Self {
builder: self
.builder
.property("propagation-limit", propagation_limit),
}
}
/// The propagation phase at which this controller will handle events.
pub fn propagation_phase(self, propagation_phase: PropagationPhase) -> Self {
Self {
builder: self
.builder
.property("propagation-phase", propagation_phase),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`EventControllerKey`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> EventControllerKey {
self.builder.build()
}
}
impl fmt::Display for EventControllerKey {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("EventControllerKey")
}
}