Widget to display text, with simple html-like markup. More...

Functions
EINA_DEPRECATED void	elm_label_slide_set (Evas_Object *obj, Eina_Bool slide)
	Set slide effect of label widget. More...

EINA_DEPRECATED Eina_Bool	elm_label_slide_get (const Evas_Object *obj)
	Get whether slide effect is shown or not. More...

EOAPI void	elm_obj_label_wrap_width_set (Evas_Coord w)
	Set wrap width of the label. More...

EOAPI Evas_Coord	elm_obj_label_wrap_width_get (void)
	Get wrap width of the label. More...

EOAPI void	elm_obj_label_slide_speed_set (double speed)
	Set the slide speed of the label. More...

EOAPI double	elm_obj_label_slide_speed_get (void)
	Get the slide speed of the label. More...

EOAPI void	elm_obj_label_slide_mode_set (Elm_Label_Slide_Mode mode)
	Set the slide mode of the label widget. More...

EOAPI Elm_Label_Slide_Mode	elm_obj_label_slide_mode_get (void)
	Get the slide mode of the label widget. More...

EOAPI void	elm_obj_label_slide_duration_set (double duration)
	Set the slide duration of the label. More...

EOAPI double	elm_obj_label_slide_duration_get (void)
	Get the slide duration of the label. More...

EOAPI void	elm_obj_label_line_wrap_set (Elm_Wrap_Type wrap)
	Set the wrapping behavior of the label. More...

EOAPI Elm_Wrap_Type	elm_obj_label_line_wrap_get (void)
	Get the wrapping behavior of the label. More...

EOAPI void	elm_obj_label_ellipsis_set (Eina_Bool ellipsis)
	Set the ellipsis behavior of the label. More...

EOAPI Eina_Bool	elm_obj_label_ellipsis_get (void)
	Get the ellipsis behavior of the label. More...

EOAPI void	elm_obj_label_slide_go (void)
	Start slide effect. More...

void	elm_label::slide_go () const
	Start slide effect. More...

Evas_Coord	elm_label::wrap_width_get () const
	Get wrap width of the label. More...

void	elm_label::wrap_width_set (Evas_Coord w_) const
	Get wrap width of the label. More...

double	elm_label::slide_speed_get () const
	Get the slide speed of the label. More...

void	elm_label::slide_speed_set (double speed_) const
	Get the slide speed of the label. More...

Elm_Label_Slide_Mode	elm_label::slide_mode_get () const
	Get the slide mode of the label widget. More...

void	elm_label::slide_mode_set (Elm_Label_Slide_Mode mode_) const
	Get the slide mode of the label widget. More...

double	elm_label::slide_duration_get () const
	Get the slide duration of the label. More...

void	elm_label::slide_duration_set (double duration_) const
	Get the slide duration of the label. More...

Elm_Wrap_Type	elm_label::line_wrap_get () const
	Get the wrapping behavior of the label. More...

void	elm_label::line_wrap_set (Elm_Wrap_Type wrap_) const
	Get the wrapping behavior of the label. More...

bool	elm_label::ellipsis_get () const
	Get the ellipsis behavior of the label. More...

void	elm_label::ellipsis_set (bool ellipsis_) const
	Get the ellipsis behavior of the label. More...

void	elm_label_wrap_width_set (Elm_Label *obj, Evas_Coord w)
	Set wrap width of the label. More...

Evas_Coord	elm_label_wrap_width_get (const Elm_Label *obj)
	Get wrap width of the label. More...

void	elm_label_slide_speed_set (Elm_Label *obj, double speed)
	Set the slide speed of the label. More...

double	elm_label_slide_speed_get (const Elm_Label *obj)
	Get the slide speed of the label. More...

void	elm_label_slide_mode_set (Elm_Label *obj, Elm_Label_Slide_Mode mode)
	Set the slide mode of the label widget. More...

Elm_Label_Slide_Mode	elm_label_slide_mode_get (const Elm_Label *obj)
	Get the slide mode of the label widget. More...

void	elm_label_slide_duration_set (Elm_Label *obj, double duration)
	Set the slide duration of the label. More...

double	elm_label_slide_duration_get (const Elm_Label *obj)
	Get the slide duration of the label. More...

void	elm_label_line_wrap_set (Elm_Label *obj, Elm_Wrap_Type wrap)
	Set the wrapping behavior of the label. More...

Elm_Wrap_Type	elm_label_line_wrap_get (const Elm_Label *obj)
	Get the wrapping behavior of the label. More...

