gtk/auto/

accel_group.rs

// 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;
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// A [`AccelGroup`][crate::AccelGroup] represents a group of keyboard accelerators,
    /// typically attached to a toplevel [`Window`][crate::Window] (with
    /// [`GtkWindowExt::add_accel_group()`][crate::prelude::GtkWindowExt::add_accel_group()]). Usually you won’t need to create a
    /// [`AccelGroup`][crate::AccelGroup] directly; instead, when using `GtkUIManager`, GTK+
    /// automatically sets up the accelerators for your menus in the ui
    /// manager’s [`AccelGroup`][crate::AccelGroup].
    ///
    /// Note that “accelerators” are different from
    /// “mnemonics”. Accelerators are shortcuts for
    /// activating a menu item; they appear alongside the menu item they’re a
    /// shortcut for. For example “Ctrl+Q” might appear alongside the “Quit”
    /// menu item. Mnemonics are shortcuts for GUI elements such as text
    /// entries or buttons; they appear as underlined characters. See
    /// [`Label::with_mnemonic()`][crate::Label::with_mnemonic()]. Menu items can have both accelerators
    /// and mnemonics, of course.
    ///
    /// ## Properties
    ///
    ///
    /// #### `is-locked`
    ///  Readable
    ///
    ///
    /// #### `modifier-mask`
    ///  Readable
    ///
    /// ## Signals
    ///
    ///
    /// #### `accel-activate`
    ///  The accel-activate signal is an implementation detail of
    /// [`AccelGroup`][crate::AccelGroup] and not meant to be used by applications.
    ///
    /// Detailed
    ///
    ///
    /// #### `accel-changed`
    ///  The accel-changed signal is emitted when an entry
    /// is added to or removed from the accel group.
    ///
    /// Widgets like [`AccelLabel`][crate::AccelLabel] which display an associated
    /// accelerator should connect to this signal, and rebuild
    /// their visual representation if the `accel_closure` is theirs.
    ///
    /// Detailed
    ///
    /// # Implements
    ///
    /// [`AccelGroupExt`][trait@crate::prelude::AccelGroupExt], [`trait@glib::ObjectExt`], [`AccelGroupExtManual`][trait@crate::prelude::AccelGroupExtManual]
    #[doc(alias = "GtkAccelGroup")]
    pub struct AccelGroup(Object<ffi::GtkAccelGroup, ffi::GtkAccelGroupClass>);

    match fn {
        type_ => || ffi::gtk_accel_group_get_type(),
    }
}

impl AccelGroup {
    pub const NONE: Option<&'static AccelGroup> = None;

    /// Creates a new [`AccelGroup`][crate::AccelGroup].
    ///
    /// # Returns
    ///
    /// a new [`AccelGroup`][crate::AccelGroup] object
    #[doc(alias = "gtk_accel_group_new")]
    pub fn new() -> AccelGroup {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_accel_group_new()) }
    }

    /// Finds the [`AccelGroup`][crate::AccelGroup] to which `closure` is connected;
    /// see [`AccelGroupExtManual::connect_accel_group()`][crate::prelude::AccelGroupExtManual::connect_accel_group()].
    /// ## `closure`
    /// a [`glib::Closure`][crate::glib::Closure]
    ///
    /// # Returns
    ///
    /// the [`AccelGroup`][crate::AccelGroup] to which `closure`
    ///  is connected, or [`None`]
    #[doc(alias = "gtk_accel_group_from_accel_closure")]
    pub fn from_accel_closure(closure: &glib::Closure) -> Option<AccelGroup> {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_none(ffi::gtk_accel_group_from_accel_closure(
                closure.to_glib_none().0,
            ))
        }
    }
}

impl Default for AccelGroup {
    fn default() -> Self {
        Self::new()
    }
}

