Adw.Animation – libadwaita-1 – Vala Binding Reference

Description:

[ CCode ( type_id = "adw_animation_get_type ()" ) ]
[ Version ( since = "1.0" ) ]
public abstract class Animation : Object

A base class for animations.

`AdwAnimation` represents an animation on a widget. It has a target that provides a value to animate, and a state indicating whether the animation hasn't been started yet, is playing, paused or finished.

Currently there are two concrete animation types: [class@TimedAnimation] and [class@SpringAnimation].

`AdwAnimation` will automatically skip the animation if [property@Animation:widget] is unmapped, or if [ [email protected]:gtk-enable-animations] is `FALSE`.

The [signal@Animation:AdwAnimation:done] signal can be used to perform an action after the animation ends, for example hiding a widget after animating its [[email protected]:opacity] to 0.

`AdwAnimation` will be kept alive while the animation is playing. As such, it's safe to create an animation, start it and immediately unref it: A fire-and-forget animation:

```c static void animation_cb (double value, MyObject *self) { // Do something with value }

static void my_object_animate (MyObject *self) { AdwAnimationTarget *target = adw_callback_animation_target_new (( AdwAnimationTargetFunc) animation_cb, self, NULL); g_autoptr (AdwAnimation) animation = adw_timed_animation_new (widget, 0, 1, 250, target);

adw_animation_play (animation); } ```

If there's a chance the previous animation for the same target hasn't yet finished, the previous animation should be stopped first, or the existing `AdwAnimation` object can be reused.

Namespace: Adw

Content:

Properties:

public AnimationState state { get; }

The animation state.

public AnimationTarget target { get; set construct; }

The target to animate.

public double value { get; }

The current value of the animation.

public Widget widget { get; construct; }

The animation widget.

Creation methods:

protected Animation ()

Methods:

public AnimationState get_state ()

Gets the current value of this.

public unowned AnimationTarget get_target ()

Gets the target this animates.

public double get_value ()

Gets the current value of this.

public unowned Widget get_widget ()

Gets the widget this was created for.

public void pause ()

Pauses a playing animation for this.

public void play ()

Starts the animation for this.

public void reset ()

Resets the animation for this.

public void resume ()

Resumes a paused animation for this.

public void set_target (AnimationTarget target)

Sets the target this animates to target.

public void skip ()

Skips the animation for this.

Signals:

public signal void done ()

This signal is emitted when the animation has been completed, either on its own or via calling [method@Animation.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

Animation