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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
// 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::{Buildable, EventController, Shortcut, ShortcutScope};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// [`ShortcutController`][crate::ShortcutController] is an event controller that manages shortcuts.
///
/// Most common shortcuts are using this controller implicitly, e.g. by
/// adding a mnemonic underline to a [`Label`][crate::Label], or by installing a key
/// binding using `Gtk::WidgetClass::add_binding()`, or by adding accelerators
/// to global actions using [`GtkApplicationExt::set_accels_for_action()`][crate::prelude::GtkApplicationExt::set_accels_for_action()].
///
/// But it is possible to create your own shortcut controller, and add
/// shortcuts to it.
///
/// [`ShortcutController`][crate::ShortcutController] implements `GListModel` for querying the
/// shortcuts that have been added to it.
///
/// # GtkShortcutController as a GtkBuildable
///
/// `GtkShortcutControllers` can be creates in ui files to set up
/// shortcuts in the same place as the widgets.
///
/// An example of a UI definition fragment with [`ShortcutController`][crate::ShortcutController]:
/// ```xml
/// <object class='GtkButton'>
/// <child>
/// <object class='GtkShortcutController'>
/// <property name='scope'>managed</property>
/// <child>
/// <object class='GtkShortcut'>
/// <property name='trigger'><Control>k</property>
/// <property name='action'>activate</property>
/// </object>
/// </child>
/// </object>
/// </child>
/// </object>
/// ```
///
/// This example creates a [`ActivateAction`][crate::ActivateAction] for triggering the
/// `activate` signal of the [`Button`][crate::Button]. See [`ShortcutAction::parse_string()`][crate::ShortcutAction::parse_string()]
/// for the syntax for other kinds of [`ShortcutAction`][crate::ShortcutAction]. See
/// [`ShortcutTrigger::parse_string()`][crate::ShortcutTrigger::parse_string()] to learn more about the syntax
/// for triggers.
///
/// ## Properties
///
///
/// #### `item-type`
/// The type of items. See [`ListModelExtManual::item_type()`][crate::gio::prelude::ListModelExtManual::item_type()].
///
/// Readable
///
///
/// #### `mnemonic-modifiers`
/// The modifiers that need to be pressed to allow mnemonics activation.
///
/// Readable | Writeable
///
///
/// #### `model`
/// A list model to take shortcuts from.
///
/// Writeable | Construct Only
///
///
/// #### `n-items`
/// The number of items. See [`ListModelExtManual::n_items()`][crate::gio::prelude::ListModelExtManual::n_items()].
///
/// Readable
///
///
/// #### `scope`
/// What scope the shortcuts will be handled in.
///
/// Readable | Writeable
/// <details><summary><h4>EventController</h4></summary>
///
///
/// #### `name`
/// The name for this controller, typically used for debugging purposes.
///
/// Readable | Writeable
///
///
/// #### `propagation-limit`
/// The limit for which events this controller will handle.
///
/// Readable | Writeable
///
///
/// #### `propagation-phase`
/// The propagation phase at which this controller will handle events.
///
/// Readable | Writeable
///
///
/// #### `widget`
/// The widget receiving the `GdkEvents` that the controller will handle.
///
/// Readable
/// </details>
///
/// # Implements
///
/// [`EventControllerExt`][trait@crate::prelude::EventControllerExt], [`trait@glib::ObjectExt`], [`trait@gio::prelude::ListModelExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt]
#[doc(alias = "GtkShortcutController")]
pub struct ShortcutController(Object<ffi::GtkShortcutController, ffi::GtkShortcutControllerClass>) @extends EventController, @implements gio::ListModel, Buildable;
match fn {
type_ => || ffi::gtk_shortcut_controller_get_type(),
}
}
impl ShortcutController {
/// Creates a new shortcut controller.
///
/// # Returns
///
/// a newly created shortcut controller
#[doc(alias = "gtk_shortcut_controller_new")]
pub fn new() -> ShortcutController {
assert_initialized_main_thread!();
unsafe { EventController::from_glib_full(ffi::gtk_shortcut_controller_new()).unsafe_cast() }
}
/// Creates a new shortcut controller that takes its shortcuts from
/// the given list model.
///
/// A controller created by this function does not let you add or
/// remove individual shortcuts using the shortcut controller api,
/// but you can change the contents of the model.
/// ## `model`
/// a `GListModel` containing shortcuts
///
/// # Returns
///
/// a newly created shortcut controller
#[doc(alias = "gtk_shortcut_controller_new_for_model")]
#[doc(alias = "new_for_model")]
pub fn for_model(model: &impl IsA<gio::ListModel>) -> ShortcutController {
assert_initialized_main_thread!();
unsafe {
EventController::from_glib_full(ffi::gtk_shortcut_controller_new_for_model(
model.as_ref().to_glib_none().0,
))
.unsafe_cast()
}
}
/// Adds @shortcut to the list of shortcuts handled by @self.
///
/// If this controller uses an external shortcut list, this
/// function does nothing.
/// ## `shortcut`
/// a [`Shortcut`][crate::Shortcut]
#[doc(alias = "gtk_shortcut_controller_add_shortcut")]
pub fn add_shortcut(&self, shortcut: Shortcut) {
unsafe {
ffi::gtk_shortcut_controller_add_shortcut(
self.to_glib_none().0,
shortcut.into_glib_ptr(),
);
}
}
/// Gets the mnemonics modifiers for when this controller activates its shortcuts.
///
/// # Returns
///
/// the controller's mnemonics modifiers
#[doc(alias = "gtk_shortcut_controller_get_mnemonics_modifiers")]
#[doc(alias = "get_mnemonics_modifiers")]
pub fn mnemonics_modifiers(&self) -> gdk::ModifierType {
unsafe {
from_glib(ffi::gtk_shortcut_controller_get_mnemonics_modifiers(
self.to_glib_none().0,
))
}
}
/// Gets the scope for when this controller activates its shortcuts.
///
/// See [`set_scope()`][Self::set_scope()] for details.
///
/// # Returns
///
/// the controller's scope
#[doc(alias = "gtk_shortcut_controller_get_scope")]
#[doc(alias = "get_scope")]
pub fn scope(&self) -> ShortcutScope {
unsafe {
from_glib(ffi::gtk_shortcut_controller_get_scope(
self.to_glib_none().0,
))
}
}
/// Removes @shortcut from the list of shortcuts handled by @self.
///
/// If @shortcut had not been added to @controller or this controller
/// uses an external shortcut list, this function does nothing.
/// ## `shortcut`
/// a [`Shortcut`][crate::Shortcut]
#[doc(alias = "gtk_shortcut_controller_remove_shortcut")]
pub fn remove_shortcut(&self, shortcut: &Shortcut) {
unsafe {
ffi::gtk_shortcut_controller_remove_shortcut(
self.to_glib_none().0,
shortcut.to_glib_none().0,
);
}
}
/// Sets the controller to use the given modifier for mnemonics.
///
/// The mnemonics modifiers determines which modifiers need to be pressed to allow
/// activation of shortcuts with mnemonics triggers.
///
/// GTK normally uses the Alt modifier for mnemonics, except in [`PopoverMenu`][crate::PopoverMenu]s,
/// where mnemonics can be triggered without any modifiers. It should be very
/// rarely necessary to change this, and doing so is likely to interfere with
/// other shortcuts.
///
/// This value is only relevant for local shortcut controllers. Global and managed
/// shortcut controllers will have their shortcuts activated from other places which
/// have their own modifiers for activating mnemonics.
/// ## `modifiers`
/// the new mnemonics_modifiers to use
#[doc(alias = "gtk_shortcut_controller_set_mnemonics_modifiers")]
pub fn set_mnemonics_modifiers(&self, modifiers: gdk::ModifierType) {
unsafe {
ffi::gtk_shortcut_controller_set_mnemonics_modifiers(
self.to_glib_none().0,
modifiers.into_glib(),
);
}
}
/// Sets the controller to have the given @scope.
///
/// The scope allows shortcuts to be activated outside of the normal
/// event propagation. In particular, it allows installing global
/// keyboard shortcuts that can be activated even when a widget does
/// not have focus.
///
/// With [`ShortcutScope::Local`][crate::ShortcutScope::Local], shortcuts will only be activated
/// when the widget has focus.
/// ## `scope`
/// the new scope to use
#[doc(alias = "gtk_shortcut_controller_set_scope")]
pub fn set_scope(&self, scope: ShortcutScope) {
unsafe {
ffi::gtk_shortcut_controller_set_scope(self.to_glib_none().0, scope.into_glib());
}
}
/// The modifiers that need to be pressed to allow mnemonics activation.
#[doc(alias = "mnemonic-modifiers")]
pub fn mnemonic_modifiers(&self) -> gdk::ModifierType {
glib::ObjectExt::property(self, "mnemonic-modifiers")
}
/// The modifiers that need to be pressed to allow mnemonics activation.
#[doc(alias = "mnemonic-modifiers")]
pub fn set_mnemonic_modifiers(&self, mnemonic_modifiers: gdk::ModifierType) {
glib::ObjectExt::set_property(self, "mnemonic-modifiers", mnemonic_modifiers)
}
#[doc(alias = "mnemonic-modifiers")]
pub fn connect_mnemonic_modifiers_notify<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_mnemonic_modifiers_trampoline<
F: Fn(&ShortcutController) + 'static,
>(
this: *mut ffi::GtkShortcutController,
_param_spec: glib::ffi::gpointer,
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"notify::mnemonic-modifiers\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_mnemonic_modifiers_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "scope")]
pub fn connect_scope_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_scope_trampoline<F: Fn(&ShortcutController) + 'static>(
this: *mut ffi::GtkShortcutController,
_param_spec: glib::ffi::gpointer,
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"notify::scope\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_scope_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for ShortcutController {
fn default() -> Self {
Self::new()
}
}
impl fmt::Display for ShortcutController {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("ShortcutController")
}
}