gtk/auto/

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

glib::wrapper! {
    /// [`GestureSwipe`][crate::GestureSwipe] is a [`Gesture`][crate::Gesture] implementation able to recognize
    /// swipes, after a press/move/.../move/release sequence happens, the
    /// [`swipe`][struct@crate::GestureSwipe#swipe] signal will be emitted, providing the velocity
    /// and directionality of the sequence at the time it was lifted.
    ///
    /// If the velocity is desired in intermediate points,
    /// [`velocity()`][Self::velocity()] can be called on eg. a
    /// [`update`][struct@crate::Gesture#update] handler.
    ///
    /// All velocities are reported in pixels/sec units.
    ///
    /// ## Signals
    ///
    ///
    /// #### `swipe`
    ///  This signal is emitted when the recognized gesture is finished, velocity
    /// and direction are a product of previously recorded events.
    ///
    ///
    /// <details><summary><h4>Gesture</h4></summary>
    ///
    ///
    /// #### `begin`
    ///  This signal is emitted when the gesture is recognized. This means the
    /// number of touch sequences matches [`n-points`][struct@crate::Gesture#n-points], and the [`check`][struct@crate::Gesture#check]
    /// handler(s) returned [`true`].
    ///
    /// Note: These conditions may also happen when an extra touch (eg. a third touch
    /// on a 2-touches gesture) is lifted, in that situation `sequence` won't pertain
    /// to the current set of active touches, so don't rely on this being true.
    ///
    ///
    ///
    ///
    /// #### `cancel`
    ///  This signal is emitted whenever a sequence is cancelled. This usually
    /// happens on active touches when [`EventControllerExt::reset()`][crate::prelude::EventControllerExt::reset()] is called
    /// on `gesture` (manually, due to grabs...), or the individual `sequence`
    /// was claimed by parent widgets' controllers (see [`GestureExt::set_sequence_state()`][crate::prelude::GestureExt::set_sequence_state()]).
    ///
    /// `gesture` must forget everything about `sequence` as a reaction to this signal.
    ///
    ///
    ///
    ///
    /// #### `end`
    ///  This signal is emitted when `gesture` either stopped recognizing the event
    /// sequences as something to be handled (the [`check`][struct@crate::Gesture#check] handler returned
    /// [`false`]), or the number of touch sequences became higher or lower than
    /// [`n-points`][struct@crate::Gesture#n-points].
    ///
    /// Note: `sequence` might not pertain to the group of sequences that were
    /// previously triggering recognition on `gesture` (ie. a just pressed touch
    /// sequence that exceeds [`n-points`][struct@crate::Gesture#n-points]). This situation may be detected
    /// by checking through [`GestureExt::handles_sequence()`][crate::prelude::GestureExt::handles_sequence()].
    ///
    ///
    ///
    ///
    /// #### `sequence-state-changed`
    ///  This signal is emitted whenever a sequence state changes. See
    /// [`GestureExt::set_sequence_state()`][crate::prelude::GestureExt::set_sequence_state()] to know more about the expectable
    /// sequence lifetimes.
    ///
    ///
    ///
    ///
    /// #### `update`
    ///  This signal is emitted whenever an event is handled while the gesture is
    /// recognized. `sequence` is guaranteed to pertain to the set of active touches.
    ///
    ///
    /// </details>
    ///
    /// # Implements
    ///
    /// [`GestureSingleExt`][trait@crate::prelude::GestureSingleExt], [`GestureExt`][trait@crate::prelude::GestureExt], [`EventControllerExt`][trait@crate::prelude::EventControllerExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GtkGestureSwipe")]
    pub struct GestureSwipe(Object<ffi::GtkGestureSwipe, ffi::GtkGestureSwipeClass>) @extends GestureSingle, Gesture, EventController;

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

impl GestureSwipe {
    /// Returns a newly created [`Gesture`][crate::Gesture] that recognizes swipes.
    /// ## `widget`
    /// a [`Widget`][crate::Widget]
    ///
    /// # Returns
    ///
    /// a newly created [`GestureSwipe`][crate::GestureSwipe]
    #[doc(alias = "gtk_gesture_swipe_new")]
    pub fn new(widget: &impl IsA<Widget>) -> GestureSwipe {
        skip_assert_initialized!();
        unsafe {
            Gesture::from_glib_full(ffi::gtk_gesture_swipe_new(widget.as_ref().to_glib_none().0))
                .unsafe_cast()
        }
    }

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

    /// If the gesture is recognized, this function returns [`true`] and fill in
    /// `velocity_x` and `velocity_y` with the recorded velocity, as per the
    /// last event(s) processed.
    ///
    /// # Returns
    ///
    /// whether velocity could be calculated
    ///
    /// ## `velocity_x`
    /// return value for the velocity in the X axis, in pixels/sec
    ///
    /// ## `velocity_y`
    /// return value for the velocity in the Y axis, in pixels/sec
    #[doc(alias = "gtk_gesture_swipe_get_velocity")]
    #[doc(alias = "get_velocity")]
    pub fn velocity(&self) -> Option<(f64, f64)> {
        unsafe {
            let mut velocity_x = std::mem::MaybeUninit::uninit();
            let mut velocity_y = std::mem::MaybeUninit::uninit();
            let ret = from_glib(ffi::gtk_gesture_swipe_get_velocity(
                self.to_glib_none().0,
                velocity_x.as_mut_ptr(),
                velocity_y.as_mut_ptr(),
            ));
            if ret {
                Some((velocity_x.assume_init(), velocity_y.assume_init()))
            } else {
                None
            }
        }
    }

    /// This signal is emitted when the recognized gesture is finished, velocity
    /// and direction are a product of previously recorded events.
    /// ## `velocity_x`
    /// velocity in the X axis, in pixels/sec
    /// ## `velocity_y`
    /// velocity in the Y axis, in pixels/sec
    #[doc(alias = "swipe")]
    pub fn connect_swipe<F: Fn(&Self, f64, f64) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn swipe_trampoline<F: Fn(&GestureSwipe, f64, f64) + 'static>(
            this: *mut ffi::GtkGestureSwipe,
            velocity_x: std::ffi::c_double,
            velocity_y: std::ffi::c_double,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this), velocity_x, velocity_y)
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"swipe".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    swipe_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

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

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

    /// Mouse button number to listen to, or 0 to listen for any button.
    pub fn button(self, button: u32) -> Self {
        Self {
            builder: self.builder.property("button", button),
        }
    }

    /// Whether the gesture is exclusive. Exclusive gestures only listen to pointer
    /// and pointer emulated events.
    pub fn exclusive(self, exclusive: bool) -> Self {
        Self {
            builder: self.builder.property("exclusive", exclusive),
        }
    }

    /// Whether the gesture handles only touch events.
    pub fn touch_only(self, touch_only: bool) -> Self {
        Self {
            builder: self.builder.property("touch-only", touch_only),
        }
    }

    /// The number of touch points that trigger recognition on this gesture,
    pub fn n_points(self, n_points: u32) -> Self {
        Self {
            builder: self.builder.property("n-points", n_points),
        }
    }

    /// If non-[`None`], the gesture will only listen for events that happen on
    /// this [`gdk::Window`][crate::gdk::Window], or a child of it.
    pub fn window(self, window: &gdk::Window) -> Self {
        Self {
            builder: self.builder.property("window", window.clone()),
        }
    }

    /// 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),
        }
    }

    /// The widget receiving the `GdkEvents` that the controller will handle.
    pub fn widget(self, widget: &impl IsA<Widget>) -> Self {
        Self {
            builder: self.builder.property("widget", widget.clone().upcast()),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`GestureSwipe`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> GestureSwipe {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}