// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT

use crate::{ffi, NavigationDirection, Swipeable};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// A swipe tracker used in [`Carousel`][crate::Carousel], [`Lapel`][crate::Lapel] and [`Album`][crate::Album].
    ///
    /// The `BisSwipeTracker` object can be used for implementing widgets with swipe
    /// gestures. It supports touch-based swipes, pointer dragging, and touchpad
    /// scrolling.
    ///
    /// The widgets will probably want to expose the [`enabled`][struct@crate::SwipeTracker#enabled]
    /// property. If they expect to use horizontal orientation,
    /// [`reversed`][struct@crate::SwipeTracker#reversed] can be used for supporting RTL text
    /// direction.
    ///
    /// ## Properties
    ///
    ///
    /// #### `allow-long-swipes`
    ///  Whether to allow swiping for more than one snap point at a time.
    ///
    /// If the value is `FALSE`, each swipe can only move to the adjacent snap
    /// points.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `allow-mouse-drag`
    ///  Whether to allow dragging with mouse pointer.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `enabled`
    ///  Whether the swipe tracker is enabled.
    ///
    /// When it's not enabled, no events will be processed. Usually widgets will
    /// want to expose this via a property.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `reversed`
    ///  Whether to reverse the swipe direction.
    ///
    /// If the swipe tracker is horizontal, it can be used for supporting RTL text
    /// direction.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `swipeable`
    ///  The widget the swipe tracker is attached to.
    ///
    /// Readable | Writeable | Construct Only
    /// <details><summary><h4>Orientable</h4></summary>
    ///
    ///
    /// #### `orientation`
    ///  The orientation of the orientable.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// ## Signals
    ///
    ///
    /// #### `begin-swipe`
    ///  This signal is emitted right before a swipe will be started, after the
    /// drag threshold has been passed.
    ///
    ///
    ///
    ///
    /// #### `end-swipe`
    ///  This signal is emitted as soon as the gesture has stopped.
    ///
    /// The user is expected to animate the deceleration from the current progress
    /// value to @to with an animation using @velocity as the initial velocity,
    /// provided in pixels per second. [`SpringAnimation`][crate::SpringAnimation] is usually a good
    /// fit for this.
    ///
    ///
    ///
    ///
    /// #### `prepare`
    ///  This signal is emitted when a possible swipe is detected.
    ///
    /// The @direction value can be used to restrict the swipe to a certain
    /// direction.
    ///
    ///
    ///
    ///
    /// #### `update-swipe`
    ///  This signal is emitted every time the progress value changes.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`trait@gtk::prelude::OrientableExt`]
    #[doc(alias = "BisSwipeTracker")]
    pub struct SwipeTracker(Object<ffi::BisSwipeTracker, ffi::BisSwipeTrackerClass>) @implements gtk::Orientable;

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

impl SwipeTracker {
    /// Creates a new `BisSwipeTracker` for @widget.
    /// ## `swipeable`
    /// a widget to add the tracker on
    ///
    /// # Returns
    ///
    /// the newly created `BisSwipeTracker`
    #[doc(alias = "bis_swipe_tracker_new")]
    pub fn new(swipeable: &impl IsA<Swipeable>) -> SwipeTracker {
        skip_assert_initialized!();
        unsafe {
            from_glib_full(ffi::bis_swipe_tracker_new(
                swipeable.as_ref().to_glib_none().0,
            ))
        }
    }

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

