gtk/auto/

gesture_long_press.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};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};

glib::wrapper! {
    /// [`GestureLongPress`][crate::GestureLongPress] is a [`Gesture`][crate::Gesture] implementation able to recognize
    /// long presses, triggering the [`pressed`][struct@crate::GestureLongPress#pressed] after the
    /// timeout is exceeded.
    ///
    /// If the touchpoint is lifted before the timeout passes, or if it drifts
    /// too far of the initial press point, the [`cancelled`][struct@crate::GestureLongPress#cancelled]
    /// signal will be emitted.
    ///
    /// ## Properties
    ///
    ///
    /// #### `delay-factor`
    ///  Readable | Writeable
    /// <details><summary><h4>GestureSingle</h4></summary>
    ///
    ///
    /// #### `button`
    ///  Mouse button number to listen to, or 0 to listen for any button.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `exclusive`
    ///  Whether the gesture is exclusive. Exclusive gestures only listen to pointer
    /// and pointer emulated events.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `touch-only`
    ///  Whether the gesture handles only touch events.
    ///
    /// Readable | Writeable
    /// </details>
    /// <details><summary><h4>Gesture</h4></summary>
    ///
    ///
    /// #### `n-points`
    ///  The number of touch points that trigger recognition on this gesture,
    ///
    /// Readable | Writeable | Construct Only
    ///
    ///
    /// #### `window`
    ///  If non-[`None`], the gesture will only listen for events that happen on
    /// this [`gdk::Window`][crate::gdk::Window], or a child of it.
    ///
    /// Readable | Writeable
    /// </details>
    /// <details><summary><h4>EventController</h4></summary>
    ///
    ///
    /// #### `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 | Writeable | Construct Only
    /// </details>
    ///
    /// ## Signals
    ///
    ///
    /// #### `cancelled`
    ///  This signal is emitted whenever a press moved too far, or was released
    /// before [`pressed`][struct@crate::GestureLongPress#pressed] happened.
    ///
    ///
    ///
    ///
    /// #### `pressed`
    ///  This signal is emitted whenever a press goes unmoved/unreleased longer than
    /// what the GTK+ defaults tell.
    ///
    ///
    /// <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 = "GtkGestureLongPress")]
    pub struct GestureLongPress(Object<ffi::GtkGestureLongPress, ffi::GtkGestureLongPressClass>) @extends GestureSingle, Gesture, EventController;

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

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

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

    #[doc(alias = "delay-factor")]
    pub fn delay_factor(&self) -> f64 {
        ObjectExt::property(self, "delay-factor")
    }

    #[doc(alias = "delay-factor")]
    pub fn set_delay_factor(&self, delay_factor: f64) {
        ObjectExt::set_property(self, "delay-factor", delay_factor)
    }

    /// This signal is emitted whenever a press moved too far, or was released
    /// before [`pressed`][struct@crate::GestureLongPress#pressed] happened.
    #[doc(alias = "cancelled")]
    pub fn connect_cancelled<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn cancelled_trampoline<F: Fn(&GestureLongPress) + 'static>(
            this: *mut ffi::GtkGestureLongPress,
            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"cancelled\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    cancelled_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// This signal is emitted whenever a press goes unmoved/unreleased longer than
    /// what the GTK+ defaults tell.
    /// ## `x`
    /// the X coordinate where the press happened, relative to the widget allocation
    /// ## `y`
    /// the Y coordinate where the press happened, relative to the widget allocation
    #[doc(alias = "pressed")]
    pub fn connect_pressed<F: Fn(&Self, f64, f64) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn pressed_trampoline<F: Fn(&GestureLongPress, f64, f64) + 'static>(
            this: *mut ffi::GtkGestureLongPress,
            x: libc::c_double,
            y: libc::c_double,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), x, y)
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"pressed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    pressed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "delay-factor")]
    pub fn connect_delay_factor_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_delay_factor_trampoline<F: Fn(&GestureLongPress) + 'static>(
            this: *mut ffi::GtkGestureLongPress,
            _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::delay-factor\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    notify_delay_factor_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

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

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

    pub fn delay_factor(self, delay_factor: f64) -> Self {
        Self {
            builder: self.builder.property("delay-factor", delay_factor),
        }
    }

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

impl fmt::Display for GestureLongPress {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("GestureLongPress")
    }
}