elm icon_animated: Refactoring.

1. Enhance the document.
2. Call elm_icon_animated_xxx() when the icon supports animation.
3. Anyway, animated icon doesn't work on my machine :(
   I got this error when I ran it.
   >> sh: evas_image_loader.gif: not found

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/elementary@62426 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/src/bin/test_icon_animated.c b/src/bin/test_icon_animated.c
index 6da7bb9..c1ba563 100644 (file)
--- a/src/bin/test_icon_animated.c
+++ b/src/bin/test_icon_animated.c
@@ -32,9 +32,9 @@ test_icon_animated(void *data __UNUSED__, Evas_Object *obj __UNUSED__, void *eve
    if (elm_icon_animated_available_get(ic))
      {
         printf("============Support animator==============\n");
+        elm_icon_animated_set(ic, EINA_TRUE);
+        elm_icon_animated_play_set(ic, EINA_TRUE);
      }
-   elm_icon_animated_set(ic, EINA_TRUE);
-   elm_icon_animated_play_set(ic, EINA_TRUE);
    elm_icon_scale_set(ic, 0, 0);
    elm_icon_no_scale_set(ic, 1);
    evas_object_size_hint_weight_set(ic, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);

diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in
index 306ef75..ae7791c 100644 (file)
--- a/src/lib/Elementary.h.in
+++ b/src/lib/Elementary.h.in
@@ -4770,15 +4770,15 @@ extern "C" {
     */
    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
    /**
-    * Get the flag related with elm icon can support animation
+    * Get if the icon supports animation or not.
     *
     * @param obj The icon object
-    * @return The flag of animation available
+    * @return @c EINA_TRUE if the icon supports animation,
+    *         @c EINA_FALSE otherwise.
     *
-    * Return this elm icon's image can be animated
-    * Currently Evas only support gif's animation
-    * If the return value of this function is EINA_FALSE,
-    * other elm_icon_animated_XXX functions don't work
+    * Return if this elm icon's image can be animated. Currently Evas only
+    * supports gif animation. If the return value is EINA_FALSE, other
+    * elm_icon_animated_XXX APIs won't work.
     * @ingroup Icon
     */
    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);