Download

Support

Text Object Functions
[Specific Object Functions]

Functions that operate on evas text objects. More...

Functions

EAPI Evas_Objectevas_object_text_add (Evas *e)
 Creates a new text Evas_Object on the provided Evas canvas.
EAPI void evas_object_text_font_source_set (Evas_Object *obj, const char *font_source)
 To be documented.
EAPI const char * evas_object_text_font_source_get (const Evas_Object *obj)
 To be documented.
EAPI void evas_object_text_font_set (Evas_Object *obj, const char *font, Evas_Font_Size size)
 To be documented.
EAPI void evas_object_text_font_get (const Evas_Object *obj, const char **font, Evas_Font_Size *size)
 Query evas for font information of a text Evas_Object.
EAPI void evas_object_text_text_set (Evas_Object *obj, const char *text)
 Sets the text to be displayed by the given evas text object.
EAPI const char * evas_object_text_text_get (const Evas_Object *obj)
 Retrieves the text currently being displayed by the given evas text object.
EAPI Evas_Coord evas_object_text_ascent_get (const Evas_Object *obj)
 To be documented.
EAPI Evas_Coord evas_object_text_descent_get (const Evas_Object *obj)
 To be documented.
EAPI Evas_Coord evas_object_text_max_ascent_get (const Evas_Object *obj)
 To be documented.
EAPI Evas_Coord evas_object_text_max_descent_get (const Evas_Object *obj)
 To be documented.
EAPI Evas_Coord evas_object_text_inset_get (const Evas_Object *obj)
 To be documented.
EAPI Evas_Coord evas_object_text_horiz_advance_get (const Evas_Object *obj)
 To be documented.
EAPI Evas_Coord evas_object_text_vert_advance_get (const Evas_Object *obj)
 To be documented.
EAPI Eina_Bool evas_object_text_char_pos_get (const Evas_Object *obj, int pos, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
 Retrieve position and dimension information of a character within a text Evas_Object.
EAPI int evas_object_text_char_coords_get (const Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
 To be documented.
EAPI void evas_object_text_style_set (Evas_Object *obj, Evas_Text_Style_Type style)
 To be documented.
EAPI Evas_Text_Style_Type evas_object_text_style_get (const Evas_Object *obj)
 To be documented.
EAPI void evas_object_text_shadow_color_set (Evas_Object *obj, int r, int g, int b, int a)
 To be documented.
EAPI void evas_object_text_shadow_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a)
 To be documented.
EAPI void evas_object_text_glow_color_set (Evas_Object *obj, int r, int g, int b, int a)
 To be documented.
EAPI void evas_object_text_glow_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a)
 To be documented.
EAPI void evas_object_text_glow2_color_set (Evas_Object *obj, int r, int g, int b, int a)
 To be documented.
EAPI void evas_object_text_glow2_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a)
 To be documented.
EAPI void evas_object_text_outline_color_set (Evas_Object *obj, int r, int g, int b, int a)
 To be documented.
EAPI void evas_object_text_outline_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a)
 To be documented.
EAPI void evas_object_text_style_pad_get (const Evas_Object *obj, int *l, int *r, int *t, int *b)
 Gets the text style pad.

Detailed Description

Functions that operate on evas text objects.


Function Documentation

EAPI Evas_Object* evas_object_text_add ( Evas e  ) 

Creates a new text Evas_Object on the provided Evas canvas.

Parameters:
e The Evas canvas to create the text object upon.
See also:
evas_object_text_font_source_set
evas_object_text_font_set
evas_object_text_text_set
Returns:
NULL on error, A pointer to a new Evas_Object on success.
EAPI Evas_Coord evas_object_text_ascent_get ( const Evas_Object obj  ) 

To be documented.

FIXME: To be fixed.

EAPI int evas_object_text_char_coords_get ( const Evas_Object obj,
Evas_Coord  x,
Evas_Coord  y,
Evas_Coord *  cx,
Evas_Coord *  cy,
Evas_Coord *  cw,
Evas_Coord *  ch 
)

To be documented.

FIXME: To be fixed.

EAPI Eina_Bool evas_object_text_char_pos_get ( const Evas_Object obj,
int  pos,
Evas_Coord *  cx,
Evas_Coord *  cy,
Evas_Coord *  cw,
Evas_Coord *  ch 
)

Retrieve position and dimension information of a character within a text Evas_Object.

