gtk/auto/

gesture_multi_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! {
    /// [`GestureMultiPress`][crate::GestureMultiPress] is a [`Gesture`][crate::Gesture] implementation able to recognize
    /// multiple clicks on a nearby zone, which can be listened for through the
    /// [`pressed`][struct@crate::GestureMultiPress#pressed] signal. Whenever time or distance between
    /// clicks exceed the GTK+ defaults, [`stopped`][struct@crate::GestureMultiPress#stopped] is emitted,
    /// and the click counter is reset.
    ///
    /// Callers may also restrict the area that is considered valid for a >1
    /// touch/button press through [`set_area()`][Self::set_area()], so any
    /// click happening outside that area is considered to be a first click of
    /// its own.
    ///
    /// ## Signals
    ///
    ///
    /// #### `pressed`
    ///  This signal is emitted whenever a button or touch press happens.
    ///
    ///
    ///
    ///
    /// #### `released`
    ///  This signal is emitted when a button or touch is released. `n_press`
    /// will report the number of press that is paired to this event, note
    /// that [`stopped`][struct@crate::GestureMultiPress#stopped] may have been emitted between the
    /// press and its release, `n_press` will only start over at the next press.
    ///
    ///
    ///
    ///
    /// #### `stopped`
    ///  This signal is emitted whenever any time/distance threshold has
    /// been exceeded.
    ///
    ///
    /// <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 = "GtkGestureMultiPress")]
    pub struct GestureMultiPress(Object<ffi::GtkGestureMultiPress, ffi::GtkGestureMultiPressClass>) @extends GestureSingle, Gesture, EventController;

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

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

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

    /// If an area was set through [`set_area()`][Self::set_area()],
    /// this function will return [`true`] and fill in `rect` with the
    /// press area. See [`set_area()`][Self::set_area()] for more
    /// details on what the press area represents.
    ///
    /// # Returns
    ///
    /// [`true`] if `rect` was filled with the press area
    ///
    /// ## `rect`
    /// return location for the press area
    #[doc(alias = "gtk_gesture_multi_press_get_area")]
    #[doc(alias = "get_area")]
    pub fn area(&self) -> Option<gdk::Rectangle> {
        unsafe {
            let mut rect = gdk::Rectangle::uninitialized();
            let ret = from_glib(ffi::gtk_gesture_multi_press_get_area(
                self.to_glib_none().0,
                rect.to_glib_none_mut().0,
            ));
            if ret {
                Some(rect)
            } else {
                None
            }
        }
    }

    /// If `rect` is non-[`None`], the press area will be checked to be
    /// confined within the rectangle, otherwise the button count
    /// will be reset so the press is seen as being the first one.
    /// If `rect` is [`None`], the area will be reset to an unrestricted
    /// state.
    ///
    /// Note: The rectangle is only used to determine whether any
    /// non-first click falls within the expected area. This is not
    /// akin to an input shape.
    /// ## `rect`
    /// rectangle to receive coordinates on
    #[doc(alias = "gtk_gesture_multi_press_set_area")]
    pub fn set_area(&self, rect: Option<&gdk::Rectangle>) {
        unsafe {
            ffi::gtk_gesture_multi_press_set_area(self.to_glib_none().0, rect.to_glib_none().0);
        }
    }

    /// This signal is emitted whenever a button or touch press happens.
    /// ## `n_press`
    /// how many touch/button presses happened with this one
    /// ## `x`
    /// The X coordinate, in widget allocation coordinates
    /// ## `y`
    /// The Y coordinate, in widget allocation coordinates
    #[doc(alias = "pressed")]
    pub fn connect_pressed<F: Fn(&Self, i32, f64, f64) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn pressed_trampoline<
            F: Fn(&GestureMultiPress, i32, f64, f64) + 'static,
        >(
            this: *mut ffi::GtkGestureMultiPress,
            n_press: libc::c_int,
            x: libc::c_double,
            y: libc::c_double,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), n_press, 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),
            )
        }
    }

    /// This signal is emitted when a button or touch is released. `n_press`
    /// will report the number of press that is paired to this event, note
    /// that [`stopped`][struct@crate::GestureMultiPress#stopped] may have been emitted between the
    /// press and its release, `n_press` will only start over at the next press.
    /// ## `n_press`
    /// number of press that is paired with this release
    /// ## `x`
    /// The X coordinate, in widget allocation coordinates
    /// ## `y`
    /// The Y coordinate, in widget allocation coordinates
    #[doc(alias = "released")]
    pub fn connect_released<F: Fn(&Self, i32, f64, f64) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn released_trampoline<
            F: Fn(&GestureMultiPress, i32, f64, f64) + 'static,
        >(
            this: *mut ffi::GtkGestureMultiPress,
            n_press: libc::c_int,
            x: libc::c_double,
            y: libc::c_double,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), n_press, x, y)
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"released\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    released_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// This signal is emitted whenever any time/distance threshold has
    /// been exceeded.
    #[doc(alias = "stopped")]
    pub fn connect_stopped<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn stopped_trampoline<F: Fn(&GestureMultiPress) + 'static>(
            this: *mut ffi::GtkGestureMultiPress,
            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"stopped\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    stopped_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

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

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

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