Tizen Native API
Edje Text Part

Functions

void edje_object_text_change_cb_set (Edje_Object *obj, Edje_Text_Change_Cb func, void *data)
 Set the object text callback.
Eina_Bool edje_object_part_text_escaped_set (Edje_Object *obj, const char *part, const char *text)
 Sets the text for an object part, but converts HTML escapes to UTF8.
const char * edje_object_part_text_style_user_peek (const Edje_Object *obj, const char *part)
 Return the text of the object part.
void edje_object_part_text_style_user_push (Edje_Object *obj, const char *part, const char *style)
 Set the style of the.
void edje_object_part_text_append (Edje_Object *obj, const char *part, const char *text)
 Insert text for an object part.
Eina_Bool edje_object_part_text_item_geometry_get (const Edje_Object *obj, const char *part, const char *item, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
 Return item geometry.
void edje_object_part_text_style_user_pop (Edje_Object *obj, const char *part)
 Delete the top style form the user style stack.
void edje_object_part_text_insert (Edje_Object *obj, const char *part, const char *text)
 Insert text for an object part.
const Eina_Listedje_object_part_text_anchor_geometry_get (const Edje_Object *obj, const char *part, const char *anchor)
 Return a list of Evas_Textblock_Rectangle anchor rectangles.
Eina_Bool edje_object_part_text_unescaped_set (Edje_Object *obj, const char *part, const char *text_to_escape)
 Sets the raw (non escaped) text for an object part.
char * edje_object_part_text_unescaped_get (const Edje_Object *obj, const char *part)
 Returns the text of the object part, without escaping.
Eina_Bool edje_object_part_text_set (Edje_Object *obj, const char *part, const char *text)
 Sets the text for an object part.
const char * edje_object_part_text_get (const Edje_Object *obj, const char *part)
 Return the text of the object part.
const Eina_Listedje_object_part_text_anchor_list_get (const Edje_Object *obj, const char *part)
 Return a list of char anchor names.
void edje_object_part_text_user_insert (const Edje_Object *obj, const char *part, const char *text)
 This function inserts text as if the user has inserted it.
const Eina_Listedje_object_part_text_item_list_get (const Edje_Object *obj, const char *part)
 Return a list of char item names.

Typedefs

typedef void(* Edje_Text_Change_Cb )(void *data, Evas_Object *obj, const char *part)

Functions that deal with parts of type text.

Text is an element type for parts. It's basic functionality is to display a string on the layout, but a lot more things can be done with texts, like string selection, setting the cursor and include a input panel, where one can set a virtual keyboard to handle keyboard entry easily.


Typedef Documentation

Callback prototype for Edje_Text_Change

Parameters:
datauser provided data to pass to the callback
objthe Evas_Object
Theedje part

Enumeration Type Documentation

Enumerator:
EDJE_TEXT_EFFECT_NONE 

None text effect value

EDJE_TEXT_EFFECT_PLAIN 

Plain text effect value

EDJE_TEXT_EFFECT_OUTLINE 

Outline text effect value

EDJE_TEXT_EFFECT_SOFT_OUTLINE 

Soft outline text effect value

EDJE_TEXT_EFFECT_SHADOW 

Shadown text effect value

EDJE_TEXT_EFFECT_SOFT_SHADOW 

Soft shadow text effect value

EDJE_TEXT_EFFECT_OUTLINE_SHADOW 

Outline shadow text effect value

EDJE_TEXT_EFFECT_OUTLINE_SOFT_SHADOW 

Outline soft shadow text effect value

EDJE_TEXT_EFFECT_FAR_SHADOW 

Far shadow text effect value

EDJE_TEXT_EFFECT_FAR_SOFT_SHADOW 

Far soft shadow text effect value

EDJE_TEXT_EFFECT_GLOW 

Glow text effect value

EDJE_TEXT_EFFECT_LAST 

Last text effect value

EDJE_TEXT_EFFECT_SHADOW_DIRECTION_BOTTOM_RIGHT 

Bottom right shadow direction value

EDJE_TEXT_EFFECT_SHADOW_DIRECTION_BOTTOM 

Bottom shadow direction value

EDJE_TEXT_EFFECT_SHADOW_DIRECTION_BOTTOM_LEFT 

Bottom left shadow direction value

EDJE_TEXT_EFFECT_SHADOW_DIRECTION_LEFT 

Left shadow direction value

EDJE_TEXT_EFFECT_SHADOW_DIRECTION_TOP_LEFT 

Top left shadow direction value

EDJE_TEXT_EFFECT_SHADOW_DIRECTION_TOP 

Top shadow direction value

EDJE_TEXT_EFFECT_SHADOW_DIRECTION_TOP_RIGHT 

Top right shadow direction value

EDJE_TEXT_EFFECT_SHADOW_DIRECTION_RIGHT 

right shadow direction value


Function Documentation

const Eina_List* edje_object_part_text_anchor_geometry_get ( const Edje_Object *  obj,
const char *  part,
const char *  anchor 
)

Return a list of Evas_Textblock_Rectangle anchor rectangles.

Since :
2.3
Returns:
The list of anchor rects (const Evas_Textblock_Rectangle *), do not modify! Geometry is relative to entry part.
Remarks:
This function return a list of Evas_Textblock_Rectangle anchor rectangles.
Parameters:
[in]objThe edje object
[in]partThe part name
[in]anchorThe anchor name
const Eina_List* edje_object_part_text_anchor_list_get ( const Edje_Object *  obj,
const char *  part 
)

Return a list of char anchor names.

Since :
2.3
Returns:
The list of anchors (const char *), do not modify!

This function returns a list of char anchor names.

Parameters:
[in]objThe edje object
[in]partThe part name
void edje_object_part_text_append ( Edje_Object *  obj,
const char *  part,
const char *  text 
)

Insert text for an object part.

Since :
2.3
Remarks:
This function inserts the text for an object part at the end; It does not move the cursor.
Since (EFL) :
1.1
Parameters:
[in]objThe edje object
[in]partThe part name
[in]textThe text string
Eina_Bool edje_object_part_text_escaped_set ( Edje_Object *  obj,
const char *  part,
const char *  text 
)

Sets the text for an object part, but converts HTML escapes to UTF8.

Since :
2.3
Remarks:
This converts the given string text to UTF8 assuming it contains HTML style escapes like & and © etc. IF the part is of type TEXT, as opposed to TEXTBLOCK.
Returns:
EINA_TRUE on success, EINA_FALSE otherwise
Since (EFL) :
1.2
Parameters:
[in]objThe edje object
[in]partThe part name
[in]textThe text string
const char* edje_object_part_text_get ( const Edje_Object *  obj,
const char *  part 
)

Return the text of the object part.

Since :
2.3
Returns:
The text string
Remarks:
This function returns the text associated to the object part.
See also:
edje_object_part_text_set().
Parameters:
[in]objThe edje object
[in]partThe part name
void edje_object_part_text_insert ( Edje_Object *  obj,
const char *  part,
const char *  text 
)

Insert text for an object part.

Since :
2.3
Remarks:
This function inserts the text for an object part just before the cursor position.
Parameters:
[in]objThe edje object
[in]partThe part name
[in]textThe text string
Eina_Bool edje_object_part_text_item_geometry_get ( const Edje_Object *  obj,
const char *  part,
const char *  item,
Evas_Coord cx,
Evas_Coord cy,
Evas_Coord cw,
Evas_Coord ch 
)

Return item geometry.

Since :
2.3
Returns:
1 if item exists, 0 if not
Remarks:
This function return a list of Evas_Textblock_Rectangle item rectangles.
Parameters:
[in]objThe edje object
[in]partThe part name
[in]itemThe item name
[out]cxItem x return (relative to entry part)
[out]cyItem y return (relative to entry part)
[out]cwItem width return
[out]chItem height return
const Eina_List* edje_object_part_text_item_list_get ( const Edje_Object *  obj,
const char *  part 
)

Return a list of char item names.

Since :
2.3
Returns:
The list of items (const char *), do not modify!

This function returns a list of char item names.

Parameters:
[in]objThe edje object
[in]partThe part name
Eina_Bool edje_object_part_text_set ( Edje_Object *  obj,
const char *  part,
const char *  text 
)

Sets the text for an object part.

Since :
2.3
Returns:
EINA_TRUE on success, EINA_FALSE otherwise
Parameters:
[in]objThe edje object
[in]partThe part name
[in]textThe text string
const char* edje_object_part_text_style_user_peek ( const Edje_Object *  obj,
const char *  part 
)

Return the text of the object part.

Since :
2.3
Returns:
The text string
Remarks:
This function returns the style associated with the textblock part.
Since (EFL) :
1.2.0
Parameters:
[in]objThe edje object
[in]partThe part name
void edje_object_part_text_style_user_pop ( Edje_Object *  obj,
const char *  part 
)

Delete the top style form the user style stack.

Since :
2.3
Since (EFL) :
1.2.0
Parameters:
[in]objThe edje object
[in]partThe part name
void edje_object_part_text_style_user_push ( Edje_Object *  obj,
const char *  part,
const char *  style 
)

Set the style of the.

Since :
2.3
Remarks:
This function sets the style associated with the textblock part.
Since (EFL) :
1.2.0
Parameters:
[in]objThe edje object
[in]partThe part name
[in]styleThe style to set (textblock conventions).
char* edje_object_part_text_unescaped_get ( const Edje_Object *  obj,
const char *  part 
)

Returns the text of the object part, without escaping.

Since :
2.3
Returns:
The allocated text string without escaping, or NULL on problems.
Remarks:
This function is the counterpart of edje_object_part_text_unescaped_set(). Please notice that the result is newly allocated memory and should be released with free() when done.
See also:
edje_object_part_text_unescaped_set().
Parameters:
[in]objThe edje object
[in]partThe part name
Eina_Bool edje_object_part_text_unescaped_set ( Edje_Object *  obj,
const char *  part,
const char *  text_to_escape 
)

Sets the raw (non escaped) text for an object part.

Since :
2.3
Remarks:
This funciton will not do escape for you if it is a TEXTBLOCK part, that is, if text contain tags, these tags will not be interpreted/parsed by TEXTBLOCK.
See also:
edje_object_part_text_unescaped_get().
Parameters:
[in]objThe edje object
[in]partThe part name
[in]text_to_escapeThe text string
void edje_object_part_text_user_insert ( const Edje_Object *  obj,
const char *  part,
const char *  text 
)

This function inserts text as if the user has inserted it.

Since :
2.3
Remarks:
This means it actually registers as a change and emits signals, triggers callbacks as appropriate.
Since (EFL) :
1.2.0
Parameters:
[in]objThe edje object
[in]partThe part name
[in]textThe text string
void edje_object_text_change_cb_set ( Edje_Object *  obj,
Edje_Text_Change_Cb  func,
void *  data 
)

Set the object text callback.

Since :
2.3

This function sets the callback to be called when the text changes.

Parameters:
[in]objThe edje object
[in]funcThe callback function to handle the text change
[in]dataThe data associated to the callback function.