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
// 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::{ShortcutAction, ShortcutTrigger};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// A [`Shortcut`][crate::Shortcut] describes a keyboard shortcut.
///
/// It contains a description of how to trigger the shortcut via a
/// [`ShortcutTrigger`][crate::ShortcutTrigger] and a way to activate the shortcut
/// on a widget via a [`ShortcutAction`][crate::ShortcutAction].
///
/// The actual work is usually done via [`ShortcutController`][crate::ShortcutController],
/// which decides if and when to activate a shortcut. Using that controller
/// directly however is rarely necessary as various higher level
/// convenience APIs exist on [`Widget`][crate::Widget]s that make it easier to use
/// shortcuts in GTK.
///
/// [`Shortcut`][crate::Shortcut] does provide functionality to make it easy for users
/// to work with shortcuts, either by providing informational strings
/// for display purposes or by allowing shortcuts to be configured.
///
/// ## Properties
///
///
/// #### `action`
/// The action that gets activated by this shortcut.
///
/// Readable | Writeable
///
///
/// #### `arguments`
/// Arguments passed to activation.
///
/// Readable | Writeable
///
///
/// #### `trigger`
/// The trigger that triggers this shortcut.
///
/// Readable | Writeable
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GtkShortcut")]
pub struct Shortcut(Object<ffi::GtkShortcut, ffi::GtkShortcutClass>);
match fn {
type_ => || ffi::gtk_shortcut_get_type(),
}
}
impl Shortcut {
/// Creates a new [`Shortcut`][crate::Shortcut] that is triggered by
/// @trigger and then activates @action.
/// ## `trigger`
/// The trigger that will trigger the shortcut
/// ## `action`
/// The action that will be activated upon
/// triggering
///
/// # Returns
///
/// a new [`Shortcut`][crate::Shortcut]
#[doc(alias = "gtk_shortcut_new")]
pub fn new(
trigger: Option<impl IsA<ShortcutTrigger>>,
action: Option<impl IsA<ShortcutAction>>,
) -> Shortcut {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_shortcut_new(
trigger.map(|p| p.upcast()).into_glib_ptr(),
action.map(|p| p.upcast()).into_glib_ptr(),
))
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`Shortcut`] objects.
///
/// This method returns an instance of [`ShortcutBuilder`](crate::builders::ShortcutBuilder) which can be used to create [`Shortcut`] objects.
pub fn builder() -> ShortcutBuilder {
ShortcutBuilder::new()
}
/// Gets the action that is activated by this shortcut.
///
/// # Returns
///
/// the action
#[doc(alias = "gtk_shortcut_get_action")]
#[doc(alias = "get_action")]
pub fn action(&self) -> Option<ShortcutAction> {
unsafe { from_glib_none(ffi::gtk_shortcut_get_action(self.to_glib_none().0)) }
}
/// Gets the arguments that are passed when activating the shortcut.
///
/// # Returns
///
/// the arguments
#[doc(alias = "gtk_shortcut_get_arguments")]
#[doc(alias = "get_arguments")]
pub fn arguments(&self) -> Option<glib::Variant> {
unsafe { from_glib_none(ffi::gtk_shortcut_get_arguments(self.to_glib_none().0)) }
}
/// Gets the trigger used to trigger @self.
///
/// # Returns
///
/// the trigger used
#[doc(alias = "gtk_shortcut_get_trigger")]
#[doc(alias = "get_trigger")]
pub fn trigger(&self) -> Option<ShortcutTrigger> {
unsafe { from_glib_none(ffi::gtk_shortcut_get_trigger(self.to_glib_none().0)) }
}
/// Sets the new action for @self to be @action.
/// ## `action`
/// The new action.
/// If the @action is [`None`], the nothing action will be used.
#[doc(alias = "gtk_shortcut_set_action")]
pub fn set_action(&self, action: Option<impl IsA<ShortcutAction>>) {
unsafe {
ffi::gtk_shortcut_set_action(
self.to_glib_none().0,
action.map(|p| p.upcast()).into_glib_ptr(),
);
}
}
/// Sets the arguments to pass when activating the shortcut.
/// ## `args`
/// arguments to pass when activating @self
#[doc(alias = "gtk_shortcut_set_arguments")]
pub fn set_arguments(&self, args: Option<&glib::Variant>) {
unsafe {
ffi::gtk_shortcut_set_arguments(self.to_glib_none().0, args.to_glib_none().0);
}
}
/// Sets the new trigger for @self to be @trigger.
/// ## `trigger`
/// The new trigger.
/// If the @trigger is [`None`], the never trigger will be used.
#[doc(alias = "gtk_shortcut_set_trigger")]
pub fn set_trigger(&self, trigger: Option<impl IsA<ShortcutTrigger>>) {
unsafe {
ffi::gtk_shortcut_set_trigger(
self.to_glib_none().0,
trigger.map(|p| p.upcast()).into_glib_ptr(),
);
}
}
#[doc(alias = "action")]
pub fn connect_action_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_action_trampoline<F: Fn(&Shortcut) + 'static>(
this: *mut ffi::GtkShortcut,
_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::action\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_action_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "arguments")]
pub fn connect_arguments_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_arguments_trampoline<F: Fn(&Shortcut) + 'static>(
this: *mut ffi::GtkShortcut,
_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::arguments\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_arguments_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "trigger")]
pub fn connect_trigger_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_trigger_trampoline<F: Fn(&Shortcut) + 'static>(
this: *mut ffi::GtkShortcut,
_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::trigger\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_trigger_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for Shortcut {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`Shortcut`] 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 ShortcutBuilder {
builder: glib::object::ObjectBuilder<'static, Shortcut>,
}
impl ShortcutBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The action that gets activated by this shortcut.
pub fn action(self, action: &impl IsA<ShortcutAction>) -> Self {
Self {
builder: self.builder.property("action", action.clone().upcast()),
}
}
/// Arguments passed to activation.
pub fn arguments(self, arguments: &glib::Variant) -> Self {
Self {
builder: self.builder.property("arguments", arguments.clone()),
}
}
/// The trigger that triggers this shortcut.
pub fn trigger(self, trigger: &impl IsA<ShortcutTrigger>) -> Self {
Self {
builder: self.builder.property("trigger", trigger.clone().upcast()),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`Shortcut`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> Shortcut {
self.builder.build()
}
}
impl fmt::Display for Shortcut {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("Shortcut")
}
}