    /// Gets whether to allow swiping for more than one snap point at a time.
    ///
    /// # Returns
    ///
    /// whether long swipes are allowed
    #[doc(alias = "bis_swipe_tracker_get_allow_long_swipes")]
    #[doc(alias = "get_allow_long_swipes")]
    #[doc(alias = "allow-long-swipes")]
    pub fn allows_long_swipes(&self) -> bool {
        unsafe {
            from_glib(ffi::bis_swipe_tracker_get_allow_long_swipes(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets whether @self can be dragged with mouse pointer.
    ///
    /// # Returns
    ///
    /// whether mouse dragging is allowed
    #[doc(alias = "bis_swipe_tracker_get_allow_mouse_drag")]
    #[doc(alias = "get_allow_mouse_drag")]
    #[doc(alias = "allow-mouse-drag")]
    pub fn allows_mouse_drag(&self) -> bool {
        unsafe {
            from_glib(ffi::bis_swipe_tracker_get_allow_mouse_drag(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets whether @self is enabled.
    ///
    /// # Returns
    ///
    /// whether @self is enabled
    #[doc(alias = "bis_swipe_tracker_get_enabled")]
    #[doc(alias = "get_enabled")]
    #[doc(alias = "enabled")]
    pub fn is_enabled(&self) -> bool {
        unsafe { from_glib(ffi::bis_swipe_tracker_get_enabled(self.to_glib_none().0)) }
    }

    /// Gets whether @self is reversing the swipe direction.
    ///
    /// # Returns
    ///
    /// whether the direction is reversed
    #[doc(alias = "bis_swipe_tracker_get_reversed")]
    #[doc(alias = "get_reversed")]
    #[doc(alias = "reversed")]
    pub fn is_reversed(&self) -> bool {
        unsafe { from_glib(ffi::bis_swipe_tracker_get_reversed(self.to_glib_none().0)) }
    }

    /// Get the widget @self is attached to.
    ///
    /// # Returns
    ///
    /// the swipeable widget
    #[doc(alias = "bis_swipe_tracker_get_swipeable")]
    #[doc(alias = "get_swipeable")]
    pub fn swipeable(&self) -> Swipeable {
        unsafe { from_glib_none(ffi::bis_swipe_tracker_get_swipeable(self.to_glib_none().0)) }
    }

    /// Sets whether to allow swiping for more than one snap point at a time.
    ///
    /// If the value is `FALSE`, each swipe can only move to the adjacent snap
    /// points.
    /// ## `allow_long_swipes`
    /// whether to allow long swipes
    #[doc(alias = "bis_swipe_tracker_set_allow_long_swipes")]
    #[doc(alias = "allow-long-swipes")]
    pub fn set_allow_long_swipes(&self, allow_long_swipes: bool) {
        unsafe {
            ffi::bis_swipe_tracker_set_allow_long_swipes(
                self.to_glib_none().0,
                allow_long_swipes.into_glib(),
            );
        }
    }

    /// Sets whether @self can be dragged with mouse pointer.
    /// ## `allow_mouse_drag`
    /// whether to allow mouse dragging
    #[doc(alias = "bis_swipe_tracker_set_allow_mouse_drag")]
    #[doc(alias = "allow-mouse-drag")]
    pub fn set_allow_mouse_drag(&self, allow_mouse_drag: bool) {
        unsafe {
            ffi::bis_swipe_tracker_set_allow_mouse_drag(
                self.to_glib_none().0,
                allow_mouse_drag.into_glib(),
            );
        }
    }

    /// Sets whether @self is enabled.
    ///
    /// When it's not enabled, no events will be processed. Usually widgets will want
    /// to expose this via a property.
    /// ## `enabled`
    /// whether @self is enabled
    #[doc(alias = "bis_swipe_tracker_set_enabled")]
    #[doc(alias = "enabled")]
    pub fn set_enabled(&self, enabled: bool) {
        unsafe {
            ffi::bis_swipe_tracker_set_enabled(self.to_glib_none().0, enabled.into_glib());
        }
    }

    /// Sets whether to reverse the swipe direction.
    ///
    /// If the swipe tracker is horizontal, it can be used for supporting RTL text
    /// direction.
    /// ## `reversed`
    /// whether to reverse the swipe direction
    #[doc(alias = "bis_swipe_tracker_set_reversed")]
    #[doc(alias = "reversed")]
    pub fn set_reversed(&self, reversed: bool) {
        unsafe {
            ffi::bis_swipe_tracker_set_reversed(self.to_glib_none().0, reversed.into_glib());
        }
    }

    /// Moves the current progress value by @delta.
    ///
    /// This can be used to adjust the current position if snap points move during
    /// the gesture.
    /// ## `delta`
    /// the position delta
    #[doc(alias = "bis_swipe_tracker_shift_position")]
    pub fn shift_position(&self, delta: f64) {
        unsafe {
            ffi::bis_swipe_tracker_shift_position(self.to_glib_none().0, delta);
        }
    }

    /// This signal is emitted right before a swipe will be started, after the
    /// drag threshold has been passed.
    #[doc(alias = "begin-swipe")]
    pub fn connect_begin_swipe<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn begin_swipe_trampoline<F: Fn(&SwipeTracker) + 'static>(
            this: *mut ffi::BisSwipeTracker,
            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"begin-swipe\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    begin_swipe_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// This signal is emitted as soon as the gesture has stopped.
    ///
    /// The user is expected to animate the deceleration from the current progress
    /// value to @to with an animation using @velocity as the initial velocity,
    /// provided in pixels per second. [`SpringAnimation`][crate::SpringAnimation] is usually a good
    /// fit for this.
    /// ## `velocity`
    /// the velocity of the swipe
    /// ## `to`
    /// the progress value to animate to
    #[doc(alias = "end-swipe")]
    pub fn connect_end_swipe<F: Fn(&Self, f64, f64) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn end_swipe_trampoline<F: Fn(&SwipeTracker, f64, f64) + 'static>(
            this: *mut ffi::BisSwipeTracker,
            velocity: libc::c_double,
            to: libc::c_double,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), velocity, to)
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"end-swipe\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    end_swipe_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// This signal is emitted when a possible swipe is detected.
    ///
    /// The @direction value can be used to restrict the swipe to a certain
    /// direction.
    /// ## `direction`
    /// the direction of the swipe
    #[doc(alias = "prepare")]
    pub fn connect_prepare<F: Fn(&Self, NavigationDirection) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn prepare_trampoline<
            F: Fn(&SwipeTracker, NavigationDirection) + 'static,
        >(
            this: *mut ffi::BisSwipeTracker,
            direction: ffi::BisNavigationDirection,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), from_glib(direction))
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"prepare\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    prepare_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    /// This signal is emitted every time the progress value changes.
    /// ## `progress`
    /// the current animation progress value
    #[doc(alias = "update-swipe")]
    pub fn connect_update_swipe<F: Fn(&Self, f64) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn update_swipe_trampoline<F: Fn(&SwipeTracker, f64) + 'static>(
            this: *mut ffi::BisSwipeTracker,
            progress: libc::c_double,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(&from_glib_borrow(this), progress)
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"update-swipe\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    update_swipe_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "allow-long-swipes")]
    pub fn connect_allow_long_swipes_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_allow_long_swipes_trampoline<F: Fn(&SwipeTracker) + 'static>(
            this: *mut ffi::BisSwipeTracker,
            _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::allow-long-swipes\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_allow_long_swipes_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "allow-mouse-drag")]
    pub fn connect_allow_mouse_drag_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_allow_mouse_drag_trampoline<F: Fn(&SwipeTracker) + 'static>(
            this: *mut ffi::BisSwipeTracker,
            _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::allow-mouse-drag\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_allow_mouse_drag_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "enabled")]
    pub fn connect_enabled_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_enabled_trampoline<F: Fn(&SwipeTracker) + 'static>(
            this: *mut ffi::BisSwipeTracker,
            _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::enabled\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_enabled_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "reversed")]
    pub fn connect_reversed_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_reversed_trampoline<F: Fn(&SwipeTracker) + 'static>(
            this: *mut ffi::BisSwipeTracker,
            _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::reversed\0".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_reversed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

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

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

    /// Whether to allow swiping for more than one snap point at a time.
    ///
    /// If the value is `FALSE`, each swipe can only move to the adjacent snap
    /// points.
    pub fn allow_long_swipes(self, allow_long_swipes: bool) -> Self {
        Self {
            builder: self
                .builder
                .property("allow-long-swipes", allow_long_swipes),
        }
    }

    /// Whether to allow dragging with mouse pointer.
    pub fn allow_mouse_drag(self, allow_mouse_drag: bool) -> Self {
        Self {
            builder: self.builder.property("allow-mouse-drag", allow_mouse_drag),
        }
    }

    /// Whether the swipe tracker is enabled.
    ///
    /// When it's not enabled, no events will be processed. Usually widgets will
    /// want to expose this via a property.
    pub fn enabled(self, enabled: bool) -> Self {
        Self {
            builder: self.builder.property("enabled", enabled),
        }
    }

    /// Whether to reverse the swipe direction.
    ///
    /// If the swipe tracker is horizontal, it can be used for supporting RTL text
    /// direction.
    pub fn reversed(self, reversed: bool) -> Self {
        Self {
            builder: self.builder.property("reversed", reversed),
        }
    }

    /// The widget the swipe tracker is attached to.
    pub fn swipeable(self, swipeable: &impl IsA<Swipeable>) -> Self {
        Self {
            builder: self
                .builder
                .property("swipeable", swipeable.clone().upcast()),
        }
    }

    //pub fn orientation(self, orientation: /*Ignored*/gtk::Orientation) -> Self {
    //    Self { builder: self.builder.property("orientation", orientation), }
    //}

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