void	elm_label_ellipsis_set (Elm_Label *obj, Eina_Bool ellipsis)
	Set the ellipsis behavior of the label. More...

Eina_Bool	elm_label_ellipsis_get (const Elm_Label *obj)
	Get the ellipsis behavior of the label. More...

void	elm_label_slide_go (Elm_Label *obj)
	Start slide effect. More...

Evas_Object *	elm_label_add (Evas_Object *parent)
	Add a new label to the parent. More...

Detailed Description

Widget to display text, with simple html-like markup.

The Label widget doesn't allow text to overflow its boundaries, if the text doesn't fit the geometry of the label it will be ellipsized or be cut. Elementary provides several styles for this widget:

default - No animation
marker - Centers the text in the label and makes it bold by default
slide_long - The entire text appears from the right of the screen and slides until it disappears in the left of the screen(reappearing on the right again).
slide_short - The text appears in the left of the label and slides to the right to show the overflow. When all of the text has been shown the position is reset.
slide_bounce - The text appears in the left of the label and slides to the right to show the overflow. When all of the text has been shown the animation reverses, moving the text to the left.

Custom themes can of course invent new markup tags and style them any way they like.

This widget inherits from the Layout one, so that all the functions acting on it also work for label objects.

This widget emits the following signals, besides the ones sent from Layout:

"language,changed": The program's language changed.
"slide,end": The slide is end.

See Label example for a demonstration of how to use a label widget.

Function Documentation

bool elm_label::ellipsis_get ( ) const

inline

Get the ellipsis behavior of the label.

Returns: If true, an ellipsis will be shown at the end of the label area.

See also: elm_label_ellipsis_set()

Parameters

ellipsis To ellipsis text or not

References elm_obj_label_ellipsis_get().

void elm_label::ellipsis_set ( bool ellipsis_ ) const

inline

Get the ellipsis behavior of the label.

Returns: If true, an ellipsis will be shown at the end of the label area.

See also: elm_label_ellipsis_set()

Parameters

ellipsis To ellipsis text or not

References elm_obj_label_ellipsis_set().

Evas_Object* elm_label_add ( Evas_Object * parent )

Add a new label to the parent.

Parameters

parent The parent object

Returns: The new object or NULL if it cannot be created

Eina_Bool elm_label_ellipsis_get ( const Elm_Label * obj )

Get the ellipsis behavior of the label.

Returns: If true, an ellipsis will be shown at the end of the label area.

See also: elm_label_ellipsis_set()

References elm_obj_label_ellipsis_get().

void elm_label_ellipsis_set	(	Elm_Label *	obj,
		Eina_Bool	ellipsis
	)

Set the ellipsis behavior of the label.

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.

Parameters

[in] ellipsis To ellipsis text or not

References elm_obj_label_ellipsis_set().

Elm_Wrap_Type elm_label_line_wrap_get ( const Elm_Label * obj )

Get the wrapping behavior of the label.

Returns: Wrap type

See also: elm_label_line_wrap_set()

References elm_obj_label_line_wrap_get().

void elm_label_line_wrap_set	(	Elm_Label *	obj,
		Elm_Wrap_Type	wrap
	)

Set the wrapping behavior of the label.

By default no wrapping is done. Possible values for wrap are:

#ELM_WRAP_NONE - No wrapping
#ELM_WRAP_CHAR - wrap between characters
#ELM_WRAP_WORD - wrap between words
#ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap

Parameters

[in] wrap To wrap text or not

References elm_obj_label_line_wrap_set().

double elm_label_slide_duration_get ( const Elm_Label * obj )

Get the slide duration of the label.

Returns: 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 also: elm_label_slide_duration_set()

References elm_obj_label_slide_duration_get().

void elm_label_slide_duration_set	(	Elm_Label *	obj,
		double	duration
	)

Set the slide duration of the label.

See also: elm_label_slide_speed_set()

Parameters

[in] duration The duration in seconds in moving text from slide begin position to slide end position

References elm_obj_label_slide_duration_set().

EINA_DEPRECATED Eina_Bool elm_label_slide_get ( const Evas_Object * obj )

Get whether slide effect is shown or not.

Parameters

obj	The label object

Returns: If true, slide effect is shown.

See also: elm_label_slide_set()

Deprecated:: see elm_label_slide_mode_get() instead.

References elm_label_slide_mode_get().

void elm_label_slide_go ( Elm_Label * obj )

Start slide effect.

See also: elm_label_slide_mode_set()

Since: 1.8

