ide-animation: LibIDE Reference Manual

## ide-animation ide-animation |

## Functions

#define | IDE_TYPE_ANIMATION
void | ide_animation_start ()
void | ide_animation_stop ()
void | ide_animation_add_property ()
IdeAnimation * | ide_object_animate ()
IdeAnimation * | ide_object_animate_full ()

## Properties

guint | duration | Write / Construct Only
GdkFrameClock * | frame-clock | Write / Construct Only
IdeAnimationMode | mode | Write / Construct Only
GObject * | target | Write / Construct Only

## Signals

void | tick | Run First

## Types and Values

| IdeAnimation

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── IdeAnimation

## Description

## Functions

### IDE_TYPE_ANIMATION

    #define IDE_TYPE_ANIMATION      (ide_animation_get_type())

### ide_animation_start ()

    void
    ide_animation_start (IdeAnimation *animation);

Start the animation. When the animation stops, the internal reference will be dropped and the animation may be finalized.

#### Parameters

animation | A IdeAnimation. | [in]

#### Returns

None. Side effects: None.

### ide_animation_stop ()

    void
    ide_animation_stop (IdeAnimation *animation);

Stops a running animation. The internal reference to the animation is dropped and therefore may cause the object to finalize.

#### Parameters

animation | A IdeAnimation. | [in]

#### Returns

None. Side effects: None.

### ide_animation_add_property ()

    void
    ide_animation_add_property (IdeAnimation *animation,
                                GParamSpec *pspec,
                                const GValue *value);

Adds a new property to the set of properties to be animated during the lifetime of the animation.

#### Parameters

animation | A IdeAnimation. | [in]
pspec | A ParamSpec of `target` or a GtkWidget's parent. | [in]
value | The new value for the property at the end of the animation. | [in]

#### Returns

None. Side effects: None.

### ide_object_animate ()

    IdeAnimation *
    ide_object_animate (gpointer object,
                        IdeAnimationMode mode,
                        guint duration_msec,
                        GdkFrameClock *frame_clock,
                        const gchar *first_property,
                        ...);

Animates the properties of `object` . The can be set in a similar manner to `g_object_set()`. They will be animated from their current value to the target value over the time period.

#### Parameters

object | A GObject. | [in]
mode | The animation mode. | [in]
duration_msec | The duration in milliseconds. | [in]
first_property | The first property to animate. | [in]

#### Returns

A IdeAnimation. Side effects: None.

[transfer none]

### ide_object_animate_full ()

    IdeAnimation *
    ide_object_animate_full (gpointer object,
                             IdeAnimationMode mode,
                             guint duration_msec,
                             GdkFrameClock *frame_clock,
                             GDestroyNotify notify,
                             gpointer notify_data,
                             const gchar *first_property,
                             ...);

#### Returns

A IdeAnimation.

[transfer none]

## Types and Values

### IdeAnimation

    typedef struct _IdeAnimation IdeAnimation;

## Property Details

### The `“duration”` property

      “duration”                 guint

The "duration" property is the total number of milliseconds that the animation should run before being completed.

Flags: Write / Construct Only

Default value: 250

### The `“frame-clock”` property

      “frame-clock”              GdkFrameClock *

An optional frame-clock to synchronize with.

Flags: Write / Construct Only

### The `“mode”` property

      “mode”                     IdeAnimationMode

The "mode" property is the Alpha function that should be used to determine the offset within the animation based on the current offset in the animations duration.

Flags: Write / Construct Only

Default value: IDE_ANIMATION_LINEAR

### The `“target”` property

      “target”                   GObject *

The "target" property is the GObject that should have it's properties animated.

Flags: Write / Construct Only

## Signal Details

### The `“tick”` signal

    void
    user_function (IdeAnimation *arg0,
                   gpointer      user_data)

The "tick" signal is emitted on each frame in the animation.

#### Parameters

user_data | user data set when the signal handler was connected. |

Flags: Run First