Macros
Text Object Functions

Functions that operate on single line, single style text objects. More...

Macros

#define EVAS_TEXT_STYLE_MASK_BASIC   0xf
 
#define EVAS_TEXT_STYLE_BASIC_SET(x, s)   do { x = ((x) & ~EVAS_TEXT_STYLE_MASK_BASIC) | (s); } while (0)
 Text style type creation macro. More...
 
#define EVAS_TEXT_STYLE_MASK_SHADOW_DIRECTION   (0x7 << 4)
 
#define EVAS_TEXT_STYLE_SHADOW_DIRECTION_SET(x, s)   do { x = ((x) & ~EVAS_TEXT_STYLE_MASK_SHADOW_DIRECTION) | (s); } while (0)
 Text style type creation macro. More...
 
Evas_Objectevas_object_text_add (Evas *e)
 Creates a new text object on the provided canvas. More...
 
void evas_object_text_text_set (Eo *obj, const char *text)
 Sets the text string to be displayed by the given text object. More...
 
const char * evas_object_text_text_get (const Eo *obj)
 Retrieves the text string currently being displayed by the given text object. More...
 
void evas_object_text_font_source_set (Eo *obj, const char *font_source)
 Set the font (source) file to be used on a given text object. More...
 
const char * evas_object_text_font_source_get (const Eo *obj)
 Get the font file's path which is being used on a given text object. More...
 
void evas_object_text_font_set (Eo *obj, const char *font, Evas_Font_Size size)
 Set the font family or filename, and size on a given text object. More...
 
void evas_object_text_font_get (const Eo *obj, const char **font, Evas_Font_Size *size)
 Retrieve the font family and size in use on a given text object. More...
 

Detailed Description

Functions that operate on single line, single style text objects.

For multiline and multiple style text, see Textblock Object Functions.

See some examples on this group of functions.

Warning
We don't guarantee any proper results if you create a Text object without setting the evas engine.

Macro Definition Documentation

§ EVAS_TEXT_STYLE_BASIC_SET

#define EVAS_TEXT_STYLE_BASIC_SET (   x,
 
)    do { x = ((x) & ~EVAS_TEXT_STYLE_MASK_BASIC) | (s); } while (0)

Text style type creation macro.

Use style types on the 's' arguments, being 'x' your style variable.

§ EVAS_TEXT_STYLE_SHADOW_DIRECTION_SET

#define EVAS_TEXT_STYLE_SHADOW_DIRECTION_SET (   x,
 
)    do { x = ((x) & ~EVAS_TEXT_STYLE_MASK_SHADOW_DIRECTION) | (s); } while (0)

Text style type creation macro.

This one will impose shadow directions on the style type variable – use the EVAS_TEXT_STYLE_SHADOW_DIRECTION_* values on 's', incrementally.

Function Documentation

§ evas_object_text_add()

Evas_Object* evas_object_text_add ( Evas e)

Creates a new text object on the provided canvas.

Parameters
eThe canvas to create the text object on.
Returns
NULL on error, a pointer to a new text object on success.

Text objects are for simple, single line text elements. If you want more elaborated text blocks, see Textblock Object Functions.

See also
evas_object_text_font_source_set()
evas_object_text_font_set()
evas_object_text_text_set()

References EINA_UNUSED, and eo_add.

§ evas_object_text_text_set()

void evas_object_text_text_set ( Eo obj,
const char *  text 
)

Sets the text string to be displayed by the given text object.

See also
evas_object_text_text_get()
Parameters
[in]textText string to display on it.
Examples:
ecore_evas_window_sizes_example.c, eina_tiler_01.c, evas-text.c, and test_bouncing_text.c.

§ evas_object_text_text_get()

const char* evas_object_text_text_get ( const Eo obj)

Retrieves the text string currently being displayed by the given text object.

Returns
The text string currently being displayed on it.
Note
Do not free() the return value.
See also
evas_object_text_text_set()

§ evas_object_text_font_source_set()

void evas_object_text_font_source_set ( Eo obj,
const char *  font_source 
)

Set the font (source) file to be used on a given text object.

This function allows the font file to be explicitly set for a given text object, overriding system lookup, which will first occur in the given file's contents.

See also
evas_object_text_font_get()
Parameters
[in]font_sourceThe font file's path.

§ evas_object_text_font_source_get()

const char* evas_object_text_font_source_get ( const Eo obj)

Get the font file's path which is being used on a given text object.

Returns
The font file's path.
See also
evas_object_text_font_get() for more details

§ evas_object_text_font_set()

void evas_object_text_font_set ( Eo obj,
const char *  font,
Evas_Font_Size  size 
)

Set the font family or filename, and size on a given text object.

This function allows the font name and size of a text object to be set. The font string has to follow fontconfig's convention on naming fonts, as it's the underlying library used to query system fonts by Evas (see the fc-list command's output, on your system, to get an idea). Alternatively, one can use a full path to a font file.

See also
evas_object_text_font_get()
evas_object_text_font_source_set()
Parameters
[in]fontThe font family name or filename.
[in]sizeThe font size, in points.
Examples:
ecore_evas_window_sizes_example.c, eina_tiler_01.c, evas-text.c, and test_bouncing_text.c.

§ evas_object_text_font_get()

void evas_object_text_font_get ( const Eo obj,
const char **  font,
Evas_Font_Size *  size 
)

Retrieve the font family and size in use on a given text object.

This function allows the font name and size of a text object to be queried. Be aware that the font name string is still owned by Evas and should not have free() called on it by the caller of the function.

See also
evas_object_text_font_set()
Parameters
[out]fontThe font family name or filename.
[out]sizeThe font size, in points.
Examples:
evas-text.c.