Elementary migration revision 70341
[framework/uifw/elementary.git] / src / lib / elm_transit.h
1 /**
2  * @defgroup Transit Transit
3  * @ingroup Elementary
4  *
5  * Transit is designed to apply various animated transition effects to @c
6  * Evas_Object, such like translation, rotation, etc. For using these
7  * effects, create an @ref Elm_Transit and add the desired transition effects.
8  *
9  * Once the effects are added into transit, they will be automatically
10  * managed (their callback will be called for the set duration and
11  * they will be deleted upon completion).
12  *
13  * Example:
14  * @code
15  * Elm_Transit *trans = elm_transit_add();
16  * elm_transit_object_add(trans, obj);
17  * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
18  * elm_transit_duration_set(transit, 1);
19  * elm_transit_auto_reverse_set(transit, EINA_TRUE);
20  * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
21  * elm_transit_repeat_times_set(transit, 3);
22  * @endcode
23  *
24  * Some transition effects are used to change the properties of objects. They
25  * are:
26  * @li @ref elm_transit_effect_translation_add
27  * @li @ref elm_transit_effect_color_add
28  * @li @ref elm_transit_effect_rotation_add
29  * @li @ref elm_transit_effect_wipe_add
30  * @li @ref elm_transit_effect_zoom_add
31  * @li @ref elm_transit_effect_resizing_add
32  *
33  * Other transition effects are used to make one object disappear and another
34  * object appear on its place. These effects are:
35  *
36  * @li @ref elm_transit_effect_flip_add
37  * @li @ref elm_transit_effect_resizable_flip_add
38  * @li @ref elm_transit_effect_fade_add
39  * @li @ref elm_transit_effect_blend_add
40  *
41  * It's also possible to make a transition chain with @ref
42  * elm_transit_chain_transit_add.
43  *
44  * @warning We strongly recommend to use elm_transit just when edje can not do
45  * the trick. Edje is better at handling transitions than Elm_Transit.
46  * Edje has more flexibility and animations can be manipulated inside the theme.
47  *
48  * List of examples:
49  * @li @ref transit_example_01_explained
50  * @li @ref transit_example_02_explained
51  * @li @ref transit_example_03_c
52  * @li @ref transit_example_04_c
53  *
54  * @{
55  */
56
57 /**
58  * @enum Elm_Transit_Tween_Mode
59  *
60  * The type of acceleration used in the transition.
61  */
62 typedef enum
63 {
64    ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
65    ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
66                                          over time, then decrease again
67                                          and stop slowly */
68    ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
69                                          speed over time */
70    ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
71                                         over time */
72 } Elm_Transit_Tween_Mode;
73
74 /**
75  * @enum Elm_Transit_Effect_Flip_Axis
76  *
77  * The axis along which flip effect should be applied.
78  */
79 typedef enum
80 {
81    ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
82    ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
83 } Elm_Transit_Effect_Flip_Axis;
84
85 /**
86  * @enum Elm_Transit_Effect_Wipe_Dir
87  *
88  * The direction in which the wipe effect should occur.
89  */
90 typedef enum
91 {
92    ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
93    ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
94    ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
95    ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
96 } Elm_Transit_Effect_Wipe_Dir;
97
98 /** @enum Elm_Transit_Effect_Wipe_Type
99  *
100  * Whether the wipe effect should show or hide the object.
101  */
102 typedef enum
103 {
104    ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
105                                          animation */
106    ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
107                                         animation */
108 } Elm_Transit_Effect_Wipe_Type;
109
110 /**
111  * @typedef Elm_Transit
112  *
113  * The Transit created with elm_transit_add(). This type has the information
114  * about the objects which the transition will be applied, and the
115  * transition effects that will be used. It also contains info about
116  * duration, number of repetitions, auto-reverse, etc.
117  */
118 typedef struct _Elm_Transit Elm_Transit;
119 typedef void                Elm_Transit_Effect;
120
121 /**
122  * @typedef Elm_Transit_Effect_Transition_Cb
123  *
124  * Transition callback called for this effect on each transition iteration.
125  */
126 typedef void (*Elm_Transit_Effect_Transition_Cb)(Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
127
128 /**
129  * Elm_Transit_Effect_End_Cb
130  *
131  * Transition callback called for this effect when the transition is over.
132  */
133 typedef void (*Elm_Transit_Effect_End_Cb)(Elm_Transit_Effect *effect, Elm_Transit *transit);
134
135 /**
136  * Elm_Transit_Del_Cb
137  *
138  * A callback called when the transit is deleted.
139  */
140 typedef void (*Elm_Transit_Del_Cb)(void *data, Elm_Transit *transit);
141
142 /**
143  * Create new transit.
144  *
145  * @note It is not necessary to delete the transit object, it will be deleted at
146  * the end of its operation.
147  * @note The transit will start playing when the program enters the main loop.
148  *
149  * @return The transit object.
150  *
151  * @ingroup Transit
152  */
153 EAPI Elm_Transit           *elm_transit_add(void);
154
155 /**
156  * Stops the animation and delete the @p transit object.
157  *
158  * Call this function if you want to stop the animation before the
159  * transit time. Make sure the @p transit object is still alive with
160  * elm_transit_del_cb_set() function.
161  * All added effects will be deleted, calling its respective data_free_cb
162  * functions. The function set by elm_transit_del_cb_set() will be called.
163  *
164  * @see elm_transit_del_cb_set()
165  *
166  * @param transit The transit object to be deleted.
167  *
168  * @ingroup Transit
169  */
170 EAPI void                   elm_transit_del(Elm_Transit *transit);
171
172 /**
173  * Add a new effect to the transit.
174  *
175  * @note The cb function and the data are the key to the effect.
176  * If you try to add an existing effect, nothing is done.
177  * @note After the first addition of an effect to @p transit, if its
178  * effect list become empty again, the @p transit will be killed by
179  * elm_transit_del(transit) function.
180  *
181  * Example:
182  * @code
183  * Elm_Transit *transit = elm_transit_add();
184  * elm_transit_effect_add(transit,
185  *                        elm_transit_effect_blend_op,
186  *                        elm_transit_effect_blend_context_new(),
187  *                        elm_transit_effect_blend_context_free);
188  * @endcode
189  *
190  * @param transit The transit object.
191  * @param transition_cb The operation function. It is called when the
192  * animation begins, it is the function that actually performs the animation.
193  * It is called with the @p data, @p transit and the time progression of the
194  * animation (a double value between 0.0 and 1.0).
195  * @param effect The context data of the effect.
196  * @param end_cb The function to free the context data, it will be called
197  * at the end of the effect, it must finalize the animation and free the
198  * @p data.
199  *
200  * @ingroup Transit
201  * @warning The transit will free the context data at the and of the
202  * transition with the data_free_cb function.
203  * Do not share the context data in between different transit objects.
204  */
205 EAPI void                   elm_transit_effect_add(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect, Elm_Transit_Effect_End_Cb end_cb);
206
207 /**
208  * Delete an added effect.
209  *
210  * This function will remove the effect from the @p transit, calling the
211  * data_free_cb to free the @p data.
212  *
213  * @see elm_transit_effect_add()
214  *
215  * @note If the effect is not found, nothing is done.
216  * @note If the effect list become empty, this function will call
217  * elm_transit_del(transit), i.e., it will kill the @p transit.
218  *
219  * @param transit The transit object.
220  * @param transition_cb The operation function.
221  * @param effect The context data of the effect.
222  *
223  * @ingroup Transit
224  */
225 EAPI void                   elm_transit_effect_del(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect);
226
227 /**
228  * Add new object to apply the effects.
229  *
230  * @note After the first addition of an object to @p transit, if its
231  * object list become empty again, the @p transit will be killed by
232  * elm_transit_del(transit) function.
233  * @note If the @p obj belongs to another transit, the @p obj will be
234  * removed from it and it will only belong to the other @p transit.
235  * If the old transit stays without objects, it will die.
236  * @note When you add an object into the @p transit, its state from
237  * evas_object_pass_events_get(obj) is saved, and it is applied when the
238  * transit ends, if you change this state with evas_object_pass_events_set()
239  * after add the object, this state will change again when @p transit stops.
240  *
241  * @param transit The transit object.
242  * @param obj Object to be animated.
243  *
244  * @ingroup Transit
245  * @warning It is not allowed to add a new object after transit begins.
246  */
247 EAPI void                   elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj);
248
249 /**
250  * Removes an added object from the transit.
251  *
252  * @note If the @p obj is not in the @p transit, nothing is done.
253  * @note If the list become empty, this function will call
254  * elm_transit_del(transit), i.e., it will kill the @p transit.
255  *
256  * @param transit The transit object.
257  * @param obj Object to be removed from @p transit.
258  *
259  * @ingroup Transit
260  * @warning It is not allowed to remove objects after transit begins.
261  */
262 EAPI void                   elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj);
263
264 /**
265  * Get the objects of the transit.
266  *
267  * @param transit The transit object.
268  * @return a Eina_List with the objects from the transit.
269  *
270  * @ingroup Transit
271  */
272 EAPI const Eina_List       *elm_transit_objects_get(const Elm_Transit *transit);
273
274 /**
275  * Enable/disable keeping up the objects states.
276  * If it is not kept, the objects states will be reset when transition ends.
277  *
278  * @note @p transit can not be NULL.
279  * @note One state includes geometry, color, map data.
280  *
281  * @param transit The transit object.
282  * @param state_keep retain the state or not.
283  *
284  * @ingroup Transit
285  */
286 EAPI void                   elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep);
287
288 /**
289  * Get a value whether the objects states will be reset or not.
290  *
291  * @note @p transit can not be NULL
292  *
293  * @see elm_transit_objects_final_state_keep_set()
294  *
295  * @param transit The transit object.
296  * @return EINA_TRUE means the states of the objects will be reset.
297  * If @p transit is NULL, EINA_FALSE is returned
298  *
299  * @ingroup Transit
300  */
301 EAPI Eina_Bool              elm_transit_objects_final_state_keep_get(const Elm_Transit *transit);
302
303 /**
304  * Set the event enabled when transit is operating.
305  *
306  * If @p enabled is EINA_TRUE, the objects of the transit will receive
307  * events from mouse and keyboard during the animation.
308  * @note When you add an object with elm_transit_object_add(), its state from
309  * evas_object_freeze_events_get(obj) is saved, and it is applied when the
310  * transit ends. If you change this state with evas_object_freeze_events_set()
311  * after adding the object, this state will change again when @p transit stops
312  * to run.
313  *
314  * @param transit The transit object.
315  * @param enabled Events are received when enabled is @c EINA_TRUE, and
316  * ignored otherwise.
317  *
318  * @ingroup Transit
319  */
320 EAPI void                   elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled);
321
322 /**
323  * Get the value of event enabled status.
324  *
325  * @see elm_transit_event_enabled_set()
326  *
327  * @param transit The Transit object
328  * @return EINA_TRUE, when event is enabled. If @p transit is NULL
329  * EINA_FALSE is returned
330  *
331  * @ingroup Transit
332  */
333 EAPI Eina_Bool              elm_transit_event_enabled_get(const Elm_Transit *transit);
334
335 /**
336  * Set the user-callback function when the transit is deleted.
337  *
338  * @note Using this function twice will overwrite the first function set.
339  * @note the @p transit object will be deleted after call @p cb function.
340  *
341  * @param transit The transit object.
342  * @param cb Callback function pointer. This function will be called before
343  * the deletion of the transit.
344  * @param data Callback function user data. It is the @p op parameter.
345  *
346  * @ingroup Transit
347  */
348 EAPI void                   elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data);
349
350 /**
351  * Set reverse effect automatically.
352  *
353  * If auto reverse is set, after running the effects with the progress
354  * parameter from 0 to 1, it will call the effects again with the progress
355  * from 1 to 0. The transit will last for a time equal to (2 * duration * repeat),
356  * where the duration was set with the function elm_transit_add and
357  * the repeat with the function elm_transit_repeat_times_set().
358  *
359  * @param transit The transit object.
360  * @param reverse EINA_TRUE means the auto_reverse is on.
361  *
362  * @ingroup Transit
363  */
364 EAPI void                   elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse);
365
366 /**
367  * Get if the auto reverse is on.
368  *
369  * @see elm_transit_auto_reverse_set()
370  *
371  * @param transit The transit object.
372  * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
373  * EINA_FALSE is returned
374  *
375  * @ingroup Transit
376  */
377 EAPI Eina_Bool              elm_transit_auto_reverse_get(const Elm_Transit *transit);
378
379 /**
380  * Set the transit repeat count. Effect will be repeated by repeat count.
381  *
382  * This function sets the number of repetition the transit will run after
383  * the first one, i.e., if @p repeat is 1, the transit will run 2 times.
384  * If the @p repeat is a negative number, it will repeat infinite times.
385  *
386  * @note If this function is called during the transit execution, the transit
387  * will run @p repeat times, ignoring the times it already performed.
388  *
389  * @param transit The transit object
390  * @param repeat Repeat count
391  *
392  * @ingroup Transit
393  */
394 EAPI void                   elm_transit_repeat_times_set(Elm_Transit *transit, int repeat);
395
396 /**
397  * Get the transit repeat count.
398  *
399  * @see elm_transit_repeat_times_set()
400  *
401  * @param transit The Transit object.
402  * @return The repeat count. If @p transit is NULL
403  * 0 is returned
404  *
405  * @ingroup Transit
406  */
407 EAPI int                    elm_transit_repeat_times_get(const Elm_Transit *transit);
408
409 /**
410  * Set the transit animation acceleration type.
411  *
412  * This function sets the tween mode of the transit that can be:
413  * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
414  * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
415  * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
416  * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
417  *
418  * @param transit The transit object.
419  * @param tween_mode The tween type.
420  *
421  * @ingroup Transit
422  */
423 EAPI void                   elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode);
424
425 /**
426  * Get the transit animation acceleration type.
427  *
428  * @note @p transit can not be NULL
429  *
430  * @param transit The transit object.
431  * @return The tween type. If @p transit is NULL
432  * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
433  *
434  * @ingroup Transit
435  */
436 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit);
437
438 /**
439  * Set the transit animation time
440  *
441  * @note @p transit can not be NULL
442  *
443  * @param transit The transit object.
444  * @param duration The animation time.
445  *
446  * @ingroup Transit
447  */
448 EAPI void                   elm_transit_duration_set(Elm_Transit *transit, double duration);
449
450 /**
451  * Get the transit animation time
452  *
453  * @note @p transit can not be NULL
454  *
455  * @param transit The transit object.
456  *
457  * @return The transit animation time.
458  *
459  * @ingroup Transit
460  */
461 EAPI double                 elm_transit_duration_get(const Elm_Transit *transit);
462
463 /**
464  * Starts the transition.
465  * Once this API is called, the transit begins to measure the time.
466  *
467  * @note @p transit can not be NULL
468  *
469  * @param transit The transit object.
470  *
471  * @ingroup Transit
472  */
473 EAPI void                   elm_transit_go(Elm_Transit *transit);
474
475 /**
476  * Pause/Resume the transition.
477  *
478  * If you call elm_transit_go again, the transit will be started from the
479  * beginning, and will be played.
480  *
481  * @note @p transit can not be NULL
482  *
483  * @param transit The transit object.
484  * @param paused Whether the transition should be paused or not.
485  *
486  * @ingroup Transit
487  */
488 EAPI void                   elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused);
489
490 /**
491  * Get the value of paused status.
492  *
493  * @see elm_transit_paused_set()
494  *
495  * @note @p transit can not be NULL
496  *
497  * @param transit The transit object.
498  * @return EINA_TRUE means transition is paused. If @p transit is NULL
499  * EINA_FALSE is returned
500  *
501  * @ingroup Transit
502  */
503 EAPI Eina_Bool              elm_transit_paused_get(const Elm_Transit *transit);
504
505 /**
506  * Get the time progression of the animation (a double value between 0.0 and 1.0).
507  *
508  * The value returned is a fraction (current time / total time). It
509  * represents the progression position relative to the total.
510  *
511  * @note @p transit can not be NULL
512  *
513  * @param transit The transit object.
514  *
515  * @return The time progression value. If @p transit is NULL
516  * 0 is returned
517  *
518  * @ingroup Transit
519  */
520 EAPI double                 elm_transit_progress_value_get(const Elm_Transit *transit);
521
522 /**
523  * Makes the chain relationship between two transits.
524  *
525  * @note @p transit can not be NULL. Transit would have multiple chain transits.
526  * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
527  *
528  * @param transit The transit object.
529  * @param chain_transit The chain transit object. This transit will be operated
530  *        after transit is done.
531  *
532  * This function adds @p chain_transit transition to a chain after the @p
533  * transit, and will be started as soon as @p transit ends. See @ref
534  * transit_example_02_explained for a full example.
535  *
536  * @ingroup Transit
537  */
538 EAPI void                   elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit);
539
540 /**
541  * Cut off the chain relationship between two transits.
542  *
543  * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
544  * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
545  *
546  * @param transit The transit object.
547  * @param chain_transit The chain transit object.
548  *
549  * This function remove the @p chain_transit transition from the @p transit.
550  *
551  * @ingroup Transit
552  */
553 EAPI void                   elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit);
554
555 /**
556  * Get the current chain transit list.
557  *
558  * @note @p transit can not be NULL.
559  *
560  * @param transit The transit object.
561  * @return chain transit list.
562  *
563  * @ingroup Transit
564  */
565 EAPI Eina_List             *elm_transit_chain_transits_get(const Elm_Transit *transit);
566
567 /**
568  * Add the Resizing Effect to Elm_Transit.
569  *
570  * @note This API is one of the facades. It creates resizing effect context
571  * and add it's required APIs to elm_transit_effect_add.
572  *
573  * @see elm_transit_effect_add()
574  *
575  * @param transit Transit object.
576  * @param from_w Object width size when effect begins.
577  * @param from_h Object height size when effect begins.
578  * @param to_w Object width size when effect ends.
579  * @param to_h Object height size when effect ends.
580  * @return Resizing effect context data.
581  *
582  * @ingroup Transit
583  */
584 EAPI Elm_Transit_Effect    *elm_transit_effect_resizing_add(Elm_Transit *transit, Evas_Coord from_w, Evas_Coord from_h, Evas_Coord to_w, Evas_Coord to_h);
585
586 /**
587  * Add the Translation Effect to Elm_Transit.
588  *
589  * @note This API is one of the facades. It creates translation effect context
590  * and add it's required APIs to elm_transit_effect_add.
591  *
592  * @see elm_transit_effect_add()
593  *
594  * @param transit Transit object.
595  * @param from_dx X Position variation when effect begins.
596  * @param from_dy Y Position variation when effect begins.
597  * @param to_dx X Position variation when effect ends.
598  * @param to_dy Y Position variation when effect ends.
599  * @return Translation effect context data.
600  *
601  * @ingroup Transit
602  * @warning It is highly recommended just create a transit with this effect when
603  * the window that the objects of the transit belongs has already been created.
604  * This is because this effect needs the geometry information about the objects,
605  * and if the window was not created yet, it can get a wrong information.
606  */
607 EAPI Elm_Transit_Effect    *elm_transit_effect_translation_add(Elm_Transit *transit, Evas_Coord from_dx, Evas_Coord from_dy, Evas_Coord to_dx, Evas_Coord to_dy);
608
609 /**
610  * Add the Zoom Effect to Elm_Transit.
611  *
612  * @note This API is one of the facades. It creates zoom effect context
613  * and add it's required APIs to elm_transit_effect_add.
614  *
615  * @see elm_transit_effect_add()
616  *
617  * @param transit Transit object.
618  * @param from_rate Scale rate when effect begins (1 is current rate).
619  * @param to_rate Scale rate when effect ends.
620  * @return Zoom effect context data.
621  *
622  * @ingroup Transit
623  * @warning It is highly recommended just create a transit with this effect when
624  * the window that the objects of the transit belongs has already been created.
625  * This is because this effect needs the geometry information about the objects,
626  * and if the window was not created yet, it can get a wrong information.
627  */
628 EAPI Elm_Transit_Effect    *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
629
630 /**
631  * Add the Flip Effect to Elm_Transit.
632  *
633  * @note This API is one of the facades. It creates flip effect context
634  * and add it's required APIs to elm_transit_effect_add.
635  * @note This effect is applied to each pair of objects in the order they are listed
636  * in the transit list of objects. The first object in the pair will be the
637  * "front" object and the second will be the "back" object.
638  *
639  * @see elm_transit_effect_add()
640  *
641  * @param transit Transit object.
642  * @param axis Flipping Axis(X or Y).
643  * @param cw Flipping Direction. EINA_TRUE is clock-wise.
644  * @return Flip effect context data.
645  *
646  * @ingroup Transit
647  * @warning It is highly recommended just create a transit with this effect when
648  * the window that the objects of the transit belongs has already been created.
649  * This is because this effect needs the geometry information about the objects,
650  * and if the window was not created yet, it can get a wrong information.
651  */
652 EAPI Elm_Transit_Effect    *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
653
654 /**
655  * Add the Resizeable Flip Effect to Elm_Transit.
656  *
657  * @note This API is one of the facades. It creates resizable flip effect context
658  * and add it's required APIs to elm_transit_effect_add.
659  * @note This effect is applied to each pair of objects in the order they are listed
660  * in the transit list of objects. The first object in the pair will be the
661  * "front" object and the second will be the "back" object.
662  *
663  * @see elm_transit_effect_add()
664  *
665  * @param transit Transit object.
666  * @param axis Flipping Axis(X or Y).
667  * @param cw Flipping Direction. EINA_TRUE is clock-wise.
668  * @return Resizeable flip effect context data.
669  *
670  * @ingroup Transit
671  * @warning It is highly recommended just create a transit with this effect when
672  * the window that the objects of the transit belongs has already been created.
673  * This is because this effect needs the geometry information about the objects,
674  * and if the window was not created yet, it can get a wrong information.
675  */
676 EAPI Elm_Transit_Effect    *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
677
678 /**
679  * Add the Wipe Effect to Elm_Transit.
680  *
681  * @note This API is one of the facades. It creates wipe effect context
682  * and add it's required APIs to elm_transit_effect_add.
683  *
684  * @see elm_transit_effect_add()
685  *
686  * @param transit Transit object.
687  * @param type Wipe type. Hide or show.
688  * @param dir Wipe Direction.
689  * @return Wipe effect context data.
690  *
691  * @ingroup Transit
692  * @warning It is highly recommended just create a transit with this effect when
693  * the window that the objects of the transit belongs has already been created.
694  * This is because this effect needs the geometry information about the objects,
695  * and if the window was not created yet, it can get a wrong information.
696  */
697 EAPI Elm_Transit_Effect    *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
698
699 /**
700  * Add the Color Effect to Elm_Transit.
701  *
702  * @note This API is one of the facades. It creates color effect context
703  * and add it's required APIs to elm_transit_effect_add.
704  *
705  * @see elm_transit_effect_add()
706  *
707  * @param transit        Transit object.
708  * @param  from_r        RGB R when effect begins.
709  * @param  from_g        RGB G when effect begins.
710  * @param  from_b        RGB B when effect begins.
711  * @param  from_a        RGB A when effect begins.
712  * @param  to_r          RGB R when effect ends.
713  * @param  to_g          RGB G when effect ends.
714  * @param  to_b          RGB B when effect ends.
715  * @param  to_a          RGB A when effect ends.
716  * @return               Color effect context data.
717  *
718  * @ingroup Transit
719  */
720 EAPI Elm_Transit_Effect    *elm_transit_effect_color_add(Elm_Transit *transit, unsigned int from_r, unsigned int from_g, unsigned int from_b, unsigned int from_a, unsigned int to_r, unsigned int to_g, unsigned int to_b, unsigned int to_a);
721
722 /**
723  * Add the Fade Effect to Elm_Transit.
724  *
725  * @note This API is one of the facades. It creates fade effect context
726  * and add it's required APIs to elm_transit_effect_add.
727  * @note This effect is applied to each pair of objects in the order they are listed
728  * in the transit list of objects. The first object in the pair will be the
729  * "before" object and the second will be the "after" object.
730  *
731  * @see elm_transit_effect_add()
732  *
733  * @param transit Transit object.
734  * @return Fade effect context data.
735  *
736  * @ingroup Transit
737  * @warning It is highly recommended just create a transit with this effect when
738  * the window that the objects of the transit belongs has already been created.
739  * This is because this effect needs the color information about the objects,
740  * and if the window was not created yet, it can get a wrong information.
741  */
742 EAPI Elm_Transit_Effect    *elm_transit_effect_fade_add(Elm_Transit *transit);
743
744 /**
745  * Add the Blend Effect to Elm_Transit.
746  *
747  * @note This API is one of the facades. It creates blend effect context
748  * and add it's required APIs to elm_transit_effect_add.
749  * @note This effect is applied to each pair of objects in the order they are listed
750  * in the transit list of objects. The first object in the pair will be the
751  * "before" object and the second will be the "after" object.
752  *
753  * @see elm_transit_effect_add()
754  *
755  * @param transit Transit object.
756  * @return Blend effect context data.
757  *
758  * @ingroup Transit
759  * @warning It is highly recommended just create a transit with this effect when
760  * the window that the objects of the transit belongs has already been created.
761  * This is because this effect needs the color information about the objects,
762  * and if the window was not created yet, it can get a wrong information.
763  */
764 EAPI Elm_Transit_Effect    *elm_transit_effect_blend_add(Elm_Transit *transit);
765
766 /**
767  * Add the Rotation Effect to Elm_Transit.
768  *
769  * @note This API is one of the facades. It creates rotation effect context
770  * and add it's required APIs to elm_transit_effect_add.
771  *
772  * @see elm_transit_effect_add()
773  *
774  * @param transit Transit object.
775  * @param from_degree Degree when effect begins.
776  * @param to_degree Degree when effect is ends.
777  * @return Rotation effect context data.
778  *
779  * @ingroup Transit
780  * @warning It is highly recommended just create a transit with this effect when
781  * the window that the objects of the transit belongs has already been created.
782  * This is because this effect needs the geometry information about the objects,
783  * and if the window was not created yet, it can get a wrong information.
784  */
785 EAPI Elm_Transit_Effect    *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
786
787 /**
788  * Add the ImageAnimation Effect to Elm_Transit.
789  *
790  * @note This API is one of the facades. It creates image animation effect context
791  * and add it's required APIs to elm_transit_effect_add.
792  * The @p images parameter is a list images paths. This list and
793  * its contents will be deleted at the end of the effect by
794  * elm_transit_effect_image_animation_context_free() function.
795  *
796  * Example:
797  * @code
798  * char buf[PATH_MAX];
799  * Eina_List *images = NULL;
800  * Elm_Transit *transi = elm_transit_add();
801  *
802  * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
803  * images = eina_list_append(images, eina_stringshare_add(buf));
804  *
805  * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
806  * images = eina_list_append(images, eina_stringshare_add(buf));
807  * elm_transit_effect_image_animation_add(transi, images);
808  *
809  * @endcode
810  *
811  * @see elm_transit_effect_add()
812  *
813  * @param transit Transit object.
814  * @param images Eina_List of images file paths. This list and
815  * its contents will be deleted at the end of the effect by
816  * elm_transit_effect_image_animation_context_free() function.
817  * @return Image Animation effect context data.
818  *
819  * @ingroup Transit
820  */
821 EAPI Elm_Transit_Effect    *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
822 /**
823  * @}
824  */