Linux Certif

Toute la documentation sur la certification Linux LPI

Edje.h

NAME

Edje.h -

Edje Graphical Design Library.

SYNOPSIS

Data Structures

struct _Edje_External_Type
an external type to be used.

Functions

EAPI const char * edje_external_param_type_str (Edje_External_Param_Type type) EINA_PURE
Converts type identifier to string nicer representation.
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 edje trasitions' frame time.
EAPI double edje_frametime_get (void)
Get edje trasitions' frame time.
EAPI void edje_freeze (void)
Freeze Edje objects.
EAPI void edje_thaw (void)
Thaw edje objects.
EAPI void edje_fontset_append_set (const char *fonts)
Set the edje append fontset.
EAPI const char * edje_fontset_append_get (void)
Get the edje append fontset.
EAPI void edje_scale_set (double scale)
Set edje's global scaling factor.
EAPI double edje_scale_get (void)
Get edje's global scaling factor.
EAPI Eina_Bool edje_object_scale_set (Evas_Object *obj, double scale)
Set the edje object's scaling factor.
EAPI double edje_object_scale_get (const Evas_Object *obj)
Get the edje object's scaling factor.
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 Eina_Bool 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_file_cache_set (int count)
Set the file cache size.
EAPI int edje_file_cache_get (void)
Return the file cache size.
EAPI void edje_file_cache_flush (void)
Clean the file cache.
EAPI void edje_collection_cache_set (int count)
Set the collection cache size.
EAPI int edje_collection_cache_get (void)
Return the collection cache size.
EAPI void edje_collection_cache_flush (void)
Clean the collection cache.
EAPI Eina_Bool 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 Eina_Bool edje_color_class_get (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)
Get Edje color class.
EAPI void edje_color_class_del (const char *color_class)
Delete edje color class.
EAPI Eina_List * edje_color_class_list (void)
Lists color classes.
EAPI Eina_Bool 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)
Delete the text class.
EAPI Eina_List * edje_text_class_list (void)
List text classes.
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 Eina_Bool 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 an edje object.
EAPI void edje_object_play_set (Evas_Object *obj, Eina_Bool play)
Set the edje object to playing or paused states.
EAPI Eina_Bool edje_object_play_get (const Evas_Object *obj)
Get the edje object's play/pause state.
EAPI void edje_object_animation_set (Evas_Object *obj, Eina_Bool on)
Set the object's animation state.
EAPI Eina_Bool edje_object_animation_get (const Evas_Object *obj)
Get the edje object's animation state.
EAPI int edje_object_freeze (Evas_Object *obj)
Freeze object.
EAPI int edje_object_thaw (Evas_Object *obj)
Thaw object.
EAPI Eina_Bool 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 Eina_Bool edje_object_color_class_get (const Evas_Object *o, 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)
Gets the object color class.
EAPI void edje_object_color_class_del (Evas_Object *obj, const char *color_class)
Delete the object color class.
EAPI Eina_Bool 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 Eina_Bool edje_object_parts_extends_calc (Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
Calculate the geometry used by all parts.
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 Eina_Bool 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 from a part.
EAPI Eina_Bool 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_item_provider_set (Evas_Object *obj, Evas_Object *(*func)(void *data, Evas_Object *obj, const char *part, const char *item), void *data)
Set the function that provides item objects for named items in an edje entry text.
EAPI Eina_Bool 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)
Return the text of the object part.
EAPI Eina_Bool 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)
Return the selection text of the object part.
EAPI void edje_object_part_text_select_none (const Evas_Object *obj, const char *part)
Set the selection to be none.
EAPI void edje_object_part_text_select_all (const Evas_Object *obj, const char *part)
Set the selection to be everything.
EAPI void edje_object_part_text_insert (Evas_Object *obj, const char *part, const char *text)
Insert text for an object part.
EAPI const Eina_List * edje_object_part_text_anchor_list_get (const Evas_Object *obj, const char *part)
Return 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)
Return a list of Evas_Textblock_Rectangle anchor rectangles.
EAPI const Eina_List * edje_object_part_text_item_list_get (const Evas_Object *obj, const char *part)
Return a list of char item names.
EAPI Eina_Bool edje_object_part_text_item_geometry_get (const Evas_Object *obj, const char *part, const char *item, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
Return item geometry.
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, Eina_Bool allow)
Enables selection if the entry 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_text_select_begin (const Evas_Object *obj, const char *part)
Starts selecting at current cursor position.
EAPI void edje_object_part_text_select_extend (const Evas_Object *obj, const char *part)
Extends the current selection to the current cursor position.
EAPI Eina_Bool edje_object_part_text_cursor_next (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI Eina_Bool edje_object_part_text_cursor_prev (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI Eina_Bool edje_object_part_text_cursor_up (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI Eina_Bool edje_object_part_text_cursor_down (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI void edje_object_part_text_cursor_begin_set (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI void edje_object_part_text_cursor_end_set (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI void edje_object_part_text_cursor_copy (const Evas_Object *obj, const char *part, Edje_Cursor src, Edje_Cursor dst)
XX.
EAPI void edje_object_part_text_cursor_line_begin_set (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI void edje_object_part_text_cursor_line_end_set (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI Eina_Bool edje_object_part_text_cursor_is_format_get (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI Eina_Bool edje_object_part_text_cursor_is_visible_format_get (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI const char * edje_object_part_text_cursor_content_get (const Evas_Object *obj, const char *part, Edje_Cursor cur)
XX.
EAPI Eina_Bool edje_object_part_swallow (Evas_Object *obj, const char *part, Evas_Object *obj_swallow)
Swallows an object into the edje.
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 Eina_Bool edje_object_part_drag_value_set (Evas_Object *obj, const char *part, double dx, double dy)
Set the dragable object location.
EAPI Eina_Bool edje_object_part_drag_value_get (const Evas_Object *obj, const char *part, double *dx, double *dy)
Get the dragable object location.
EAPI Eina_Bool edje_object_part_drag_size_set (Evas_Object *obj, const char *part, double dw, double dh)
Set the dragable object size.
EAPI Eina_Bool edje_object_part_drag_size_get (const Evas_Object *obj, const char *part, double *dw, double *dh)
Get the dragable object size.
EAPI Eina_Bool edje_object_part_drag_step_set (Evas_Object *obj, const char *part, double dx, double dy)
Sets the drag step increment.
EAPI Eina_Bool edje_object_part_drag_step_get (const Evas_Object *obj, const char *part, double *dx, double *dy)
Gets the drag step increment values.
EAPI Eina_Bool edje_object_part_drag_page_set (Evas_Object *obj, const char *part, double dx, double dy)
Sets the page step increments.
EAPI Eina_Bool edje_object_part_drag_page_get (const Evas_Object *obj, const char *part, double *dx, double *dy)
Gets the page step increments.
EAPI Eina_Bool edje_object_part_drag_step (Evas_Object *obj, const char *part, double dx, double dy)
Steps the dragable x,y steps.
EAPI Eina_Bool edje_object_part_drag_page (Evas_Object *obj, const char *part, double dx, double dy)
Pages x,y steps.
EAPI Evas_Object * edje_object_part_external_object_get (const Evas_Object *obj, const char *part)
Get the object created by this external part.
EAPI Eina_Bool edje_object_part_external_param_set (Evas_Object *obj, const char *part, const Edje_External_Param *param)
Set the parameter for the external part.
EAPI Eina_Bool edje_object_part_external_param_get (const Evas_Object *obj, const char *part, Edje_External_Param *param)
Get the parameter for the external part.
EAPI Edje_External_Param_Type edje_object_part_external_param_type_get (const Evas_Object *obj, const char *part, const char *param)
Facility to query the type of the given parameter of the given part.
EAPI Eina_Bool edje_object_part_box_append (Evas_Object *obj, const char *part, Evas_Object *child)
Appends an object to the box.
EAPI Eina_Bool edje_object_part_box_prepend (Evas_Object *obj, const char *part, Evas_Object *child)
Prepends an object to the box.
EAPI Eina_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 Eina_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 Eina_Bool edje_object_part_box_remove_all (Evas_Object *obj, const char *part, Eina_Bool clear)
Removes all elements from the box.
EAPI Evas_Object * edje_object_part_table_child_get (Evas_Object *obj, const char *part, unsigned int col, unsigned int row)
Retrieve a child from a table.
EAPI Eina_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 Eina_Bool edje_object_part_table_unpack (Evas_Object *obj, const char *part, Evas_Object *child_obj)
Removes an object from the table.
EAPI Eina_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 Eina_Bool edje_object_part_table_clear (Evas_Object *obj, const char *part, Eina_Bool clear)
Removes all object from the table.
EAPI void edje_object_message_send (Evas_Object *obj, Edje_Message_Type type, int id, void *msg)
Send message to object.
EAPI void edje_object_message_signal_process (Evas_Object *obj)
Process an object's message queue.
EAPI void edje_message_signal_process (void)
Process all queued up edje messages.
EAPI Eina_Bool edje_external_type_register (const char *type_name, const Edje_External_Type *type_info)
Register given type name to return the given information.
EAPI Eina_Bool edje_external_type_unregister (const char *type_name)
Unregister given type name previously registered.
EAPI void edje_external_type_array_register (const Edje_External_Type_Info *array)
Register a batch of types and their information.
EAPI void edje_external_type_array_unregister (const Edje_External_Type_Info *array)
Unregister a batch of given external type previously registered.
EAPI unsigned int edje_external_type_abi_version_get (void) EINA_CONST
Return the current ABI version for Edje_External_Type structure.
EAPI const Edje_External_Param_Info * edje_external_param_info_get (const char *type_name)
Get the array of parameters information about a type given its name.

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

This function registers custom layouts that can be referred from themes by the registered name. The Evas_Object_Box_Layout functions receive two pointers for internal use, one being private data, and the other the function to free that data when it's not longer needed. From Edje, this private data will be retrieved by calling layout_data_get, and layout_data_free will be the free function passed to func. layout_data_get will be called with data as its parameter, and this one will be freed by free_data whenever the layout is unregistered from Edje.

References edje_box_layout_register().

Referenced by edje_box_layout_register().

EAPI void edje_color_class_del (const char * color_class)

Delete edje color class. Parameters:

color_class This function deletes any values at the process level for the specified color class.

Deleting color emits a signal 'color_class,del' with source being the given color class in all objects.

References edje_color_class_del().

Referenced by edje_color_class_del().

EAPI Eina_Bool edje_color_class_get (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)

Get 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

Returns:

EINA_TRUE if found or EINA_FALSE if not found and all values are zeroed.

This function gets the color values for a process level color class. This value is the globally set and not per-object, that is, the value that would be used by objects if they did not override with edje_object_color_class_set().

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).

See also:

edje_color_class_set().

Note:

unlike Evas, Edje colors are not pre-multiplied. That is, half-transparent white is 255 255 255 128.

References edje_color_class_get().

Referenced by edje_color_class_get().

EAPI Eina_List* edje_color_class_list (void)

Lists color classes. Returns:

A list of color class names (strings). These strings and the list must be free()'d by the caller.

This function lists all color classes known about by the current process.

References edje_color_class_list().

Referenced by edje_color_class_list().

EAPI Eina_Bool 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

This function sets the color values for a process level color class. This will cause all edje parts in the current process that have the specified color class to have their colors multiplied by these values. (Object level color classes set by edje_object_color_class_set() will override the values set by this function).

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).

Setting color emits a signal 'color_class,set' with source being the given color class in all objects.

See also:

edje_color_class_set().

Note:

unlike Evas, Edje colors are not pre-multiplied. That is, half-transparent white is 255 255 255 128.

References edje_color_class_set().

Referenced by edje_color_class_set().

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

This sets the desired aspect ratio to keep an object that will be swallowed by Edje. The width and height define a preferred size ASPECT and the object may be scaled to be larger or smaller, but retaining the relative scale of both aspect width and height.

References edje_extern_object_aspect_set().

Referenced by edje_extern_object_aspect_set().

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

This sets the maximum size restriction for the object.

References edje_extern_object_max_size_set().

Referenced by edje_extern_object_max_size_set().

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

This sets the minimum size restriction for the object.

References edje_extern_object_min_size_set().

Referenced by edje_extern_object_min_size_set().

EAPI const Edje_External_Param_Info* edje_external_param_info_get (const char * type_name)

Get the array of parameters information about a type given its name. Note:

the type names and other strings are static, that means they NOT translated. One must use Edje_External_Type::translate() to translate those.

Returns:

the NULL terminated array, or NULL if type is unknown or it does not have any parameter information.

See also:

edje_external_type_get()

References edje_external_param_info_get().

Referenced by edje_edit_state_add(), and edje_external_param_info_get().

EAPI const char* edje_external_param_type_str (Edje_External_Param_Type type)

Converts type identifier to string nicer representation. This may be used to debug or other informational purposes.

Parameters:

type the identifier to convert.

Returns:

the string with the string representation, or '(unknown)'.

References edje_external_param_type_str().

Referenced by edje_external_param_type_str().

EAPI unsigned int edje_external_type_abi_version_get (void)

Return the current ABI version for Edje_External_Type structure. Always check this number before accessing Edje_External_Type in your own software. If the number is not the same, your software may access invalid memory and crash, or just get garbage values.

Warning:

NEVER, EVER define your own Edje_External_Type using the return of this function as it will change as Edje library (libedje.so) changes, but your type definition will not. Instead, use EDJE_EXTERNAL_TYPE_ABI_VERSION.

Summary:

*

use edje_external_type_abi_version_get() to check.

*

use EDJE_EXTERNAL_TYPE_ABI_VERSION to define/declare.

Returns:

version this edje library was compiled.

References edje_external_type_abi_version_get().

Referenced by edje_external_type_abi_version_get().

EAPI void edje_external_type_array_register (const Edje_External_Type_Info * array)

Register a batch of types and their information. This is the recommended function to add information as it's faster than the single version edje_external_type_register().

Note:

the given array is not modified, but the type name strings are not duplicated! That is, all type names must be live until they are unregistered! This was choosen to save some memory and most people will just define the array as a global static const type anyway.

Parameters:

arrray NULL terminated array with type name and information. Note that type name or information are not modified by are referenced, so they must keep alive after this function returns!

Returns:

EINA_TRUE on success, EINA_FALSE on failure (like type already registered).

See also:

edje_external_type_register()

References edje_external_type_array_register().

Referenced by edje_external_type_array_register().

EAPI void edje_external_type_array_unregister (const Edje_External_Type_Info * array)

Unregister a batch of given external type previously registered. Parameters:

array NULL terminated array, should be the same as the one used to register with edje_external_type_array_register()

See also:

edje_external_type_unregister()

References edje_external_type_array_unregister().

Referenced by edje_external_type_array_unregister().

EAPI Eina_Bool edje_external_type_register (const char * type_name, const Edje_External_Type * type_info)

Register given type name to return the given information. Parameters:

type_name name to register and be known by edje's 'source:' parameter of 'type: EXTERNAL' parts.
type_info meta-information describing how to interact with it.

Returns:

EINA_TRUE on success, EINA_FALSE on failure (like type already registered).

See also:

edje_external_type_array_register()

References _Edje_External_Type::abi_version, and edje_external_type_register().

Referenced by edje_external_type_register().

EAPI Eina_Bool edje_external_type_unregister (const char * type_name)

Unregister given type name previously registered. Parameters:

type_name name to unregister. It should be registered with edje_external_type_register() before.

Returns:

EINA_TRUE on success, EINA_FALSE on failure (like type_name did not exist).

See also:

edje_external_type_array_unregister()

References edje_external_type_unregister().

Referenced by edje_external_type_unregister().

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 *)

Note: the list must be freed using edje_file_collection_list_free() when you are done with it.

References edje_file_collection_list().

Referenced by edje_file_collection_list().

EAPI void edje_file_collection_list_free (Eina_List * lst)

Free file collection list. Parameters:

lst The Eina_List of groups

Frees the list returned by edje_file_collection_list().

References edje_file_collection_list_free().

Referenced by edje_file_collection_list_free().

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

If an edje file is built from the following edc:

data { item: 'key1' 'value1'; item: 'key2' 'value2'; } collections { ... }

Then, edje_file_data_get('key1') will return 'value1'

References edje_file_data_get().

Referenced by edje_file_data_get().

EAPI Eina_Bool 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

References edje_file_group_exists().

Referenced by edje_file_group_exists().

EAPI const char* edje_fontset_append_get (void)

Get the edje append fontset. Returns:

The edje append fontset.

This function returns the edje append fontset set by edje_fontset_append_set() function.

See also:

edje_fontset_append_set().

References edje_fontset_append_get().

Referenced by edje_fontset_append_get().

EAPI void edje_fontset_append_set (const char * fonts)

Set the edje append fontset. Parameters:

fonts The fontset to append.

This function sets the edje append fontset.

References edje_fontset_append_set().

Referenced by edje_fontset_append_set().

EAPI void edje_freeze (void)

Freeze Edje objects. This function freezes every edje objects in the current process.

See edje_object_freeze().

References edje_freeze(), and edje_object_freeze().

Referenced by edje_freeze().

EAPI Evas_Object* edje_object_add (Evas * evas)

Constructs the Edje object. Parameters:

evas A valid Evas handle

Returns:

The Evas_Object pointer.

Creates the Edje smart object, returning the Evas_Object handle.

References edje_object_add().

Referenced by edje_edit_part_source_set(), and edje_object_add().

EAPI void edje_object_calc_force (Evas_Object * obj)

Force a Size/Geometry calculation. Parameters:

obj A valid Evas_Object handle

Forces the object obj to recalculation layout regardless of freeze/thaw.

References edje_object_calc_force().

Referenced by edje_edit_part_clip_to_set(), edje_edit_part_del(), edje_edit_part_effect_set(), edje_edit_part_scale_set(), edje_edit_part_selected_state_set(), edje_edit_spectra_stop_color_set(), edje_edit_state_color2_set(), edje_edit_state_color3_set(), edje_edit_state_color_set(), edje_edit_state_fill_origin_offset_x_set(), edje_edit_state_fill_origin_offset_y_set(), edje_edit_state_fill_origin_relative_x_set(), edje_edit_state_fill_origin_relative_y_set(), edje_edit_state_fill_size_offset_x_set(), edje_edit_state_fill_size_offset_y_set(), edje_edit_state_fill_size_relative_x_set(), edje_edit_state_fill_size_relative_y_set(), edje_edit_state_font_set(), edje_edit_state_gradient_angle_set(), edje_edit_state_gradient_rel1_offset_x_set(), edje_edit_state_gradient_rel1_offset_y_set(), edje_edit_state_gradient_rel1_relative_x_set(), edje_edit_state_gradient_rel1_relative_y_set(), edje_edit_state_gradient_rel2_offset_x_set(), edje_edit_state_gradient_rel2_offset_y_set(), edje_edit_state_gradient_rel2_relative_x_set(), edje_edit_state_gradient_rel2_relative_y_set(), edje_edit_state_gradient_spectra_set(), edje_edit_state_gradient_type_set(), edje_edit_state_image_border_fill_set(), edje_edit_state_image_border_set(), edje_edit_state_image_set(), edje_edit_state_rel1_offset_x_set(), edje_edit_state_rel1_offset_y_set(), edje_edit_state_rel1_relative_x_set(), edje_edit_state_rel1_relative_y_set(), edje_edit_state_rel2_offset_x_set(), edje_edit_state_rel2_offset_y_set(), edje_edit_state_rel2_relative_x_set(), edje_edit_state_rel2_relative_y_set(), edje_edit_state_text_align_x_set(), edje_edit_state_text_align_y_set(), edje_edit_state_text_elipsis_set(), edje_edit_state_text_fit_x_set(), edje_edit_state_text_fit_y_set(), edje_edit_state_text_set(), edje_edit_state_text_size_set(), edje_edit_state_visible_set(), edje_object_calc_force(), edje_object_scale_set(), and edje_scale_set().

EAPI void edje_object_color_class_del (Evas_Object * obj, const char * color_class)

Delete the object color class. Parameters:

obj The edje object's reference.
color_class The color class to be deleted.

This function deletes any values at the object level for the specified object and color class.

Deleting color emits a signal 'color_class,del' with source being the given color.

References edje_object_color_class_del().

Referenced by edje_object_color_class_del().

EAPI Eina_Bool edje_object_color_class_get (const 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)

Gets 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

Returns:

EINA_TRUE if found or EINA_FALSE if not found and all values are zeroed.

This function gets the color values for an object level color class. If no explicit object color is set, then global values will be used.

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).

Note:

unlike Evas, Edje colors are not pre-multiplied. That is, half-transparent white is 255 255 255 128.

References edje_object_color_class_get().

Referenced by edje_object_color_class_get().

EAPI Eina_Bool 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

This function sets the color values for an object level color class. This will cause all edje parts in the specified object that have the specified color class to have their colors multiplied by these values.

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).

Setting color emits a signal 'color_class,set' with source being the given color.

Note:

unlike Evas, Edje colors are not pre-multiplied. That is, half-transparent white is 255 255 255 128.

References edje_object_color_class_set().

Referenced by edje_object_color_class_set().

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

This function fetches data specified at the object level.

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';
      }
    }
  }
 

 

References edje_object_data_get().

Referenced by edje_object_data_get().

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

This gets the EET file location and group for the given Evas_Object. If obj is either not an edje file, or has not had its file/group set using edje_object_file_set(), then both file and group will be set to NULL.

It is valid to pass in NULL for either file or group if you are not interested in one of the values.

References edje_object_file_get().

Referenced by edje_object_file_get().

EAPI Eina_Bool 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

Edje uses EET files, conventionally ending in .edj, to store object descriptions. A single file contains multiple named groups. This function specifies the file and group name to load obj from.

References edje_object_file_set().

Referenced by edje_edit_part_source_set(), and edje_object_file_set().

EAPI int edje_object_freeze (Evas_Object * obj)

Freeze object. Parameters:

obj A valid Evas_Object handle

Returns:

The frozen state or 0 on Error

This function puts all changes on hold. Successive freezes will nest, requiring an equal number of thaws.

References edje_object_freeze().

Referenced by edje_freeze(), and edje_object_freeze().

EAPI void edje_object_item_provider_set (Evas_Object * obj, Evas_Object *(*)(void *data, Evas_Object *obj, const char *part, const char *item) func, void * data)

Set the function that provides item objects for named items in an edje entry text. Parameters:

obj A valid Evas Object handle
func The function to call (or NULL to disable) to get item objects
data The data pointer to pass to the func callback

Item objects may be deleted any time by Edje, and will be deleted when the Edje object is deleted (or file is set to a new file).

References edje_object_item_provider_set().

Referenced by edje_object_item_provider_set().

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:

 EDJE_LOAD_ERROR_NONE: No Error

 EDJE_LOAD_ERROR_GENERIC: Generic Error

 EDJE_LOAD_ERROR_DOES_NOT_EXIST: Does not Exist

 EDJE_LOAD_ERROR_PERMISSION_DENIED: Permission Denied

 EDJE_LOAD_ERROR_RESOURCE_ALLOCATION_FAILED: Resource Allocation Failed

 EDJE_LOAD_ERROR_CORRUPT_FILE: Corrupt File

 EDJE_LOAD_ERROR_UNKNOWN_FORMAT: Unknown Format

 EDJE_LOAD_ERROR_INCOMPATIBLE_FILE: Incompatible File

 EDJE_LOAD_ERROR_UNKNOWN_COLLECTION: Unknown Collection

 EDJE_LOAD_ERROR_RECURSIVE_REFERENCE: Recursive Reference

 

References edje_object_load_error_get().

Referenced by edje_object_load_error_get().

EAPI Eina_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.

Appends child to the box indicated by part.

References edje_object_part_box_append().

Referenced by edje_object_part_box_append().

EAPI Eina_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.

Adds child to the box indicated by part, in the position given by pos.

References edje_object_part_box_insert_at().

Referenced by edje_object_part_box_insert_at().

EAPI Eina_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.

Inserts child in the box given by part, in the position marked by reference.

References edje_object_part_box_insert_before().

Referenced by edje_object_part_box_insert_before().

EAPI Eina_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.

Prepends child to the box indicated by part.

References edje_object_part_box_prepend().

Referenced by edje_object_part_box_prepend().

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:

Pointer to the object removed, or NULL.

Removes child from the box indicated by part.

References edje_object_part_box_remove().

Referenced by edje_object_part_box_remove().

EAPI Eina_Bool edje_object_part_box_remove_all (Evas_Object * obj, const char * part, Eina_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.

Removes all the external objects from the box indicated by part. Elements created from the theme will not be removed.

References edje_object_part_box_remove_all().

Referenced by edje_object_part_box_remove_all().

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:

Pointer to the object removed, or NULL.

Removes from the box indicated by part, the object in the position pos.

References edje_object_part_box_remove_at().

Referenced by edje_object_part_box_remove_at().

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 

References edje_object_part_drag_dir_get().

Referenced by edje_object_part_drag_dir_get().

EAPI Eina_Bool 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

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

 WARNING: Paging is bugged! 

References edje_object_part_drag_page().

Referenced by edje_object_part_drag_page().

EAPI Eina_Bool 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

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

References edje_object_part_drag_page_get().

Referenced by edje_object_part_drag_page_get().

EAPI Eina_Bool 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

Sets the x,y page step increment values.

References edje_object_part_drag_page_set().

Referenced by edje_object_part_drag_page_set().

EAPI Eina_Bool 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

Gets the dragable object size.

References edje_object_part_drag_size_get().

Referenced by edje_object_part_drag_size_get().

EAPI Eina_Bool 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

Sets the size of the dragable object.

References edje_object_part_drag_size_set().

Referenced by edje_object_part_drag_size_set().

EAPI Eina_Bool 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

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

References edje_object_part_drag_step().

Referenced by edje_object_part_drag_step().

EAPI Eina_Bool 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

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

References edje_object_part_drag_step_get().

Referenced by edje_object_part_drag_step_get().

EAPI Eina_Bool 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

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

References edje_object_part_drag_step_set().

Referenced by edje_object_part_drag_step_set().

EAPI Eina_Bool 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

Gets the drag location values.

References edje_object_part_drag_value_get().

Referenced by edje_object_part_drag_value_get().

EAPI Eina_Bool 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

Places the dragable object at the given location.

References edje_object_part_drag_value_set().

Referenced by edje_object_part_drag_value_set().

EAPI Eina_Bool 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.

This function returns if a part exists in the edje.

References edje_object_part_exists().

Referenced by edje_object_part_exists().

EAPI Evas_Object* edje_object_part_external_object_get (const Evas_Object * obj, const char * part)

Get the object created by this external part. Parts of type external creates the part object using information provided by external plugins. It's somehow like 'swallow' (edje_object_part_swallow()), but it's all set automatically.

This function returns the part created by such external plugins and being currently managed by this Edje.

Note:

Almost all swallow rules apply: you should not move, resize, hide, show, set the color or clipper of such part. It's a bit more restrictive as one must never delete this object!

Parameters:

obj A valid Evas_Object handle
part The part name

Returns:

The externally created object, or NULL if there is none or part is not an external.

References edje_object_part_external_object_get().

Referenced by edje_object_part_external_object_get().

EAPI Eina_Bool edje_object_part_external_param_get (const Evas_Object * obj, const char * part, Edje_External_Param * param)

Get the parameter for the external part. Parts of type external may carry extra properties that have meanings defined by the external plugin. For instance, it may be a string that defines a button label. This property can be modifed by state parameters, by explicit calls to edje_object_part_external_param_set() or getting the actual object with edje_object_part_external_object_get() and calling native functions.

This function asks the external plugin what is the current value, independent on how it was set.

Parameters:

obj A valid Evas_Object handle
part The part name
param the parameter details. It is used as both input and output variable. This pointer should be valid, and the parameter must exist in Edje_External_Type::parameters_info, with the exact type, otherwise the operation will fail and EINA_FALSE will be returned.

Returns:

EINA_TRUE if everything went fine and param members are filled with information, EINA_FALSE on errors and param member values are not set or valid.

References edje_object_part_external_param_get().

Referenced by edje_object_part_external_param_get().

EAPI Eina_Bool edje_object_part_external_param_set (Evas_Object * obj, const char * part, const Edje_External_Param * param)

Set the parameter for the external part. Parts of type external may carry extra properties that have meanings defined by the external plugin. For instance, it may be a string that defines a button label and setting this property will change that label on the fly.

Note:

external parts have parameters set when they change states. Those parameters will never be changed by this function. The interpretation of how state_set parameters and param_set will interact is up to the external plugin.
this function will not check if parameter value is valid using Edje_External_Param_Info minimum, maximum, valid choices and others. However these should be checked by the underlying implementation provided by the external plugin. This is done for performance reasons.

Parameters:

obj A valid Evas_Object handle
part The part name
param the parameter details, including its name, type and actual value. This pointer should be valid, and the parameter must exist in Edje_External_Type::parameters_info, with the exact type, otherwise the operation will fail and EINA_FALSE will be returned.

Returns:

EINA_TRUE if everything went fine, EINA_FALSE on errors.

References edje_object_part_external_param_set().

Referenced by edje_edit_state_external_param_set(), and edje_object_part_external_param_set().

EAPI Edje_External_Param_Type edje_object_part_external_param_type_get (const Evas_Object * obj, const char * part, const char * param)

Facility to query the type of the given parameter of the given part. Parameters:

obj A valid Evas_Object handle
part The part name
param the parameter name to use.

Returns:

EDJE_EXTERNAL_PARAM_TYPE_MAX on errors, or another value from Edje_External_Param_Type on success.

References edje_object_part_external_param_type_get().

Referenced by edje_object_part_external_param_type_get().

EAPI Eina_Bool 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

This function gets the geometry of an Edje part.

It is valid to pass NULL as any of x, y, w or h, whose values you are uninterested in.

References edje_object_part_geometry_get().

Referenced by edje_object_part_geometry_get().

EAPI const Evas_Object* edje_object_part_object_get (const Evas_Object * obj, const char * part)

Gets the evas object from a part. 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)

This functio 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)

References edje_object_part_object_get().

Referenced by edje_object_part_object_get().

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 

References edje_object_part_state_get().

Referenced by edje_object_part_state_get().

EAPI Eina_Bool 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

Swallows the object into the edje part so that all geometry changes for the part affect the swallowed object. (e.g. resize, move, show, raise/lower, etc.).

If an object has already been swallowed into this part, then it will first be unswallowed before the new object is swallowed.

References edje_object_part_swallow().

Referenced by edje_object_part_swallow().

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.

References edje_object_part_swallow_get().

Referenced by edje_object_part_swallow_get().

EAPI Evas_Object* edje_object_part_table_child_get (Evas_Object * obj, const char * part, unsigned int col, unsigned int row)

Retrieve a child from a table. Parameters:

obj A valid Evas_Object handle
part The part name
col The column of the child to get
row The row of the child to get

Returns:

The child Evas_Object

References edje_object_part_table_child_get().

Referenced by edje_object_part_table_child_get().

EAPI Eina_Bool edje_object_part_table_clear (Evas_Object * obj, const char * part, Eina_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.

Removes all object from the table indicated by part, except the internal ones set from the theme.

References edje_object_part_table_clear().

Referenced by edje_object_part_table_clear().

EAPI Eina_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.

Retrieves the size of the table in number of columns and rows.

References edje_object_part_table_col_row_size_get().

Referenced by edje_object_part_table_col_row_size_get().

EAPI Eina_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_obj 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.

Packs an object into the table indicated by part.

References edje_object_part_table_pack().

Referenced by edje_object_part_table_pack().

EAPI Eina_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_obj The object to pack in

Returns:

1: Successfully removed.

 0: An error occured.

Removes an object from the table indicated by part.

References edje_object_part_table_unpack().

Referenced by edje_object_part_table_unpack().

EAPI const Eina_List* edje_object_part_text_anchor_geometry_get (const Evas_Object * obj, const char * part, const char * anchor)

Return 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! Geometry is relative to entry part.

This function return a list of Evas_Textblock_Rectangle anchor rectangles.

References edje_object_part_text_anchor_geometry_get().

Referenced by edje_object_part_text_anchor_geometry_get().

EAPI const Eina_List* edje_object_part_text_anchor_list_get (const Evas_Object * obj, const char * part)

Return 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!

This function returns a list of char anchor names.

References edje_object_part_text_anchor_list_get().

Referenced by edje_object_part_text_anchor_list_get().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_begin_set().

Referenced by edje_object_part_text_cursor_begin_set().

EAPI const char* edje_object_part_text_cursor_content_get (const Evas_Object * obj, const char * part, Edje_Cursor cur)

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_content_get().

Referenced by edje_object_part_text_cursor_content_get().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_copy().

Referenced by edje_object_part_text_cursor_copy().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_down().

Referenced by edje_object_part_text_cursor_down().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_end_set().

Referenced by edje_object_part_text_cursor_end_set().

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

References edje_object_part_text_cursor_geometry_get().

Referenced by edje_object_part_text_cursor_geometry_get().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_is_format_get().

Referenced by edje_object_part_text_cursor_is_format_get().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_is_visible_format_get().

Referenced by edje_object_part_text_cursor_is_visible_format_get().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_line_begin_set().

Referenced by edje_object_part_text_cursor_line_begin_set().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_line_end_set().

Referenced by edje_object_part_text_cursor_line_end_set().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_next().

Referenced by edje_object_part_text_cursor_next().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_prev().

Referenced by edje_object_part_text_cursor_prev().

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

XX. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_cursor_up().

Referenced by edje_object_part_text_cursor_up().

EAPI const char* edje_object_part_text_get (const Evas_Object * obj, const char * part)

Return the text of the object part. Parameters:

obj A valid Evas_Object handle
part The part name

Returns:

The text string

This function returns the text associated to the object part.

References edje_object_part_text_get().

Referenced by edje_object_part_text_get().

EAPI void edje_object_part_text_insert (Evas_Object * obj, const char * part, const char * text)

Insert text for an object part. Parameters:

obj A valid Evas Object handle
part The part name
text The text string

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

References edje_object_part_text_insert().

Referenced by edje_object_part_text_insert().

EAPI Eina_Bool edje_object_part_text_item_geometry_get (const Evas_Object * obj, const char * part, const char * item, Evas_Coord * cx, Evas_Coord * cy, Evas_Coord * cw, Evas_Coord * ch)

Return item geometry. Parameters:

obj A valid Evas_Object handle
part The part name
item The item name
cx Item x return (relative to entry part)
cy Item y return (relative to entry part)
cw Item width return
ch Item height return

Returns:

1 if item exists, 0 if not

This function return a list of Evas_Textblock_Rectangle item rectangles.

References edje_object_part_text_item_geometry_get().

Referenced by edje_object_part_text_item_geometry_get().

EAPI const Eina_List* edje_object_part_text_item_list_get (const Evas_Object * obj, const char * part)

Return a list of char item names. Parameters:

obj A valid Evas_Object handle
part The part name

Returns:

The list of items (const char *), do not modify!

This function returns a list of char item names.

References edje_object_part_text_item_list_get().

Referenced by edje_object_part_text_item_list_get().

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

References edje_object_part_text_select_abort().

Referenced by edje_object_part_text_select_abort().

EAPI void edje_object_part_text_select_all (const Evas_Object * obj, const char * part)

Set the selection to be everything. Parameters:

obj A valid Evas_Object handle
part The part name

This function selects all text of the object of the part.

References edje_object_part_text_select_all().

Referenced by edje_object_part_text_select_all().

EAPI void edje_object_part_text_select_allow_set (const Evas_Object * obj, const char * part, Eina_Bool allow)

Enables selection if the entry is an EXPLICIT selection mode type. Parameters:

obj A valid Evas_Object handle
part The part name
allow EINA_TRUE to enable, EINA_FALSE otherwise

References edje_object_part_text_select_allow_set().

Referenced by edje_object_part_text_select_allow_set().

EAPI void edje_object_part_text_select_begin (const Evas_Object * obj, const char * part)

Starts selecting at current cursor position. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_select_begin().

Referenced by edje_object_part_text_select_begin().

EAPI void edje_object_part_text_select_extend (const Evas_Object * obj, const char * part)

Extends the current selection to the current cursor position. Parameters:

obj A valid Evas_Object handle
part The part name

References edje_object_part_text_select_extend().

Referenced by edje_object_part_text_select_extend().

EAPI void edje_object_part_text_select_none (const Evas_Object * obj, const char * part)

Set the selection to be none. Parameters:

obj A valid Evas_Object handle
part The part name

This function sets the selection text to be none.

References edje_object_part_text_select_none().

Referenced by edje_object_part_text_select_none().

EAPI const char* edje_object_part_text_selection_get (const Evas_Object * obj, const char * part)

Return the selection text of the object part. Parameters:

obj A valid Evas_Object handle
part The part name

Returns:

The text string

This function returns selection text of the object part.

References edje_object_part_text_selection_get().

Referenced by edje_object_part_text_selection_get().

EAPI Eina_Bool 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

References edje_object_part_text_set().

Referenced by edje_object_part_text_set().

EAPI char* edje_object_part_text_unescaped_get (const Evas_Object * obj, const char * part)

Returns the text of the object part, without escaping. Parameters:

obj A valid Evas_Object handle
part The part name

Returns:

The allocated text string without escaping, or NULL on problems.

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().

References edje_object_part_text_unescaped_get().

Referenced by edje_object_part_text_unescaped_get().

EAPI Eina_Bool 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. Parameters:

obj A valid Evas Object handle
part The part name
text_to_escape The text string

This funciton 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.

See also:

edje_object_part_text_unescaped_get().

References edje_object_part_text_unescaped_set().

Referenced by edje_object_part_text_unescaped_set().

EAPI Eina_Bool edje_object_parts_extends_calc (Evas_Object * obj, Evas_Coord * x, Evas_Coord * y, Evas_Coord * w, Evas_Coord * h)

Calculate the geometry used by all parts. Parameters:

obj A valid Evas_Object handle
x The x coordinate pointer
y The y coordinate pointer
w The width pointer
h The height pointer

Calculates the geometry used by all object parts. Including out of bounds parts.

References edje_object_parts_extends_calc().

Referenced by edje_object_parts_extends_calc().

EAPI double edje_object_scale_get (const Evas_Object * obj)

Get the edje object's scaling factor. Parameters:

obj The edje object's reference.

This function returns the individual scale factor of the obj edje object, which can be set by edje_object_scale_set().

See also:

edje_object_scale_set().

References edje_object_scale_get().

Referenced by edje_object_scale_get().

EAPI Eina_Bool edje_object_scale_set (Evas_Object * obj, double scale)

Set the edje object's scaling factor. Parameters:

obj The edje object's reference.
scale The edje object scale factor. The defaul is 1.0.

This function sets the individual scale factor of the obj edje object. This property (or edje's global scale factor, when applicable), will affect this object's parts. However, only parts which, at the EDC language level, were declared which the 'scale' attribute set to 1 (default is zero) will be affected.

This scale factor can be retrieved with edje_object_scale_get().

See also:

edje_object_scale_get().

References edje_object_calc_force(), and edje_object_scale_set().

Referenced by edje_object_scale_set().

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

Gets the object's maximum size values from the Edje. These are set to zero if no Edje is connected to the Evas Object.

References edje_object_size_max_get().

Referenced by edje_object_size_max_get().

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

Calculates the object's minimum size ?!

References edje_object_size_min_calc(), and edje_object_size_min_restricted_calc().

Referenced by edje_object_size_min_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

Gets the object's minimum size values from the Edje. These are set to zero if no Edje is connected to the Evas Object.

References edje_object_size_min_get().

Referenced by edje_object_size_min_get().

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

Calculates the object's minimum size ?!

References edje_object_size_min_restricted_calc().

Referenced by edje_object_size_min_calc(), and edje_object_size_min_restricted_calc().

EAPI Eina_Bool 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

This function sets the text class for the Edje.

References edje_object_text_class_set().

Referenced by edje_object_text_class_set().

EAPI int edje_object_thaw (Evas_Object * obj)

Thaw object. Parameters:

obj A valid Evas_Object handle

Returns:

The frozen state or 0 on Error

This allows frozen changes to occur.

References edje_object_thaw().

Referenced by edje_object_thaw(), and edje_thaw().

EAPI double edje_scale_get (void)

Get edje's global scaling factor. Returns:

The edje (global) scale factor. The defaul is 1.0.

This function returns edje's global scale factor, which can be set by edje_scale_set().

See also:

edje_scale_set().

References edje_scale_get().

Referenced by edje_scale_get().

EAPI void edje_scale_set (double scale)

Set edje's global scaling factor. Parameters:

scale The edje (global) scale factor. The defaul is 1.0.

Edje allows one to build scalable interfaces. Scale factors, which are set to neutral values by default (no scaling, actual sizes), are of two types: global and individual. Edje's global scaling factor will affect all its objects which hadn't their individual scaling factors altered from the default value. If they had it set differently, that factor will override the global one.

Scaling affects the values of min/max object sizes, which are multiplied by it. Font sizes are scaled, too.

This property can be retrieved with edje_scale_get().

See also:

edje_scale_get().

References edje_object_calc_force(), and edje_scale_set().

Referenced by edje_scale_set().

EAPI void edje_text_class_del (const char * text_class)

Delete the text class. Parameters:

text_class The text class name string

This function deletes any values at the process level for the specified text class.

References edje_text_class_del().

Referenced by edje_text_class_del().

EAPI Eina_List* edje_text_class_list (void)

List text classes. Returns:

A list of text class names (strings). These strings are stringshares and the list must be free()'d by the caller.

This function lists all text classes known about by the current process.

References edje_text_class_list().

Referenced by edje_text_class_list().

EAPI Eina_Bool 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

This function sets updates all edje members which belong to this text class with the new font attributes.

See also:

edje_text_class_get().

References edje_text_class_set().

Referenced by edje_text_class_set().

EAPI void edje_thaw (void)

Thaw edje objects. This function thaw all edje object in the current process.

See edje_object_thaw().

References edje_object_thaw(), and edje_thaw().

Referenced by edje_thaw().

Author

Generated automatically by Doxygen for Edje from the source code.