gtk4/auto/

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

glib::wrapper! {
    /// Tracks keyboard focus.
    ///
    /// The event controller offers [`enter`][struct@crate::EventControllerFocus#enter]
    /// and [`leave`][struct@crate::EventControllerFocus#leave] signals, as well as
    /// [`is-focus`][struct@crate::EventControllerFocus#is-focus] and
    /// [`contains-focus`][struct@crate::EventControllerFocus#contains-focus] properties
    /// which are updated to reflect focus changes inside the widget hierarchy
    /// that is rooted at the controllers widget.
    ///
    /// ## Properties
    ///
    ///
    /// #### `contains-focus`
    ///  [`true`] if focus is contained in the controllers widget.
    ///
    /// See [`is-focus`][struct@crate::EventControllerFocus#is-focus] for whether
    /// the focus is in the widget itself or inside a descendent.
    ///
    /// When handling focus events, this property is updated
    /// before [`enter`][struct@crate::EventControllerFocus#enter] or
    /// [`leave`][struct@crate::EventControllerFocus#leave] are emitted.
    ///
    /// Readable
    ///
    ///
    /// #### `is-focus`
    ///  [`true`] if focus is in the controllers widget itself,
    /// as opposed to in a descendent widget.
    ///
    /// See also [`contains-focus`][struct@crate::EventControllerFocus#contains-focus].
    ///
    /// When handling focus events, this property is updated
    /// before [`enter`][struct@crate::EventControllerFocus#enter] or
    /// [`leave`][struct@crate::EventControllerFocus#leave] are emitted.
    ///
    /// Readable
    /// <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>
    ///
    /// ## Signals
    ///
    ///
    /// #### `enter`
    ///  Emitted whenever the focus enters into the widget or one
    /// of its descendents.
    ///
    /// Note that this means you may not get an ::enter signal
    /// even though the widget becomes the focus location, in
    /// certain cases (such as when the focus moves from a descendent
    /// of the widget to the widget itself). If you are interested
    /// in these cases, you can monitor the
    /// [`is-focus`][struct@crate::EventControllerFocus#is-focus]
    /// property for changes.
    ///
    ///
    ///
    ///
    /// #### `leave`
    ///  Emitted whenever the focus leaves the widget hierarchy
    /// that is rooted at the widget that the controller is attached to.
    ///
    /// Note that this means you may not get a ::leave signal
    /// even though the focus moves away from the widget, in
    /// certain cases (such as when the focus moves from the widget
    /// to a descendent). If you are interested in these cases, you
    /// can monitor the [`is-focus`][struct@crate::EventControllerFocus#is-focus]
    /// property for changes.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`EventControllerExt`][trait@crate::prelude::EventControllerExt], [`trait@glib::ObjectExt`], [`EventControllerExtManual`][trait@crate::prelude::EventControllerExtManual]
    #[doc(alias = "GtkEventControllerFocus")]
    pub struct EventControllerFocus(Object<ffi::GtkEventControllerFocus, ffi::GtkEventControllerFocusClass>) @extends EventController;

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

impl EventControllerFocus {
    /// Creates a new event controller that will handle focus events.
    ///
    /// # Returns
    ///
    /// a new [`EventControllerFocus`][crate::EventControllerFocus]
    #[doc(alias = "gtk_event_controller_focus_new")]
    pub fn new() -> EventControllerFocus {
        assert_initialized_main_thread!();
        unsafe {
            EventController::from_glib_full(ffi::gtk_event_controller_focus_new()).unsafe_cast()
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`EventControllerFocus`] objects.
    ///
    /// This method returns an instance of [`EventControllerFocusBuilder`](crate::builders::EventControllerFocusBuilder) which can be used to create [`EventControllerFocus`] objects.
    pub fn builder() -> EventControllerFocusBuilder {
        EventControllerFocusBuilder::new()
    }

    /// Returns [`true`] if focus is within @self or one of its children.
    ///
    /// # Returns
    ///
    /// [`true`] if focus is within @self or one of its children
    #[doc(alias = "gtk_event_controller_focus_contains_focus")]
    #[doc(alias = "contains-focus")]
    pub fn contains_focus(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_event_controller_focus_contains_focus(
                self.to_glib_none().0,
            ))
        }
    }

    /// Returns [`true`] if focus is within @self, but not one of its children.
    ///
    /// # Returns
    ///
    /// [`true`] if focus is within @self, but not one of its children
    #[doc(alias = "gtk_event_controller_focus_is_focus")]
    #[doc(alias = "is-focus")]
    pub fn is_focus(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_event_controller_focus_is_focus(
                self.to_glib_none().0,
            ))
        }
    }

    /// Emitted whenever the focus enters into the widget or one
    /// of its descendents.
    ///
    /// Note that this means you may not get an ::enter signal
    /// even though the widget becomes the focus location, in
    /// certain cases (such as when the focus moves from a descendent
    /// of the widget to the widget itself). If you are interested
    /// in these cases, you can monitor the
    /// [`is-focus`][struct@crate::EventControllerFocus#is-focus]
    /// property for changes.
    #[doc(alias = "enter")]
    pub fn connect_enter<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn enter_trampoline<F: Fn(&EventControllerFocus) + 'static>(
            this: *mut ffi::GtkEventControllerFocus,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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 _,
                c"enter".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    enter_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Emitted whenever the focus leaves the widget hierarchy
    /// that is rooted at the widget that the controller is attached to.
    ///
    /// Note that this means you may not get a ::leave signal
    /// even though the focus moves away from the widget, in
    /// certain cases (such as when the focus moves from the widget
    /// to a descendent). If you are interested in these cases, you
    /// can monitor the [`is-focus`][struct@crate::EventControllerFocus#is-focus]
    /// property for changes.
    #[doc(alias = "leave")]
    pub fn connect_leave<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn leave_trampoline<F: Fn(&EventControllerFocus) + 'static>(
            this: *mut ffi::GtkEventControllerFocus,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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 _,
                c"leave".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    leave_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "contains-focus")]
    pub fn connect_contains_focus_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_contains_focus_trampoline<
            F: Fn(&EventControllerFocus) + 'static,
        >(
            this: *mut ffi::GtkEventControllerFocus,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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 _,
                c"notify::contains-focus".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_contains_focus_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "is-focus")]
    pub fn connect_is_focus_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_is_focus_trampoline<F: Fn(&EventControllerFocus) + 'static>(
            this: *mut ffi::GtkEventControllerFocus,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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 _,
                c"notify::is-focus".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_is_focus_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`EventControllerFocus`] 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 EventControllerFocusBuilder {
    builder: glib::object::ObjectBuilder<'static, EventControllerFocus>,
}

impl EventControllerFocusBuilder {
    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 [`EventControllerFocus`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> EventControllerFocus {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}