Linux Certif

Toute la documentation sur la certification Linux LPI

Evas_Object_Textblock

NAME

Textblock Object Functions -

Functions used to create and manipulate textblock objects.

Functions

EAPI Evas_Object * evas_object_textblock_add (Evas *e)
Adds a textblock to the given evas.
EAPI Evas_Textblock_Style * evas_textblock_style_new (void)
Creates a new textblock style.
EAPI void evas_textblock_style_free (Evas_Textblock_Style *ts)
Destroys a textblock style.
EAPI void evas_textblock_style_set (Evas_Textblock_Style *ts, const char *text)
to be documented.
EAPI const char * evas_textblock_style_get (const Evas_Textblock_Style *ts)
to be documented.
EAPI void evas_object_textblock_style_set (Evas_Object *obj, Evas_Textblock_Style *ts)
to be documented.
EAPI const Evas_Textblock_Style * evas_object_textblock_style_get (const Evas_Object *obj)
to be documented.
EAPI void evas_object_textblock_replace_char_set (Evas_Object *obj, const char *ch)
Set the 'replacement character' to use for the given textblock object.
EAPI const char * evas_object_textblock_replace_char_get (Evas_Object *obj)
Get the 'replacement character' for given textblock object.
EAPI const char * evas_textblock_escape_string_get (const char *escape)
to be documented.
EAPI const char * evas_textblock_escape_string_range_get (const char *escape_start, const char *escape_end)
to be documented.
EAPI const char * evas_textblock_string_escape_get (const char *string, int *len_ret)
to be documented.
EAPI void evas_object_textblock_text_markup_set (Evas_Object *obj, const char *text)
to be documented.
EAPI void evas_object_textblock_text_markup_prepend (Evas_Textblock_Cursor *cur, const char *text)
to be documented.
EAPI const char * evas_object_textblock_text_markup_get (const Evas_Object *obj)
to be documented.
EAPI const Evas_Textblock_Cursor * evas_object_textblock_cursor_get (const Evas_Object *obj)
to be documented.
EAPI Evas_Textblock_Cursor * evas_object_textblock_cursor_new (Evas_Object *obj)
to be documented.
EAPI void evas_textblock_cursor_free (Evas_Textblock_Cursor *cur)
to be documented.
EAPI void evas_textblock_cursor_node_first (Evas_Textblock_Cursor *cur)
to be documented.
EAPI void evas_textblock_cursor_node_last (Evas_Textblock_Cursor *cur)
to be documented.
EAPI Eina_Bool evas_textblock_cursor_node_next (Evas_Textblock_Cursor *cur)
to be documented.
EAPI Eina_Bool evas_textblock_cursor_node_prev (Evas_Textblock_Cursor *cur)
to be documented.
EAPI Eina_Bool evas_textblock_cursor_char_next (Evas_Textblock_Cursor *cur)
to be documented.
EAPI Eina_Bool evas_textblock_cursor_char_prev (Evas_Textblock_Cursor *cur)
to be documented.
EAPI void evas_textblock_cursor_char_first (Evas_Textblock_Cursor *cur)
to be documented.
EAPI void evas_textblock_cursor_char_last (Evas_Textblock_Cursor *cur)
to be documented.
EAPI void evas_textblock_cursor_line_first (Evas_Textblock_Cursor *cur)
to be documented.
EAPI void evas_textblock_cursor_line_last (Evas_Textblock_Cursor *cur)
to be documented.
EAPI int evas_textblock_cursor_pos_get (const Evas_Textblock_Cursor *cur)
to be documented.
EAPI void evas_textblock_cursor_pos_set (Evas_Textblock_Cursor *cur, int pos)
to be documented.
EAPI Eina_Bool evas_textblock_cursor_line_set (Evas_Textblock_Cursor *cur, int line)
to be documented.
EAPI int evas_textblock_cursor_compare (const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2)
to be documented.
EAPI void evas_textblock_cursor_copy (const Evas_Textblock_Cursor *cur, Evas_Textblock_Cursor *cur_dest)
to be documented.
EAPI void evas_textblock_cursor_text_append (Evas_Textblock_Cursor *cur, const char *text)
to be documented.
EAPI void evas_textblock_cursor_text_prepend (Evas_Textblock_Cursor *cur, const char *text)
to be documented.
EAPI void evas_textblock_cursor_format_append (Evas_Textblock_Cursor *cur, const char *format)
to be documented.
EAPI void evas_textblock_cursor_format_prepend (Evas_Textblock_Cursor *cur, const char *format)
to be documented.
EAPI void evas_textblock_cursor_node_delete (Evas_Textblock_Cursor *cur)
to be documented.
EAPI void evas_textblock_cursor_char_delete (Evas_Textblock_Cursor *cur)
to be documented.
EAPI void evas_textblock_cursor_range_delete (Evas_Textblock_Cursor *cur1, Evas_Textblock_Cursor *cur2)
to be documented.
EAPI const char * evas_textblock_cursor_node_text_get (const Evas_Textblock_Cursor *cur)
to be documented.
EAPI int evas_textblock_cursor_node_text_length_get (const Evas_Textblock_Cursor *cur)
to be documented.
EAPI const char * evas_textblock_cursor_node_format_get (const Evas_Textblock_Cursor *cur)
to be documented.
EAPI Eina_Bool evas_textblock_cursor_node_format_is_visible_get (const Evas_Textblock_Cursor *cur)
to be documented.
EAPI char * evas_textblock_cursor_range_text_get (const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2, Evas_Textblock_Text_Type format)
to be documented.
EAPI int evas_textblock_cursor_char_geometry_get (const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
to be documented.
EAPI int evas_textblock_cursor_line_geometry_get (const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
to be documented.
EAPI Eina_Bool evas_textblock_cursor_char_coord_set (Evas_Textblock_Cursor *cur, Evas_Coord x, Evas_Coord y)
to be documented.
EAPI int evas_textblock_cursor_line_coord_set (Evas_Textblock_Cursor *cur, Evas_Coord y)
to be documented.
EAPI Eina_List * evas_textblock_cursor_range_geometry_get (const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2)
to be documented.
EAPI Eina_Bool evas_textblock_cursor_format_item_geometry_get (const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
to be documented.
EAPI Eina_Bool evas_textblock_cursor_eol_get (const Evas_Textblock_Cursor *cur)
To be documented.
EAPI void evas_textblock_cursor_eol_set (Evas_Textblock_Cursor *cur, Eina_Bool eol)
To be documented.
EAPI Eina_Bool evas_object_textblock_line_number_geometry_get (const Evas_Object *obj, int line, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
to be documented.
EAPI void evas_object_textblock_clear (Evas_Object *obj)
to be documented.
EAPI void evas_object_textblock_size_formatted_get (const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h)
to be documented.
EAPI void evas_object_textblock_size_native_get (const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h)
to be documented.
EAPI void evas_object_textblock_style_insets_get (const Evas_Object *obj, Evas_Coord *l, Evas_Coord *r, Evas_Coord *t, Evas_Coord *b)
to be documented.

Detailed Description

Functions used to create and manipulate textblock objects.

Unlike Text Object Functions, these handle complex text, doing multiple styles and multiline text based on HTML-like tags. Of these extra features will be heavier on memory and processing cost.

Todo

put here some usage examples

Function Documentation

EAPI Evas_Object* evas_object_textblock_add (Evas * e)

Adds a textblock to the given evas. Parameters:

e The given evas.

Returns:

The new textblock object.

EAPI void evas_object_textblock_clear (Evas_Object * obj)

to be documented. Parameters:

obj to be documented.

Returns:

Returns no value.

EAPI const Evas_Textblock_Cursor* evas_object_textblock_cursor_get (const Evas_Object * obj)

to be documented. Parameters:

obj to be documented.

Returns:

to be documented.

EAPI Evas_Textblock_Cursor* evas_object_textblock_cursor_new (Evas_Object * obj)

to be documented. Parameters:

obj to be documented.

Returns:

to be documented.

EAPI Eina_Bool evas_object_textblock_line_number_geometry_get (const Evas_Object * obj, int line, Evas_Coord * cx, Evas_Coord * cy, Evas_Coord * cw, Evas_Coord * ch)

to be documented. Parameters:

obj to be documented.
line to be documented.
cx to be documented.
cy to be documented.
cw to be documented.
ch to be documented.

Returns:

to be documented.

Referenced by evas_textblock_cursor_range_geometry_get().

EAPI const char* evas_object_textblock_replace_char_get (Evas_Object * obj)

Get the 'replacement character' for given textblock object. Returns NULL if no replacement character is in use.

Parameters:

obj The given textblock object

Returns:

replacement character or NULL

EAPI void evas_object_textblock_replace_char_set (Evas_Object * obj, const char * ch)

Set the 'replacement character' to use for the given textblock object. Parameters:

obj The given textblock object.
ch The charset name.

EAPI void evas_object_textblock_size_formatted_get (const Evas_Object * obj, Evas_Coord * w, Evas_Coord * h)

to be documented. Parameters:

obj to be documented.
w to be documented.
h to be documented.

Returns:

Returns no value.

EAPI void evas_object_textblock_size_native_get (const Evas_Object * obj, Evas_Coord * w, Evas_Coord * h)

to be documented. Parameters:

obj to be documented.
w to be documented.
h to be documented.

Returns:

Returns no value.

EAPI const Evas_Textblock_Style* evas_object_textblock_style_get (const Evas_Object * obj)

to be documented. Parameters:

obj to be documented.

Returns:

to be documented.

EAPI void evas_object_textblock_style_insets_get (const Evas_Object * obj, Evas_Coord * l, Evas_Coord * r, Evas_Coord * t, Evas_Coord * b)

to be documented. Parameters:

obj to be documented.
l to be documented.
r to be documented.
t to be documented.
b to be documented.

Returns:

Returns no value.

EAPI void evas_object_textblock_style_set (Evas_Object * obj, Evas_Textblock_Style * ts)

to be documented. Parameters:

obj to be documented.
ts to be documented.

Returns:

Returns no value.

References evas_object_textblock_text_markup_get(), and evas_textblock_style_free().

EAPI const char* evas_object_textblock_text_markup_get (const Evas_Object * obj)

to be documented. Parameters:

obj to be documented.

Returns:

to be documented.

Referenced by evas_object_textblock_style_set(), and evas_textblock_style_set().

EAPI void evas_object_textblock_text_markup_prepend (Evas_Textblock_Cursor * cur, const char * text)

to be documented. Parameters:

cur to be documented.
text to be documented.

Returns:

Return no value.

References evas_textblock_cursor_format_prepend().

EAPI void evas_object_textblock_text_markup_set (Evas_Object * obj, const char * text)

to be documented. Parameters:

obj to be documented.
text to be documented.

Returns:

Return no value.

References evas_textblock_cursor_format_append(), and evas_textblock_cursor_node_first().

Referenced by evas_textblock_style_set().

EAPI Eina_Bool evas_textblock_cursor_char_coord_set (Evas_Textblock_Cursor * cur, Evas_Coord x, Evas_Coord y)

to be documented. Parameters:

cur to be documented.
x to be documented.
y to be documented.

Returns:

to be documented.

EAPI void evas_textblock_cursor_char_delete (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

Returns no value.

References evas_textblock_cursor_char_last(), and evas_textblock_cursor_node_delete().

Referenced by evas_textblock_cursor_range_delete().

EAPI void evas_textblock_cursor_char_first (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

Returns no value.

EAPI int evas_textblock_cursor_char_geometry_get (const Evas_Textblock_Cursor * cur, Evas_Coord * cx, Evas_Coord * cy, Evas_Coord * cw, Evas_Coord * ch)

to be documented. Parameters:

cur to be documented.
cx to be documented.
cy to be documented.
cw to be documented.
ch to be documented.

Returns:

to be documented.

Referenced by evas_textblock_cursor_range_geometry_get().

EAPI void evas_textblock_cursor_char_last (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

Returns no value.

Referenced by evas_textblock_cursor_char_delete(), evas_textblock_cursor_node_delete(), evas_textblock_cursor_node_last(), evas_textblock_cursor_node_prev(), and evas_textblock_cursor_range_delete().

EAPI Eina_Bool evas_textblock_cursor_char_next (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

to be documented.

EAPI Eina_Bool evas_textblock_cursor_char_prev (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

to be documented.

EAPI int evas_textblock_cursor_compare (const Evas_Textblock_Cursor * cur1, const Evas_Textblock_Cursor * cur2)

to be documented. Parameters:

cur1 to be documented.
cur2 to be documented.

Returns:

to be documented.

Referenced by evas_textblock_cursor_range_delete(), evas_textblock_cursor_range_geometry_get(), and evas_textblock_cursor_range_text_get().

EAPI void evas_textblock_cursor_copy (const Evas_Textblock_Cursor * cur, Evas_Textblock_Cursor * cur_dest)

to be documented. Parameters:

cur to be documented.
cur_dest to be documented.

Returns:

Returns no value.

Referenced by evas_textblock_cursor_range_delete().

EAPI Eina_Bool evas_textblock_cursor_eol_get (const Evas_Textblock_Cursor * cur)

To be documented. FIXME: To be fixed.

EAPI void evas_textblock_cursor_eol_set (Evas_Textblock_Cursor * cur, Eina_Bool eol)

To be documented. FIXME: To be fixed.

EAPI void evas_textblock_cursor_format_append (Evas_Textblock_Cursor * cur, const char * format)

to be documented. Parameters:

cur to be documented.
format to be documented.

Returns:

Returns no value.

Referenced by evas_object_textblock_text_markup_set().

EAPI Eina_Bool evas_textblock_cursor_format_item_geometry_get (const Evas_Textblock_Cursor * cur, Evas_Coord * cx, Evas_Coord * cy, Evas_Coord * cw, Evas_Coord * ch)

to be documented. Parameters:

cur to be documented.
cx to be documented.
cy to be documented.
cw to be documented.
ch to be documented.

Returns:

to be documented.

EAPI void evas_textblock_cursor_format_prepend (Evas_Textblock_Cursor * cur, const char * format)

to be documented. Parameters:

cur to be documented.
format to be documented.

Returns:

Returns no value.

Referenced by evas_object_textblock_text_markup_prepend().

EAPI void evas_textblock_cursor_free (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

Returns no value.

EAPI int evas_textblock_cursor_line_coord_set (Evas_Textblock_Cursor * cur, Evas_Coord y)

to be documented. Parameters:

cur to be documented.
y to be documented.

Returns:

to be documented.

References evas_textblock_cursor_line_set().

EAPI void evas_textblock_cursor_line_first (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

Returns no value.

EAPI int evas_textblock_cursor_line_geometry_get (const Evas_Textblock_Cursor * cur, Evas_Coord * cx, Evas_Coord * cy, Evas_Coord * cw, Evas_Coord * ch)

to be documented. Parameters:

cur to be documented.
cx to be documented.
cy to be documented.
cw to be documented.
ch to be documented.

Returns:

to be documented.

Referenced by evas_textblock_cursor_range_geometry_get().

EAPI void evas_textblock_cursor_line_last (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

Returns no value.

EAPI Eina_Bool evas_textblock_cursor_line_set (Evas_Textblock_Cursor * cur, int line)

to be documented. Parameters:

cur to be documented.
line to be documented.

Returns:

to be documented.

Referenced by evas_textblock_cursor_line_coord_set().

EAPI void evas_textblock_cursor_node_delete (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

Returns no value.

References evas_textblock_cursor_char_last().

Referenced by evas_textblock_cursor_char_delete(), and evas_textblock_cursor_range_delete().

EAPI void evas_textblock_cursor_node_first (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

Returns no value.

Referenced by evas_object_textblock_text_markup_set().

EAPI const char* evas_textblock_cursor_node_format_get (const Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

to be documented.

EAPI Eina_Bool evas_textblock_cursor_node_format_is_visible_get (const Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

to be documented.

EAPI void evas_textblock_cursor_node_last (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

Returns no value.

References evas_textblock_cursor_char_last().

EAPI Eina_Bool evas_textblock_cursor_node_next (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

to be documented.

EAPI Eina_Bool evas_textblock_cursor_node_prev (Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

to be documented.

References evas_textblock_cursor_char_last().

EAPI const char* evas_textblock_cursor_node_text_get (const Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

to be documented.

EAPI int evas_textblock_cursor_node_text_length_get (const Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

to be documented.

EAPI int evas_textblock_cursor_pos_get (const Evas_Textblock_Cursor * cur)

to be documented. Parameters:

cur to be documented.

Returns:

to be documented.

EAPI void evas_textblock_cursor_pos_set (Evas_Textblock_Cursor * cur, int pos)

to be documented. Parameters:

cur to be documented.
pos to be documented.

EAPI void evas_textblock_cursor_range_delete (Evas_Textblock_Cursor * cur1, Evas_Textblock_Cursor * cur2)

to be documented. Parameters:

cur1 to be documented.
cur2 to be documented.

Returns:

Returns no value.

References evas_textblock_cursor_char_delete(), evas_textblock_cursor_char_last(), evas_textblock_cursor_compare(), evas_textblock_cursor_copy(), and evas_textblock_cursor_node_delete().

EAPI Eina_List* evas_textblock_cursor_range_geometry_get (const Evas_Textblock_Cursor * cur1, const Evas_Textblock_Cursor * cur2)

to be documented. Parameters:

cur1 to be documented.
cur2 to be documented.

Returns:

to be documented.

References evas_object_textblock_line_number_geometry_get(), evas_textblock_cursor_char_geometry_get(), evas_textblock_cursor_compare(), and evas_textblock_cursor_line_geometry_get().

EAPI char* evas_textblock_cursor_range_text_get (const Evas_Textblock_Cursor * cur1, const Evas_Textblock_Cursor * cur2, Evas_Textblock_Text_Type format)

to be documented. Parameters:

cur1 to be documented.
cur2 to be documented.
format to be documented.

Returns:

to be documented.

References evas_textblock_cursor_compare().

EAPI void evas_textblock_cursor_text_append (Evas_Textblock_Cursor * cur, const char * text)

to be documented. Parameters:

cur to be documented.
text to be documented.

Returns:

Returns no value.

EAPI void evas_textblock_cursor_text_prepend (Evas_Textblock_Cursor * cur, const char * text)

to be documented. Parameters:

cur to be documented.
text to be documented.

Returns:

Returns no value.

EAPI const char* evas_textblock_escape_string_get (const char * escape)

to be documented. Parameters:

escape to be documented.

Returns:

to be documented.

EAPI const char* evas_textblock_escape_string_range_get (const char * escape_start, const char * escape_end)

to be documented. Parameters:

escape_start to be documented.
escape_end to be documented.

Returns:

to be documented.

EAPI const char* evas_textblock_string_escape_get (const char * string, int * len_ret)

to be documented. Parameters:

string to be documented.
len_ret to be documented.

Returns:

to be documented.

EAPI void evas_textblock_style_free (Evas_Textblock_Style * ts)

Destroys a textblock style. Parameters:

ts The textblock style to free.

Referenced by evas_object_textblock_style_set().

EAPI const char* evas_textblock_style_get (const Evas_Textblock_Style * ts)

to be documented. Parameters:

ts to be documented.

Returns:

to be documented.

EAPI Evas_Textblock_Style* evas_textblock_style_new (void)

Creates a new textblock style. Returns:

The new textblock style.

EAPI void evas_textblock_style_set (Evas_Textblock_Style * ts, const char * text)

to be documented. Parameters:

ts to be documented.
text to be documented.

Returns:

Returns no value.

References evas_object_textblock_text_markup_get(), and evas_object_textblock_text_markup_set().

Author

Generated automatically by Doxygen for Evas from the source code.