References elm_obj_label_slide_go().

Elm_Label_Slide_Mode elm_label_slide_mode_get ( const Elm_Label * obj )

Get the slide mode of the label widget.

Returns: The slide mode

See also: elm_label_slide_mode_set()

Since: 1.8

References elm_obj_label_slide_mode_get().

Referenced by elm_label_slide_get().

void elm_label_slide_mode_set	(	Elm_Label *	obj,
		Elm_Label_Slide_Mode	mode
	)

Set the slide mode of the label widget.

elm_label_slide_mode_set() changes label slide mode. By default, slide mode is none. Possible values for mode are:

#ELM_LABEL_SLIDE_MODE_NONE - no slide effect
#ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than the text width length
#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".; #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 also: elm_label_slide_mode_get().

Since: 1.8

Parameters

[in] mode The slide mode

References elm_obj_label_slide_mode_set().

Referenced by elm_label_slide_set().

EINA_DEPRECATED void elm_label_slide_set	(	Evas_Object *	obj,
		Eina_Bool	slide
	)

Set slide effect of label widget.

Parameters

obj	The label object
slide	If true, slide effect will be shown

If set to true, the text of the label will slide/scroll through the length of label.

Warning: This only works with the themes "slide_short", "slide_long" and "slide_bounce".; This doesn't work if the line wrap(elm_label_line_wrap_set()) or ellipsis(elm_label_ellipsis_set()) is set.

Deprecated:: see elm_label_slide_mode_set() instead.

References elm_label_slide_mode_set().

double elm_label_slide_speed_get ( const Elm_Label * obj )

Get the slide speed of the label.

Returns: 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 also: elm_label_slide_speed_set()

References elm_obj_label_slide_speed_get().

void elm_label_slide_speed_set	(	Elm_Label *	obj,
		double	speed
	)

Set the slide speed of the label.

See also: elm_label_slide_duration_set()

Parameters

[in] speed The speed of the slide animation in px per seconds

References elm_obj_label_slide_speed_set().

Evas_Coord elm_label_wrap_width_get ( const Elm_Label * obj )

Get wrap width of the label.

Returns: The wrap width in pixels at a minimum where words need to wrap

See also: elm_label_wrap_width_set()

References elm_obj_label_wrap_width_get().

void elm_label_wrap_width_set	(	Elm_Label *	obj,
		Evas_Coord	w
	)

Set wrap width of the label.

This function sets the maximum width size hint of the label.

Warning: This is only relevant if the label is inside a container.

Parameters

[in] w The wrap width in pixels at a minimum where words need to wrap

References elm_obj_label_wrap_width_set().

EOAPI Eina_Bool elm_obj_label_ellipsis_get ( void )

Get the ellipsis behavior of the label.

Returns: If true, an ellipsis will be shown at the end of the label area.

See also: elm_label_ellipsis_set()

Referenced by elm_label::ellipsis_get(), and elm_label_ellipsis_get().

EOAPI void elm_obj_label_ellipsis_set ( Eina_Bool ellipsis )

Set the ellipsis behavior of the label.

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.

Parameters

[in] ellipsis To ellipsis text or not

Referenced by elm_label::ellipsis_set(), and elm_label_ellipsis_set().

EOAPI Elm_Wrap_Type elm_obj_label_line_wrap_get ( void )

Get the wrapping behavior of the label.

Returns: Wrap type

See also: elm_label_line_wrap_set()

Referenced by elm_label_line_wrap_get(), and elm_label::line_wrap_get().

EOAPI void elm_obj_label_line_wrap_set ( Elm_Wrap_Type wrap )

Set the wrapping behavior of the label.

By default no wrapping is done. Possible values for wrap are:

#ELM_WRAP_NONE - No wrapping
#ELM_WRAP_CHAR - wrap between characters
#ELM_WRAP_WORD - wrap between words
#ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap

Parameters

[in] wrap To wrap text or not

Referenced by elm_label_line_wrap_set(), and elm_label::line_wrap_set().

EOAPI double elm_obj_label_slide_duration_get ( void )

Get the slide duration of the label.

Returns: 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 also: elm_label_slide_duration_set()

Referenced by elm_label_slide_duration_get(), and elm_label::slide_duration_get().

EOAPI void elm_obj_label_slide_duration_set ( double duration )

Set the slide duration of the label.

See also: elm_label_slide_speed_set()

Parameters

[in] duration The duration in seconds in moving text from slide begin position to slide end position

Referenced by elm_label_slide_duration_set(), and elm_label::slide_duration_set().

