[gtk+] Allow GdkPixbufSimpleAnim to loop

[Claudio Saavedra <csaavedra src gnome org>]

commit 3c9e7c73bf63fe99ee095fbcfc9f5078c84e331d
Author: Claudio Saavedra <csaavedra igalia com>
Date:   Sat Apr 18 15:16:22 2009 +0300

    Allow GdkPixbufSimpleAnim to loop
    
    Add a GdkPixbufSimpleAnim:loop boolean property and its accessors.
    Based on a patch by Tim Evans. (#561139)
---
 docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt |    2 +
 docs/reference/gdk-pixbuf/tmpl/animation.sgml     |   18 +++
 gdk-pixbuf/gdk-pixbuf-simple-anim.c               |  119 ++++++++++++++++++++-
 gdk-pixbuf/gdk-pixbuf-simple-anim.h               |    3 +
 gdk-pixbuf/gdk-pixbuf.symbols                     |    2 +
 5 files changed, 140 insertions(+), 4 deletions(-)

diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt
index be208fd..6d84f8e 100644
--- a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt
+++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt
@@ -136,6 +136,8 @@ gdk_pixbuf_animation_iter_get_pixbuf
 GdkPixbufSimpleAnim
 gdk_pixbuf_simple_anim_new
 gdk_pixbuf_simple_anim_add_frame
+gdk_pixbuf_simple_anim_set_loop
+gdk_pixbuf_simple_anim_get_loop
 
 <SUBSECTION Standard>
 GDK_PIXBUF_ANIMATION
diff --git a/docs/reference/gdk-pixbuf/tmpl/animation.sgml b/docs/reference/gdk-pixbuf/tmpl/animation.sgml
index 3cd15b4..6df1a8b 100644
--- a/docs/reference/gdk-pixbuf/tmpl/animation.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/animation.sgml
@@ -172,3 +172,21 @@ An opaque struct representing a simple animation.
 @pixbuf: 
 
 
+<!-- ##### FUNCTION gdk_pixbuf_simple_anim_set_loop ##### -->
+<para>
+
+</para>
+
+ animation: 
+ loop: 
+
+
+<!-- ##### FUNCTION gdk_pixbuf_simple_anim_get_loop ##### -->
+<para>
+
+</para>
+
+ animation: 
+ Returns: 
+
+
diff --git a/gdk-pixbuf/gdk-pixbuf-simple-anim.c b/gdk-pixbuf/gdk-pixbuf-simple-anim.c
index 3cd1560..24d7ba4 100644
--- a/gdk-pixbuf/gdk-pixbuf-simple-anim.c
+++ b/gdk-pixbuf/gdk-pixbuf-simple-anim.c
@@ -25,9 +25,12 @@
  *          Havoc Pennington <hp redhat com>
  */
 
+#include "config.h"
 #include <glib.h>
 
+#define GDK_PIXBUF_C_COMPILATION
 #include "gdk-pixbuf.h"
+#include "gdk-pixbuf-private.h"
 #include "gdk-pixbuf-io.h"
 #include "gdk-pixbuf-simple-anim.h"
 #include "gdk-pixbuf-alias.h"
@@ -109,6 +112,21 @@ static GdkPixbufAnimationIter *get_iter (GdkPixbufAnimation *anim,
                                          const GTimeVal     *start_time);
 
 
+static void gdk_pixbuf_simple_anim_set_property (GObject        *object,
+                                                 guint           prop_id,
+                                                 const GValue   *value,
+                                                 GParamSpec     *pspec);
+static void gdk_pixbuf_simple_anim_get_property (GObject        *object,
+                                                 guint           prop_id,
+                                                 GValue         *value,
+                                                 GParamSpec     *pspec);
+
+enum
+{
+        PROP_0,
+        PROP_LOOP
+};
+
 G_DEFINE_TYPE (GdkPixbufSimpleAnim, gdk_pixbuf_simple_anim, GDK_TYPE_PIXBUF_ANIMATION)
 
 static void
@@ -124,13 +142,30 @@ gdk_pixbuf_simple_anim_class_init (GdkPixbufSimpleAnimClass *klass)
 
         object_class = G_OBJECT_CLASS (klass);
         anim_class = GDK_PIXBUF_ANIMATION_CLASS (klass);
-        
+
+        object_class->set_property = gdk_pixbuf_simple_anim_set_property;
+        object_class->get_property = gdk_pixbuf_simple_anim_get_property;
         object_class->finalize = gdk_pixbuf_simple_anim_finalize;
         
         anim_class->is_static_image = is_static_image;
         anim_class->get_static_image = get_static_image;
         anim_class->get_size = get_size;
         anim_class->get_iter = get_iter;
+
+        /**
+         * GdkPixbufSimpleAnim:loop:
+         *
+         * Whether the animation should loop when it reaches the end.
+         *
+         * Since: 2.18
+         */
+        g_object_class_install_property (object_class,
+                                         PROP_LOOP,
+                                         g_param_spec_boolean ("loop",
+                                                               P_("Loop"),
+                                                               P_("Whether the animation should loop when it reaches the end"),
+                                                               FALSE,
+                                                               G_PARAM_READWRITE));
 }
 
 static void