This function is used to obtain the X, Y, width and height of a the character located at pos within the Evas_Object obj. obj must be a text object as created with evas_object_text_add(). Any of the Evas_Coord parameters (cx, cy, cw, ch) may be NULL in which case no value will be assigned to that parameter.

Parameters:
obj The text object to retrieve position information for.
pos The character position to request co-ordinates for.
cx A pointer to an Evas_Coord to store the X value in (can be NULL).
cy A pointer to an Evas_Coord to store the Y value in (can be NULL).
cw A pointer to an Evas_Coord to store the Width value in (can be NULL).
ch A pointer to an Evas_Coord to store the Height value in (can be NULL).
Returns:
EINA_FALSE on error, EINA_TRUE on success.
EAPI Evas_Coord evas_object_text_descent_get ( const Evas_Object obj  ) 

To be documented.

FIXME: To be fixed.

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

Query evas for font information of a text Evas_Object.

This function allows the font name and size of a text Evas_Object as created with evas_object_text_add() 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.

Parameters:
obj The evas text object to query for font information.
font A pointer to the location to store the font name in (may be NULL).
size A pointer to the location to store the font size in (may be NULL).
EAPI void evas_object_text_font_set ( Evas_Object obj,
const char *  font,
Evas_Font_Size  size 
)

To be documented.

FIXME: To be fixed.

EAPI const char* evas_object_text_font_source_get ( const Evas_Object obj  ) 

To be documented.

FIXME: To be fixed.

EAPI void evas_object_text_font_source_set ( Evas_Object obj,
const char *  font_source 
)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_text_glow2_color_get ( const Evas_Object obj,
int *  r,
int *  g,
int *  b,
int *  a 
)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_text_glow2_color_set ( Evas_Object obj,
int  r,
int  g,
int  b,
int  a 
)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_text_glow_color_get ( const Evas_Object obj,
int *  r,
int *  g,
int *  b,
int *  a 
)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_text_glow_color_set ( Evas_Object obj,
int  r,
int  g,
int  b,
int  a 
)

To be documented.

FIXME: To be fixed.

EAPI Evas_Coord evas_object_text_horiz_advance_get ( const Evas_Object obj  ) 

To be documented.

FIXME: To be fixed.

EAPI Evas_Coord evas_object_text_inset_get ( const Evas_Object obj  ) 

To be documented.

FIXME: To be fixed.

EAPI Evas_Coord evas_object_text_max_ascent_get ( const Evas_Object obj  ) 

To be documented.

FIXME: To be fixed.

EAPI Evas_Coord evas_object_text_max_descent_get ( const Evas_Object obj  ) 

To be documented.

FIXME: To be fixed.

EAPI void evas_object_text_outline_color_get ( const Evas_Object obj,
int *  r,
int *  g,
int *  b,
int *  a 
)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_text_outline_color_set ( Evas_Object obj,
int  r,
int  g,
int  b,
int  a 
)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_text_shadow_color_get ( const Evas_Object obj,
int *  r,
int *  g,
int *  b,
int *  a 
)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_text_shadow_color_set ( Evas_Object obj,
int  r,
int  g,
int  b,
int  a 
)

To be documented.

FIXME: To be fixed.

EAPI Evas_Text_Style_Type evas_object_text_style_get ( const Evas_Object obj  ) 

To be documented.

FIXME: To be fixed.

EAPI void evas_object_text_style_pad_get ( const Evas_Object obj,
int *  l,
int *  r,
int *  t,
int *  b 
)

Gets the text style pad.

Parameters:
l The left pad (or NULL).
r The right pad (or NULL).
t The top pad (or NULL).
b The bottom pad (or NULL).
EAPI void evas_object_text_style_set ( Evas_Object obj,
Evas_Text_Style_Type  style 
)

To be documented.

FIXME: To be fixed.

EAPI const char* evas_object_text_text_get ( const Evas_Object obj  ) 

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

Parameters:
obj The given evas text object.
Returns:
The text currently being displayed. Do not free it.
EAPI void evas_object_text_text_set ( Evas_Object obj,
const char *  text 
)

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

Parameters:
obj Evas text object.
text Text to display.
EAPI Evas_Coord evas_object_text_vert_advance_get ( const Evas_Object obj  ) 

To be documented.

FIXME: To be fixed.


Copyright © Enlightenment.org

Evas Documentation Generated: Sat Sep 5 03:05:15 2009