*/
typedef void (*Elm_Animator_Completion_Cb) (void *data);
+ /**
+ * @brief Create a new animator.
+ *
+ * @param[in] parent Parent object
+ *
+ * The @a parent argument can be set to NULL for no parent. If a parent is set
+ * there is no need to call elm_animator_del(), when the parent is deleted it
+ * will delete the animator.
+ * @deprecated Use @ref Transit instead.
++
+ */
EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
+ /**
+ * Deletes the animator freeing any resources it used. If the animator was
+ * created with a NULL parent this must be called, otherwise it will be
+ * automatically called when the parent is deleted.
+ *
+ * @param[in] animator Animator object
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
+ /**
+ * Set the duration of the animation.
+ *
+ * @param[in] animator Animator object
+ * @param[in] duration Duration in second
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Set the callback function for animator operation.
+ *
+ * @param[in] animator Animator object
+ * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
+ * @param[in] data Callback function user argument
+ *
+ * The @p func callback will be called with a frame value in range [0, 1] which
+ * indicates how far along the animation should be. It is the job of @p func to
+ * actually change the state of any object(or objects) that are being animated.
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
+ /**
+ * Set the callback function for the when the animation ends.
+ *
+ * @param[in] animator Animator object
+ * @param[in] func Callback function pointe
+ * @param[in] data Callback function user argument
+ *
+ * @warning @a func will not be executed if elm_animator_stop() is called.
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Stop animator.
+ *
+ * @param[in] animator Animator object
+ *
+ * If called before elm_animator_animate() it does nothing. If there is an
+ * animation in progress the animation will be stopped(the operation callback
+ * will not be executed again) and it can't be restarted using
+ * elm_animator_resume().
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
+ /**
+ * Set the animator repeat count.
+ *
+ * @param[in] animator Animator object
+ * @param[in] repeat_cnt Repeat count
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Start animation.
+ *
+ * @param[in] animator Animator object
+ *
+ * This function starts the animation if the nescessary properties(duration
+ * and operation callback) have been set. Once started the animation will
+ * run until complete or elm_animator_stop() is called.
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
+ /**
+ * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
+ *
+ * @param[in] animator Animator object
+ * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
- EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator); EINA_ARG_NONNULL(1);
+ /**
+ * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
+ *
+ * @param[in] animator Animator object
+ * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
+ * @deprecated Use @ref Transit instead.
+ */
+ EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Sets wether the animation should be automatically reversed.
+ *
+ * @param[in] animator Animator object
+ * @param[in] reverse Reverse or not
+ *
+ * This controls wether the animation will be run on reverse imediately after
+ * running forward. When this is set together with repetition the animation
+ * will run in reverse once for each time it ran forward.@n
+ * Runnin an animation in reverse is accomplished by calling the operation
+ * callback with a frame value starting at 1 and diminshing until 0.
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
+ /**
+ * Gets wether the animation will automatically reversed
+ *
+ * @param[in] animator Animator object
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
+ /**
+ * Gets the status for the animator operation. The status of the animator @b
+ * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
+ * only informs if the animation was started and has not ended(either normally
+ * or through elm_animator_stop()).
+ *
+ * @param[in] animator Animator object
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
+ /**
+ * Gets how many times the animation will be repeated
+ *
+ * @param[in] animator Animator object
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
+ /**
+ * Pause the animator.
+ *
+ * @param[in] animator Animator object
+ *
+ * This causes the animation to be temporarily stopped(the operation callback
+ * will not be called). If the animation is not yet running this is a no-op.
+ * Once an animation has been paused with this function it can be resumed
+ * using elm_animator_resume().
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
+ /**
+ * @brief Resumes the animator.
+ *
+ * @param[in] animator Animator object
+ *
+ * Resumes an animation that was paused using elm_animator_pause(), after
+ * calling this function calls to the operation callback will happen
+ * normally. If an animation is stopped by means of elm_animator_stop it
+ * @b can't be restarted with this function.@n
+ *
+ * @warning When an animation is resumed it doesn't start from where it was paused, it
+ * will go to where it would have been if it had not been paused. If an
+ * animation with a duration of 3 seconds is paused after 1 second for 1 second
+ * it will resume as if it had ben animating for 2 seconds, the operating
+ * callback will be called with a frame value of aproximately 2/3.
+ * @deprecated Use @ref Transit instead.
+ */
EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
+ /**
+ * @}
+ */
/* calendar */
typedef enum
projects / framework / uifw / elementary.git / commitdiff