aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJunsuChoi <jsuya.choi@samsung.com>2019-04-24 16:17:48 +0900
committerShinwoo Kim <cinoo.kim@samsung.com>2019-04-25 10:16:36 +0900
commitdd577f27f9b17547f669b8edf158157e70db530f (patch)
tree01a40ff7d192961d0179bab3ebff31c0f5650b8c
parentMerge branch 'master' into devs/hermet/lottie (diff)
downloadefl-devs/hermet/lottie.tar.gz
Efl.Ui.Animation_View: Enhance documentation of elm_animation_view.devs/hermet/lottie
Summary: - Add "Animation View" item at elementary_main. - Change EAPIs naming. - Change version 1.22 to 1.23. Test Plan: make doc firefox doc/html/widgetslist.html Go "Animation View" Reviewers: Hermet, kimcinoo, segfaultxavi Subscribers: segfaultxavi, cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D8675
-rw-r--r--doc/index_elm.dox2
-rw-r--r--src/lib/elementary/efl_ui_animation_view.eo153
-rw-r--r--src/lib/elementary/efl_ui_animation_view.h40
-rw-r--r--src/lib/elementary/efl_ui_animation_view_eo.legacy.h245
-rw-r--r--src/lib/elementary/efl_ui_animation_view_legacy.h41
5 files changed, 269 insertions, 212 deletions
diff --git a/doc/index_elm.dox b/doc/index_elm.dox
index 2aa1f4b1ae..effe1aed35 100644
--- a/doc/index_elm.dox
+++ b/doc/index_elm.dox
@@ -44,6 +44,8 @@
*
* @image html img/widget/actionslider/preview-00.png
* @image latex img/widget/actionslider/preview-00.eps
+ * @li @ref Elm_Animation_View
+ *
* @li @ref Elm_Bg
*
* @image html img/widget/bg/preview-00.png
diff --git a/src/lib/elementary/efl_ui_animation_view.eo b/src/lib/elementary/efl_ui_animation_view.eo
index 0d377408a3..e5af3b7502 100644
--- a/src/lib/elementary/efl_ui_animation_view.eo
+++ b/src/lib/elementary/efl_ui_animation_view.eo
@@ -1,18 +1,28 @@
enum Efl.Ui.Animation_View.State
{
- //FIXME: This enum is not neccessary in legacy header. but legacy:null command is not working correct.
- //legacy: null;
- not_ready, [[Animation is not ready to play. (Probably, it didn't file set yet or failed to read file. @since 1.22]]
- play, [[Animation is on playing. see @Efl.Ui.Animation_View.play @since 1.22]]
- play_back, [[Animation is on playing back (rewinding). see @Efl.Ui.Animation_View.play_back @since 1.22]]
- pause, [[Animation has been paused. To continue animation, call @Efl.Ui.Animation_View.resume. see @Efl.Ui.Animation_View.pause @since 1.22]]
- stop [[Animation view successfully loaded a file then readied for playing. Otherwise after finished animation or stopped forcely by request. see @Efl.Ui.Animation_View.stop @since 1.22]]
+ not_ready, [[Animation is not ready to play. (Probably, it didn't file set yet or failed to read file. @since 1.23]]
+ play, [[Animation is on playing. see @Efl.Ui.Animation_View.play @since 1.23]]
+ play_back, [[Animation is on playing back (rewinding). see @Efl.Ui.Animation_View.play_back @since 1.23]]
+ pause, [[Animation has been paused. To continue animation, call @Efl.Ui.Animation_View.resume. see @Efl.Ui.Animation_View.pause @since 1.23]]
+ stop [[Animation view successfully loaded a file then readied for playing. Otherwise after finished animation or stopped forcely by request. see @Efl.Ui.Animation_View.stop @since 1.23]]
}
class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View, Efl.File
{
- [[Elementary Animation View class]]
+ [[Elementary Animation view class.
+ Animation view is designed to show and play animation of
+ vector graphics based content. It hides all efl_canvas_vg details
+ but just open an API to read vector data from file. Also, it implements
+ details of animation control methods of Vector.
+
+ Vector data could contain static or animatable vector elements including
+ animation infomation. Currently approved vector data file format is svg, json and eet.
+ Only json(known for Lottie file as well) and eet could contains animation infomation,
+ currently Animation_View is supporting.
+
+ @since 1.23
+ ]]
event_prefix: efl_ui_animation_view;
methods {
@property auto_play {
@@ -25,26 +35,38 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
it turns to pause state then resume animation when it's visible again.
Warning: This auto play will be only affected to the next animation source.
- So must be called before setting animation file ]]
+ So must be called before setting animation file
+
+ @since 1.23
+ ]]
set {
+ [[Set auto play mode of an animation view object.
+ $true Enable auto play mode, disable otherwise]]
}
get {
+ [[Returns auto play mode of an animation view object.]]
}
values {
- auto_play: bool; [[$true Enable auto play mode, disable otherwise]]
+ auto_play: bool; [[Auto play mode, Default value is $false]]
}
}
@property auto_repeat {
[[Turn on/off animation looping.
If @.auto_repeat is $true, it repeats animation when animation frame is reached to
- end. This auto repeat mode is valid to both play and play_back cases.]]
+ end. This auto repeat mode is valid to both play and play_back cases.
+
+ @since 1.23
+ ]]
set {
+ [[Enable loop mode if $true, disable otherwise
+ $true Enable auto play mode, disable otherwise]]
}
get {
+ [[Returns auto repeat mode of an animation view object.]]
}
values {
- auto_repeat: bool; [[Enable loop mode if $true, disable otherwise]]
+ auto_repeat: bool; [[Loop mode, Defalut is $false.]]
}
}
@property speed {
@@ -54,52 +76,68 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
animation double-time faster, you can give $speed 2. If you want to play
animation double-time slower, you can give $speed 0.5.
- Warning: speed must be greater than zero.]]
+ Warning: speed must be greater than zero.
+
+ @since 1.23
+ ]]
set {
return: bool; [[$true when it's successful. $false otherwise.]]
}
get {
+ [[Returns current animation speed of an animation view object.]]
}
values {
- speed: double; [[ Speed factor. Default value is 1]]
+ speed: double; [[ Speed factor. Default value is 1.0]]
}
}
@property duration_time {
[[Get the duration of animation in seconds.
This API returns total duration time of current animation in the seconds.
- If current animation source isn't animatable, it returns zero.]]
+ If current animation source isn't animatable, it returns zero.
+
+ @since 1.23
+ ]]
get {
+ [[Returns current duration of an animation in seconds.]]
}
values {
frame_duration: double; [[duration time in the seconds]]
}
}
@property progress {
- [[Set current progress position of animation view.
+ [[Set current progress position of animation view object.
When you required to jump on a certain frame instantly,
you can change current position by using this API.
- Warning: The range of progress is 0 ~ 1.]]
+ Warning: The range of progress is 0 ~ 1.
+
+ @since 1.23
+ ]]
set {
+ [[Set the current progress position of an animation view object.]]
}
get {
+ [[Returns current progress position of an animation view object.]]
}
values {
progress: double; [[Progress position. Value must be 0 ~ 1.]]
}
}
@property frame {
- //FIXME : frame_count need add '@' symbol after add eo method frame_count.
[[Number of current frame.
- Ranges from 0 to frame_count - 1.
+ Ranges from 0 to @.frame_count - 1.
+
+ @since 1.23
]]
set {
[[Set the current frame of an animation view object.]]
}
- get {}
+ get {
+ [[Returns the current frame of an animation view object.]]
+ }
values {
frame_num: int; [[Current frame number.]]
}
@@ -111,7 +149,10 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
play forward from there.
Warning: Play request will be ignored if animation source is not set yet or
- animation is paused state or it's already on playing.]]
+ animation is paused state or it's already on playing.
+
+ @since 1.23
+ ]]
return: bool; [[$true when it's successful. $false otherwise.]]
}
@@ -122,7 +163,10 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
play backward from there.
Warning: Play back request will be ignored if animation source is not set yet or
- animation is paused state or it's already on playing back.]]
+ animation is paused state or it's already on playing back.
+
+ @since 1.23
+ ]]
return: bool; [[$true when it's successful. $false otherwise.]]
}
@@ -131,14 +175,20 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
Once animation is paused, animation view must get resume to play continue again.
- Warning: Animation must be on playing or playing back status.]]
+ Warning: Animation must be on playing or playing back status.
+
+ @since 1.23
+ ]]
return: bool; [[$true when it's successful. $false otherwise.]]
}
resume {
[[Resume paused animation to continue animation.
- Warning: This resume must be called on animation paused status. ]]
+ Warning: This resume must be called on animation paused status.
+
+ @since 1.23
+ ]]
return: bool; [[$true when it's successful. $false otherwise.]]
}
@@ -147,14 +197,19 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
Stop animation instatly regardless of it's status and reset to
show first frame of animation. Even though current animation is paused,
- the animation status will be stopped.]]
+ the animation status will be stopped.
+
+ @since 1.23
+ ]]
return: bool; [[$true when it's successful. $false otherwise.]]
}
@property default_size {
get {
[[Get the default view size that specified from vector resource.
- @since 1.22]]
+
+ @since 1.23
+ ]]
}
values {
size: Eina.Size2D;
@@ -164,7 +219,9 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
get{
[[Get current animation view state.
see @.State
- @since 1.22]]
+
+ @since 1.23
+ ]]
}
values {
state: Efl.Ui.Animation_View.State; [[Current animation view state]]
@@ -172,15 +229,19 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
}
is_playing_back {
[[Returns the status whether current animation is on playing forward or backward.
- warning: If animation view is not on playing, it will return $false.
- @since 1.22]]
+ warning: If animation view is not on playing, it will return $false.
+
+ @since 1.23
+ ]]
return: bool; [[$true, if animation on playing back, $false otherwise.]]
}
@property frame_count {
get {
[[Get the index of end frame of the animation view, if it's animated.
note : frame number starts with 0.
- @since 1.22]]
+
+ @since 1.23
+ ]]
}
values {
frame_count: int; [[ The number of frames. 0, if it's not animated.]]
@@ -189,14 +250,14 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
@property min_progress {
[[ The start progress of the play.
Default value is 0.
+
+ @since 1.23
]]
set {
- [[Set start progress of an animation object.
- @since 1.22]]
+ [[Set start progress of an animation object.]]
}
get {
- [[Returns start progress of an animation object.
- @since 1.22]]
+ [[Returns start progress of an animation object.]]
}
values {
min_progress: double; [[ The minimum progress. Value must be 0 ~ 1. ]]
@@ -205,14 +266,14 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
@property max_progress {
[[ The last progress of the play.
Default value is 1.
+
+ @since 1.23
]]
set {
- [[Set last progress of an animation object.
- @since 1.22]]
+ [[Set last progress of an animation object.]]
}
get {
- [[Returns last progress of an animation object.
- @since 1.22]]
+ [[Returns last progress of an animation object.]]
}
values {
max_progress: double; [[ The maximum progress. Value must be 0 ~ 1. ]]
@@ -221,14 +282,14 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
@property min_frame {
[[ The start frame of the play.
Default value is 0.
+
+ @since 1.23
]]
set {
- [[Set minimum frame of an animation object.
- @since 1.22]]
+ [[Set minimum frame of an animation object.]]
}
get {
- [[Returns minimum frame of an animation object.
- @since 1.22]]
+ [[Returns minimum frame of an animation object.]]
}
values {
min_frame: int; [[ The minimum frame for play. Value must be 0 ~ @.max_frame ]]
@@ -237,14 +298,14 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
@property max_frame {
[[ The last frame of the play.
Default value is @.frame_count - 1
+
+ @since 1.23
]]
set {
- [[Set maximum frame of an animation object.
- @since 1.22]]
+ [[Set maximum frame of an animation object.]]
}
get {
- [[Returns maximum frame of an animation object.
- @since 1.22]]
+ [[Returns maximum frame of an animation object.]]
}
values {
max_frame: int; [[ The maximum frame for play. Value must be @.min_frame ~ (@.frame_count - 1) ]]
diff --git a/src/lib/elementary/efl_ui_animation_view.h b/src/lib/elementary/efl_ui_animation_view.h
index e566454fa4..9241791bf4 100644
--- a/src/lib/elementary/efl_ui_animation_view.h
+++ b/src/lib/elementary/efl_ui_animation_view.h
@@ -1,5 +1,5 @@
/**
- * @defgroup Efl_Ui_Animation_View Animation_View
+ * @defgroup Elm_Animation_View Animation View
* @ingroup Elementary
*
* Animation_View widget is designed to show and play animation of
@@ -12,8 +12,7 @@
* Only json(known for Lottie file as well) and eet could contains animation infomation,
* currently Animation_View is supporting.
*
- * This widget emits the following signals, besides the ones sent from
- * @ref Animation_View:
+ * This widget emits the following signals, besides the ones sent from Animation View.
* @li "play,start": animation is just started.
* @li "play,repeat": animation is just repeated.
* @li "play,done": animation is just finished.
@@ -23,41 +22,8 @@
* @li "play,update": animation is updated to the next frame.
*
*/
-
/**
- * @ingroup Efl_Ui_Animation_View
- */
-/**
- * @}
- */
-
-/**
- * @defgroup Elm_Animation_View_Group Animation_View
- * @ingroup Elementary
- *
- * Animation_View widget is designed to show and play animation of
- * vector graphics based content. It hides all efl_canvas_vg details
- * but just open an API to read vector data from file. Also, it implements
- * details of animation control methods of Vector.
- *
- * Vector data could contain static or animatable vector elements including
- * animation infomation. Currently approved vector data file format is svg, json and eet.
- * Only json(known for Lottie file as well) and eet could contains animation infomation,
- * currently Animation_View is supporting.
- *
- * This widget emits the following signals, besides the ones sent from
- * @ref Animation_View:
- * @li "play,start": animation is just started.
- * @li "play,repeat": animation is just repeated.
- * @li "play,done": animation is just finished.
- * @li "play,pause": animation is just paused.
- * @li "play,resume": animation is just resumed.
- * @li "play,stop": animation is just stopped.
- * @li "play,update": animation is updated to the next frame.
- *
- */
-/**
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
#ifndef EFL_NOLEGACY_API_SUPPORT
#include "efl_ui_animation_view_legacy.h"
diff --git a/src/lib/elementary/efl_ui_animation_view_eo.legacy.h b/src/lib/elementary/efl_ui_animation_view_eo.legacy.h
index 05060503d3..f7944e26f4 100644
--- a/src/lib/elementary/efl_ui_animation_view_eo.legacy.h
+++ b/src/lib/elementary/efl_ui_animation_view_eo.legacy.h
@@ -1,46 +1,51 @@
#ifndef _EFL_UI_ANIMATION_VIEW_EO_LEGACY_H_
#define _EFL_UI_ANIMATION_VIEW_EO_LEGACY_H_
-#ifndef _EFL_UI_ANIMATION_VIEW_EO_CLASS_TYPE
-#define _EFL_UI_ANIMATION_VIEW_EO_CLASS_TYPE
+#ifndef _ELM_ANIMATION_VIEW_EO_CLASS_TYPE
+#define _ELM_ANIMATION_VIEW_EO_CLASS_TYPE
-typedef Eo Efl_Ui_Animation_View;
+typedef Eo Elm_Animation_View;
#endif
-#ifndef _EFL_UI_ANIMATION_VIEW_EO_TYPES
-#define _EFL_UI_ANIMATION_VIEW_EO_TYPES
+#ifndef _ELM_ANIMATION_VIEW_EO_TYPES
+#define _ELM_ANIMATION_VIEW_EO_TYPES
+/**
+ * @brief Defines the state of animation view
+ *
+ * @ingroup Elm_Animation_View
+ */
typedef enum
{
- EFL_UI_ANIMATION_VIEW_STATE_NOT_READY = 0, /**< Animation is not ready to
+ ELM_ANIMATION_VIEW_STATE_NOT_READY = 0, /**< Animation is not ready to
* play. (Probably, it didn't file
* set yet or failed to read file.
*
- * @since 1.22 */
- EFL_UI_ANIMATION_VIEW_STATE_PLAY, /**< Animation is on playing. see
+ * @since 1.23 */
+ ELM_ANIMATION_VIEW_STATE_PLAY, /**< Animation is on playing. see
* @ref elm_animation_view_play
*
- * @since 1.22 */
- EFL_UI_ANIMATION_VIEW_STATE_PLAY_BACK, /**< Animation is on playing back
+ * @since 1.23 */
+ ELM_ANIMATION_VIEW_STATE_PLAY_BACK, /**< Animation is on playing back
* (rewinding). see
* @ref elm_animation_view_play_back
*
- * @since 1.22 */
- EFL_UI_ANIMATION_VIEW_STATE_PAUSE, /**< Animation has been paused. To continue
+ * @since 1.23 */
+ ELM_ANIMATION_VIEW_STATE_PAUSE, /**< Animation has been paused. To continue
* animation, call
* @ref elm_animation_view_resume. see
* @ref elm_animation_view_pause
*
- * @since 1.22 */
- EFL_UI_ANIMATION_VIEW_STATE_STOP /**< Animation view successfully loaded a
+ * @since 1.23 */
+ ELM_ANIMATION_VIEW_STATE_STOP /**< Animation view successfully loaded a
* file then readied for playing. Otherwise
* after finished animation or stopped
* forcely by request. see
* @ref elm_animation_view_stop
*
- * @since 1.22 */
-} Efl_Ui_Animation_View_State;
+ * @since 1.23 */
+} Elm_Animation_View_State;
#endif
@@ -57,12 +62,17 @@ typedef enum
* @warning This auto play will be only affected to the next animation source.
* So must be called before setting animation file
*
+ * Set auto play mode of an animation view object. @c true Enable auto play
+ * mode, disable otherwise
+ *
* @param[in] obj The object.
- * @param[in] auto_play @c true Enable auto play mode, disable otherwise
+ * @param[in] auto_play Auto play mode, Default value is @c false
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI void elm_animation_view_auto_play_set(Efl_Ui_Animation_View *obj, Eina_Bool auto_play);
+EAPI void elm_animation_view_auto_play_set(Elm_Animation_View *obj, Eina_Bool auto_play);
/**
* @brief Animation will be started automatically when it's possible.
@@ -76,13 +86,17 @@ EAPI void elm_animation_view_auto_play_set(Efl_Ui_Animation_View *obj, Eina_Bool
* @warning This auto play will be only affected to the next animation source.
* So must be called before setting animation file
*
+ * Returns auto play mode of an animation view object.
+ *
* @param[in] obj The object.
*
- * @return @c true Enable auto play mode, disable otherwise
+ * @return Auto play mode, Default value is @c false
+ *
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI Eina_Bool elm_animation_view_auto_play_get(const Efl_Ui_Animation_View *obj);
+EAPI Eina_Bool elm_animation_view_auto_play_get(const Elm_Animation_View *obj);
/**
* @brief Turn on/off animation looping.
@@ -91,12 +105,17 @@ EAPI Eina_Bool elm_animation_view_auto_play_get(const Efl_Ui_Animation_View *obj
* when animation frame is reached to end. This auto repeat mode is valid to
* both play and play_back cases.
*
+ * Enable loop mode if @c true, disable otherwise @c true Enable auto play
+ * mode, disable otherwise
+ *
* @param[in] obj The object.
- * @param[in] auto_repeat Enable loop mode if @c true, disable otherwise
+ * @param[in] auto_repeat Loop mode, Defalut is @c false.
+ *
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI void elm_animation_view_auto_repeat_set(Efl_Ui_Animation_View *obj, Eina_Bool auto_repeat);
+EAPI void elm_animation_view_auto_repeat_set(Elm_Animation_View *obj, Eina_Bool auto_repeat);
/**
* @brief Turn on/off animation looping.
@@ -105,13 +124,17 @@ EAPI void elm_animation_view_auto_repeat_set(Efl_Ui_Animation_View *obj, Eina_Bo
* when animation frame is reached to end. This auto repeat mode is valid to
* both play and play_back cases.
*
+ * Returns auto repeat mode of an animation view object.
+ *
* @param[in] obj The object.
*
- * @return Enable loop mode if @c true, disable otherwise
+ * @return Loop mode, Defalut is @c false.
+ *
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI Eina_Bool elm_animation_view_auto_repeat_get(const Efl_Ui_Animation_View *obj);
+EAPI Eina_Bool elm_animation_view_auto_repeat_get(const Elm_Animation_View *obj);
/**
* @brief Control animation speed.
@@ -123,13 +146,15 @@ EAPI Eina_Bool elm_animation_view_auto_repeat_get(const Efl_Ui_Animation_View *o
* @warning speed must be greater than zero.
*
* @param[in] obj The object.
- * @param[in] speed Speed factor. Default value is 1
+ * @param[in] speed Speed factor. Default value is 1.0
*
* @return @c true when it's successful. @c false otherwise.
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI Eina_Bool elm_animation_view_speed_set(Efl_Ui_Animation_View *obj, double speed);
+EAPI Eina_Bool elm_animation_view_speed_set(Elm_Animation_View *obj, double speed);
/**
* @brief Control animation speed.
@@ -140,13 +165,17 @@ EAPI Eina_Bool elm_animation_view_speed_set(Efl_Ui_Animation_View *obj, double s
*
* @warning speed must be greater than zero.
*
+ * Returns current animation speed of an animation view object.
+ *
* @param[in] obj The object.
*
- * @return Speed factor. Default value is 1
+ * @return Speed factor. Default value is 1.0
+ *
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI double elm_animation_view_speed_get(const Efl_Ui_Animation_View *obj);
+EAPI double elm_animation_view_speed_get(const Elm_Animation_View *obj);
/**
* @brief Get the duration of animation in seconds.
@@ -154,71 +183,89 @@ EAPI double elm_animation_view_speed_get(const Efl_Ui_Animation_View *obj);
* This API returns total duration time of current animation in the seconds. If
* current animation source isn't animatable, it returns zero.
*
+ * Returns current duration of an animation in seconds.
+ *
* @param[in] obj The object.
*
* @return duration time in the seconds
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI double elm_animation_view_duration_time_get(const Efl_Ui_Animation_View *obj);
+EAPI double elm_animation_view_duration_time_get(const Elm_Animation_View *obj);
/**
- * @brief Set current progress position of animation view.
+ * @brief Set current progress position of animation view object.
*
* When you required to jump on a certain frame instantly, you can change
* current position by using this API.
*
* @warning The range of progress is 0 ~ 1.
*
+ * Set the current progress position of an animation view object.
+ *
* @param[in] obj The object.
* @param[in] progress Progress position. Value must be 0 ~ 1.
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI void elm_animation_view_progress_set(Efl_Ui_Animation_View *obj, double progress);
+EAPI void elm_animation_view_progress_set(Elm_Animation_View *obj, double progress);
/**
- * @brief Set current progress position of animation view.
+ * @brief Set current progress position of animation view object.
*
* When you required to jump on a certain frame instantly, you can change
* current position by using this API.
*
* @warning The range of progress is 0 ~ 1.
*
+ * Returns current progress position of an animation view object.
+ *
* @param[in] obj The object.
*
* @return Progress position. Value must be 0 ~ 1.
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI double elm_animation_view_progress_get(const Efl_Ui_Animation_View *obj);
+EAPI double elm_animation_view_progress_get(const Elm_Animation_View *obj);
/**
* @brief Number of current frame.
*
- * Ranges from 0 to frame_count - 1.
+ * Ranges from 0 to @ref elm_animation_view_frame_count_get - 1.
*
* Set the current frame of an animation view object.
*
* @param[in] obj The object.
* @param[in] frame_num Current frame number.
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI void elm_animation_view_frame_set(Efl_Ui_Animation_View *obj, int frame_num);
+EAPI void elm_animation_view_frame_set(Elm_Animation_View *obj, int frame_num);
/**
* @brief Number of current frame.
*
- * Ranges from 0 to frame_count - 1.
+ * Ranges from 0 to @ref elm_animation_view_frame_count_get - 1.
+ *
+ * Returns the current frame of an animation view object.
*
* @param[in] obj The object.
*
* @return Current frame number.
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI int elm_animation_view_frame_get(const Efl_Ui_Animation_View *obj);
+EAPI int elm_animation_view_frame_get(const Elm_Animation_View *obj);
/**
* @brief Play animation one time instantly when it's available.
@@ -233,9 +280,11 @@ EAPI int elm_animation_view_frame_get(const Efl_Ui_Animation_View *obj);
*
* @return @c true when it's successful. @c false otherwise.
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI Eina_Bool elm_animation_view_play(Efl_Ui_Animation_View *obj);
+EAPI Eina_Bool elm_animation_view_play(Elm_Animation_View *obj);
/**
* @brief Play back animation one time instantly when it's available.
@@ -250,9 +299,11 @@ EAPI Eina_Bool elm_animation_view_play(Efl_Ui_Animation_View *obj);
*
* @return @c true when it's successful. @c false otherwise.
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI Eina_Bool elm_animation_view_play_back(Efl_Ui_Animation_View *obj);
+EAPI Eina_Bool elm_animation_view_play_back(Elm_Animation_View *obj);
/**
* @brief Pause current animation instantly.
@@ -266,9 +317,11 @@ EAPI Eina_Bool elm_animation_view_play_back(Efl_Ui_Animation_View *obj);
*
* @return @c true when it's successful. @c false otherwise.
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI Eina_Bool elm_animation_view_pause(Efl_Ui_Animation_View *obj);
+EAPI Eina_Bool elm_animation_view_pause(Elm_Animation_View *obj);
/**
* @brief Resume paused animation to continue animation.
@@ -279,9 +332,11 @@ EAPI Eina_Bool elm_animation_view_pause(Efl_Ui_Animation_View *obj);
*
* @return @c true when it's successful. @c false otherwise.
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI Eina_Bool elm_animation_view_resume(Efl_Ui_Animation_View *obj);
+EAPI Eina_Bool elm_animation_view_resume(Elm_Animation_View *obj);
/**
* @brief Stop playing animation.
@@ -294,17 +349,19 @@ EAPI Eina_Bool elm_animation_view_resume(Efl_Ui_Animation_View *obj);
*
* @return @c true when it's successful. @c false otherwise.
*
- * @ingroup Elm_Animation_View_Group
+ * @since 1.23
+ *
+ * @ingroup Elm_Animation_View
*/
-EAPI Eina_Bool elm_animation_view_stop(Efl_Ui_Animation_View *obj);
+EAPI Eina_Bool elm_animation_view_stop(Elm_Animation_View *obj);
/** Get the default view size that specified from vector resource.
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI Eina_Size2D elm_animation_view_default_size_get(const Efl_Ui_Animation_View *obj);
+EAPI Eina_Size2D elm_animation_view_default_size_get(const Elm_Animation_View *obj);
/**
@@ -316,11 +373,11 @@ EAPI Eina_Size2D elm_animation_view_default_size_get(const Efl_Ui_Animation_View
*
* @return @c true, if animation on playing back, @c false otherwise.
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI Eina_Bool elm_animation_view_is_playing_back(Efl_Ui_Animation_View *obj);
+EAPI Eina_Bool elm_animation_view_is_playing_back(Elm_Animation_View *obj);
/**
* @brief Get the index of end frame of the animation view, if it's animated.
@@ -330,11 +387,11 @@ EAPI Eina_Bool elm_animation_view_is_playing_back(Efl_Ui_Animation_View *obj);
*
* @return The number of frames. 0, if it's not animated.
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI int elm_animation_view_frame_count_get(const Efl_Ui_Animation_View *obj);
+EAPI int elm_animation_view_frame_count_get(const Elm_Animation_View *obj);
/**
* @brief The start progress of the play. Default value is 0.
@@ -344,11 +401,11 @@ EAPI int elm_animation_view_frame_count_get(const Efl_Ui_Animation_View *obj);
* @param[in] obj The object.
* @param[in] min_progress The minimum progress. Value must be 0 ~ 1.
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI void elm_animation_view_min_progress_set(Efl_Ui_Animation_View *obj, double min_progress);
+EAPI void elm_animation_view_min_progress_set(Elm_Animation_View *obj, double min_progress);
/**
* @brief The start progress of the play. Default value is 0.
@@ -359,11 +416,11 @@ EAPI void elm_animation_view_min_progress_set(Efl_Ui_Animation_View *obj, double
*
* @return The minimum progress. Value must be 0 ~ 1.
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI double elm_animation_view_min_progress_get(const Efl_Ui_Animation_View *obj);
+EAPI double elm_animation_view_min_progress_get(const Elm_Animation_View *obj);
/**
* @brief The last progress of the play. Default value is 1.
@@ -373,11 +430,11 @@ EAPI double elm_animation_view_min_progress_get(const Efl_Ui_Animation_View *obj
* @param[in] obj The object.
* @param[in] max_progress The maximum progress. Value must be 0 ~ 1.
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI void elm_animation_view_max_progress_set(Efl_Ui_Animation_View *obj, double max_progress);
+EAPI void elm_animation_view_max_progress_set(Elm_Animation_View *obj, double max_progress);
/**
* @brief The last progress of the play. Default value is 1.
@@ -388,11 +445,11 @@ EAPI void elm_animation_view_max_progress_set(Efl_Ui_Animation_View *obj, double
*
* @return The maximum progress. Value must be 0 ~ 1.
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI double elm_animation_view_max_progress_get(const Efl_Ui_Animation_View *obj);
+EAPI double elm_animation_view_max_progress_get(const Elm_Animation_View *obj);
/**
* @brief The start frame of the play. Default value is 0.
@@ -403,11 +460,11 @@ EAPI double elm_animation_view_max_progress_get(const Efl_Ui_Animation_View *obj
* @param[in] min_frame The minimum frame for play. Value must be 0 ~
* @ref elm_animation_view_max_frame_get
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI void elm_animation_view_min_frame_set(Efl_Ui_Animation_View *obj, int min_frame);
+EAPI void elm_animation_view_min_frame_set(Elm_Animation_View *obj, int min_frame);
/**
* @brief The start frame of the play. Default value is 0.
@@ -419,11 +476,11 @@ EAPI void elm_animation_view_min_frame_set(Efl_Ui_Animation_View *obj, int min_f
* @return The minimum frame for play. Value must be 0 ~
* @ref elm_animation_view_max_frame_get
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI int elm_animation_view_min_frame_get(const Efl_Ui_Animation_View *obj);
+EAPI int elm_animation_view_min_frame_get(const Elm_Animation_View *obj);
/**
* @brief The last frame of the play. Default value is
@@ -433,14 +490,13 @@ EAPI int elm_animation_view_min_frame_get(const Efl_Ui_Animation_View *obj);
*
* @param[in] obj The object.
* @param[in] max_frame The maximum frame for play. Value must be
- * @ref elm_animation_view_min_frame_get ~ (@Efl.Ui.Animation_View.frame_count
- * - 1)
+ * @ref elm_animation_view_min_frame_get ~ (@ref elm_animation_view_frame_count_get - 1)
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI void elm_animation_view_max_frame_set(Efl_Ui_Animation_View *obj, int max_frame);
+EAPI void elm_animation_view_max_frame_set(Elm_Animation_View *obj, int max_frame);
/**
* @brief The last frame of the play. Default value is
@@ -451,13 +507,12 @@ EAPI void elm_animation_view_max_frame_set(Efl_Ui_Animation_View *obj, int max_f
* @param[in] obj The object.
*
* @return The maximum frame for play. Value must be
- * @ref elm_animation_view_min_frame_get ~ (@Efl.Ui.Animation_View.frame_count
- * - 1)
+ * @ref elm_animation_view_min_frame_get ~ (@ref elm_animation_view_frame_count_get - 1)
*
- * @since 1.22
+ * @since 1.23
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*/
-EAPI int elm_animation_view_max_frame_get(const Efl_Ui_Animation_View *obj);
+EAPI int elm_animation_view_max_frame_get(const Elm_Animation_View *obj);
#endif
diff --git a/src/lib/elementary/efl_ui_animation_view_legacy.h b/src/lib/elementary/efl_ui_animation_view_legacy.h
index 5d2775a6bc..95054168c5 100644
--- a/src/lib/elementary/efl_ui_animation_view_legacy.h
+++ b/src/lib/elementary/efl_ui_animation_view_legacy.h
@@ -1,31 +1,5 @@
-typedef Eo Elm_Animation_View;
-
-typedef enum _Elm_Animation_View_State
-{
- ELM_ANIMATION_VIEW_STATE_NOT_READY = 0, /**< Animation is not ready to
- * play. (Probably, it didn't file
- * set yet or failed to read file.
- *
- * @since 1.22 */
- ELM_ANIMATION_VIEW_STATE_PLAY, /**< Animation is on playing. see @elm_animation_view_play
- *
- * @since 1.22 */
- ELM_ANIMATION_VIEW_STATE_PLAY_BACK, /**< Animation is on playing back
- * (rewinding). see @elm_animation_view_play_back
- *
- * @since 1.22 */
- ELM_ANIMATION_VIEW_STATE_PAUSE, /**< Animation has been paused. To continue
- * animation, call @elm_animation_view_resume. see @elm_animation_view_pause
- *
- * @since 1.22 */
- ELM_ANIMATION_VIEW_STATE_STOP /**< Animation view successfully loaded a
- * file then readied for playing. Otherwise
- * after finished animation or stopped
- * forcely by request. see @elm_animation_view_stop
- *
- * @since 1.22 */
-}Elm_Animation_View_State;
+#include "efl_ui_animation_view_eo.legacy.h"
/**
* Add a new animation view widget to the parent's canvas
@@ -33,9 +7,9 @@ typedef enum _Elm_Animation_View_State
* @param parent The parent object
* @return The new animation view object or @c NULL if it failed to create.
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*
- * @since 1.22
+ * @since 1.23
*/
EAPI Elm_Animation_View *elm_animation_view_add(Evas_Object *parent);
@@ -54,9 +28,9 @@ NULL, otherwise.
*
* @return @c EINA_TRUE if it's succeed to read file, @c EINA_FALSE otherwise.
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*
- * @since 1.22
+ * @since 1.23
*/
EAPI Eina_Bool elm_animation_view_file_set(Elm_Animation_View *obj, const char *file, const char *key);
@@ -67,10 +41,9 @@ EAPI Eina_Bool elm_animation_view_file_set(Elm_Animation_View *obj, const
*
* @see Elm_Animation_View_State
*
- * @ingroup Elm_Animation_View_Group
+ * @ingroup Elm_Animation_View
*
- * @since 1.22
+ * @since 1.23
*/
EAPI Elm_Animation_View_State elm_animation_view_state_get(Elm_Animation_View *obj);
-#include "efl_ui_animation_view_eo.legacy.h"