dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Few fixes to icon animation documentation. 

SVN revision: 64333
This commit is contained in:
Sanjeev BA 2011-10-23 23:41:31 +00:00
parent 110ab53953
commit 1390faa5d9
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
legacy/elementary/src/lib/Elementary.h.in
View File

@ -5076,11 +5076,11 @@ extern "C" {
* @param anim @c EINA_TRUE if the object do animation job,
* @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
*
* Even though elm icon's file can be animated,
* sometimes appication developer want to just first page of image.
* In that time, don't call this function, because default value is EINA_FALSE
* Only when you want icon support anition,
* use this function and set animated to EINA_TURE
* Since the default animation mode is set to EINA_FALSE,
* the icon is shown without animation.
* This might be desirable when the application developer wants to show
* a snapshot of the animated icon.
* Set it to EINA_TRUE when the icon needs to be animated.
* @ingroup Icon
*/
EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
@ -5100,7 +5100,7 @@ extern "C" {
* @param play @c EINA_TRUE the object play animation images,
* @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
*
* If you want to play elm icon's animation, you set play to EINA_TURE.
* To play elm icon's animation, set play to EINA_TURE.
* For example, you make gif player using this set/get API and click event.
*
* 1. Click event occurs
@ -5116,7 +5116,7 @@ extern "C" {
* @param obj The icon object
* @return The play mode of the icon object
*
* @see elm_icon_animated_lay_get
* @see elm_icon_animated_play_get
* @ingroup Icon
*/
EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);