edje.dox File Reference
Edje Graphical Design Library. More...
Functions | |
EAPI int | edje_init (void) |
Initialize the EDJE library. | |
EAPI int | edje_shutdown (void) |
Shutdown the EDJE library. | |
EAPI void | edje_frametime_set (double t) |
Set the frametime. | |
EAPI double | edje_frametime_get (void) |
Get the frametime. | |
EAPI void | edje_freeze (void) |
Freeze all Edje objects in the current process. | |
EAPI void | edje_thaw (void) |
Thaw all Edje objects in the current process. | |
EAPI Eina_List * | edje_file_collection_list (const char *file) |
Get a list of groups in an edje file. | |
EAPI void | edje_file_collection_list_free (Eina_List *lst) |
Free file collection list. | |
EAPI int | edje_file_group_exists (const char *file, const char *glob) |
Determine whether a group matching glob exists in an edje file. | |
EAPI char * | edje_file_data_get (const char *file, const char *key) |
Get data from the file level data block of an edje file. | |
EAPI void | edje_color_class_set (const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3) |
Set Edje color class. | |
EAPI void | edje_color_class_del (const char *color_class) |
EAPI Eina_List * | edje_color_class_list (void) |
Lists all color classes known about by the current process. | |
EAPI void | edje_text_class_set (const char *text_class, const char *font, Evas_Font_Size size) |
Set the Edje text class. | |
EAPI void | edje_text_class_del (const char *text_class) |
EAPI Eina_List * | edje_text_class_list (void) |
Lists all text classes known about by the current process. | |
EAPI void | edje_extern_object_min_size_set (Evas_Object *obj, Evas_Coord minw, Evas_Coord minh) |
Set the object minimum size. | |
EAPI void | edje_extern_object_max_size_set (Evas_Object *obj, Evas_Coord maxw, Evas_Coord maxh) |
Set the object maximum size. | |
EAPI void | edje_extern_object_aspect_set (Evas_Object *obj, Edje_Aspect_Control aspect, Evas_Coord aw, Evas_Coord ah) |
Set the object aspect size. | |
EAPI void | edje_box_layout_register (const char *name, Evas_Object_Box_Layout func, void *(*layout_data_get)(void *), void(*layout_data_free)(void *), void(*free_data)(void *), void *data) |
Registers a custom layout to be used in edje boxes. | |
EAPI Evas_Object * | edje_object_add (Evas *evas) |
Constructs the Edje object. | |
EAPI const char * | edje_object_data_get (const Evas_Object *obj, const char *key) |
Get Edje object data. | |
EAPI int | edje_object_file_set (Evas_Object *obj, const char *file, const char *group) |
Sets the EET file and group to load obj from. | |
EAPI void | edje_object_file_get (const Evas_Object *obj, const char **file, const char **group) |
Get the file and group name that obj was loaded from. | |
EAPI int | edje_object_load_error_get (const Evas_Object *obj) |
Gets the Edje load error. | |
EAPI void | edje_object_signal_emit (Evas_Object *obj, const char *emission, const char *source) |
Send a signal to the Edje object. | |
EAPI void | edje_object_play_set (Evas_Object *obj, int play) |
Set the Edje to play or pause. | |
EAPI int | edje_object_play_get (const Evas_Object *obj) |
Get the Edje play/pause state. | |
EAPI void | edje_object_animation_set (Evas_Object *obj, int on) |
Set Animation state. | |
EAPI int | edje_object_animation_get (const Evas_Object *obj) |
Get the animation state. | |
EAPI int | edje_object_freeze (Evas_Object *obj) |
Freeze object. | |
EAPI int | edje_object_thaw (Evas_Object *obj) |
Thaw object. | |
EAPI void | edje_object_color_class_set (Evas_Object *obj, const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3) |
Sets the object color class. | |
EAPI void | edje_object_color_class_del (Evas_Object *obj, const char *color_class) |
EAPI void | edje_object_text_class_set (Evas_Object *obj, const char *text_class, const char *font, Evas_Font_Size size) |
Sets Edje text class. | |
EAPI void | edje_object_size_min_get (const Evas_Object *obj, Evas_Coord *minw, Evas_Coord *minh) |
Get the minimum size for an object. | |
EAPI void | edje_object_size_max_get (const Evas_Object *obj, Evas_Coord *maxw, Evas_Coord *maxh) |
Get the maximum size for an object. | |
EAPI void | edje_object_calc_force (Evas_Object *obj) |
Force a Size/Geometry calculation. | |
EAPI void | edje_object_size_min_calc (Evas_Object *obj, Evas_Coord *minw, Evas_Coord *minh) |
Calculate minimum size. | |
EAPI void | edje_object_size_min_restricted_calc (Evas_Object *obj, Evas_Coord *minw, Evas_Coord *minh, Evas_Coord restrictedw, Evas_Coord restrictedh) |
Calculate minimum size. | |
EAPI int | edje_object_part_exists (const Evas_Object *obj, const char *part) |
Check if Edje part exists. | |
EAPI const Evas_Object * | edje_object_part_object_get (const Evas_Object *obj, const char *part) |
Gets the Evas_Object corresponding to a given part. | |
EAPI void | edje_object_part_geometry_get (const Evas_Object *obj, const char *part, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) |
Get the geometry of an Edje part. | |
EAPI void | edje_object_part_text_set (Evas_Object *obj, const char *part, const char *text) |
Sets the text for an object part. | |
EAPI const char * | edje_object_part_text_get (const Evas_Object *obj, const char *part) |
Returns the text of the object part. | |
EAPI void | edje_object_part_text_unescaped_set (Evas_Object *obj, const char *part, const char *text_to_escape) |
Sets the raw (non escaped) text for an object part. | |
EAPI char * | edje_object_part_text_unescaped_get (const Evas_Object *obj, const char *part) |
Returns the text of the object part, without escaping. | |
EAPI const char * | edje_object_part_text_selection_get (const Evas_Object *obj, const char *part) |
Returns the selection text of the object part. | |
EAPI void | edje_object_part_text_select_none (const Evas_Object *obj, const char *part) |
sets the selection to be none | |
EAPI void | edje_object_part_text_select_all (const Evas_Object *obj, const char *part) |
sets the selection to be everything | |
EAPI void | edje_object_part_text_insert (Evas_Object *obj, const char *part, const char *text) |
Inserts the text for an object part just before the cursor position. | |
EAPI const Eina_List * | edje_object_part_text_anchor_list_get (const Evas_Object *obj, const char *part) |
Returns a list of char * anchor names. | |
EAPI const Eina_List * | edje_object_part_text_anchor_geometry_get (const Evas_Object *obj, const char *part, const char *anchor) |
Returns a list of Evas_Textblock_Rectangle * anchor rectangles. | |
EAPI void | edje_object_part_text_cursor_geometry_get (const Evas_Object *obj, const char *part, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) |
Returns the cursor geometry of the part relative to the edje object. | |
EAPI void | edje_object_part_text_select_allow_set (const Evas_Object *obj, const char *part, Evas_Bool allow) |
Enables selection if the entyr is an EXPLICIT selection mode type. | |
EAPI void | edje_object_part_text_select_abort (const Evas_Object *obj, const char *part) |
Aborts any selection action on a part. | |
EAPI void | edje_object_part_swallow (Evas_Object *obj, const char *part, Evas_Object *obj_swallow) |
Swallows an object into the edje. | |
EAPI void | edje_object_part_unswallow (Evas_Object *obj, Evas_Object *obj_swallow) |
Unswallow an object. | |
EAPI Evas_Object * | edje_object_part_swallow_get (const Evas_Object *obj, const char *part) |
Get the object currently swallowed by a part. | |
EAPI const char * | edje_object_part_state_get (const Evas_Object *obj, const char *part, double *val_ret) |
Returns the state of the Edje part. | |
EAPI int | edje_object_part_drag_dir_get (const Evas_Object *obj, const char *part) |
Determine dragable directions. | |
EAPI void | edje_object_part_drag_value_set (Evas_Object *obj, const char *part, double dx, double dy) |
Set the dragable object location. | |
EAPI void | edje_object_part_drag_value_get (const Evas_Object *obj, const char *part, double *dx, double *dy) |
Get the dragable object location. | |
EAPI void | edje_object_part_drag_size_set (Evas_Object *obj, const char *part, double dw, double dh) |
Set the dragable object size. | |
EAPI void | edje_object_part_drag_size_get (const Evas_Object *obj, const char *part, double *dw, double *dh) |
Get the dragable object size. | |
EAPI void | edje_object_part_drag_step_set (Evas_Object *obj, const char *part, double dx, double dy) |
Sets the drag step increment. | |
EAPI void | edje_object_part_drag_step_get (const Evas_Object *obj, const char *part, double *dx, double *dy) |
Gets the drag step increment values. | |
EAPI void | edje_object_part_drag_page_set (Evas_Object *obj, const char *part, double dx, double dy) |
Sets the page step increments. | |
EAPI void | edje_object_part_drag_page_get (const Evas_Object *obj, const char *part, double *dx, double *dy) |
Gets the page step increments. | |
EAPI void | edje_object_part_drag_step (Evas_Object *obj, const char *part, double dx, double dy) |
Steps the dragable x,y steps. | |
EAPI void | edje_object_part_drag_page (Evas_Object *obj, const char *part, double dx, double dy) |
Pages x,y steps. | |
EAPI Evas_Bool | edje_object_part_box_append (Evas_Object *obj, const char *part, Evas_Object *child) |
Appends an object to the box. | |
EAPI Evas_Bool | edje_object_part_box_prepend (Evas_Object *obj, const char *part, Evas_Object *child) |
Prepends an object to the box. | |
EAPI Evas_Bool | edje_object_part_box_insert_before (Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) |
Adds an object to the box. | |
EAPI Evas_Bool | edje_object_part_box_insert_at (Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) |
Inserts an object to the box. | |
EAPI Evas_Object * | edje_object_part_box_remove (Evas_Object *obj, const char *part, Evas_Object *child) |
Removes an object from the box. | |
EAPI Evas_Object * | edje_object_part_box_remove_at (Evas_Object *obj, const char *part, unsigned int pos) |
Removes an object from the box. | |
EAPI Evas_Bool | edje_object_part_box_remove_all (Evas_Object *obj, const char *part, Evas_Bool clear) |
Removes all elements from the box. | |
EAPI Evas_Bool | edje_object_part_table_pack (Evas_Object *obj, const char *part, Evas_Object *child_obj, unsigned short col, unsigned short row, unsigned short colspan, unsigned short rowspan) |
Packs an object into the table. | |
EAPI Evas_Bool | edje_object_part_table_unpack (Evas_Object *obj, const char *part, Evas_Object *child_obj) |
Removes an object from the table. | |
EAPI Evas_Bool | edje_object_part_table_col_row_size_get (const Evas_Object *obj, const char *part, int *cols, int *rows) |
Gets the number of columns and rows the table has. | |
EAPI Evas_Bool | edje_object_part_table_clear (Evas_Object *obj, const char *part, Evas_Bool clear) |
Removes all object from the table. | |
EAPI void | edje_object_signal_callback_add (Evas_Object *obj, const char *emission, const char *source, void(*func)(void *data, Evas_Object *o, const char *emission, const char *source), void *data) |
Add a callback for a signal emitted by obj. | |
EAPI void * | edje_object_signal_callback_del (Evas_Object *obj, const char *emission, const char *source, void(*func)(void *data, Evas_Object *o, const char *emission, const char *source)) |
Remove a callback from an object. |
Detailed Description
Edje Graphical Design Library.These routines are used for Edje.
Function Documentation
EAPI void edje_box_layout_register | ( | const char * | name, | |
Evas_Object_Box_Layout | func, | |||
void *(*)(void *) | layout_data_get, | |||
void(*)(void *) | layout_data_free, | |||
void(*)(void *) | free_data, | |||
void * | data | |||
) |
Registers a custom layout to be used in edje boxes.
- Parameters:
-
name The name of the layout func The function defining the layout layout_data_get This function gets the custom data pointer for func layout_data_free Passed to func to free its private data when needed free_data Frees data data Private pointer passed to layout_data_get
void edje_color_class_del | ( | const char * | color_class | ) |
- Parameters:
-
color_class Deletes any values at the process level for the specified color class.
Eina_List * edje_color_class_list | ( | void | ) |
Lists all color classes known about by the current process.
- Returns:
- A list of color class names (strings). These strings and the list must be free()'d by the caller.
EAPI void edje_color_class_set | ( | const char * | color_class, | |
int | r, | |||
int | g, | |||
int | b, | |||
int | a, | |||
int | r2, | |||
int | g2, | |||
int | b2, | |||
int | a2, | |||
int | r3, | |||
int | g3, | |||
int | b3, | |||
int | a3 | |||
) |
Set Edje color class.
- Parameters:
-
color_class r Object Red value g Object Green value b Object Blue value a Object Alpha value r2 Outline Red value g2 Outline Green value b2 Outline Blue value a2 Outline Alpha value r3 Shadow Red value g3 Shadow Green value b3 Shadow Blue value a3 Shadow Alpha value
The first color is the object, the second is the text outline, and the third is the text shadow. (Note that the second two only apply to text parts)
EAPI void edje_extern_object_aspect_set | ( | Evas_Object * | obj, | |
Edje_Aspect_Control | aspect, | |||
Evas_Coord | aw, | |||
Evas_Coord | ah | |||
) |
Set the object aspect size.
- Parameters:
-
obj A valid Evas_Object handle aspect The aspect control axes aw The aspect radio width ah The aspect ratio height
EAPI void edje_extern_object_max_size_set | ( | Evas_Object * | obj, | |
Evas_Coord | maxw, | |||
Evas_Coord | maxh | |||
) |
Set the object maximum size.
- Parameters:
-
obj A valid Evas_Object handle maxw The maximum width maxh The maximum height
EAPI void edje_extern_object_min_size_set | ( | Evas_Object * | obj, | |
Evas_Coord | minw, | |||
Evas_Coord | minh | |||
) |
Set the object minimum size.
- Parameters:
-
obj A valid Evas_Object handle minw The minimum width minh The minimum height
EAPI Eina_List * edje_file_collection_list | ( | const char * | file | ) |
Get a list of groups in an edje file.
- Parameters:
-
file The path to the edje file
- Returns:
- The Eina_List of group names (char *)
EAPI void edje_file_collection_list_free | ( | Eina_List * | lst | ) |
Free file collection list.
- Parameters:
-
lst The Eina_List of groups
EAPI char * edje_file_data_get | ( | const char * | file, | |
const char * | key | |||
) |
Get data from the file level data block of an edje file.
- Parameters:
-
file The path to the .edj file key The data key
- Returns:
- The string value of the data
data { item: "key1" "value1"; item: "key2" "value2"; } collections { ... }
Then, edje_file_data_get("key1") will return "value1"
EAPI int edje_file_group_exists | ( | const char * | file, | |
const char * | glob | |||
) |
Determine whether a group matching glob exists in an edje file.
- Parameters:
-
file The file path glob A glob to match on
- Returns:
- 1 if a match is found, 0 otherwise
EAPI double edje_frametime_get | ( | void | ) |
Get the frametime.
- Returns:
- The frametime
EAPI void edje_frametime_set | ( | double | t | ) |
Set the frametime.
- Parameters:
-
t The frametime
EAPI void edje_freeze | ( | void | ) |
Freeze all Edje objects in the current process.
See edje_object_freeze() for more.
References edje_object_freeze().
EAPI int edje_init | ( | void | ) |
Initialize the EDJE library.
- Returns:
- The new init count.
EAPI Evas_Object * edje_object_add | ( | Evas * | evas | ) |
Constructs the Edje object.
- Parameters:
-
evas A valid Evas handle
- Returns:
- The Evas_Object pointer.
EAPI int edje_object_animation_get | ( | const Evas_Object * | obj | ) |
Get the animation state.
- Parameters:
-
obj A valid Evas_Object handle
- Returns:
- 0 on Error or if not animated
1 if animated
EAPI void edje_object_animation_set | ( | Evas_Object * | obj, | |
int | on | |||
) |
Set Animation state.
- Parameters:
-
obj A valid Evas_Object handle on Animation State
EAPI void edje_object_calc_force | ( | Evas_Object * | obj | ) |
Force a Size/Geometry calculation.
- Parameters:
-
obj A valid Evas_Object handle
obj
to recalculation layout regardless of freeze/thaw.
void edje_object_color_class_del | ( | Evas_Object * | obj, | |
const char * | color_class | |||
) |
- Parameters:
-
color_class Deletes any values at the object level for the specified object and color class.
EAPI void edje_object_color_class_set | ( | Evas_Object * | obj, | |
const char * | color_class, | |||
int | r, | |||
int | g, | |||
int | b, | |||
int | a, | |||
int | r2, | |||
int | g2, | |||
int | b2, | |||
int | a2, | |||
int | r3, | |||
int | g3, | |||
int | b3, | |||
int | a3 | |||
) |
Sets the object color class.
- Parameters:
-
obj A valid Evas_Object handle color_class r Object Red value g Object Green value b Object Blue value a Object Alpha value r2 Outline Red value g2 Outline Green value b2 Outline Blue value a2 Outline Alpha value r3 Shadow Red value g3 Shadow Green value b3 Shadow Blue value a3 Shadow Alpha value
The first color is the object, the second is the text outline, and the third is the text shadow. (Note that the second two only apply to text parts)
EAPI const char * edje_object_data_get | ( | const Evas_Object * | obj, | |
const char * | key | |||
) |
Get Edje object data.
- Parameters:
-
obj A valid Evas_Object handle key The data key
- Returns:
- The data string
In EDC this comes from a data block within the group block that obj was loaded from. E.g.
collections { group { name: "a_group"; data { item: "key1" "value1"; item: "key2" "value2"; } } }
EAPI void edje_object_file_get | ( | const Evas_Object * | obj, | |
const char ** | file, | |||
const char ** | group | |||
) |
Get the file and group name that obj was loaded from.
- Parameters:
-
obj A valid Evas_Object handle file A pointer to store a pointer to the filename in group A pointer to store a pointer to the group name in
It is valid to pass in NULL for either file or group if you are not interested in one of the values.
EAPI int edje_object_file_set | ( | Evas_Object * | obj, | |
const char * | file, | |||
const char * | group | |||
) |
Sets the EET file and group to load obj from.
- Parameters:
-
obj A valid Evas_Object handle file The path to the EET file group The group name in the Edje
- Returns:
- 0 on Error
1 on Success and sets EDJE_LOAD_ERROR_NONE
EAPI int edje_object_freeze | ( | Evas_Object * | obj | ) |
Freeze object.
- Parameters:
-
obj A valid Evas_Object handle
- Returns:
- The frozen state
0 on Error
Referenced by edje_freeze().
EAPI int edje_object_load_error_get | ( | const Evas_Object * | obj | ) |
Gets the Edje load error.
- Parameters:
-
obj A valid Evas_Object handle
- Returns:
- The Edje load error:
0: No Error
1: Generic Error
2: Does not Exist
3: Permission Denied
4: Resource Allocation Failed
5: Corrupt File
6: Unknown Format
7: Incompatible File
EAPI Evas_Bool edje_object_part_box_append | ( | Evas_Object * | obj, | |
const char * | part, | |||
Evas_Object * | child | |||
) |
Appends an object to the box.
- Parameters:
-
obj A valid Evas_Object handle part The part name child The object to append
- Returns:
- 1: Successfully added.
0: An error occured.
EAPI Evas_Bool edje_object_part_box_insert_at | ( | Evas_Object * | obj, | |
const char * | part, | |||
Evas_Object * | child, | |||
unsigned int | pos | |||
) |
Inserts an object to the box.
- Parameters:
-
obj A valid Evas_Object handle part The part name child The object to insert pos The position where to insert child
- Returns:
- 1: Successfully added.
0: An error occured.
EAPI Evas_Bool edje_object_part_box_insert_before | ( | Evas_Object * | obj, | |
const char * | part, | |||
Evas_Object * | child, | |||
const Evas_Object * | reference | |||
) |
Adds an object to the box.
- Parameters:
-
obj A valid Evas_Object handle part The part name child The object to insert reference The object to be used as reference
- Returns:
- 1: Successfully added.
0: An error occured.
EAPI Evas_Bool edje_object_part_box_prepend | ( | Evas_Object * | obj, | |
const char * | part, | |||
Evas_Object * | child | |||
) |
Prepends an object to the box.
- Parameters:
-
obj A valid Evas_Object handle part The part name child The object to prepend
- Returns:
- 1: Successfully added.
0: An error occured.
EAPI Evas_Object * edje_object_part_box_remove | ( | Evas_Object * | obj, | |
const char * | part, | |||
Evas_Object * | child | |||
) |
Removes an object from the box.
- Parameters:
-
obj A valid Evas_Object handle part The part name child The object to remove
- Returns:
- 1: Successfully removed.
0: An error occured.
EAPI Evas_Bool edje_object_part_box_remove_all | ( | Evas_Object * | obj, | |
const char * | part, | |||
Evas_Bool | clear | |||
) |
Removes all elements from the box.
- Parameters:
-
obj A valid Evas_Object handle part The part name clear Delete objects on removal
- Returns:
- 1: Successfully cleared.
0: An error occured.
EAPI Evas_Object * edje_object_part_box_remove_at | ( | Evas_Object * | obj, | |
const char * | part, | |||
unsigned int | pos | |||
) |
Removes an object from the box.
- Parameters:
-
obj A valid Evas_Object handle part The part name pos
- Returns:
- 1: Successfully removed.
0: An error occured.
EAPI int edje_object_part_drag_dir_get | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
Determine dragable directions.
- Parameters:
-
obj A valid Evas_Object handle part The part name
- Returns:
- 0: Not dragable
1: Dragable in X direction
2: Dragable in Y direction
3: Dragable in X & Y directions
EAPI void edje_object_part_drag_page | ( | Evas_Object * | obj, | |
const char * | part, | |||
double | dx, | |||
double | dy | |||
) |
Pages x,y steps.
- Parameters:
-
obj A valid Evas_Object handle part The part name dx The x step dy The y step
WARNING: Paging is bugged!
EAPI void edje_object_part_drag_page_get | ( | const Evas_Object * | obj, | |
const char * | part, | |||
double * | dx, | |||
double * | dy | |||
) |
Gets the page step increments.
- Parameters:
-
obj A valid Evas_Object handle part The part name dx The dx page increment pointer dy The dy page increment pointer
EAPI void edje_object_part_drag_page_set | ( | Evas_Object * | obj, | |
const char * | part, | |||
double | dx, | |||
double | dy | |||
) |
Sets the page step increments.
- Parameters:
-
obj A valid Evas_Object handle part The part name dx The x page step increment dy The y page step increment
EAPI void edje_object_part_drag_size_get | ( | const Evas_Object * | obj, | |
const char * | part, | |||
double * | dw, | |||
double * | dh | |||
) |
Get the dragable object size.
- Parameters:
-
obj A valid Evas_Object handle part The part name dw The drag width pointer dh The drag height pointer
EAPI void edje_object_part_drag_size_set | ( | Evas_Object * | obj, | |
const char * | part, | |||
double | dw, | |||
double | dh | |||
) |
Set the dragable object size.
- Parameters:
-
obj A valid Evas_Object handle part The part name dw The drag width dh The drag height
EAPI void edje_object_part_drag_step | ( | Evas_Object * | obj, | |
const char * | part, | |||
double | dx, | |||
double | dy | |||
) |
Steps the dragable x,y steps.
- Parameters:
-
obj A valid Evas_Object handle part The part name dx The x step dy The y step
EAPI void edje_object_part_drag_step_get | ( | const Evas_Object * | obj, | |
const char * | part, | |||
double * | dx, | |||
double * | dy | |||
) |
Gets the drag step increment values.
- Parameters:
-
obj A valid Evas_Object handle part The part dx The x step increment pointer dy The y step increment pointer
EAPI void edje_object_part_drag_step_set | ( | Evas_Object * | obj, | |
const char * | part, | |||
double | dx, | |||
double | dy | |||
) |
Sets the drag step increment.
- Parameters:
-
obj A valid Evas_Object handle part The part name dx The x step ammount dy The y step ammount
EAPI void edje_object_part_drag_value_get | ( | const Evas_Object * | obj, | |
const char * | part, | |||
double * | dx, | |||
double * | dy | |||
) |
Get the dragable object location.
- Parameters:
-
obj A valid Evas_Object handle part The part name dx The X value pointer dy The Y value pointer
EAPI void edje_object_part_drag_value_set | ( | Evas_Object * | obj, | |
const char * | part, | |||
double | dx, | |||
double | dy | |||
) |
Set the dragable object location.
- Parameters:
-
obj A valid Evas_Object handle part The part name dx The x value dy The y value
EAPI int edje_object_part_exists | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
Check if Edje part exists.
- Parameters:
-
obj A valid Evas_Object handle part The part name to check
- Returns:
- 0 on Error
1 if Edje part exists
EAPI void edje_object_part_geometry_get | ( | const Evas_Object * | obj, | |
const char * | part, | |||
Evas_Coord * | x, | |||
Evas_Coord * | y, | |||
Evas_Coord * | w, | |||
Evas_Coord * | h | |||
) |
Get the geometry of an Edje part.
- Parameters:
-
obj A valid Evas_Object handle part The Edje part x The x coordinate pointer y The y coordinate pointer w The width pointer h The height pointer
It is valid to pass NULL as any of x, y, w or h, whose values you are uninterested in.
EAPI const Evas_Object * edje_object_part_object_get | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
Gets the Evas_Object corresponding to a given part.
You should never modify the state of the returned object (with evas_object_move() or evas_object_hide() for example), but you can safely query info about its current state (with evas_object_visible_get() or evas_object_color_get() for example)
- Parameters:
-
obj A valid Evas_Object handle part The Edje part
- Returns:
- Returns the Evas_Object corresponding to the given part, or NULL on failure (if the part doesn't exist)
EAPI const char * edje_object_part_state_get | ( | const Evas_Object * | obj, | |
const char * | part, | |||
double * | val_ret | |||
) |
Returns the state of the Edje part.
- Parameters:
-
obj A valid Evas_Object handle part The part name val_ret
- Returns:
- The part state:
"default" for the default state
"" for other states
EAPI void edje_object_part_swallow | ( | Evas_Object * | obj, | |
const char * | part, | |||
Evas_Object * | obj_swallow | |||
) |
Swallows an object into the edje.
- Parameters:
-
obj A valid Evas_Object handle part The part name obj_swallow The object to swallow
If an object has already been swallowed into this part, then it will first be unswallowed before the new object is swallowed.
EAPI Evas_Object * edje_object_part_swallow_get | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
Get the object currently swallowed by a part.
- Parameters:
-
obj A valid Evas_Object handle part The part name
- Returns:
- The swallowed object, or NULL if there is none.
EAPI Evas_Bool edje_object_part_table_clear | ( | Evas_Object * | obj, | |
const char * | part, | |||
Evas_Bool | clear | |||
) |
Removes all object from the table.
- Parameters:
-
obj A valid Evas_Object handle part The part name clear If set, will delete subobjs on remove
- Returns:
- 1: Successfully clear table.
0: An error occured.
EAPI Evas_Bool edje_object_part_table_col_row_size_get | ( | const Evas_Object * | obj, | |
const char * | part, | |||
int * | cols, | |||
int * | rows | |||
) |
Gets the number of columns and rows the table has.
- Parameters:
-
obj A valid Evas_Object handle part The part name cols Pointer where to store number of columns (can be NULL) rows Pointer where to store number of rows (can be NULL)
- Returns:
- 1: Successfully get some data.
0: An error occured.
EAPI Evas_Bool edje_object_part_table_pack | ( | Evas_Object * | obj, | |
const char * | part, | |||
Evas_Object * | child_obj, | |||
unsigned short | col, | |||
unsigned short | row, | |||
unsigned short | colspan, | |||
unsigned short | rowspan | |||
) |
Packs an object into the table.
- Parameters:
-
obj A valid Evas_Object handle part The part name child The object to pack in col The column to place it in row The row to place it in colspan Columns the child will take rowspan Rows the child will take
- Returns:
- 1: Successfully added.
0: An error occured.
EAPI Evas_Bool edje_object_part_table_unpack | ( | Evas_Object * | obj, | |
const char * | part, | |||
Evas_Object * | child_obj | |||
) |
Removes an object from the table.
- Parameters:
-
obj A valid Evas_Object handle part The part name child The object to pack in
- Returns:
- 1: Successfully removed.
0: An error occured.
EAPI const Eina_List * edje_object_part_text_anchor_geometry_get | ( | const Evas_Object * | obj, | |
const char * | part, | |||
const char * | anchor | |||
) |
Returns a list of Evas_Textblock_Rectangle * anchor rectangles.
- Parameters:
-
obj A valid Evas_Object handle part The part name anchor The anchor name
- Returns:
- The list of anchor rects (const Evas_Textblock_Rectangle *), do not modify!
EAPI const Eina_List * edje_object_part_text_anchor_list_get | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
Returns a list of char * anchor names.
- Parameters:
-
obj A valid Evas_Object handle part The part name
- Returns:
- The list of anchors (const char *), do not modify!
EAPI void edje_object_part_text_cursor_geometry_get | ( | const Evas_Object * | obj, | |
const char * | part, | |||
Evas_Coord * | x, | |||
Evas_Coord * | y, | |||
Evas_Coord * | w, | |||
Evas_Coord * | h | |||
) |
Returns the cursor geometry of the part relative to the edje object.
- Parameters:
-
obj A valid Evas_Object handle part The part name x Cursor X position y Cursor Y position w Cursor width h Cursor height
EAPI const char * edje_object_part_text_get | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
Returns the text of the object part.
- Parameters:
-
obj A valid Evas_Object handle part The part name
- Returns:
- The text string
EAPI void edje_object_part_text_insert | ( | Evas_Object * | obj, | |
const char * | part, | |||
const char * | text | |||
) |
Inserts the text for an object part just before the cursor position.
- Parameters:
-
obj A valid Evas Object handle part The part name text The text string
EAPI void edje_object_part_text_select_abort | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
Aborts any selection action on a part.
- Parameters:
-
obj A valid Evas_Object handle part The part name
EAPI void edje_object_part_text_select_all | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
sets the selection to be everything
- Parameters:
-
obj A valid Evas_Object handle part The part name
EAPI void edje_object_part_text_select_allow_set | ( | const Evas_Object * | obj, | |
const char * | part, | |||
Evas_Bool | allow | |||
) |
Enables selection if the entyr is an EXPLICIT selection mode type.
- Parameters:
-
obj A valid Evas_Object handle part The part name
EAPI void edje_object_part_text_select_none | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
sets the selection to be none
- Parameters:
-
obj A valid Evas_Object handle part The part name
EAPI const char * edje_object_part_text_selection_get | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
Returns the selection text of the object part.
- Parameters:
-
obj A valid Evas_Object handle part The part name
- Returns:
- The text string
EAPI void edje_object_part_text_set | ( | Evas_Object * | obj, | |
const char * | part, | |||
const char * | text | |||
) |
Sets the text for an object part.
- Parameters:
-
obj A valid Evas Object handle part The part name text The text string
EAPI char * edje_object_part_text_unescaped_get | ( | const Evas_Object * | obj, | |
const char * | part | |||
) |
Returns the text of the object part, without escaping.
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.
- Parameters:
-
obj A valid Evas_Object handle part The part name
- Returns:
- The allocated text string without escaping, or NULL on problems.
EAPI void edje_object_part_text_unescaped_set | ( | Evas_Object * | obj, | |
const char * | part, | |||
const char * | text_to_escape | |||
) |
Sets the raw (non escaped) text for an object part.
This will 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.
- Parameters:
-
obj A valid Evas Object handle part The part name text The text string
EAPI void edje_object_part_unswallow | ( | Evas_Object * | obj, | |
Evas_Object * | obj_swallow | |||
) |
Unswallow an object.
- Parameters:
-
obj A valid Evas_Object handle obj_swallow The swallowed object
EAPI int edje_object_play_get | ( | const Evas_Object * | obj | ) |
Get the Edje play/pause state.
- Parameters:
-
obj A valid Evas_Object handle
- Returns:
- 0 if Edje not connected, Edje delete_me, or Edje paused
1 if Edje set to play
EAPI void edje_object_play_set | ( | Evas_Object * | obj, | |
int | play | |||
) |
Set the Edje to play or pause.
- Parameters:
-
obj A valid Evas_Object handle play Play instruction (1 to play, 0 to pause)
EAPI void edje_object_signal_callback_add | ( | Evas_Object * | obj, | |
const char * | emission, | |||
const char * | source, | |||
void(*)(void *data, Evas_Object *o, const char *emission, const char *source) | func, | |||
void * | data | |||
) |
Add a callback for a signal emitted by obj.
- Parameters:
-
obj A valid Evas_Object handle emission The signal name source The signal source func The callback function to be executed when the signal is emitted data A pointer to data to pass in to the callback function
program { name: "emit_example"; action: SIGNAL_EMIT "a_signal" "a_source"; }
Assuming a function with the following declaration is definded:
void cb_signal(void *data, Evas_Object *o, const char *emission, const char *source);
a callback is attached using:
edje_object_callback_add(obj, "a_signal", "a_source", cb_signal, data);
Here, data is an arbitrary pointer to be used as desired. Note that emission and source correspond respectively to first and second parameters to the SIGNAL_EMIT action.
Internal edje signals can also be attached to, and globs can be in either the emission or source name. e.g.
edje_object_callback_add(obj, "mouse,down,*", "button.*", NULL);
Here, any mouse down events on an edje part whose name begins with "button." will trigger the callback. The actual signal and source name will be passed in to the emission and source parameters of the callback function. (e.g. "mouse,down,2" and "button.close").
EAPI void * edje_object_signal_callback_del | ( | Evas_Object * | obj, | |
const char * | emission, | |||
const char * | source, | |||
void(*)(void *data, Evas_Object *o, const char *emission, const char *source) | func | |||
) |
Remove a callback from an object.
- Parameters:
-
obj A valid Evas_Object handle emission the emission string source the source string func the callback function
- Returns:
- the data pointer
EAPI void edje_object_signal_emit | ( | Evas_Object * | obj, | |
const char * | emission, | |||
const char * | source | |||
) |
Send a signal to the Edje object.
- Parameters:
-
obj A vaild Evas_Object handle emission The signal source The signal source
An edje program can respond to a signal by specifying matching 'signal' and 'source' fields.
E.g.
edje_object_signal_emit(obj, "a_signal", "");
will trigger a program whose edc is:
program { name: "a_program"; signal: "a_signal"; source: ""; action: ... }
FIXME should this signal be sent to children also?
EAPI void edje_object_size_max_get | ( | const Evas_Object * | obj, | |
Evas_Coord * | maxw, | |||
Evas_Coord * | maxh | |||
) |
Get the maximum size for an object.
- Parameters:
-
obj A valid Evas_Object handle maxw Maximum width pointer maxh Maximum height pointer
EAPI void edje_object_size_min_calc | ( | Evas_Object * | obj, | |
Evas_Coord * | minw, | |||
Evas_Coord * | minh | |||
) |
Calculate minimum size.
- Parameters:
-
obj A valid Evas_Object handle minw Minimum width pointer minh Minimum height pointer
References edje_object_size_min_restricted_calc().
EAPI void edje_object_size_min_get | ( | const Evas_Object * | obj, | |
Evas_Coord * | minw, | |||
Evas_Coord * | minh | |||
) |
Get the minimum size for an object.
- Parameters:
-
obj A valid Evas_Object handle minw Minimum width pointer minh Minimum height pointer
EAPI void edje_object_size_min_restricted_calc | ( | Evas_Object * | obj, | |
Evas_Coord * | minw, | |||
Evas_Coord * | minh, | |||
Evas_Coord | restrictedw, | |||
Evas_Coord | restrictedh | |||
) |
Calculate minimum size.
- Parameters:
-
obj A valid Evas_Object handle minw Minimum width pointer minh Minimum height pointer restrictedw Do not allow object min width calc to be less than this restrictedh Do not allow object min height calc to be less than this
Referenced by edje_object_size_min_calc().
EAPI void edje_object_text_class_set | ( | Evas_Object * | obj, | |
const char * | text_class, | |||
const char * | font, | |||
Evas_Font_Size | size | |||
) |
Sets Edje text class.
- Parameters:
-
obj A valid Evas_Object handle text_class The text class name font Font name size Font Size
EAPI int edje_object_thaw | ( | Evas_Object * | obj | ) |
Thaw object.
- Parameters:
-
obj A valid Evas_Object handle
- Returns:
- The frozen state
0 on Error
Referenced by edje_thaw().
EAPI int edje_shutdown | ( | void | ) |
Shutdown the EDJE library.
- Returns:
- The new init count.
void edje_text_class_del | ( | const char * | text_class | ) |
- Parameters:
-
text_class Deletes any values at the process level for the specified text class.
Eina_List * edje_text_class_list | ( | void | ) |
Lists all text classes known about by the current process.
- Returns:
- A list of text class names (strings). These strings are stringshares and the list must be free()'d by the caller.
EAPI void edje_text_class_set | ( | const char * | text_class, | |
const char * | font, | |||
Evas_Font_Size | size | |||
) |
Set the Edje text class.
- Parameters:
-
text_class The text class name ?! font The font name size The font size
EAPI void edje_thaw | ( | void | ) |
Thaw all Edje objects in the current process.
See edje_object_thaw() for more.
References edje_object_thaw().