Tizen Native API
|
Functions | |
Evas_Object * | evas_object_text_add (Evas *e) |
Creates a new text object on the provided canvas. | |
void | evas_object_text_font_source_set (Evas_Object *obj, const char *font) |
Sets the font (source) file to be used on a given text object. | |
const char * | evas_object_text_font_source_get (const Evas_Object *obj) |
Gets the font file's path which is being used on a given text object. | |
void | evas_object_text_font_set (Evas_Object *obj, const char *font, Evas_Font_Size size) |
Sets the font family and size on a given text object. | |
void | evas_object_text_font_get (const Evas_Object *obj, const char **font, Evas_Font_Size *size) |
Gets the font family and size in use on a given text object. | |
void | evas_object_text_text_set (Evas_Object *obj, const char *text) |
Sets the text string to be displayed by the given text object. | |
const char * | evas_object_text_text_get (const Evas_Object *obj) |
Gets the text string currently being displayed by the given text object. | |
void | evas_object_text_bidi_delimiters_set (Evas_Object *obj, const char *delim) |
Sets the BiDi delimiters used in the textblock. | |
const char * | evas_object_text_bidi_delimiters_get (const Evas_Object *obj) |
Gets the BiDi delimiters used in the textblock. | |
void | evas_object_text_ellipsis_set (Evas_Object *obj, double ellipsis) |
Sets the ellipsis that should be used for the text object. | |
double | evas_object_text_ellipsis_get (const Evas_Object *obj) |
Gets the ellipsis currently set on the text object. | |
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) |
Gets the position and dimension information of a character within a text Evas_Object . | |
int | evas_object_text_last_up_to_pos (const Evas_Object *obj, Evas_Coord x, Evas_Coord y) |
Gets the logical position of the last char in the text up to the given position. This is NOT the position of the last char because of the possibility of RTL in the text. | |
Evas_Text_Style_Type | evas_object_text_style_get (const Evas_Object *obj) |
Gets the style on use on the given text object. | |
void | evas_object_text_style_set (Evas_Object *obj, Evas_Text_Style_Type type) |
Sets the style to apply on the given text object. | |
void | evas_object_text_shadow_color_set (Evas_Object *obj, int r, int g, int b, int a) |
Sets the shadow color for the given text object. | |
void | evas_object_text_shadow_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a) |
Gets the shadow color for the given text object. | |
void | evas_object_text_glow_color_set (Evas_Object *obj, int r, int g, int b, int a) |
Sets the glow color for the given text object. | |
void | evas_object_text_glow_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a) |
Gets the glow color for the given text object. | |
void | evas_object_text_glow2_color_set (Evas_Object *obj, int r, int g, int b, int a) |
Sets the 'glow 2' color for the given text object. | |
void | evas_object_text_glow2_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a) |
Gets the 'glow 2' color for the given text object. | |
void | evas_object_text_outline_color_set (Evas_Object *obj, int r, int g, int b, int a) |
Sets the outline color for the given text object. | |
void | evas_object_text_outline_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a) |
Gets the outline color for the given text object. | |
void | evas_object_text_style_pad_get (const Evas_Object *obj, int *l, int *r, int *t, int *b) |
Gets the text style pad of a text object. | |
Evas_BiDi_Direction | evas_object_text_direction_get (const Evas_Object *obj) |
Gets the direction of the text currently being displayed in the text object. | |
void | evas_object_text_filter_program_set (Evas_Object *obj, const char *arg) |
Sets an Evas filter program on this Text Object. | |
void | evas_object_text_filter_source_set (Evas_Object *obj, const char *name, Evas_Object *source) |
Binds an object to use as a mask or texture with Evas Filters. This automatically creates a new RGBA buffer containing the source object's pixels (as it is rendered). | |
Typedefs | |
typedef enum _Evas_Text_Style_Type | Evas_Text_Style_Type |
Defines | |
#define | EVAS_TEXT_STYLE_BASIC_SET(x, s) do { x = ((x) & ~EVAS_TEXT_STYLE_MASK_BASIC) | (s); } while (0) |
Definition for text style type creation macro. Use style types on the 's' arguments, being 'x' your style variable. | |
#define | EVAS_TEXT_STYLE_SHADOW_DIRECTION_SET(x, s) do { x = ((x) & ~EVAS_TEXT_STYLE_MASK_SHADOW_DIRECTION) | (s); } while (0) |
Definition for text style type creation macro. This one imposes shadow directions on the style type variable -- use the EVAS_TEXT_STYLE_SHADOW_DIRECTION_* values on 's', incrementally. |
This group provides functions that operate on single line, single style text objects.
For multiline and multiple style text, see Textblock Object Functions.
typedef enum _Evas_Text_Style_Type Evas_Text_Style_Type |
Types of styles to be applied on text objects. The EVAS_TEXT_STYLE_SHADOW_DIRECTION_*
ones are to be ORed together with others imposing shadow, to change shadow's direction
Types of styles to be applied on text objects. The EVAS_TEXT_STYLE_SHADOW_DIRECTION_*
ones are to be ORed together with others imposing shadow, to change shadow's direction
Evas_Object* evas_object_text_add | ( | Evas * | e | ) |
Creates a new text object on the provided canvas.
[in] | e | The canvas to create the text object on |
NULL
on errorconst char* evas_object_text_bidi_delimiters_get | ( | const Evas_Object * | obj | ) |
Gets the BiDi delimiters used in the textblock.
[in] | obj | The given text object |
NULL
if empty void evas_object_text_bidi_delimiters_set | ( | Evas_Object * | obj, |
const char * | delim | ||
) |
Sets the BiDi delimiters used in the textblock.
[in] | obj | The given text object |
[in] | delim | A null terminated string of delimiters, for example ",|" |
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 | ||
) |
Gets the 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 is assigned to that parameter.
[in] | obj | The text object to retrieve position information for |
[in] | pos | The character position to request co-ordinates for |
[out] | cx | A pointer to an Evas_Coord to store the X value in (can be NULL ) |
[out] | cy | A pointer to an Evas_Coord to store the Y value in (can be NULL ) |
[out] | cw | A pointer to an Evas_Coord to store the Width value in (can be NULL ) |
[out] | ch | A pointer to an Evas_Coord to store the Height value in (can be NULL ) |
Evas_BiDi_Direction evas_object_text_direction_get | ( | const Evas_Object * | obj | ) |
Gets the direction of the text currently being displayed in the text object.
[in] | obj | The given evas text object |
double evas_object_text_ellipsis_get | ( | const Evas_Object * | obj | ) |
Gets the ellipsis currently set on the text object.
[in] | obj | The given text object |
void evas_object_text_ellipsis_set | ( | Evas_Object * | obj, |
double | ellipsis | ||
) |
Sets the ellipsis that should be used for the text object.
This is a value between 0.0
and 1.0
indicating the position of the text to be shown. 0.0
means the start is shown and the end trimmed, 1.0
means the beginning is trimmed and the end is shown, and any value in between causes ellipsis to be added in both the end of the text and the requested part to be shown.
-1.0
means ellipsis is turned off.[in] | obj | The given text object |
[in] | ellipsis | The ellipsis |
void evas_object_text_filter_program_set | ( | Evas_Object * | obj, |
const char * | arg | ||
) |
Sets an Evas filter program on this Text Object.
[in] | obj | The given evas text object |
[in] | arg | The program code, as defined by the "Evas filters script language". Pass NULL to remove the former program and switch back to the standard text effects. |
void evas_object_text_filter_source_set | ( | Evas_Object * | obj, |
const char * | name, | ||
Evas_Object * | source | ||
) |
Binds an object to use as a mask or texture with Evas Filters. This automatically creates a new RGBA buffer containing the source object's pixels (as it is rendered).
[in] | obj | The given evas object |
[in] | name | The object name as used in the program code |
[in] | source | The evas object to use through proxy rendering |
void evas_object_text_font_get | ( | const Evas_Object * | obj, |
const char ** | font, | ||
Evas_Font_Size * | size | ||
) |
Gets 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.
[in] | obj | The evas text object to query for font information |
[out] | font | A pointer to the location to store the font name in |
[out] | size | A pointer to the location to store the font size in |
void evas_object_text_font_set | ( | Evas_Object * | obj, |
const char * | font, | ||
Evas_Font_Size | size | ||
) |
Sets the font family 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 is the underlying library used to query system fonts by Evas (see the fc-list
command's output, on your system, to get an idea).
[in] | obj | The text object to set font for |
[in] | font | The font (family) name |
[in] | size | The font size, in points |
const char* evas_object_text_font_source_get | ( | const Evas_Object * | obj | ) |
Gets the font file's path which is being used on a given text object.
[in] | obj | The text object to set the font for |
void evas_object_text_font_source_set | ( | Evas_Object * | obj, |
const char * | font | ||
) |
Sets 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 first occurs in the given file's contents.
[in] | obj | The text object to set font for |
[in] | font | The font file's path |
void evas_object_text_glow2_color_get | ( | const Evas_Object * | obj, |
int * | r, | ||
int * | g, | ||
int * | b, | ||
int * | a | ||
) |
Gets the 'glow 2' color for the given text object.
NULL
pointers on the color components that you are not interested in: they are ignored by the function.[in] | obj | The given Evas text object |
[out] | r | The pointer to variable to hold the red component of the given color |
[out] | g | The pointer to variable to hold the green component of the given color |
[out] | b | The pointer to variable to hold the blue component of the given color |
[out] | a | The pointer to variable to hold the alpha component of the given color |
void evas_object_text_glow2_color_set | ( | Evas_Object * | obj, |
int | r, | ||
int | g, | ||
int | b, | ||
int | a | ||
) |
Sets the 'glow 2' color for the given text object.
[in] | obj | The given Evas text object |
[in] | r | The red component of the given color |
[in] | g | The green component of the given color |
[in] | b | The blue component of the given color |
[in] | a | The alpha component of the given color |
void evas_object_text_glow_color_get | ( | const Evas_Object * | obj, |
int * | r, | ||
int * | g, | ||
int * | b, | ||
int * | a | ||
) |
Gets the glow color for the given text object.
NULL
pointers on the color components that you are not interested in: they are ignored by the function.[in] | obj | The given Evas text object. |
[out] | r | The pointer to variable to hold the red component of the given color |
[out] | g | The pointer to variable to hold the green component of the given color |
[out] | b | The pointer to variable to hold the blue component of the given color |
[out] | a | The pointer to variable to hold the alpha component of the given color |
void evas_object_text_glow_color_set | ( | Evas_Object * | obj, |
int | r, | ||
int | g, | ||
int | b, | ||
int | a | ||
) |
Sets the glow color for the given text object.
[in] | obj | The given Evas text object |
[in] | r | The red component of the given color |
[in] | g | The green component of the given color |
[in] | b | The blue component of the given color |
[in] | a | The alpha component of the given color |
int evas_object_text_last_up_to_pos | ( | const Evas_Object * | obj, |
Evas_Coord | x, | ||
Evas_Coord | y | ||
) |
Gets the logical position of the last char in the text up to the given position.
This is NOT the position of the last char because of the possibility of RTL in the text.
[in] | obj | The text object |
[in] | x | The X co-ordinate |
[in] | y | The Y co-ordinate |
void evas_object_text_outline_color_get | ( | const Evas_Object * | obj, |
int * | r, | ||
int * | g, | ||
int * | b, | ||
int * | a | ||
) |
Gets the outline color for the given text object.
NULL
pointers on the color components that you are not interested in: they are ignored by the function.[in] | obj | The given Evas text object |
[out] | r | The pointer to the variable to hold the red component of the given color |
[out] | g | The pointer to the variable to hold the green component of the given color |
[out] | b | The pointer to the variable to hold the blue component of the given color |
[out] | a | The pointer to the variable to hold the alpha component of the given color |
void evas_object_text_outline_color_set | ( | Evas_Object * | obj, |
int | r, | ||
int | g, | ||
int | b, | ||
int | a | ||
) |
Sets the outline color for the given text object.
[in] | obj | The given Evas text object |
[in] | r | The red component of the given color |
[in] | g | The green component of the given color |
[in] | b | The blue component of the given color |
[in] | a | The alpha component of the given color |
void evas_object_text_shadow_color_get | ( | const Evas_Object * | obj, |
int * | r, | ||
int * | g, | ||
int * | b, | ||
int * | a | ||
) |
Gets the shadow color for the given text object.
NULL
pointers on the color components that you are not interested in: they are ignored by the function.[in] | obj | The given Evas text object |
[out] | r | The pointer to variable to hold the red component of the given color |
[out] | g | The pointer to variable to hold the green component of the given color |
[out] | b | The pointer to variable to hold the blue component of the given color |
[out] | a | The pointer to variable to hold the alpha component of the given color |
void evas_object_text_shadow_color_set | ( | Evas_Object * | obj, |
int | r, | ||
int | g, | ||
int | b, | ||
int | a | ||
) |
Sets the shadow color for the given text object.
[in] | obj | The given Evas text object |
[in] | r | The red component of the given color |
[in] | g | The green component of the given color |
[in] | b | The blue component of the given color |
[in] | a | The alpha component of the given color |
Evas_Text_Style_Type evas_object_text_style_get | ( | const Evas_Object * | obj | ) |
Gets the style on use on the given text object.
[in] | obj | The given text object to set style on |
void evas_object_text_style_pad_get | ( | const Evas_Object * | obj, |
int * | l, | ||
int * | r, | ||
int * | t, | ||
int * | b | ||
) |
Gets the text style pad of a text object.
[in] | obj | The given text object |
[out] | l | The left pad (or NULL ) |
[out] | r | The right pad (or NULL ) |
[out] | t | The top pad (or NULL ) |
[out] | b | The bottom pad (or NULL ) |
void evas_object_text_style_set | ( | Evas_Object * | obj, |
Evas_Text_Style_Type | type | ||
) |
Sets the style to apply on the given text object.
[in] | obj | The given text object to set style on |
[in] | type | The style type |
const char* evas_object_text_text_get | ( | const Evas_Object * | obj | ) |
Gets the text string currently being displayed by the given text object.
[in] | obj | The given text object |
void evas_object_text_text_set | ( | Evas_Object * | obj, |
const char * | text | ||
) |
Sets the text string to be displayed by the given text object.
[in] | obj | The text object to set text string on |
[in] | text | The text string to display on it |