Page MenuHomePhabricator
Differential D8675 Diff 21542 src/lib/elementary/efl_ui_animation_view_eo.legacy.h

Changeset View

Standalone View

View Options

src/lib/elementary/efl_ui_animation_view_eo.legacy.h

1#ifndef _EFL_UI_ANIMATION_VIEW_EO_LEGACY_H_ 1​#ifndef _EFL_UI_ANIMATION_VIEW_EO_LEGACY_H_
2#define _EFL_UI_ANIMATION_VIEW_EO_LEGACY_H_ 2​#define _EFL_UI_ANIMATION_VIEW_EO_LEGACY_H_
3 3​
4#ifndef _EFL_UI_ANIMATION_VIEW_EO_CLASS_TYPE 4​#ifndef _ELM_ANIMATION_VIEW_EO_CLASS_TYPE
5#define _EFL_UI_ANIMATION_VIEW_EO_CLASS_TYPE 5​#define _ELM_ANIMATION_VIEW_EO_CLASS_TYPE
6 6​
7typedef Eo Efl_Ui_Animation_View; 7​typedef Eo Elm_Animation_View;
8 8​
9#endif 9​#endif
10 10​
11#ifndef _EFL_UI_ANIMATION_VIEW_EO_TYPES 11​#ifndef _ELM_ANIMATION_VIEW_EO_TYPES
12#define _EFL_UI_ANIMATION_VIEW_EO_TYPES 12​#define _ELM_ANIMATION_VIEW_EO_TYPES
13 13​
14​/**
15​ * @brief Defines the state of animation view
16​ *
17​ * @ingroup Elm_Animation_View
18​ */
14typedef enum 19​typedef enum
15{ 20​{
16 EFL_UI_ANIMATION_VIEW_STATE_NOT_READY = 0, /**< Animation is not ready to 21​ ELM_ANIMATION_VIEW_STATE_NOT_READY = 0, /**< Animation is not ready to
17 * play. (Probably, it didn't file 22​ * play. (Probably, it didn't file
18 * set yet or failed to read file. 23​ * set yet or failed to read file.
19 * 24​ *
20 * @since 1.22 */ 25​ * @since 1.23 */
21 EFL_UI_ANIMATION_VIEW_STATE_PLAY, /**< Animation is on playing. see 26​ ELM_ANIMATION_VIEW_STATE_PLAY, /**< Animation is on playing. see
22 * @ref elm_animation_view_play 27​ * @ref elm_animation_view_play
23 * 28​ *
24 * @since 1.22 */ 29​ * @since 1.23 */
25 EFL_UI_ANIMATION_VIEW_STATE_PLAY_BACK, /**< Animation is on playing back 30​ ELM_ANIMATION_VIEW_STATE_PLAY_BACK, /**< Animation is on playing back
26 * (rewinding). see 31​ * (rewinding). see
27 * @ref elm_animation_view_play_back 32​ * @ref elm_animation_view_play_back
28 * 33​ *
29 * @since 1.22 */ 34​ * @since 1.23 */
30 EFL_UI_ANIMATION_VIEW_STATE_PAUSE, /**< Animation has been paused. To continue 35​ ELM_ANIMATION_VIEW_STATE_PAUSE, /**< Animation has been paused. To continue
31 * animation, call 36​ * animation, call
32 * @ref elm_animation_view_resume. see 37​ * @ref elm_animation_view_resume. see
33 * @ref elm_animation_view_pause 38​ * @ref elm_animation_view_pause
34 * 39​ *
35 * @since 1.22 */ 40​ * @since 1.23 */
36 EFL_UI_ANIMATION_VIEW_STATE_STOP /**< Animation view successfully loaded a 41​ ELM_ANIMATION_VIEW_STATE_STOP /**< Animation view successfully loaded a
37 * file then readied for playing. Otherwise 42​ * file then readied for playing. Otherwise
38 * after finished animation or stopped 43​ * after finished animation or stopped
39 * forcely by request. see 44​ * forcely by request. see
40 * @ref elm_animation_view_stop 45​ * @ref elm_animation_view_stop
41 * 46​ *
42 * @since 1.22 */ 47​ * @since 1.23 */
43} Efl_Ui_Animation_View_State; 48​} Elm_Animation_View_State;
44 49​
45 50​
46#endif 51​#endif
47 52​
48/** 53​/**
49 * @brief Animation will be started automatically when it's possible. 54​ * @brief Animation will be started automatically when it's possible.
50 * 55​ *
51 * If @ref elm_animation_view_auto_play_get is @c true, animation will be 56​ * If @ref elm_animation_view_auto_play_get is @c true, animation will be
52 * started when it's readied. The condition of @c auto play is when animation 57​ * started when it's readied. The condition of @c auto play is when animation
53 * view opened file successfully, yet to play it plus when the object is 58​ * view opened file successfully, yet to play it plus when the object is
54 * visible. If animation view is disabled, invisible, it turns to pause state 59​ * visible. If animation view is disabled, invisible, it turns to pause state
55 * then resume animation when it's visible again. 60​ * then resume animation when it's visible again.
56 * 61​ *
57 * @warning This auto play will be only affected to the next animation source. 62​ * @warning This auto play will be only affected to the next animation source.
58 * So must be called before setting animation file 63​ * So must be called before setting animation file
59 * 64​ *
60 * @param[in] obj The object. 65​ * @param[in] obj The object.
61 * @param[in] auto_play @c true Enable auto play mode, disable otherwise 66​ * @param[in] auto_play @c true Enable auto play mode, disable otherwise
62 * 67​ *
63 * @ingroup Elm_Animation_View_Group 68​ * @since 1.23
69​ *
70​ * @ingroup Elm_Animation_View
64 */ 71​ */
65EAPI void elm_animation_view_auto_play_set(Efl_Ui_Animation_View *obj, Eina_Bool auto_play); 72​EAPI void elm_animation_view_auto_play_set(Elm_Animation_View *obj, Eina_Bool auto_play);
66 73​
67/** 74​/**
68 * @brief Animation will be started automatically when it's possible. 75​ * @brief Animation will be started automatically when it's possible.
69 * 76​ *
70 * If @ref elm_animation_view_auto_play_get is @c true, animation will be 77​ * If @ref elm_animation_view_auto_play_get is @c true, animation will be
71 * started when it's readied. The condition of @c auto play is when animation 78​ * started when it's readied. The condition of @c auto play is when animation
72 * view opened file successfully, yet to play it plus when the object is 79​ * view opened file successfully, yet to play it plus when the object is
73 * visible. If animation view is disabled, invisible, it turns to pause state 80​ * visible. If animation view is disabled, invisible, it turns to pause state
74 * then resume animation when it's visible again. 81​ * then resume animation when it's visible again.
75 * 82​ *
76 * @warning This auto play will be only affected to the next animation source. 83​ * @warning This auto play will be only affected to the next animation source.
77 * So must be called before setting animation file 84​ * So must be called before setting animation file
78 * 85​ *
79 * @param[in] obj The object. 86​ * @param[in] obj The object.
80 * 87​ *
81 * @return @c true Enable auto play mode, disable otherwise 88​ * @return @c true Enable auto play mode, disable otherwise
82 * 89​ *
83 * @ingroup Elm_Animation_View_Group 90​ * @since 1.23
91​ *
92​ * @ingroup Elm_Animation_View
84 */ 93​ */
85EAPI Eina_Bool elm_animation_view_auto_play_get(const Efl_Ui_Animation_View *obj); 94​EAPI Eina_Bool elm_animation_view_auto_play_get(const Elm_Animation_View *obj);
86 95​
87/** 96​/**
88 * @brief Turn on/off animation looping. 97​ * @brief Turn on/off animation looping.
89 * 98​ *
90 * If @ref elm_animation_view_auto_repeat_get is @c true, it repeats animation 99​ * If @ref elm_animation_view_auto_repeat_get is @c true, it repeats animation
91 * when animation frame is reached to end. This auto repeat mode is valid to 100​ * when animation frame is reached to end. This auto repeat mode is valid to
92 * both play and play_back cases. 101​ * both play and play_back cases.
93 * 102​ *
94 * @param[in] obj The object. 103​ * @param[in] obj The object.
95 * @param[in] auto_repeat Enable loop mode if @c true, disable otherwise 104​ * @param[in] auto_repeat Enable loop mode if @c true, disable otherwise
96 * 105​ *
97 * @ingroup Elm_Animation_View_Group 106​ * @since 1.23
107​ *
108​ * @ingroup Elm_Animation_View
98 */ 109​ */
99EAPI void elm_animation_view_auto_repeat_set(Efl_Ui_Animation_View *obj, Eina_Bool auto_repeat); 110​EAPI void elm_animation_view_auto_repeat_set(Elm_Animation_View *obj, Eina_Bool auto_repeat);
100 111​
101/** 112​/**
102 * @brief Turn on/off animation looping. 113​ * @brief Turn on/off animation looping.
103 * 114​ *
104 * If @ref elm_animation_view_auto_repeat_get is @c true, it repeats animation 115​ * If @ref elm_animation_view_auto_repeat_get is @c true, it repeats animation
105 * when animation frame is reached to end. This auto repeat mode is valid to 116​ * when animation frame is reached to end. This auto repeat mode is valid to
106 * both play and play_back cases. 117​ * both play and play_back cases.
107 * 118​ *
108 * @param[in] obj The object. 119​ * @param[in] obj The object.
109 * 120​ *
110 * @return Enable loop mode if @c true, disable otherwise 121​ * @return Enable loop mode if @c true, disable otherwise
111 * 122​ *
112 * @ingroup Elm_Animation_View_Group 123​ * @since 1.23
124​ *
125​ * @ingroup Elm_Animation_View
113 */ 126​ */
114EAPI Eina_Bool elm_animation_view_auto_repeat_get(const Efl_Ui_Animation_View *obj); 127​EAPI Eina_Bool elm_animation_view_auto_repeat_get(const Elm_Animation_View *obj);
115 128​
116/** 129​/**
117 * @brief Control animation speed. 130​ * @brief Control animation speed.
118 * 131​ *
119 * Control animation speed by multiplying @c speed value. If you want to play 132​ * Control animation speed by multiplying @c speed value. If you want to play
120 * animation double-time faster, you can give @c speed 2. If you want to play 133​ * animation double-time faster, you can give @c speed 2. If you want to play
121 * animation double-time slower, you can give @c speed 0.5. 134​ * animation double-time slower, you can give @c speed 0.5.
122 * 135​ *
123 * @warning speed must be greater than zero. 136​ * @warning speed must be greater than zero.
124 * 137​ *
125 * @param[in] obj The object. 138​ * @param[in] obj The object.
126 * @param[in] speed Speed factor. Default value is 1 139​ * @param[in] speed Speed factor. Default value is 1
127 * 140​ *
128 * @return @c true when it's successful. @c false otherwise. 141​ * @return @c true when it's successful. @c false otherwise.
129 * 142​ *
130 * @ingroup Elm_Animation_View_Group 143​ * @since 1.23
144​ *
145​ * @ingroup Elm_Animation_View
131 */ 146​ */
132EAPI Eina_Bool elm_animation_view_speed_set(Efl_Ui_Animation_View *obj, double speed); 147​EAPI Eina_Bool elm_animation_view_speed_set(Elm_Animation_View *obj, double speed);
133 148​
134/** 149​/**
135 * @brief Control animation speed. 150​ * @brief Control animation speed.
136 * 151​ *
137 * Control animation speed by multiplying @c speed value. If you want to play 152​ * Control animation speed by multiplying @c speed value. If you want to play
138 * animation double-time faster, you can give @c speed 2. If you want to play 153​ * animation double-time faster, you can give @c speed 2. If you want to play
139 * animation double-time slower, you can give @c speed 0.5. 154​ * animation double-time slower, you can give @c speed 0.5.
140 * 155​ *
141 * @warning speed must be greater than zero. 156​ * @warning speed must be greater than zero.
142 * 157​ *
143 * @param[in] obj The object. 158​ * @param[in] obj The object.
144 * 159​ *
145 * @return Speed factor. Default value is 1 160​ * @return Speed factor. Default value is 1
146 * 161​ *
147 * @ingroup Elm_Animation_View_Group 162​ * @since 1.23
163​ *
164​ * @ingroup Elm_Animation_View
148 */ 165​ */
149EAPI double elm_animation_view_speed_get(const Efl_Ui_Animation_View *obj); 166​EAPI double elm_animation_view_speed_get(const Elm_Animation_View *obj);
150 167​
151/** 168​/**
152 * @brief Get the duration of animation in seconds. 169​ * @brief Get the duration of animation in seconds.
153 * 170​ *
154 * This API returns total duration time of current animation in the seconds. If 171​ * This API returns total duration time of current animation in the seconds. If
155 * current animation source isn't animatable, it returns zero. 172​ * current animation source isn't animatable, it returns zero.
156 * 173​ *
157 * @param[in] obj The object. 174​ * @param[in] obj The object.
158 * 175​ *
159 * @return duration time in the seconds 176​ * @return duration time in the seconds
160 * 177​ *
161 * @ingroup Elm_Animation_View_Group 178​ * @since 1.23
179​ *
180​ * @ingroup Elm_Animation_View
162 */ 181​ */
163EAPI double elm_animation_view_duration_time_get(const Efl_Ui_Animation_View *obj); 182​EAPI double elm_animation_view_duration_time_get(const Elm_Animation_View *obj);
164 183​
165/** 184​/**
166 * @brief Set current progress position of animation view. 185​ * @brief Set current progress position of animation view.
167 * 186​ *
168 * When you required to jump on a certain frame instantly, you can change 187​ * When you required to jump on a certain frame instantly, you can change
169 * current position by using this API. 188​ * current position by using this API.
170 * 189​ *
171 * @warning The range of progress is 0 ~ 1. 190​ * @warning The range of progress is 0 ~ 1.
172 * 191​ *
173 * @param[in] obj The object. 192​ * @param[in] obj The object.
174 * @param[in] progress Progress position. Value must be 0 ~ 1. 193​ * @param[in] progress Progress position. Value must be 0 ~ 1.
175 * 194​ *
176 * @ingroup Elm_Animation_View_Group 195​ * @since 1.23
196​ *
197​ * @ingroup Elm_Animation_View
177 */ 198​ */
178EAPI void elm_animation_view_progress_set(Efl_Ui_Animation_View *obj, double progress); 199​EAPI void elm_animation_view_progress_set(Elm_Animation_View *obj, double progress);
179 200​
180/** 201​/**
181 * @brief Set current progress position of animation view. 202​ * @brief Set current progress position of animation view.
182 * 203​ *
183 * When you required to jump on a certain frame instantly, you can change 204​ * When you required to jump on a certain frame instantly, you can change
184 * current position by using this API. 205​ * current position by using this API.
185 * 206​ *
186 * @warning The range of progress is 0 ~ 1. 207​ * @warning The range of progress is 0 ~ 1.
187 * 208​ *
188 * @param[in] obj The object. 209​ * @param[in] obj The object.
189 * 210​ *
190 * @return Progress position. Value must be 0 ~ 1. 211​ * @return Progress position. Value must be 0 ~ 1.
191 * 212​ *
192 * @ingroup Elm_Animation_View_Group 213​ * @since 1.23
214​ *
215​ * @ingroup Elm_Animation_View
193 */ 216​ */
194EAPI double elm_animation_view_progress_get(const Efl_Ui_Animation_View *obj); 217​EAPI double elm_animation_view_progress_get(const Elm_Animation_View *obj);
195 218​
196/** 219​/**
197 * @brief Number of current frame. 220​ * @brief Number of current frame.
198 * 221​ *
199 * Ranges from 0 to frame_count - 1. 222​ * Ranges from 0 to frame_count - 1.
200 * 223​ *
201 * Set the current frame of an animation view object. 224​ * Set the current frame of an animation view object.
202 * 225​ *
203 * @param[in] obj The object. 226​ * @param[in] obj The object.
204 * @param[in] frame_num Current frame number. 227​ * @param[in] frame_num Current frame number.
205 * 228​ *
206 * @ingroup Elm_Animation_View_Group 229​ * @since 1.23
230​ *
231​ * @ingroup Elm_Animation_View
207 */ 232​ */
208EAPI void elm_animation_view_frame_set(Efl_Ui_Animation_View *obj, int frame_num); 233​EAPI void elm_animation_view_frame_set(Elm_Animation_View *obj, int frame_num);
209 234​
210/** 235​/**
211 * @brief Number of current frame. 236​ * @brief Number of current frame.
212 * 237​ *
213 * Ranges from 0 to frame_count - 1. 238​ * Ranges from 0 to frame_count - 1.
214 * 239​ *
215 * @param[in] obj The object. 240​ * @param[in] obj The object.
216 * 241​ *
217 * @return Current frame number. 242​ * @return Current frame number.
218 * 243​ *
219 * @ingroup Elm_Animation_View_Group 244​ * @since 1.23
245​ *
246​ * @ingroup Elm_Animation_View
220 */ 247​ */
221EAPI int elm_animation_view_frame_get(const Efl_Ui_Animation_View *obj); 248​EAPI int elm_animation_view_frame_get(const Elm_Animation_View *obj);
222 249​
223/** 250​/**
224 * @brief Play animation one time instantly when it's available. 251​ * @brief Play animation one time instantly when it's available.
225 * 252​ *
226 * If current keyframe is on a certain position by playing back, this will play 253​ * If current keyframe is on a certain position by playing back, this will play
227 * forward from there. 254​ * forward from there.
228 * 255​ *
229 * @warning Play request will be ignored if animation source is not set yet or 256​ * @warning Play request will be ignored if animation source is not set yet or
230 * animation is paused state or it's already on playing. 257​ * animation is paused state or it's already on playing.
231 * 258​ *
232 * @param[in] obj The object. 259​ * @param[in] obj The object.
233 * 260​ *
234 * @return @c true when it's successful. @c false otherwise. 261​ * @return @c true when it's successful. @c false otherwise.
235 * 262​ *
236 * @ingroup Elm_Animation_View_Group 263​ * @since 1.23
264​ *
265​ * @ingroup Elm_Animation_View
237 */ 266​ */
238EAPI Eina_Bool elm_animation_view_play(Efl_Ui_Animation_View *obj); 267​EAPI Eina_Bool elm_animation_view_play(Elm_Animation_View *obj);
239 268​
240/** 269​/**
241 * @brief Play back animation one time instantly when it's available. 270​ * @brief Play back animation one time instantly when it's available.
242 * 271​ *
243 * If current keyframe is on a certain position by playing, this will play 272​ * If current keyframe is on a certain position by playing, this will play
244 * backward from there. 273​ * backward from there.
245 * 274​ *
246 * @warning Play back request will be ignored if animation source is not set 275​ * @warning Play back request will be ignored if animation source is not set
247 * yet or animation is paused state or it's already on playing back. 276​ * yet or animation is paused state or it's already on playing back.
248 * 277​ *
249 * @param[in] obj The object. 278​ * @param[in] obj The object.
250 * 279​ *
251 * @return @c true when it's successful. @c false otherwise. 280​ * @return @c true when it's successful. @c false otherwise.
252 * 281​ *
253 * @ingroup Elm_Animation_View_Group 282​ * @since 1.23
283​ *
284​ * @ingroup Elm_Animation_View
254 */ 285​ */
255EAPI Eina_Bool elm_animation_view_play_back(Efl_Ui_Animation_View *obj); 286​EAPI Eina_Bool elm_animation_view_play_back(Elm_Animation_View *obj);
256 287​
257/** 288​/**
258 * @brief Pause current animation instantly. 289​ * @brief Pause current animation instantly.
259 * 290​ *
260 * Once animation is paused, animation view must get resume to play continue 291​ * Once animation is paused, animation view must get resume to play continue
261 * again. 292​ * again.
262 * 293​ *
263 * @warning Animation must be on playing or playing back status. 294​ * @warning Animation must be on playing or playing back status.
264 * 295​ *
265 * @param[in] obj The object. 296​ * @param[in] obj The object.
266 * 297​ *
267 * @return @c true when it's successful. @c false otherwise. 298​ * @return @c true when it's successful. @c false otherwise.
268 * 299​ *
269 * @ingroup Elm_Animation_View_Group 300​ * @since 1.23
301​ *
302​ * @ingroup Elm_Animation_View
270 */ 303​ */
271EAPI Eina_Bool elm_animation_view_pause(Efl_Ui_Animation_View *obj); 304​EAPI Eina_Bool elm_animation_view_pause(Elm_Animation_View *obj);
272 305​
273/** 306​/**
274 * @brief Resume paused animation to continue animation. 307​ * @brief Resume paused animation to continue animation.
275 * 308​ *
276 * @warning This resume must be called on animation paused status. 309​ * @warning This resume must be called on animation paused status.
277 * 310​ *
278 * @param[in] obj The object. 311​ * @param[in] obj The object.
279 * 312​ *
280 * @return @c true when it's successful. @c false otherwise. 313​ * @return @c true when it's successful. @c false otherwise.
281 * 314​ *
282 * @ingroup Elm_Animation_View_Group 315​ * @since 1.23
316​ *
317​ * @ingroup Elm_Animation_View
283 */ 318​ */
284EAPI Eina_Bool elm_animation_view_resume(Efl_Ui_Animation_View *obj); 319​EAPI Eina_Bool elm_animation_view_resume(Elm_Animation_View *obj);
285 320​
286/** 321​/**
287 * @brief Stop playing animation. 322​ * @brief Stop playing animation.
288 * 323​ *
289 * Stop animation instatly regardless of it's status and reset to show first 324​ * Stop animation instatly regardless of it's status and reset to show first
290 * frame of animation. Even though current animation is paused, the animation 325​ * frame of animation. Even though current animation is paused, the animation
291 * status will be stopped. 326​ * status will be stopped.
292 * 327​ *
293 * @param[in] obj The object. 328​ * @param[in] obj The object.
294 * 329​ *
295 * @return @c true when it's successful. @c false otherwise. 330​ * @return @c true when it's successful. @c false otherwise.
296 * 331​ *
297 * @ingroup Elm_Animation_View_Group 332​ * @since 1.23
333​ *
334​ * @ingroup Elm_Animation_View
298 */ 335​ */
299EAPI Eina_Bool elm_animation_view_stop(Efl_Ui_Animation_View *obj); 336​EAPI Eina_Bool elm_animation_view_stop(Elm_Animation_View *obj);
300 337​
301/** Get the default view size that specified from vector resource. 338​/** Get the default view size that specified from vector resource.
302 * 339​ *
303 * @since 1.22 340​ * @since 1.23
304 * 341​ *
305 * @ingroup Elm_Animation_View_Group 342​ * @ingroup Elm_Animation_View
306 */ 343​ */
307EAPI Eina_Size2D elm_animation_view_default_size_get(const Efl_Ui_Animation_View *obj); 344​EAPI Eina_Size2D elm_animation_view_default_size_get(const Elm_Animation_View *obj);
308 345​
309 346​
310/** 347​/**
311 * @brief Returns the status whether current animation is on playing forward or 348​ * @brief Returns the status whether current animation is on playing forward or
312 * backward. warning: If animation view is not on playing, it will return 349​ * backward. warning: If animation view is not on playing, it will return
313 * @c false. 350​ * @c false.
314 * 351​ *
315 * @param[in] obj The object. 352​ * @param[in] obj The object.
316 * 353​ *
317 * @return @c true, if animation on playing back, @c false otherwise. 354​ * @return @c true, if animation on playing back, @c false otherwise.
318 * 355​ *
319 * @since 1.22 356​ * @since 1.23
320 * 357​ *
321 * @ingroup Elm_Animation_View_Group 358​ * @ingroup Elm_Animation_View
322 */ 359​ */
323EAPI Eina_Bool elm_animation_view_is_playing_back(Efl_Ui_Animation_View *obj); 360​EAPI Eina_Bool elm_animation_view_is_playing_back(Elm_Animation_View *obj);
324 361​
325/** 362​/**
326 * @brief Get the index of end frame of the animation view, if it's animated. 363​ * @brief Get the index of end frame of the animation view, if it's animated.
327 * note : frame number starts with 0. 364​ * note : frame number starts with 0.
328 * 365​ *
329 * @param[in] obj The object. 366​ * @param[in] obj The object.
330 * 367​ *
331 * @return The number of frames. 0, if it's not animated. 368​ * @return The number of frames. 0, if it's not animated.
332 * 369​ *
333 * @since 1.22 370​ * @since 1.23
334 * 371​ *
335 * @ingroup Elm_Animation_View_Group 372​ * @ingroup Elm_Animation_View
336 */ 373​ */
337EAPI int elm_animation_view_frame_count_get(const Efl_Ui_Animation_View *obj); 374​EAPI int elm_animation_view_frame_count_get(const Elm_Animation_View *obj);
338 375​
339/** 376​/**
340 * @brief The start progress of the play. Default value is 0. 377​ * @brief The start progress of the play. Default value is 0.
341 * 378​ *
342 * Set start progress of an animation object. 379​ * Set start progress of an animation object.
343 * 380​ *
344 * @param[in] obj The object. 381​ * @param[in] obj The object.
345 * @param[in] min_progress The minimum progress. Value must be 0 ~ 1. 382​ * @param[in] min_progress The minimum progress. Value must be 0 ~ 1.
346 * 383​ *
347 * @since 1.22 384​ * @since 1.23
348 * 385​ *
349 * @ingroup Elm_Animation_View_Group 386​ * @ingroup Elm_Animation_View
350 */ 387​ */
351EAPI void elm_animation_view_min_progress_set(Efl_Ui_Animation_View *obj, double min_progress); 388​EAPI void elm_animation_view_min_progress_set(Elm_Animation_View *obj, double min_progress);
352 389​
353/** 390​/**
354 * @brief The start progress of the play. Default value is 0. 391​ * @brief The start progress of the play. Default value is 0.
355 * 392​ *
356 * Returns start progress of an animation object. 393​ * Returns start progress of an animation object.
357 * 394​ *
358 * @param[in] obj The object. 395​ * @param[in] obj The object.
359 * 396​ *
360 * @return The minimum progress. Value must be 0 ~ 1. 397​ * @return The minimum progress. Value must be 0 ~ 1.
361 * 398​ *
362 * @since 1.22 399​ * @since 1.23
363 * 400​ *
364 * @ingroup Elm_Animation_View_Group 401​ * @ingroup Elm_Animation_View
365 */ 402​ */
366EAPI double elm_animation_view_min_progress_get(const Efl_Ui_Animation_View *obj); 403​EAPI double elm_animation_view_min_progress_get(const Elm_Animation_View *obj);
367 404​
368/** 405​/**
369 * @brief The last progress of the play. Default value is 1. 406​ * @brief The last progress of the play. Default value is 1.
370 * 407​ *
371 * Set last progress of an animation object. 408​ * Set last progress of an animation object.
372 * 409​ *
373 * @param[in] obj The object. 410​ * @param[in] obj The object.
374 * @param[in] max_progress The maximum progress. Value must be 0 ~ 1. 411​ * @param[in] max_progress The maximum progress. Value must be 0 ~ 1.
375 * 412​ *
376 * @since 1.22 413​ * @since 1.23
377 * 414​ *
378 * @ingroup Elm_Animation_View_Group 415​ * @ingroup Elm_Animation_View
379 */ 416​ */
380EAPI void elm_animation_view_max_progress_set(Efl_Ui_Animation_View *obj, double max_progress); 417​EAPI void elm_animation_view_max_progress_set(Elm_Animation_View *obj, double max_progress);
381 418​
382/** 419​/**
383 * @brief The last progress of the play. Default value is 1. 420​ * @brief The last progress of the play. Default value is 1.
384 * 421​ *
385 * Returns last progress of an animation object. 422​ * Returns last progress of an animation object.
386 * 423​ *
387 * @param[in] obj The object. 424​ * @param[in] obj The object.
388 * 425​ *
389 * @return The maximum progress. Value must be 0 ~ 1. 426​ * @return The maximum progress. Value must be 0 ~ 1.
390 * 427​ *
391 * @since 1.22 428​ * @since 1.23
392 * 429​ *
393 * @ingroup Elm_Animation_View_Group 430​ * @ingroup Elm_Animation_View
394 */ 431​ */
395EAPI double elm_animation_view_max_progress_get(const Efl_Ui_Animation_View *obj); 432​EAPI double elm_animation_view_max_progress_get(const Elm_Animation_View *obj);
396 433​
397/** 434​/**
398 * @brief The start frame of the play. Default value is 0. 435​ * @brief The start frame of the play. Default value is 0.
399 * 436​ *
400 * Set minimum frame of an animation object. 437​ * Set minimum frame of an animation object.
401 * 438​ *
402 * @param[in] obj The object. 439​ * @param[in] obj The object.
403 * @param[in] min_frame The minimum frame for play. Value must be 0 ~ 440​ * @param[in] min_frame The minimum frame for play. Value must be 0 ~
404 * @ref elm_animation_view_max_frame_get 441​ * @ref elm_animation_view_max_frame_get
405 * 442​ *
406 * @since 1.22 443​ * @since 1.23
407 * 444​ *
408 * @ingroup Elm_Animation_View_Group 445​ * @ingroup Elm_Animation_View
409 */ 446​ */
410EAPI void elm_animation_view_min_frame_set(Efl_Ui_Animation_View *obj, int min_frame); 447​EAPI void elm_animation_view_min_frame_set(Elm_Animation_View *obj, int min_frame);
411 448​
412/** 449​/**
413 * @brief The start frame of the play. Default value is 0. 450​ * @brief The start frame of the play. Default value is 0.
414 * 451​ *
415 * Returns minimum frame of an animation object. 452​ * Returns minimum frame of an animation object.
416 * 453​ *
417 * @param[in] obj The object. 454​ * @param[in] obj The object.
418 * 455​ *
419 * @return The minimum frame for play. Value must be 0 ~ 456​ * @return The minimum frame for play. Value must be 0 ~
420 * @ref elm_animation_view_max_frame_get 457​ * @ref elm_animation_view_max_frame_get
421 * 458​ *
422 * @since 1.22 459​ * @since 1.23
423 * 460​ *
424 * @ingroup Elm_Animation_View_Group 461​ * @ingroup Elm_Animation_View
425 */ 462​ */
426EAPI int elm_animation_view_min_frame_get(const Efl_Ui_Animation_View *obj); 463​EAPI int elm_animation_view_min_frame_get(const Elm_Animation_View *obj);
427 464​
428/** 465​/**
429 * @brief The last frame of the play. Default value is 466​ * @brief The last frame of the play. Default value is
430 * @ref elm_animation_view_frame_count_get - 1 467​ * @ref elm_animation_view_frame_count_get - 1
431 * 468​ *
432 * Set maximum frame of an animation object. 469​ * Set maximum frame of an animation object.
433 * 470​ *
434 * @param[in] obj The object. 471​ * @param[in] obj The object.
435 * @param[in] max_frame The maximum frame for play. Value must be 472​ * @param[in] max_frame The maximum frame for play. Value must be
436 * @ref elm_animation_view_min_frame_get ~ (@Efl.Ui.Animation_View.frame_count 473​ * @ref elm_animation_view_min_frame_get ~ (@ref elm_animation_view_frame_count_get - 1)
437 * - 1) ​
438 * 474​ *
439 * @since 1.22 475​ * @since 1.23
440 * 476​ *
441 * @ingroup Elm_Animation_View_Group 477​ * @ingroup Elm_Animation_View
442 */ 478​ */
443EAPI void elm_animation_view_max_frame_set(Efl_Ui_Animation_View *obj, int max_frame); 479​EAPI void elm_animation_view_max_frame_set(Elm_Animation_View *obj, int max_frame);
444 480​
445/** 481​/**
446 * @brief The last frame of the play. Default value is 482​ * @brief The last frame of the play. Default value is
447 * @ref elm_animation_view_frame_count_get - 1 483​ * @ref elm_animation_view_frame_count_get - 1
448 * 484​ *
449 * Returns maximum frame of an animation object. 485​ * Returns maximum frame of an animation object.
450 * 486​ *
451 * @param[in] obj The object. 487​ * @param[in] obj The object.
452 * 488​ *
453 * @return The maximum frame for play. Value must be 489​ * @return The maximum frame for play. Value must be
454 * @ref elm_animation_view_min_frame_get ~ (@Efl.Ui.Animation_View.frame_count 490​ * @ref elm_animation_view_min_frame_get ~ (@ref elm_animation_view_frame_count_get - 1)
455 * - 1) ​
456 * 491​ *
457 * @since 1.22 492​ * @since 1.23
458 * 493​ *
459 * @ingroup Elm_Animation_View_Group 494​ * @ingroup Elm_Animation_View
460 */ 495​ */
461EAPI int elm_animation_view_max_frame_get(const Efl_Ui_Animation_View *obj); 496​EAPI int elm_animation_view_max_frame_get(const Elm_Animation_View *obj);
462 497​
463#endif 498​#endif