Struct libadwaita::TimedAnimation

pub struct TimedAnimation { /* private fields */ }

A time-based Animation.

TimedAnimation implements a simple animation interpolating the given value from value-from to value-to over duration milliseconds using the curve described by easing.

If reverse is set to TRUE, TimedAnimation will instead animate from value-to to 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 value. If 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 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.

If 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 and end at this value.

If reverse is TRUE, the animation will start at this value instead.

Readable | Writeable | Construct

Animation

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.

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

Implements

AnimationExt, [trait@glib::ObjectExt]

Implementations

impl TimedAnimation

pub fn new( widget: &impl IsA<Widget>, from: f64, to: f64, duration: u32, target: impl IsA<AnimationTarget> ) -> TimedAnimation

Creates a new 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

pub fn builder() -> TimedAnimationBuilder

Creates a new builder-pattern struct instance to construct TimedAnimation objects.

This method returns an instance of TimedAnimationBuilder which can be used to create TimedAnimation objects.

pub fn is_alternate(&self) -> bool

Gets whether @self changes direction on every iteration.

Returns

whether @self alternates

pub fn duration(&self) -> u32

Gets the duration of @self.

Returns

the duration of @self, in milliseconds

pub fn easing(&self) -> Easing

Gets the easing function @self uses.

Returns

the easing function @self uses

pub fn repeat_count(&self) -> u32

Gets the number of times @self will play.

Returns

the number of times @self will play

pub fn is_reverse(&self) -> bool

Gets whether @self plays backwards.

Returns

whether @self plays backwards

pub fn value_from(&self) -> f64

Gets the value @self will animate from.

Returns

the value to animate from

pub fn value_to(&self) -> f64

Gets the value @self will animate to.

Returns

the value to animate to

pub fn set_alternate(&self, alternate: bool)

Sets whether @self changes direction on every iteration.

alternate

whether @self alternates

pub fn set_duration(&self, duration: u32)

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

pub fn set_easing(&self, easing: Easing)

Sets the easing function @self will use.

See Easing for the description of specific easing functions.

easing

the easing function to use

pub fn set_repeat_count(&self, repeat_count: u32)

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

pub fn set_reverse(&self, reverse: bool)

Sets whether @self plays backwards.

reverse

whether @self plays backwards

pub fn set_value_from(&self, value: f64)

Sets the value @self will animate from.

The animation will start at this value and end at value-to.

If reverse is TRUE, the animation will end at this value instead.

value

the value to animate from

pub fn set_value_to(&self, value: f64)

Sets the value @self will animate to.

The animation will start at value-from and end at this value.

If reverse is TRUE, the animation will start at this value instead.

value

the value to animate to

pub fn connect_alternate_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_duration_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_easing_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_repeat_count_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_reverse_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_value_from_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_value_to_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for TimedAnimation

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TimedAnimation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TimedAnimation

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for TimedAnimation

type ParamSpec = ParamSpecObject

type SetValue = TimedAnimation

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, TimedAnimation>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TimedAnimation

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TimedAnimation

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for TimedAnimation

type Parent = Animation

impl<OT: ObjectType> PartialEq<OT> for TimedAnimation

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for TimedAnimation

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for TimedAnimation

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TimedAnimation

impl IsA<Animation> for TimedAnimation