gtk4/auto/

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

glib::wrapper! {
    /// [`EventControllerScroll`][crate::EventControllerScroll] is an event controller that handles scroll
    /// events.
    ///
    /// It is capable of handling both discrete and continuous scroll
    /// events from mice or touchpads, abstracting them both with the
    /// [`scroll`][struct@crate::EventControllerScroll#scroll] signal. Deltas in
    /// the discrete case are multiples of 1.
    ///
    /// In the case of continuous scroll events, [`EventControllerScroll`][crate::EventControllerScroll]
    /// encloses all [`scroll`][struct@crate::EventControllerScroll#scroll] emissions
    /// between two [`scroll-begin`][struct@crate::EventControllerScroll#scroll-begin] and
    /// [`scroll-end`][struct@crate::EventControllerScroll#scroll-end] signals.
    ///
    /// The behavior of the event controller can be modified by the flags
    /// given at creation time, or modified at a later point through
    /// [`set_flags()`][Self::set_flags()] (e.g. because the scrolling
    /// conditions of the widget changed).
    ///
    /// The controller can be set up to emit motion for either/both vertical
    /// and horizontal scroll events through [`EventControllerScrollFlags::VERTICAL`][crate::EventControllerScrollFlags::VERTICAL],
    /// [`EventControllerScrollFlags::HORIZONTAL`][crate::EventControllerScrollFlags::HORIZONTAL] and [`EventControllerScrollFlags::BOTH_AXES`][crate::EventControllerScrollFlags::BOTH_AXES].
    /// If any axis is disabled, the respective [`scroll`][struct@crate::EventControllerScroll#scroll]
    /// delta will be 0. Vertical scroll events will be translated to horizontal
    /// motion for the devices incapable of horizontal scrolling.
    ///
    /// The event controller can also be forced to emit discrete events on all
    /// devices through [`EventControllerScrollFlags::DISCRETE`][crate::EventControllerScrollFlags::DISCRETE]. This can be used
    /// to implement discrete actions triggered through scroll events (e.g.
    /// switching across combobox options).
    ///
    /// The [`EventControllerScrollFlags::KINETIC`][crate::EventControllerScrollFlags::KINETIC] flag toggles the emission of the
    /// [`decelerate`][struct@crate::EventControllerScroll#decelerate] signal, emitted at the end
    /// of scrolling with two X/Y velocity arguments that are consistent with the
    /// motion that was received.
    ///
    /// ## Properties
    ///
    ///
    /// #### `flags`
    ///  The flags affecting event controller behavior.
    ///
    /// 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>
    ///
    /// ## Signals
    ///
    ///
    /// #### `decelerate`
    ///  Emitted after scroll is finished if the
    /// [`EventControllerScrollFlags::KINETIC`][crate::EventControllerScrollFlags::KINETIC] flag is set.
    ///
    /// @vel_x and @vel_y express the initial velocity that was
    /// imprinted by the scroll events. @vel_x and @vel_y are expressed in
    /// pixels/ms.
    ///
    ///
    ///
    ///
    /// #### `scroll`
    ///  Signals that the widget should scroll by the
    /// amount specified by @dx and @dy.
    ///
    /// For the representation unit of the deltas, see
    /// [`EventControllerScroll::unit()`][crate::EventControllerScroll::unit()].
    ///
    ///
    ///
    ///
    /// #### `scroll-begin`
    ///  Signals that a new scrolling operation has begun.
    ///
    /// It will only be emitted on devices capable of it.
    ///
    ///
    ///
    ///
    /// #### `scroll-end`
    ///  Signals that a scrolling operation has finished.
    ///
    /// It will only be emitted on devices capable of it.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`EventControllerExt`][trait@crate::prelude::EventControllerExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkEventControllerScroll")]
    pub struct EventControllerScroll(Object<ffi::GtkEventControllerScroll, ffi::GtkEventControllerScrollClass>) @extends EventController;

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

impl EventControllerScroll {
    /// Creates a new event controller that will handle scroll events.
    /// ## `flags`
    /// flags affecting the controller behavior
    ///
    /// # Returns
    ///
    /// a new [`EventControllerScroll`][crate::EventControllerScroll]
    #[doc(alias = "gtk_event_controller_scroll_new")]
    pub fn new(flags: EventControllerScrollFlags) -> EventControllerScroll {
        assert_initialized_main_thread!();
        unsafe {
            EventController::from_glib_full(ffi::gtk_event_controller_scroll_new(flags.into_glib()))
                .unsafe_cast()
        }
    }

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

    /// Gets the flags conditioning the scroll controller behavior.
    ///
    /// # Returns
    ///
    /// the controller flags.
    #[doc(alias = "gtk_event_controller_scroll_get_flags")]
    #[doc(alias = "get_flags")]
    pub fn flags(&self) -> EventControllerScrollFlags {
        unsafe {
            from_glib(ffi::gtk_event_controller_scroll_get_flags(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the scroll unit of the last
    /// [`scroll`][struct@crate::EventControllerScroll#scroll] signal received.
    ///
    /// Always returns [`gdk::ScrollUnit::Wheel`][crate::gdk::ScrollUnit::Wheel] if the
    /// [`EventControllerScrollFlags::DISCRETE`][crate::EventControllerScrollFlags::DISCRETE] flag is set.
    ///
    /// # Returns
    ///
    /// the scroll unit.
    #[cfg(feature = "v4_8")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v4_8")))]
    #[doc(alias = "gtk_event_controller_scroll_get_unit")]
    #[doc(alias = "get_unit")]
    pub fn unit(&self) -> gdk::ScrollUnit {
        unsafe {
            from_glib(ffi::gtk_event_controller_scroll_get_unit(
                self.to_glib_none().0,
            ))
        }
    }

    /// Sets the flags conditioning scroll controller behavior.
    /// ## `flags`
    /// flags affecting the controller behavior
    #[doc(alias = "gtk_event_controller_scroll_set_flags")]
    #[doc(alias = "flags")]
    pub fn set_flags(&self, flags: EventControllerScrollFlags) {
        unsafe {
            ffi::gtk_event_controller_scroll_set_flags(self.to_glib_none().0, flags.into_glib());
        }
    }

    /// Emitted after scroll is finished if the
    /// [`EventControllerScrollFlags::KINETIC`][crate::EventControllerScrollFlags::KINETIC] flag is set.
    ///
    /// @vel_x and @vel_y express the initial velocity that was
    /// imprinted by the scroll events. @vel_x and @vel_y are expressed in
    /// pixels/ms.
    /// ## `vel_x`
    /// X velocity
    /// ## `vel_y`
    /// Y velocity
    #[doc(alias = "decelerate")]
    pub fn connect_decelerate<F: Fn(&Self, f64, f64) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn decelerate_trampoline<
            F: Fn(&EventControllerScroll, f64, f64) + 'static,
        >(
            this: *mut ffi::GtkEventControllerScroll,
            vel_x: std::ffi::c_double,
            vel_y: std::ffi::c_double,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), vel_x, vel_y)
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"decelerate".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    decelerate_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Signals that the widget should scroll by the
    /// amount specified by @dx and @dy.
    ///
    /// For the representation unit of the deltas, see
    /// [`unit()`][Self::unit()].
    /// ## `dx`
    /// X delta
    /// ## `dy`
    /// Y delta
    ///
    /// # Returns
    ///
    /// [`true`] if the scroll event was handled,
    ///   [`false`] otherwise.
    #[doc(alias = "scroll")]
    pub fn connect_scroll<F: Fn(&Self, f64, f64) -> glib::Propagation + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn scroll_trampoline<
            F: Fn(&EventControllerScroll, f64, f64) -> glib::Propagation + 'static,
        >(
            this: *mut ffi::GtkEventControllerScroll,
            dx: std::ffi::c_double,
            dy: std::ffi::c_double,
            f: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), dx, dy).into_glib()
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"scroll".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    scroll_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Signals that a new scrolling operation has begun.
    ///
    /// It will only be emitted on devices capable of it.
    #[doc(alias = "scroll-begin")]
    pub fn connect_scroll_begin<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn scroll_begin_trampoline<F: Fn(&EventControllerScroll) + 'static>(
            this: *mut ffi::GtkEventControllerScroll,
            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 _,
                c"scroll-begin".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    scroll_begin_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// Signals that a scrolling operation has finished.
    ///
    /// It will only be emitted on devices capable of it.
    #[doc(alias = "scroll-end")]
    pub fn connect_scroll_end<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn scroll_end_trampoline<F: Fn(&EventControllerScroll) + 'static>(
            this: *mut ffi::GtkEventControllerScroll,
            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 _,
                c"scroll-end".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    scroll_end_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "flags")]
    pub fn connect_flags_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_flags_trampoline<F: Fn(&EventControllerScroll) + 'static>(
            this: *mut ffi::GtkEventControllerScroll,
            _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 _,
                c"notify::flags".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_flags_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for EventControllerScroll {
    fn default() -> Self {
        glib::object::Object::new::<Self>()
    }
}

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

impl EventControllerScrollBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The flags affecting event controller behavior.
    pub fn flags(self, flags: EventControllerScrollFlags) -> Self {
        Self {
            builder: self.builder.property("flags", flags),
        }
    }

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