src/lib/elm_transit.h

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