@@ -277,7 +312,7 @@ advance (GdkPixbufAnimationIter *anim_iter,
 {
         GdkPixbufSimpleAnimIter *iter;
         gint elapsed;
-        gint loop;
+        gint loop_count;
         GList *tmp;
         GList *old;
         
@@ -302,13 +337,13 @@ advance (GdkPixbufAnimationIter *anim_iter,
         /* See how many times we've already played the full animation,
          * and subtract time for that.
          */
-        loop = elapsed / iter->simple_anim->total_time;
+        loop_count = elapsed / iter->simple_anim->total_time;
         elapsed = elapsed % iter->simple_anim->total_time;
         
         iter->position = elapsed;
         
         /* Now move to the proper frame */
-        if (loop < 1)
+        if (loop_count < 1 || iter->simple_anim->loop)
                 tmp = iter->simple_anim->frames;
         else
                 tmp = NULL;
@@ -437,6 +472,82 @@ gdk_pixbuf_simple_anim_add_frame (GdkPixbufSimpleAnim *animation,
   animation->frames = g_list_append (animation->frames, frame);
 }
 
+static void
+gdk_pixbuf_simple_anim_get_property (GObject         *object,
+                                     guint            prop_id,
+                                     GValue          *value,
+                                     GParamSpec      *pspec)
+{
+        GdkPixbufSimpleAnim *animation = GDK_PIXBUF_SIMPLE_ANIM (object);
+
+        switch (prop_id) {
+        case PROP_LOOP:
+                g_value_set_boolean (value,
+                                     gdk_pixbuf_simple_anim_get_loop (animation));
+                break;
+        default:
+                G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+                break;
+        }
+}
+
+static void
+gdk_pixbuf_simple_anim_set_property (GObject         *object,
+                                     guint            prop_id,
+                                     const GValue    *value,
+                                     GParamSpec      *pspec)
+{
+        GdkPixbufSimpleAnim *animation = GDK_PIXBUF_SIMPLE_ANIM (object);
+
+        switch (prop_id) {
+        case PROP_LOOP:
+                gdk_pixbuf_simple_anim_set_loop (animation,
+                                                 g_value_get_boolean (value));
+                break;
+        default:
+                G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+                break;
+        }
+}
+
+/**
+ * gdk_pixbuf_simple_anim_set_loop:
+ * @animation: a #GdkPixbufSimpleAnim
+ * @loop: whether to loop the animation
+ *
+ * Sets whether @animation should loop indefinitely when it reaches the end.
+ *
+ * Since: 2.18
+ **/
+void
+gdk_pixbuf_simple_anim_set_loop (GdkPixbufSimpleAnim *animation,
+                                 gboolean             loop)
+{
+        g_return_if_fail (GDK_IS_PIXBUF_SIMPLE_ANIM (animation));
+
+        if (loop != animation->loop) {
+                animation->loop = loop;
+                g_object_notify (G_OBJECT (animation), "loop");
+        }
+}
+
+/**
+ * gdk_pixbuf_simple_anim_get_loop:
+ * @animation: a #GdkPixbufSimpleAnim
+ *
+ * Gets whether @animation should loop indefinitely when it reaches the end.
+ *
+ * Returns: %TRUE if the animation loops forever, %FALSE otherwise
+ *
+ * Since: 2.18
+ **/
+gboolean
+gdk_pixbuf_simple_anim_get_loop (GdkPixbufSimpleAnim *animation)
+{
+        g_return_val_if_fail (GDK_IS_PIXBUF_SIMPLE_ANIM (animation), FALSE);
+
+        return animation->loop;
+}
 
 #define __GDK_PIXBUF_SIMPLE_ANIM_C__
 #include "gdk-pixbuf-aliasdef.c"
diff --git a/gdk-pixbuf/gdk-pixbuf-simple-anim.h b/gdk-pixbuf/gdk-pixbuf-simple-anim.h
index ae77c20..cb96c53 100644
--- a/gdk-pixbuf/gdk-pixbuf-simple-anim.h
+++ b/gdk-pixbuf/gdk-pixbuf-simple-anim.h
@@ -51,6 +51,9 @@ GdkPixbufSimpleAnim *gdk_pixbuf_simple_anim_new           (gint   width,
                                                            gfloat rate);
 void                 gdk_pixbuf_simple_anim_add_frame     (GdkPixbufSimpleAnim *animation,
                                                            GdkPixbuf           *pixbuf);
+void                 gdk_pixbuf_simple_anim_set_loop      (GdkPixbufSimpleAnim *animation,
+                                                           gboolean             loop);
+gboolean             gdk_pixbuf_simple_anim_get_loop      (GdkPixbufSimpleAnim *animation);
 
 G_END_DECLS
 
diff --git a/gdk-pixbuf/gdk-pixbuf.symbols b/gdk-pixbuf/gdk-pixbuf.symbols
index 4b579dd..ddf01c0 100644
--- a/gdk-pixbuf/gdk-pixbuf.symbols
+++ b/gdk-pixbuf/gdk-pixbuf.symbols
@@ -133,6 +133,8 @@ gdk_pixbuf_simple_anim_get_type G_GNUC_CONST
 gdk_pixbuf_simple_anim_iter_get_type G_GNUC_CONST
 gdk_pixbuf_simple_anim_new
 gdk_pixbuf_simple_anim_add_frame
+gdk_pixbuf_simple_anim_set_loop
+gdk_pixbuf_simple_anim_get_loop
 #endif
 #endif