Macros | Typedefs | Functions
Edje Drag

Functions that deal with dragable parts. More...

Macros

#define EDJE_DRAG_DIR_NONE   EFL_UI_DRAG_DIR_NONE
 Not dragable.
 
#define EDJE_DRAG_DIR_X   EFL_UI_DRAG_DIR_X
 Dragable horizontally.
 
#define EDJE_DRAG_DIR_Y   EFL_UI_DRAG_DIR_Y
 Dragable verically.
 
#define EDJE_DRAG_DIR_XY   EFL_UI_DRAG_DIR_XY
 Dragable in both directions.
 

Typedefs

typedef Efl_Ui_Drag_Dir Edje_Drag_Dir
 Dragable properties values.
 

Functions

Eina_Bool edje_object_part_drag_value_set (Edje_Object *obj, const char *part, double dx, double dy)
 Sets the dragable object location. More...
 
Eina_Bool edje_object_part_drag_value_get (const Edje_Object *obj, const char *part, double *dx, double *dy)
 Gets the dragable object location. More...
 
Eina_Bool edje_object_part_drag_size_set (Edje_Object *obj, const char *part, double dw, double dh)
 Sets the dragable object size. More...
 
Eina_Bool edje_object_part_drag_size_get (const Edje_Object *obj, const char *part, double *dw, double *dh)
 Gets the dragable object size. More...
 
Edje_Drag_Dir edje_object_part_drag_dir_get (const Edje_Object *obj, const char *part)
 Determines dragable directions. More...
 
Eina_Bool edje_object_part_drag_step_set (Edje_Object *obj, const char *part, double dx, double dy)
 Sets the drag step increment. More...
 
Eina_Bool edje_object_part_drag_step_get (const Edje_Object *obj, const char *part, double *dx, double *dy)
 Gets the drag step increment values. More...
 
Eina_Bool edje_object_part_drag_step (Edje_Object *obj, const char *part, double dx, double dy)
 Steps the dragable x,y steps. More...
 
Eina_Bool edje_object_part_drag_page_set (Edje_Object *obj, const char *part, double dx, double dy)
 Sets the page step increments. More...
 
Eina_Bool edje_object_part_drag_page_get (const Edje_Object *obj, const char *part, double *dx, double *dy)
 Gets the page step increments. More...
 
Eina_Bool edje_object_part_drag_page (Edje_Object *obj, const char *part, double dx, double dy)
 Pages x,y steps. More...
 
Eina_Bool edje_object_part_text_set (const Edje_Object *obj, const char *part, const char *text)
 Sets a given text to an Edje object TEXT or TEXTBLOCK parts. More...
 
const char * edje_object_part_text_get (const Edje_Object *obj, const char *part)
 Gets the text currntly set to the given part. More...
 
