176 lines
4.8 KiB
C
176 lines
4.8 KiB
C
/**
|
|
* @brief Add a new label to the parent
|
|
*
|
|
* @param parent The parent object
|
|
* @return The new object or NULL if it cannot be created
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI Evas_Object *elm_label_add(Evas_Object *parent);
|
|
|
|
/**
|
|
* @brief Slide only if the
|
|
*
|
|
* @param obj The label object
|
|
* @param duration The duration in seconds in moving text from slide begin position
|
|
* to slide end position
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI void elm_label_slide_area_limit_set(Evas_Object *obj, Eina_Bool limit);
|
|
|
|
/**
|
|
* @brief Set the wrapping behavior of the label
|
|
*
|
|
* @param obj The label object
|
|
* @param wrap To wrap text or not
|
|
*
|
|
* By default no wrapping is done. Possible values for @p wrap are:
|
|
* @li ELM_WRAP_NONE - No wrapping
|
|
* @li ELM_WRAP_CHAR - wrap between characters
|
|
* @li ELM_WRAP_WORD - wrap between words
|
|
* @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap);
|
|
|
|
/**
|
|
* @brief Get the wrapping behavior of the label
|
|
*
|
|
* @param obj The label object
|
|
* @return Wrap type
|
|
*
|
|
* @see elm_label_line_wrap_set()
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set wrap width of the label
|
|
*
|
|
* @param obj The label object
|
|
* @param w The wrap width in pixels at a minimum where words need to wrap
|
|
*
|
|
* This function sets the maximum width size hint of the label.
|
|
*
|
|
* @warning This is only relevant if the label is inside a container.
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w);
|
|
|
|
/**
|
|
* @brief Get wrap width of the label
|
|
*
|
|
* @param obj The label object
|
|
* @return The wrap width in pixels at a minimum where words need to wrap
|
|
*
|
|
* @see elm_label_wrap_width_set()
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set the ellipsis behavior of the label
|
|
*
|
|
* @param obj The label object
|
|
* @param ellipsis To ellipsis text or not
|
|
*
|
|
* If set to true and the text doesn't fit in the label an ellipsis("...")
|
|
* will be shown at the end of the widget.
|
|
*
|
|
* @warning This doesn't work with slide(elm_label_slide_set()) or if the
|
|
* chosen wrap method was #ELM_WRAP_WORD.
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis);
|
|
|
|
/**
|
|
* @brief Get the ellipsis behavior of the label
|
|
*
|
|
* @param obj The label object
|
|
* @return If true, an ellipsis will be shown at the end of the label area.
|
|
*
|
|
* @see elm_label_ellipsis_set()
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI Eina_Bool elm_label_ellipsis_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set the slide mode of the label widget.
|
|
*
|
|
* @param obj The label object
|
|
* @param mode The slide mode
|
|
*
|
|
* elm_label_slide_mode_set() changes label slide mode.
|
|
* By default, slide mode is none. Possible values for @p mode are:
|
|
* @li ELM_LABEL_SLIDE_MODE_NONE - no slide effect
|
|
* @li ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than
|
|
* the text width length
|
|
* @li ELM_LABEL_SLIDE_MODE_ALWAYS -slide always
|
|
*
|
|
* @warning ELM_LABEL_SLIDE_MODE_AUTO, ELM_LABEL_SLIDE_MODE_ALWAYS only work
|
|
* with the themes "slide_short", "slide_long" and "slide_bounce".
|
|
* @warning ELM_LABEL_SLIDE_MODE_AUTO, ELM_LABEL_SLIDE_MODE_ALWAYS don't work
|
|
* if the line wrap(elm_label_line_wrap_set()) or
|
|
* ellipsis(elm_label_ellipsis_set()) is set.
|
|
*
|
|
* @see elm_label_slide_mode_get().
|
|
* @since 1.8
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI void elm_label_slide_mode_set(Evas_Object *obj, Elm_Label_Slide_Mode mode);
|
|
|
|
/**
|
|
* @brief Get the slide mode of the label widget.
|
|
*
|
|
* @param obj The label object
|
|
* @return The slide mode
|
|
*
|
|
* @see elm_label_slide_mode_set()
|
|
* @since 1.8
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI Elm_Label_Slide_Mode elm_label_slide_mode_get(const Evas_Object *obj);
|
|
/**
|
|
* @brief Set the slide duration (speed) of the label
|
|
*
|
|
* @param obj The label object
|
|
* @param duration The duration in seconds in moving text from slide begin position
|
|
* to slide end position
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration);
|
|
|
|
/**
|
|
* @brief Get the slide duration(speed) of the label
|
|
*
|
|
* @param obj The label object
|
|
* @return The duration time in moving text from slide begin position to slide end position
|
|
*
|
|
* @see elm_label_slide_duration_set()
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI double elm_label_slide_duration_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Start slide effect.
|
|
*
|
|
* @param obj The label object
|
|
*
|
|
* @see elm_label_slide_mode_set()
|
|
* @since 1.8
|
|
*
|
|
* @ingroup Label
|
|
*/
|
|
EAPI void elm_label_slide_go(Evas_Object *obj);
|