libadwaita/auto/

timed_animation.rs

// 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::{Animation, AnimationTarget, Easing, ffi};
use glib::{
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// A time-based [`Animation`][crate::Animation].
    ///
    /// [`TimedAnimation`][crate::TimedAnimation] implements a simple animation interpolating the given
    /// value from [`value-from`][struct@crate::TimedAnimation#value-from] to
    /// [`value-to`][struct@crate::TimedAnimation#value-to] over
    /// [`duration`][struct@crate::TimedAnimation#duration] milliseconds using the curve described by
    /// [`easing`][struct@crate::TimedAnimation#easing].
    ///
    /// If [`reverse`][struct@crate::TimedAnimation#reverse] is set to `TRUE`, [`TimedAnimation`][crate::TimedAnimation]
    /// will instead animate from [`value-to`][struct@crate::TimedAnimation#value-to] to
    /// [`value-from`][struct@crate::TimedAnimation#value-from], and the easing curve will be inverted.
    ///
    /// The animation can repeat a certain amount of times, or endlessly, depending
    /// on the [`repeat-count`][struct@crate::TimedAnimation#repeat-count] value. If
    /// [`alternate`][struct@crate::TimedAnimation#alternate] is set to `TRUE`, it will also change the
    /// direction every other iteration.
    ///
    /// ## Properties
    ///
    ///
    /// #### `alternate`
    ///  Whether the animation changes direction on every iteration.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `duration`
    ///  Duration of the animation, in milliseconds.
    ///
    /// Describes how much time the animation will take.
    ///
    /// If the animation repeats more than once, describes the duration of one
    /// iteration.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `easing`
    ///  Easing function used in the animation.
    ///
    /// Describes the curve the value is interpolated on.
    ///
    /// See [`Easing`][crate::Easing] for the description of specific easing functions.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `repeat-count`
    ///  Number of times the animation will play.
    ///
    /// If set to 0, the animation will repeat endlessly.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `reverse`
    ///  Whether the animation plays backwards.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `value-from`
    ///  The value to animate from.
    ///
    /// The animation will start at this value and end at
    /// [`value-to`][struct@crate::TimedAnimation#value-to].
    ///
    /// If [`reverse`][struct@crate::TimedAnimation#reverse] is `TRUE`, the animation will end at
    /// this value instead.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `value-to`
    ///  The value to animate to.
    ///
    /// The animation will start at [`value-from`][struct@crate::TimedAnimation#value-from] and end at
    /// this value.
    ///
    /// If [`reverse`][struct@crate::TimedAnimation#reverse] is `TRUE`, the animation will start
    /// at this value instead.
    ///
    /// Readable | Writeable | Construct
    /// <details><summary><h4>Animation</h4></summary>
    ///
    ///
    /// #### `follow-enable-animations-setting`
    ///  Whether to skip the animation when animations are globally disabled.
    ///
    /// The default behavior is to skip the animation. Set to `FALSE` to disable
    /// this behavior.
    ///
    /// This can be useful for cases where animation is essential, like spinners,
    /// or in demo applications. Most other animations should keep it enabled.
    ///
    /// See [`gtk-enable-animations`][struct@crate::gtk::Settings#gtk-enable-animations].
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `state`
    ///  The animation state.
    ///
    /// The state indicates whether the animation is currently playing, paused,
    /// finished or hasn't been started yet.
    ///
    /// Readable
    ///
    ///
    /// #### `target`
    ///  The target to animate.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `value`
    ///  The current value of the animation.
    ///
    /// Readable
    ///
    ///
    /// #### `widget`
    ///  The animation widget.
    ///
    /// It provides the frame clock for the animation. It's not strictly necessary
    /// for this widget to be same as the one being animated.
    ///
    /// The widget must be mapped in order for the animation to work. If it's not
    /// mapped, or if it gets unmapped during an ongoing animation, the animation
    /// will be automatically skipped.
    ///
    /// Readable | Writeable | Construct Only
    /// </details>
    ///
    /// # Implements
    ///
    /// [`AnimationExt`][trait@crate::prelude::AnimationExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "AdwTimedAnimation")]
    pub struct TimedAnimation(Object<ffi::AdwTimedAnimation, ffi::AdwTimedAnimationClass>) @extends Animation;

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

impl TimedAnimation {
    /// Creates a new [`TimedAnimation`][crate::TimedAnimation] on @widget to animate @target from @from
    /// to @to.
    /// ## `widget`
    /// a widget to create animation on
    /// ## `from`
    /// a value to animate from
    /// ## `to`
    /// a value to animate to
    /// ## `duration`
    /// a duration for the animation
    /// ## `target`
    /// a target value to animate
    ///
    /// # Returns
    ///
    /// the newly created animation
    #[doc(alias = "adw_timed_animation_new")]
    pub fn new(
        widget: &impl IsA<gtk::Widget>,
        from: f64,
        to: f64,
        duration: u32,
        target: impl IsA<AnimationTarget>,
    ) -> TimedAnimation {
        skip_assert_initialized!();
        unsafe {
            Animation::from_glib_none(ffi::adw_timed_animation_new(
                widget.as_ref().to_glib_none().0,
                from,
                to,
                duration,
                target.upcast().into_glib_ptr(),
            ))
            .unsafe_cast()
        }
    }

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

    /// Gets whether @self changes direction on every iteration.
    ///
    /// # Returns
    ///
    /// whether @self alternates
    #[doc(alias = "adw_timed_animation_get_alternate")]
    #[doc(alias = "get_alternate")]
    #[doc(alias = "alternate")]
    pub fn is_alternate(&self) -> bool {
        unsafe {
            from_glib(ffi::adw_timed_animation_get_alternate(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the duration of @self.
    ///
    /// # Returns
    ///
    /// the duration of @self, in milliseconds
    #[doc(alias = "adw_timed_animation_get_duration")]
    #[doc(alias = "get_duration")]
    pub fn duration(&self) -> u32 {
        unsafe { ffi::adw_timed_animation_get_duration(self.to_glib_none().0) }
    }

    /// Gets the easing function @self uses.
    ///
    /// # Returns
    ///
    /// the easing function @self uses
    #[doc(alias = "adw_timed_animation_get_easing")]
    #[doc(alias = "get_easing")]
    pub fn easing(&self) -> Easing {
        unsafe { from_glib(ffi::adw_timed_animation_get_easing(self.to_glib_none().0)) }
    }

    /// Gets the number of times @self will play.
    ///
    /// # Returns
    ///
    /// the number of times @self will play
    #[doc(alias = "adw_timed_animation_get_repeat_count")]
    #[doc(alias = "get_repeat_count")]
    #[doc(alias = "repeat-count")]
    pub fn repeat_count(&self) -> u32 {
        unsafe { ffi::adw_timed_animation_get_repeat_count(self.to_glib_none().0) }
    }

    /// Gets whether @self plays backwards.
    ///
    /// # Returns
    ///
    /// whether @self plays backwards
    #[doc(alias = "adw_timed_animation_get_reverse")]
    #[doc(alias = "get_reverse")]
    #[doc(alias = "reverse")]
    pub fn is_reverse(&self) -> bool {
        unsafe { from_glib(ffi::adw_timed_animation_get_reverse(self.to_glib_none().0)) }
    }

    /// Gets the value @self will animate from.
    ///
    /// # Returns
    ///
    /// the value to animate from
    #[doc(alias = "adw_timed_animation_get_value_from")]
    #[doc(alias = "get_value_from")]
    #[doc(alias = "value-from")]
    pub fn value_from(&self) -> f64 {
        unsafe { ffi::adw_timed_animation_get_value_from(self.to_glib_none().0) }
    }

    /// Gets the value @self will animate to.
    ///
    /// # Returns
    ///
    /// the value to animate to
    #[doc(alias = "adw_timed_animation_get_value_to")]
    #[doc(alias = "get_value_to")]
    #[doc(alias = "value-to")]
    pub fn value_to(&self) -> f64 {
        unsafe { ffi::adw_timed_animation_get_value_to(self.to_glib_none().0) }
    }

    /// Sets whether @self changes direction on every iteration.
    /// ## `alternate`
    /// whether @self alternates
    #[doc(alias = "adw_timed_animation_set_alternate")]
    #[doc(alias = "alternate")]
    pub fn set_alternate(&self, alternate: bool) {
        unsafe {
            ffi::adw_timed_animation_set_alternate(self.to_glib_none().0, alternate.into_glib());
        }
    }

    /// Sets the duration of @self.
    ///
    /// If the animation repeats more than once, sets the duration of one iteration.
    /// ## `duration`
    /// the duration to use, in milliseconds
    #[doc(alias = "adw_timed_animation_set_duration")]
    #[doc(alias = "duration")]
    pub fn set_duration(&self, duration: u32) {
        unsafe {
            ffi::adw_timed_animation_set_duration(self.to_glib_none().0, duration);
        }
    }

    /// Sets the easing function @self will use.
    ///
    /// See [`Easing`][crate::Easing] for the description of specific easing functions.
    /// ## `easing`
    /// the easing function to use
    #[doc(alias = "adw_timed_animation_set_easing")]
    #[doc(alias = "easing")]
    pub fn set_easing(&self, easing: Easing) {
        unsafe {
            ffi::adw_timed_animation_set_easing(self.to_glib_none().0, easing.into_glib());
        }
    }

    /// Sets the number of times @self will play.
    ///
    /// If set to 0, @self will repeat endlessly.
    /// ## `repeat_count`
    /// the number of times @self will play
    #[doc(alias = "adw_timed_animation_set_repeat_count")]
    #[doc(alias = "repeat-count")]
    pub fn set_repeat_count(&self, repeat_count: u32) {
        unsafe {
            ffi::adw_timed_animation_set_repeat_count(self.to_glib_none().0, repeat_count);
        }
    }

    /// Sets whether @self plays backwards.
    /// ## `reverse`
    /// whether @self plays backwards
    #[doc(alias = "adw_timed_animation_set_reverse")]
    #[doc(alias = "reverse")]
    pub fn set_reverse(&self, reverse: bool) {
        unsafe {
            ffi::adw_timed_animation_set_reverse(self.to_glib_none().0, reverse.into_glib());
        }
    }

    /// Sets the value @self will animate from.
    ///
    /// The animation will start at this value and end at
    /// [`value-to`][struct@crate::TimedAnimation#value-to].
    ///
    /// If [`reverse`][struct@crate::TimedAnimation#reverse] is `TRUE`, the animation will end at
    /// this value instead.
    /// ## `value`
    /// the value to animate from
    #[doc(alias = "adw_timed_animation_set_value_from")]
    #[doc(alias = "value-from")]
    pub fn set_value_from(&self, value: f64) {
        unsafe {
            ffi::adw_timed_animation_set_value_from(self.to_glib_none().0, value);
        }
    }

    /// Sets the value @self will animate to.
    ///
    /// The animation will start at [`value-from`][struct@crate::TimedAnimation#value-from] and end at
    /// this value.
    ///
    /// If [`reverse`][struct@crate::TimedAnimation#reverse] is `TRUE`, the animation will start
    /// at this value instead.
    /// ## `value`
    /// the value to animate to
    #[doc(alias = "adw_timed_animation_set_value_to")]
    #[doc(alias = "value-to")]
    pub fn set_value_to(&self, value: f64) {
        unsafe {
            ffi::adw_timed_animation_set_value_to(self.to_glib_none().0, value);
        }
    }

    #[doc(alias = "alternate")]
    pub fn connect_alternate_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_alternate_trampoline<F: Fn(&TimedAnimation) + 'static>(
            this: *mut ffi::AdwTimedAnimation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::alternate".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_alternate_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "duration")]
    pub fn connect_duration_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_duration_trampoline<F: Fn(&TimedAnimation) + 'static>(
            this: *mut ffi::AdwTimedAnimation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::duration".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_duration_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "easing")]
    pub fn connect_easing_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_easing_trampoline<F: Fn(&TimedAnimation) + 'static>(
            this: *mut ffi::AdwTimedAnimation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::easing".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_easing_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "repeat-count")]
    pub fn connect_repeat_count_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_repeat_count_trampoline<F: Fn(&TimedAnimation) + 'static>(
            this: *mut ffi::AdwTimedAnimation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::repeat-count".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_repeat_count_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "reverse")]
    pub fn connect_reverse_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_reverse_trampoline<F: Fn(&TimedAnimation) + 'static>(
            this: *mut ffi::AdwTimedAnimation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::reverse".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_reverse_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "value-from")]
    pub fn connect_value_from_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_value_from_trampoline<F: Fn(&TimedAnimation) + 'static>(
            this: *mut ffi::AdwTimedAnimation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::value-from".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_value_from_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "value-to")]
    pub fn connect_value_to_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_value_to_trampoline<F: Fn(&TimedAnimation) + 'static>(
            this: *mut ffi::AdwTimedAnimation,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                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::value-to".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_value_to_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

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

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

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

    /// Whether the animation changes direction on every iteration.
    pub fn alternate(self, alternate: bool) -> Self {
        Self {
            builder: self.builder.property("alternate", alternate),
        }
    }

    /// Duration of the animation, in milliseconds.
    ///
    /// Describes how much time the animation will take.
    ///
    /// If the animation repeats more than once, describes the duration of one
    /// iteration.
    pub fn duration(self, duration: u32) -> Self {
        Self {
            builder: self.builder.property("duration", duration),
        }
    }

    /// Easing function used in the animation.
    ///
    /// Describes the curve the value is interpolated on.
    ///
    /// See [`Easing`][crate::Easing] for the description of specific easing functions.
    pub fn easing(self, easing: Easing) -> Self {
        Self {
            builder: self.builder.property("easing", easing),
        }
    }

    /// Number of times the animation will play.
    ///
    /// If set to 0, the animation will repeat endlessly.
    pub fn repeat_count(self, repeat_count: u32) -> Self {
        Self {
            builder: self.builder.property("repeat-count", repeat_count),
        }
    }

    /// Whether the animation plays backwards.
    pub fn reverse(self, reverse: bool) -> Self {
        Self {
            builder: self.builder.property("reverse", reverse),
        }
    }

    /// The value to animate from.
    ///
    /// The animation will start at this value and end at
    /// [`value-to`][struct@crate::TimedAnimation#value-to].
    ///
    /// If [`reverse`][struct@crate::TimedAnimation#reverse] is `TRUE`, the animation will end at
    /// this value instead.
    pub fn value_from(self, value_from: f64) -> Self {
        Self {
            builder: self.builder.property("value-from", value_from),
        }
    }

    /// The value to animate to.
    ///
    /// The animation will start at [`value-from`][struct@crate::TimedAnimation#value-from] and end at
    /// this value.
    ///
    /// If [`reverse`][struct@crate::TimedAnimation#reverse] is `TRUE`, the animation will start
    /// at this value instead.
    pub fn value_to(self, value_to: f64) -> Self {
        Self {
            builder: self.builder.property("value-to", value_to),
        }
    }

    /// Whether to skip the animation when animations are globally disabled.
    ///
    /// The default behavior is to skip the animation. Set to `FALSE` to disable
    /// this behavior.
    ///
    /// This can be useful for cases where animation is essential, like spinners,
    /// or in demo applications. Most other animations should keep it enabled.
    ///
    /// See [`gtk-enable-animations`][struct@crate::gtk::Settings#gtk-enable-animations].
    #[cfg(feature = "v1_3")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_3")))]
    pub fn follow_enable_animations_setting(self, follow_enable_animations_setting: bool) -> Self {
        Self {
            builder: self.builder.property(
                "follow-enable-animations-setting",
                follow_enable_animations_setting,
            ),
        }
    }

    /// The target to animate.
    pub fn target(self, target: &impl IsA<AnimationTarget>) -> Self {
        Self {
            builder: self.builder.property("target", target.clone().upcast()),
        }
    }

    /// The animation widget.
    ///
    /// It provides the frame clock for the animation. It's not strictly necessary
    /// for this widget to be same as the one being animated.
    ///
    /// The widget must be mapped in order for the animation to work. If it's not
    /// mapped, or if it gets unmapped during an ongoing animation, the animation
    /// will be automatically skipped.
    pub fn widget(self, widget: &impl IsA<gtk::Widget>) -> Self {
        Self {
            builder: self.builder.property("widget", widget.clone().upcast()),
        }
    }

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