void edje_object_part_text_cursor_begin_set (Edje_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the beginning of the text part evas_textblock_cursor_paragraph_first. More...
 
void edje_object_part_text_cursor_end_set (Edje_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the end of the text part. More...
 
void edje_object_part_text_cursor_pos_set (Edje_Object *obj, const char *part, Edje_Cursor cur, int pos)
 Sets the cursor position to the given value. More...
 
int edje_object_part_text_cursor_pos_get (const Edje_Object *obj, const char *part, Edje_Cursor cur)
 Retrieves the current position of the cursor. More...
 
Eina_Bool edje_object_part_text_cursor_coord_set (Edje_Object *obj, const char *part, Edje_Cursor cur, int x, int y)
 Position the given cursor to a X,Y position. More...
 
void edje_object_part_text_cursor_line_begin_set (Edje_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the beginning of the line. More...
 
void edje_object_part_text_cursor_line_end_set (Edje_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the end of the line. More...
 
Eina_Bool edje_object_part_text_cursor_prev (Edje_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the previous char evas_textblock_cursor_char_prev. More...
 
Eina_Bool edje_object_part_text_cursor_next (Edje_Object *obj, const char *part, Edje_Cursor cur)
 Advances the cursor to the next cursor position. More...
 
Eina_Bool edje_object_part_text_cursor_up (Edje_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the char above the current cursor position. More...
 
Eina_Bool edje_object_part_text_cursor_down (Edje_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the char below the current cursor position. More...
 
void edje_object_part_text_cursor_copy (Edje_Object *obj, const char *part, Edje_Cursor src, Edje_Cursor dst)
 Copies the cursor to another cursor. More...
 
char * edje_object_part_text_cursor_content_get (const Edje_Object *obj, const char *part, Edje_Cursor cur)
 Returns the content (char) at the cursor position. More...
 
void edje_object_part_text_cursor_geometry_get (const Edje_Object *obj, const char *part, int *x, int *y, int *w, int *h)
 Returns the cursor geometry of the part relative to the edje object. More...
 
Eina_Bool edje_object_part_text_hide_visible_password (Edje_Object *obj, const char *part)
 Hides visible last character for password mode. More...
 
Eina_Bool edje_object_part_text_cursor_is_format_get (const Edje_Object *obj, const char *part, Edje_Cursor cur)
 Returns whether the cursor points to a format. More...
 
Eina_Bool edje_object_part_text_cursor_is_visible_format_get (const Edje_Object *obj, const char *part, Edje_Cursor cur)
 Returns true if the cursor points to a visible format For example \t, \n, item and etc. More...
 
const Eina_Listedje_object_part_text_anchor_geometry_get (const Edje_Object *obj, const char *part, const char *anchor)
 Returns a list of Evas_Textblock_Rectangle anchor rectangles. More...
 
const Eina_Listedje_object_part_text_anchor_list_get (const Edje_Object *obj, const char *part)
 Returns a list of char anchor names. More...
 
const char * edje_object_part_text_style_user_peek (const Edje_Object *obj, const char *part)
 Returns the text of the object part. More...
 
void edje_object_part_text_style_user_push (Edje_Object *obj, const char *part, const char *style)
 Sets the style of the. More...
 
void edje_object_part_text_style_user_pop (Edje_Object *obj, const char *part)
 Deletes the top style form the user style stack. More...
 
Eina_Bool edje_object_part_text_item_geometry_get (const Edje_Object *obj, const char *part, const char *item, int *cx, int *cy, int *cw, int *ch)
 Returns item geometry. More...
 
const Eina_Listedje_object_part_text_item_list_get (const Edje_Object *obj, const char *part)
 Returns a list of char item names. More...
 
void edje_object_text_insert_filter_callback_add (Edje_Object *obj, const char *part, Edje_Text_Filter_Cb func, void *data)
 Adds a filter function for newly inserted text. More...
 
void * edje_object_text_insert_filter_callback_del (Edje_Object *obj, const char *part, Edje_Text_Filter_Cb func)
 Deletes a function from the filter list. More...
 
void * edje_object_text_insert_filter_callback_del_full (Edje_Object *obj, const char *part, Edje_Text_Filter_Cb func, void *data)
 Deletes a function and matching user data from the filter list. More...
 
void edje_object_text_markup_filter_callback_add (Edje_Object *obj, const char *part, Edje_Markup_Filter_Cb func, void *data)
 Adds a markup filter function for newly inserted text. More...
 
void * edje_object_text_markup_filter_callback_del (Edje_Object *obj, const char *part, Edje_Markup_Filter_Cb func)
 Deletes a function from the markup filter list. More...
 
void * edje_object_text_markup_filter_callback_del_full (Edje_Object *obj, const char *part, Edje_Markup_Filter_Cb func, void *data)
 Deletes a function and matching user data from the markup filter list. More...
 
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. More...
 
void edje_object_part_text_append (Edje_Object *obj, const char *part, const char *text)
 Inserts text for an object part. More...
 
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. More...
 
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. More...
 
char * edje_object_part_text_unescaped_get (const Edje_Object *obj, const char *part)
 Returns the text of the object part, without escaping. More...
 
void edje_object_part_text_insert (Edje_Object *obj, const char *part, const char *text)
 Inserts text for an object part. More...
 

Detailed Description

Functions that deal with dragable parts.

To create a movable part it must be declared as dragable in EDC file. To do so, one must define a "dragable" block inside the "part" block.

These functions are used to set dragging properties to a part or get dragging information about it.

See also
Dragable parts example *

Function Documentation

◆ edje_object_part_drag_value_set()

Eina_Bool edje_object_part_drag_value_set ( Edje_Object *  obj,
const char *  part,
double  dx,
double  dy 
)

Sets the dragable object location.

Places the dragable object at the given location.

Values for dx and dy are real numbers that range from 0 to 1, representing the relative position to the dragable area on that axis.

This value means, for the vertical axis, that 0.0 will be at the top if the first parameter of y in the dragable part theme is 1, and at bottom if it is -1.

For the horizontal axis, 0.0 means left if the first parameter of x in the dragable part theme is 1, and right if it is -1.

See also edje_object_part_drag_value_get()

Parameters
[in]partThe part name
[in]dxThe x value
[in]dyThe y value
Returns
true on success, false otherwise

◆ edje_object_part_drag_value_get()

Eina_Bool edje_object_part_drag_value_get ( const Edje_Object *  obj,
const char *  part,
double *  dx,
double *  dy 
)

Gets the dragable object location.

Values for dx and dy are real numbers that range from 0 to 1, representing the relative position to the dragable area on that axis.

See also edje_object_part_drag_value_set()

Gets the drag location values.

Parameters
[in]partThe part name
[out]dxThe x value
[out]dyThe y value
Returns
true on success, false otherwise

◆ edje_object_part_drag_size_set()

Eina_Bool edje_object_part_drag_size_set ( Edje_Object *  obj,
const char *  part,
double  dw,
double  dh 
)

Sets the dragable object size.

Values for dw and dh are real numbers that range from 0 to 1, representing the relative size of the dragable area on that axis.

Sets the size of the dragable object.

See also edje_object_part_drag_size_get()

Parameters
[in]partThe part name
[in]dwThe drag width
[in]dhThe drag height
Returns
true on success, false otherwise

◆ edje_object_part_drag_size_get()

Eina_Bool edje_object_part_drag_size_get ( const Edje_Object *  obj,
const char *  part,
double *  dw,
double *  dh 
)

Gets the dragable object size.

Gets the dragable object size.

See also edje_object_part_drag_size_set()

Parameters
[in]partThe part name
[out]dwThe drag width
[out]dhThe drag height
Returns
true on success, false otherwise

◆ edje_object_part_drag_dir_get()

Edje_Drag_Dir edje_object_part_drag_dir_get ( const Edje_Object *  obj,
const char *  part 
)

Determines dragable directions.

The dragable directions are defined in the EDC file, inside the dragable section, by the attributes x and y. See the Edje Data Collection reference for more information.

Parameters
[in]partThe part name
Returns
EDJE_DRAG_DIR_NONE: Not dragable EDJE_DRAG_DIR_X: Dragable in X direction EDJE_DRAG_DIR_Y: Dragable in Y direction EDJE_DRAG_DIR_XY: Dragable in X & Y directions

◆ edje_object_part_drag_step_set()

Eina_Bool edje_object_part_drag_step_set ( Edje_Object *  obj,
const char *  part,
double  dx,
double  dy 
)

Sets the drag step increment.

Sets the x,y step increments for a dragable object.

Values for dx and dy are real numbers that range from 0 to 1, representing the relative size of the dragable area on that axis by which the part will be moved.

See also edje_object_part_drag_step_get()

Parameters
[in]partThe part name
[in]dxThe x step amount
[in]dyThe y step amount
Returns
true on success, false otherwise

◆ edje_object_part_drag_step_get()

Eina_Bool edje_object_part_drag_step_get ( const Edje_Object *  obj,
const char *  part,
double *  dx,
double *  dy 
)

Gets the drag step increment values.

Gets the x and y step increments for the dragable object.

See also edje_object_part_drag_step_set()

Parameters
[in]partThe part name
[out]dxThe x step amount
[out]dyThe y step amount
Returns
true on success, false otherwise

◆ edje_object_part_drag_step()

Eina_Bool edje_object_part_drag_step ( Edje_Object *  obj,
const char *  part,
double  dx,
double  dy 
)

Steps the dragable x,y steps.

Steps x,y where the step increment is the amount set by edje_object_part_drag_step_set().

Values for dx and dy are real numbers that range from 0 to 1.

See also edje_object_part_drag_page()

Parameters
[in]partThe part name
[in]dxThe x step
[in]dyThe y step
Returns
true on success, false otherwise

◆ edje_object_part_drag_page_set()

Eina_Bool edje_object_part_drag_page_set ( Edje_Object *  obj,
const char *  part,
double  dx,
double  dy 
)

Sets the page step increments.

Sets the x,y page step increment values.

Values for dx and dy are real numbers that range from 0 to 1, representing the relative size of the dragable area on that axis by which the part will be moved.

See also edje_object_part_drag_page_get()

Parameters
[in]partThe part name
[in]dxThe x page step increment
[in]dyThe y page step increment
Returns
true on success, false otherwise

◆ edje_object_part_drag_page_get()

Eina_Bool edje_object_part_drag_page_get ( const Edje_Object *  obj,
const char *  part,
double *  dx,
double *  dy 
)

Gets the page step increments.

Gets the x,y page step increments for the dragable object.

See also edje_object_part_drag_page_set()

Parameters
[in]partThe part name
[out]dxThe x page step increment
[out]dyThe y page step increment
Returns
true on success, false otherwise

◆ edje_object_part_drag_page()

Eina_Bool edje_object_part_drag_page ( Edje_Object *  obj,
const char *  part,
double  dx,
double  dy 
)

Pages x,y steps.

Pages x,y where the increment is defined by edje_object_part_drag_page_set().

Values for dx and dy are real numbers that range from 0 to 1.

Warning
Paging is bugged!

See also edje_object_part_drag_step()

Parameters
[in]partThe part name
[in]dxThe x step
[in]dyThe y step
Returns
true on success, false otherwise

◆ edje_object_part_text_set()

Eina_Bool edje_object_part_text_set ( const Edje_Object *  obj,
const char *  part,
const char *  text 
)

Sets a given text to an Edje object TEXT or TEXTBLOCK parts.

Parameters
[in]partThe part name
[in]textThe text to set on that part
Examples:
edje-color-class.c, and edje-text.c.

References EINA_TRUE.

Referenced by edje_external_type_get().

◆ edje_object_part_text_get()

const char* edje_object_part_text_get ( const Edje_Object *  obj,
const char *  part 
)

Gets the text currntly set to the given part.

Parameters
[in]partThe part name
Returns
The text set on the part, null otherwise.

Referenced by edje_external_type_get(), and elm_layout_content_swallow_list_get().

◆ edje_object_part_text_cursor_begin_set()

void edje_object_part_text_cursor_begin_set ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Moves the cursor to the beginning of the text part evas_textblock_cursor_paragraph_first.

Parameters
[in]partThe part name
[in]curThe edje cursor to work on

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_end_set()

void edje_object_part_text_cursor_end_set ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Moves the cursor to the end of the text part.

evas_textblock_cursor_paragraph_last

Parameters
[in]partThe part name
[in]curThe edje cursor to work on

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_pos_set()

void edje_object_part_text_cursor_pos_set ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur,
int  pos 
)

Sets the cursor position to the given value.

Parameters
[in]partThe part name
[in]curThe cursor to move
[in]posThe position of the cursor
Since
1.1.0

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_pos_get()

int edje_object_part_text_cursor_pos_get ( const Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Retrieves the current position of the cursor.

Parameters
[in]partThe part name
[in]curThe cursor to move
Returns
The position of the cursor
Since
1.1.0

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_coord_set()

Eina_Bool edje_object_part_text_cursor_coord_set ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur,
int  x,
int  y 
)

Position the given cursor to a X,Y position.

This is frequently used with the user cursor.

Parameters
[in]partThe part containing the object.
[in]curThe cursor to adjust.
[in]xX Coordinate.
[in]yY Coordinate.
Returns
true on success, false otherwise

References EINA_TRUE.

◆ edje_object_part_text_cursor_line_begin_set()

void edje_object_part_text_cursor_line_begin_set ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Moves the cursor to the beginning of the line.

evas_textblock_cursor_line_char_first

Parameters
[in]partThe part name
[in]curThe edje cursor to work on

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_line_end_set()

void edje_object_part_text_cursor_line_end_set ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Moves the cursor to the end of the line.

evas_textblock_cursor_line_char_last

Parameters
[in]partThe part name
[in]curThe edje cursor to work on

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_prev()

Eina_Bool edje_object_part_text_cursor_prev ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Moves the cursor to the previous char evas_textblock_cursor_char_prev.

Parameters
[in]partThe part name
[in]curThe edje cursor to work on
Returns
true on success, false otherwise

References EINA_TRUE.

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_next()

Eina_Bool edje_object_part_text_cursor_next ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Advances the cursor to the next cursor position.

evas_textblock_cursor_char_next

Parameters
[in]partThe part name
[in]curThe edje cursor to advance
Returns
true on success, false otherwise

References EINA_TRUE.

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_up()

Eina_Bool edje_object_part_text_cursor_up ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Moves the cursor to the char above the current cursor position.

Parameters
[in]partThe part name
[in]curThe edje cursor to work on
Returns
true on success, false otherwise

References EINA_TRUE.

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_down()

Eina_Bool edje_object_part_text_cursor_down ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Moves the cursor to the char below the current cursor position.

Parameters
[in]partThe part name
[in]curThe edje cursor to work on
Returns
true on success, false otherwise

References EINA_TRUE.

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_copy()

void edje_object_part_text_cursor_copy ( Edje_Object *  obj,
const char *  part,
Edje_Cursor  src,
Edje_Cursor  dst 
)

Copies the cursor to another cursor.

Parameters
[in]partThe part name
[in]srcThe cursor to copy from
[in]dstThe cursor to copy to

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_content_get()

char* edje_object_part_text_cursor_content_get ( const Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Returns the content (char) at the cursor position.

evas_textblock_cursor_content_get

You must free the return (if not null) after you are done with it.

Parameters
[in]partThe part name
[in]curThe cursor to use
Returns
The character string pointed to (may be a multi-byte utf8 sequence) terminated by a null byte.

References efl_data_scope_get().

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_geometry_get()

void edje_object_part_text_cursor_geometry_get ( const Edje_Object *  obj,
const char *  part,
int *  x,
int *  y,
int *  w,
int *  h 
)

Returns the cursor geometry of the part relative to the edje object.

Parameters
[in]partThe part name
[out]xCursor X position
[out]yCursor Y position
[out]wCursor width
[out]hCursor height

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_hide_visible_password()

Eina_Bool edje_object_part_text_hide_visible_password ( Edje_Object *  obj,
const char *  part 
)

Hides visible last character for password mode.

Parameters
[in]partThe part name
Returns
true if the visible character is hidden. false if there is no visible character or the object is not set for password mode.
Since
1.18.0

References EDJE_PART_TYPE_TEXTBLOCK, efl_data_scope_get(), and EINA_FALSE.

◆ edje_object_part_text_cursor_is_format_get()

Eina_Bool edje_object_part_text_cursor_is_format_get ( const Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Returns whether the cursor points to a format.

evas_textblock_cursor_is_format

Parameters
[in]partThe part name
[in]curThe cursor to adjust.
Returns
true if the cursor points to a format, false otherwise.

References EINA_FALSE.

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_cursor_is_visible_format_get()

Eina_Bool edje_object_part_text_cursor_is_visible_format_get ( const Edje_Object *  obj,
const char *  part,
Edje_Cursor  cur 
)

Returns true if the cursor points to a visible format For example \t, \n, item and etc.

evas_textblock_cursor_format_is_visible_get

Parameters
[in]partThe part name
[in]curThe cursor to adjust.
Returns
true if the cursor points to a visible format, false otherwise.

References EINA_FALSE.

Referenced by elm_entry_entry_get().

◆ edje_object_part_text_anchor_geometry_get()

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

Returns a list of Evas_Textblock_Rectangle anchor rectangles.

This function return a list of Evas_Textblock_Rectangle anchor rectangles.

Parameters
[in]partThe part name
[in]anchorThe anchor name
Returns
The list of anchor rects (const Evas_Textblock_Rectangle *), do not modify! Geometry is relative to entry part.

◆ edje_object_part_text_anchor_list_get()

const Eina_List* edje_object_part_text_anchor_list_get ( const Edje_Object *  obj,
const char *  part 
)

Returns a list of char anchor names.

This function returns a list of char anchor names.

Parameters
[in]partThe part name
Returns
The list of anchors (const char *), do not modify!

◆ edje_object_part_text_style_user_peek()

const char* edje_object_part_text_style_user_peek ( const Edje_Object *  obj,
const char *  part 
)

Returns the text of the object part.

This function returns the style associated with the textblock part.

Parameters
[in]partThe part name
Returns
The text string
Since
1.2.0

References EDJE_PART_TYPE_TEXTBLOCK, efl_data_scope_get(), evas_object_textblock_style_user_peek(), and evas_textblock_style_get().

◆ edje_object_part_text_style_user_push()

void edje_object_part_text_style_user_push ( Edje_Object *  obj,
const char *  part,
const char *  style 
)

Sets the style of the.

This function sets the style associated with the textblock part.

Parameters
[in]partThe part name
[in]styleThe style to set (textblock conventions).
Since
1.2.0

References EDJE_PART_TYPE_TEXTBLOCK, efl_data_scope_get(), EINA_TRUE, evas_object_textblock_style_user_push(), evas_textblock_style_free(), evas_textblock_style_new(), and evas_textblock_style_set().

◆ edje_object_part_text_style_user_pop()

void edje_object_part_text_style_user_pop ( Edje_Object *  obj,
const char *  part 
)

Deletes the top style form the user style stack.

Parameters
[in]partThe part name
Since
1.2.0

References EDJE_PART_TYPE_TEXTBLOCK, efl_data_scope_get(), EINA_TRUE, and evas_object_textblock_style_user_pop().

◆ edje_object_part_text_item_geometry_get()

Eina_Bool edje_object_part_text_item_geometry_get ( const Edje_Object *  obj,
const char *  part,
const char *  item,
int *  cx,
int *  cy,
int *  cw,
int *  ch 
)

Returns item geometry.

This function return a list of Evas_Textblock_Rectangle item rectangles.

Parameters
[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
Returns
$1 if item exists, $0 if not

References efl_data_scope_get(), and EINA_FALSE.

◆ edje_object_part_text_item_list_get()

const Eina_List* edje_object_part_text_item_list_get ( const Edje_Object *  obj,
const char *  part 
)

Returns a list of char item names.

This function returns a list of char item names.

Parameters
[in]partThe part name
Returns
The list of items (const char *), do not modify!

References efl_data_scope_get().

◆ edje_object_text_insert_filter_callback_add()

void edje_object_text_insert_filter_callback_add ( Edje_Object *  obj,
const char *  part,
Edje_Text_Filter_Cb  func,
void *  data 
)

Adds a filter function for newly inserted text.

Whenever text is inserted (not the same as set) into the given part, the list of filter functions will be called to decide if and how the new text will be accepted. There are three types of filters, EDJE_TEXT_FILTER_TEXT, EDJE_TEXT_FILTER_FORMAT and EDJE_TEXT_FILTER_MARKUP. The text parameter in the func filter can be modified by the user and it's up to him to free the one passed if he's to change the pointer. If doing so, the newly set text should be malloc'ed, as once all the filters are called Edje will free it. If the text is to be rejected, freeing it and setting the pointer to null will make Edje break out of the filter cycle and reject the inserted text.

Warning
This function will be deprecated because of difficulty in use. The type(format, text, or markup) of text should be always checked in the filter function for correct filtering. Please use edje_object_text_markup_filter_callback_add() instead. There is no need to check the type of text in the filter function because the text is always markup. Warning: If you use this function with edje_object_text_markup_filter_callback_add() together, all Edje_Text_Filter_Cb functions and Edje_Markup_Filter_Cb functions will be executed, and then filtered text will be inserted.

See also edje_object_text_insert_filter_callback_del, edje_object_text_insert_filter_callback_del_full and edje_object_text_markup_filter_callback_add

Parameters
[in]partThe part name
[in]funcThe callback function that will act as filter
[in]dataUser provided data to pass to the filter function

References efl_data_scope_get(), eina_list_append(), and eina_stringshare_add().

◆ edje_object_text_insert_filter_callback_del()

void* edje_object_text_insert_filter_callback_del ( Edje_Object *  obj,
const char *  part,
Edje_Text_Filter_Cb  func 
)

Deletes a function from the filter list.

Delete the given func filter from the list in part. Returns the user data pointer given when added.

See also edje_object_text_insert_filter_callback_add and edje_object_text_insert_filter_callback_del_full

Parameters
[in]partThe part name
[in]funcThe function callback to remove
Returns
The user data pointer if successful, or null otherwise

References efl_data_scope_get(), EINA_LIST_FOREACH, eina_list_remove_list(), and eina_stringshare_del().

◆ edje_object_text_insert_filter_callback_del_full()

void* edje_object_text_insert_filter_callback_del_full ( Edje_Object *  obj,
const char *  part,
Edje_Text_Filter_Cb  func,
void *  data 
)

Deletes a function and matching user data from the filter list.

Delete the given func filter and data user data from the list in part. Returns the user data pointer given when added.

See also edje_object_text_insert_filter_callback_add and edje_object_text_insert_filter_callback_del

Parameters
[in]partThe part name
[in]funcThe function callback to remove
[in]dataThe data passed to the callback function
Returns
The same data pointer if successful, or null otherwise

References efl_data_scope_get(), EINA_LIST_FOREACH, eina_list_remove_list(), and eina_stringshare_del().

◆ edje_object_text_markup_filter_callback_add()

void edje_object_text_markup_filter_callback_add ( Edje_Object *  obj,
const char *  part,
Edje_Markup_Filter_Cb  func,
void *  data 
)

Adds a markup filter function for newly inserted text.

Whenever text is inserted (not the same as set) into the given part, the list of markup filter functions will be called to decide if and how the new text will be accepted. The text parameter in the func filter is always markup. It can be modified by the user and it's up to him to free the one passed if he's to change the pointer. If doing so, the newly set text should be malloc'ed, as once all the filters are called Edje will free it. If the text is to be rejected, freeing it and setting the pointer to null will make Edje break out of the filter cycle and reject the inserted text. This function is different from edje_object_text_insert_filter_callback_add() in that the text parameter in the fucn filter is always markup.

Warning
If you use this function with edje_object_text_insert_filter_callback_add() togehter, all Edje_Text_Filter_Cb functions and Edje_Markup_Filter_Cb functions will be executed, and then filtered text will be inserted.

See also edje_object_text_markup_filter_callback_del, edje_object_text_markup_filter_callback_del_full and edje_object_text_insert_filter_callback_add

Parameters
[in]partThe part name
[in]funcThe callback function that will act as markup filter
[in]dataUser provided data to pass to the filter function
Since
1.2.0

References efl_data_scope_get(), eina_list_append(), and eina_stringshare_add().

◆ edje_object_text_markup_filter_callback_del()

void* edje_object_text_markup_filter_callback_del ( Edje_Object *  obj,
const char *  part,
Edje_Markup_Filter_Cb  func 
)

Deletes a function from the markup filter list.

Delete the given func filter from the list in part. Returns the user data pointer given when added.

See also edje_object_text_markup_filter_callback_add and edje_object_text_markup_filter_callback_del_full

Parameters
[in]partThe part name
[in]funcThe function callback to remove
Returns
The user data pointer if successful, or null otherwise
Since
1.2.0

References efl_data_scope_get(), EINA_LIST_FOREACH, eina_list_remove_list(), and eina_stringshare_del().

◆ edje_object_text_markup_filter_callback_del_full()

void* edje_object_text_markup_filter_callback_del_full ( Edje_Object *  obj,
const char *  part,
Edje_Markup_Filter_Cb  func,
void *  data 
)

Deletes a function and matching user data from the markup filter list.

Delete the given func filter and data user data from the list in part. Returns the user data pointer given when added.

See also edje_object_text_markup_filter_callback_add and edje_object_text_markup_filter_callback_del

Parameters
[in]partThe part name
[in]funcThe function callback to remove
[in]dataThe data passed to the callback function
Returns
The same data pointer if successful, or null otherwise
Since
1.2.0

References efl_data_scope_get(), EINA_LIST_FOREACH, eina_list_remove_list(), and eina_stringshare_del().

◆ edje_object_part_text_user_insert()

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.

This means it actually registers as a change and emits signals, triggers callbacks as appropriate.

Parameters
[in]partThe part name
[in]textThe text string
Since
1.2.0

References efl_data_scope_get(), and EINA_TRUE.

◆ edje_object_part_text_append()

void edje_object_part_text_append ( Edje_Object *  obj,
const char *  part,
const char *  text 
)

Inserts text for an object part.

This function inserts the text for an object part at the end; It does not move the cursor.

Parameters
[in]partThe part name
[in]textThe text string
Since
1.1

References EDJE_PART_TYPE_TEXTBLOCK, efl_data_scope_get(), and EINA_TRUE.

◆ edje_object_part_text_escaped_set()

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.

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.

Parameters
[in]partThe part name
[in]textThe text string
Returns
true on success, false otherwise
Since
1.2

References EDJE_PART_TYPE_TEXT, EDJE_PART_TYPE_TEXTBLOCK, efl_data_scope_get(), EINA_FALSE, eina_strbuf_append(), eina_strbuf_append_char(), eina_strbuf_append_length(), eina_strbuf_append_n(), eina_strbuf_free(), eina_strbuf_new(), eina_strbuf_string_get(), eina_strbuf_string_steal(), evas_textblock_escape_string_range_get(), and evas_textblock_string_escape_get().

Referenced by elm_layout_content_swallow_list_get().

◆ edje_object_part_text_unescaped_set()

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.

This function 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]partThe part name
[in]text_to_escapeThe text string
Returns
true on success, false otherwise

References EDJE_PART_TYPE_TEXT, EDJE_PART_TYPE_TEXTBLOCK, efl_data_scope_get(), and EINA_FALSE.

◆ edje_object_part_text_unescaped_get()

char* edje_object_part_text_unescaped_get ( const Edje_Object *  obj,
const char *  part 
)

Returns the text of the object part, without escaping.

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]partThe part name
Returns
The text string

References EDJE_PART_TYPE_TEXT, EDJE_PART_TYPE_TEXTBLOCK, efl_data_scope_get(), EINA_TRUE, and evas_object_textblock_text_markup_get().

◆ edje_object_part_text_insert()

void edje_object_part_text_insert ( Edje_Object *  obj,
const char *  part,
const char *  text 
)

Inserts text for an object part.

This function inserts the text for an object part just before the cursor position.

Parameters
[in]partThe part name
[in]textThe text string

References efl_data_scope_get().

Referenced by elm_entry_entry_get().