/// Trait containing all [`struct@AccelGroup`] methods.
///
/// # Implementors
///
/// [`AccelGroup`][struct@crate::AccelGroup]
pub trait AccelGroupExt: IsA<AccelGroup> + 'static {
    /// Finds the first accelerator in `self` that matches
    /// `accel_key` and `accel_mods`, and activates it.
    /// ## `accel_quark`
    /// the quark for the accelerator name
    /// ## `acceleratable`
    /// the [`glib::Object`][crate::glib::Object], usually a [`Window`][crate::Window], on which
    ///  to activate the accelerator
    /// ## `accel_key`
    /// accelerator keyval from a key event
    /// ## `accel_mods`
    /// keyboard state mask from a key event
    ///
    /// # Returns
    ///
    /// [`true`] if an accelerator was activated and handled
    ///  this keypress
    #[doc(alias = "gtk_accel_group_activate")]
    fn activate(
        &self,
        accel_quark: glib::Quark,
        acceleratable: &impl IsA<glib::Object>,
        accel_key: u32,
        accel_mods: gdk::ModifierType,
    ) -> bool {
        unsafe {
            from_glib(ffi::gtk_accel_group_activate(
                self.as_ref().to_glib_none().0,
                accel_quark.into_glib(),
                acceleratable.as_ref().to_glib_none().0,
                accel_key,
                accel_mods.into_glib(),
            ))
        }
    }

    /// Removes an accelerator previously installed through
    /// [`AccelGroupExtManual::connect_accel_group()`][crate::prelude::AccelGroupExtManual::connect_accel_group()].
    ///
    /// Since 2.20 `closure` can be [`None`].
    /// ## `closure`
    /// the closure to remove from this accelerator
    ///  group, or [`None`] to remove all closures
    ///
    /// # Returns
    ///
    /// [`true`] if the closure was found and got disconnected
    #[doc(alias = "gtk_accel_group_disconnect")]
    fn disconnect(&self, closure: Option<&glib::Closure>) -> bool {
        unsafe {
            from_glib(ffi::gtk_accel_group_disconnect(
                self.as_ref().to_glib_none().0,
                closure.to_glib_none().0,
            ))
        }
    }

    /// Removes an accelerator previously installed through
    /// [`AccelGroupExtManual::connect_accel_group()`][crate::prelude::AccelGroupExtManual::connect_accel_group()].
    /// ## `accel_key`
    /// key value of the accelerator
    /// ## `accel_mods`
    /// modifier combination of the accelerator
    ///
    /// # Returns
    ///
    /// [`true`] if there was an accelerator which could be
    ///  removed, [`false`] otherwise
    #[doc(alias = "gtk_accel_group_disconnect_key")]
    fn disconnect_key(&self, accel_key: u32, accel_mods: gdk::ModifierType) -> bool {
        unsafe {
            from_glib(ffi::gtk_accel_group_disconnect_key(
                self.as_ref().to_glib_none().0,
                accel_key,
                accel_mods.into_glib(),
            ))
        }
    }

    //#[doc(alias = "gtk_accel_group_find")]
    //fn find(&self, find_func: /*Unimplemented*/FnMut(/*Ignored*/AccelKey, &glib::Closure) -> bool, data: /*Unimplemented*/Option<Basic: Pointer>) -> /*Ignored*/Option<AccelKey> {
    //    unsafe { TODO: call ffi:gtk_accel_group_find() }
    //}

    /// Locks are added and removed using [`lock()`][Self::lock()] and
    /// [`unlock()`][Self::unlock()].
    ///
    /// # Returns
    ///
    /// [`true`] if there are 1 or more locks on the `self`,
    ///  [`false`] otherwise.
    #[doc(alias = "gtk_accel_group_get_is_locked")]
    #[doc(alias = "get_is_locked")]
    #[doc(alias = "is-locked")]
    fn is_locked(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_accel_group_get_is_locked(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets a [`gdk::ModifierType`][crate::gdk::ModifierType] representing the mask for this
    /// `self`. For example, [`gdk::ModifierType::CONTROL_MASK`][crate::gdk::ModifierType::CONTROL_MASK], [`gdk::ModifierType::SHIFT_MASK`][crate::gdk::ModifierType::SHIFT_MASK], etc.
    ///
    /// # Returns
    ///
    /// the modifier mask for this accel group.
    #[doc(alias = "gtk_accel_group_get_modifier_mask")]
    #[doc(alias = "get_modifier_mask")]
    #[doc(alias = "modifier-mask")]
    fn modifier_mask(&self) -> gdk::ModifierType {
        unsafe {
            from_glib(ffi::gtk_accel_group_get_modifier_mask(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Locks the given accelerator group.
    ///
    /// Locking an acelerator group prevents the accelerators contained
    /// within it to be changed during runtime. Refer to
    /// `gtk_accel_map_change_entry()` about runtime accelerator changes.
    ///
    /// If called more than once, `self` remains locked until
    /// [`unlock()`][Self::unlock()] has been called an equivalent number
    /// of times.
    #[doc(alias = "gtk_accel_group_lock")]
    fn lock(&self) {
        unsafe {
            ffi::gtk_accel_group_lock(self.as_ref().to_glib_none().0);
        }
    }

    /// Undoes the last call to [`lock()`][Self::lock()] on this `self`.
    #[doc(alias = "gtk_accel_group_unlock")]
    fn unlock(&self) {
        unsafe {
            ffi::gtk_accel_group_unlock(self.as_ref().to_glib_none().0);
        }
    }

    /// The accel-activate signal is an implementation detail of
    /// [`AccelGroup`][crate::AccelGroup] and not meant to be used by applications.
    /// ## `acceleratable`
    /// the object on which the accelerator was activated
    /// ## `keyval`
    /// the accelerator keyval
    /// ## `modifier`
    /// the modifier combination of the accelerator
    ///
    /// # Returns
    ///
    /// [`true`] if the accelerator was activated
    #[doc(alias = "accel-activate")]
    fn connect_accel_activate<
        F: Fn(&Self, &glib::Object, u32, gdk::ModifierType) -> bool + 'static,
    >(
        &self,
        detail: Option<&str>,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn accel_activate_trampoline<
            P: IsA<AccelGroup>,
            F: Fn(&P, &glib::Object, u32, gdk::ModifierType) -> bool + 'static,
        >(
            this: *mut ffi::GtkAccelGroup,
            acceleratable: *mut glib::gobject_ffi::GObject,
            keyval: std::ffi::c_uint,
            modifier: gdk::ffi::GdkModifierType,
            f: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    AccelGroup::from_glib_borrow(this).unsafe_cast_ref(),
                    &from_glib_borrow(acceleratable),
                    keyval,
                    from_glib(modifier),
                )
                .into_glib()
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            let detailed_signal_name = detail.map(|name| format!("accel-activate::{name}\0"));
            let signal_name = detailed_signal_name
                .as_ref()
                .map_or(c"accel-activate", |n| {
                    std::ffi::CStr::from_bytes_with_nul_unchecked(n.as_bytes())
                });
            connect_raw(
                self.as_ptr() as *mut _,
                signal_name.as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    accel_activate_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// The accel-changed signal is emitted when an entry
    /// is added to or removed from the accel group.
    ///
    /// Widgets like [`AccelLabel`][crate::AccelLabel] which display an associated
    /// accelerator should connect to this signal, and rebuild
    /// their visual representation if the `accel_closure` is theirs.
    /// ## `keyval`
    /// the accelerator keyval
    /// ## `modifier`
    /// the modifier combination of the accelerator
    /// ## `accel_closure`
    /// the [`glib::Closure`][crate::glib::Closure] of the accelerator
    #[doc(alias = "accel-changed")]
    fn connect_accel_changed<F: Fn(&Self, u32, gdk::ModifierType, &glib::Closure) + 'static>(
        &self,
        detail: Option<&str>,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn accel_changed_trampoline<
            P: IsA<AccelGroup>,
            F: Fn(&P, u32, gdk::ModifierType, &glib::Closure) + 'static,
        >(
            this: *mut ffi::GtkAccelGroup,
            keyval: std::ffi::c_uint,
            modifier: gdk::ffi::GdkModifierType,
            accel_closure: *mut glib::gobject_ffi::GClosure,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(
                    AccelGroup::from_glib_borrow(this).unsafe_cast_ref(),
                    keyval,
                    from_glib(modifier),
                    &from_glib_borrow(accel_closure),
                )
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            let detailed_signal_name = detail.map(|name| format!("accel-changed::{name}\0"));
            let signal_name = detailed_signal_name.as_ref().map_or(c"accel-changed", |n| {
                std::ffi::CStr::from_bytes_with_nul_unchecked(n.as_bytes())
            });
            connect_raw(
                self.as_ptr() as *mut _,
                signal_name.as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    accel_changed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-locked")]
    fn connect_is_locked_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_locked_trampoline<
            P: IsA<AccelGroup>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkAccelGroup,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(AccelGroup::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::is-locked".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_locked_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "modifier-mask")]
    fn connect_modifier_mask_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_modifier_mask_trampoline<
            P: IsA<AccelGroup>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkAccelGroup,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(AccelGroup::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::modifier-mask".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_modifier_mask_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<AccelGroup>> AccelGroupExt for O {}