Label doc: add a note about the conversion duration->speed and viceversa.

This commit is contained in:
Davide Andreoli 2014-02-15 12:42:07 +01:00
parent 34246e34a4
commit 4ae7078e0f
1 changed files with 13 additions and 1 deletions

View File

@ -136,6 +136,8 @@ EAPI Elm_Label_Slide_Mode elm_label_slide_mode_get(const Evas_Object *obj
* @param duration The duration in seconds in moving text from slide begin position * @param duration The duration in seconds in moving text from slide begin position
* to slide end position * to slide end position
* *
* @see elm_label_slide_speed_set()
*
* @ingroup Label * @ingroup Label
*/ */
EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration); EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration);
@ -146,6 +148,10 @@ EAPI void elm_label_slide_duration_set(Evas_Object *obj,
* @param obj The label object * @param obj The label object
* @return The duration time in moving text from slide begin position to slide end position * @return The duration time in moving text from slide begin position to slide end position
* *
* @note If you set the speed of the slide using elm_label_slide_speed_set()
* you cannot get the correct duration using this function until the label
* is actually rendered and resized.
*
* @see elm_label_slide_duration_set() * @see elm_label_slide_duration_set()
* *
* @ingroup Label * @ingroup Label
@ -157,6 +163,8 @@ EAPI double elm_label_slide_duration_get(const Evas_Object
* *
* @param obj The label object * @param obj The label object
* @param speed The speed of the slide animation in px per seconds * @param speed The speed of the slide animation in px per seconds
*
* @see elm_label_slide_duration_set()
* *
* @ingroup Label * @ingroup Label
*/ */
@ -166,7 +174,11 @@ EAPI void elm_label_slide_speed_set(Evas_Object *obj, dou
* @brief Get the slide speed of the label * @brief Get the slide speed of the label
* *
* @param obj The label object * @param obj The label object
* @return The slide animation speed in px per seconds * @return The slide animation speed in px per seconds
*
* @note If you set the duration of the slide using elm_label_slide_duration_set()
* you cannot get the correct speed using this function until the label
* is actually rendered and resized.
* *
* @see elm_label_slide_speed_set() * @see elm_label_slide_speed_set()
* *