EOAPI void elm_obj_label_slide_go ( void )

Start slide effect.

See also: elm_label_slide_mode_set()

Since: 1.8

Referenced by elm_label_slide_go(), and elm_label::slide_go().

EOAPI Elm_Label_Slide_Mode elm_obj_label_slide_mode_get ( void )

Get the slide mode of the label widget.

Returns: The slide mode

See also: elm_label_slide_mode_set()

Since: 1.8

Referenced by elm_label_slide_mode_get(), and elm_label::slide_mode_get().

EOAPI void elm_obj_label_slide_mode_set ( Elm_Label_Slide_Mode mode )

Set the slide mode of the label widget.

elm_label_slide_mode_set() changes label slide mode. By default, slide mode is none. Possible values for mode are:

#ELM_LABEL_SLIDE_MODE_NONE - no slide effect
#ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than the text width length
#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".; #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 also: elm_label_slide_mode_get().

Since: 1.8

Parameters

[in] mode The slide mode

Referenced by elm_label_slide_mode_set(), and elm_label::slide_mode_set().

EOAPI double elm_obj_label_slide_speed_get ( void )

Get the slide speed of the label.

Returns: 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 also: elm_label_slide_speed_set()

Referenced by elm_label_slide_speed_get(), and elm_label::slide_speed_get().

EOAPI void elm_obj_label_slide_speed_set ( double speed )

Set the slide speed of the label.

See also: elm_label_slide_duration_set()

Parameters

[in] speed The speed of the slide animation in px per seconds

Referenced by elm_label_slide_speed_set(), and elm_label::slide_speed_set().

EOAPI Evas_Coord elm_obj_label_wrap_width_get ( void )

Get wrap width of the label.

Returns: The wrap width in pixels at a minimum where words need to wrap

See also: elm_label_wrap_width_set()

Referenced by elm_label_wrap_width_get(), and elm_label::wrap_width_get().

EOAPI void elm_obj_label_wrap_width_set ( Evas_Coord w )

Set wrap width of the label.

This function sets the maximum width size hint of the label.

Warning: This is only relevant if the label is inside a container.

Parameters

[in] w The wrap width in pixels at a minimum where words need to wrap

Referenced by elm_label_wrap_width_set(), and elm_label::wrap_width_set().

Elm_Wrap_Type elm_label::line_wrap_get ( ) const

inline

Get the wrapping behavior of the label.

Returns: Wrap type

See also: elm_label_line_wrap_set()

Parameters

wrap	To wrap text or not

References elm_obj_label_line_wrap_get().

void elm_label::line_wrap_set ( Elm_Wrap_Type wrap_ ) const

inline

Get the wrapping behavior of the label.

Returns: Wrap type

See also: elm_label_line_wrap_set()

Parameters

wrap	To wrap text or not

References elm_obj_label_line_wrap_set().

double elm_label::slide_duration_get ( ) const

inline

Get the slide duration of the label.

Returns: 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 also: elm_label_slide_duration_set()

Parameters

duration The duration in seconds in moving text from slide begin position to slide end position

References elm_obj_label_slide_duration_get().

void elm_label::slide_duration_set ( double duration_ ) const

inline

Get the slide duration of the label.

Returns: 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 also: elm_label_slide_duration_set()

Parameters

duration The duration in seconds in moving text from slide begin position to slide end position

References elm_obj_label_slide_duration_set().

void elm_label::slide_go ( ) const

inline

Start slide effect.

See also: elm_label_slide_mode_set()

Since: 1.8

References elm_obj_label_slide_go().

Elm_Label_Slide_Mode elm_label::slide_mode_get ( ) const

inline

Get the slide mode of the label widget.

Returns: The slide mode

See also: elm_label_slide_mode_set()

Since: 1.8

Parameters

mode	The slide mode

References elm_obj_label_slide_mode_get().

void elm_label::slide_mode_set ( Elm_Label_Slide_Mode mode_ ) const

inline

Get the slide mode of the label widget.

Returns: The slide mode

See also: elm_label_slide_mode_set()

Since: 1.8

Parameters

mode	The slide mode

References elm_obj_label_slide_mode_set().

double elm_label::slide_speed_get ( ) const

inline

Get the slide speed of the label.

Returns: 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 also: elm_label_slide_speed_set()

Parameters

speed The speed of the slide animation in px per seconds

References elm_obj_label_slide_speed_get().

void elm_label::slide_speed_set ( double speed_ ) const

inline

Get the slide speed of the label.

Returns: 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.