Edje Object

---

This group discusses functions that deal with Edje layouts and its components.

An important thing to know about this group is that there is no Edje_Object in code. What we refer here as object are layouts (or themes) defined by groups, and parts, both declared in EDC files. They are of type Evas_Object as the other native objects of Evas, but they only exist in Edje, so that is why we are calling them "edje objects".

With the Edje Object Group functions we can deal with layouts by managing its aspect, content, message and signal exchange and animation, among others.

Functions
void	edje_object_update_hints_set (Edje_Object *obj, Eina_Bool update)
	Edje will automatically update the size hints on itself.
Eina_Bool	edje_object_update_hints_get (const Edje_Object *obj)
	Whether or not Edje will update size hints on itself.
void	edje_object_mirrored_set (Edje_Object *obj, Eina_Bool rtl)
	Sets the RTL orientation for this object.
Eina_Bool	edje_object_mirrored_get (const Edje_Object *obj)
	Gets the RTL orientation for this object.
void	edje_object_language_set (Edje_Object *obj, const char *language)
	Sets the language for this object.
const char *	edje_object_language_get (const Edje_Object *obj)
	Gets the language for this object.
void	edje_object_animation_set (Edje_Object *obj, Eina_Bool on)
	Sets the object's animation state.
Eina_Bool	edje_object_animation_get (const Edje_Object *obj)
	Gets the Edje object's animation state.
void	edje_object_play_set (Edje_Object *obj, Eina_Bool play)
	Sets the Edje object to playing or paused states.
Eina_Bool	edje_object_play_get (const Edje_Object *obj)
	Gets the Edje object's state.
void	edje_object_perspective_set (Edje_Object *obj, Edje_Perspective *ps)
	Sets the given perspective object on this Edje object.
const Edje_Perspective *	edje_object_perspective_get (const Edje_Object *obj)
	Gets the current perspective used on this Edje object.
Eina_Bool	edje_object_scale_set (Edje_Object *obj, double scale)
	Sets the scaling factor for a given Edje object.
double	edje_object_scale_get (const Edje_Object *obj)
	Gets a given Edje object's scaling factor.
double	edje_object_base_scale_get (const Edje_Object *obj)
	Gets a given Edje object's base_scale factor.
void	edje_object_text_change_cb_set (Edje_Object *obj, Edje_Text_Change_Cb func, void *data)
	Sets the object text callback.
void	edje_object_part_text_cursor_begin_set (Edje_Object *obj, const char *part, Edje_Cursor cur)
	Moves the cursor to the beginning of the text part evas_textblock_cursor_paragraph_first.
void	edje_object_part_text_cursor_line_end_set (Edje_Object *obj, const char *part, Edje_Cursor cur)
	Moves the cursor to the end of the line. evas_textblock_cursor_line_char_last.
Eina_Bool	edje_object_text_class_set (Edje_Object *obj, const char *text_class, const char *font, Evas_Font_Size size)
	Sets Edje text class.
Eina_Bool	edje_object_part_text_cursor_coord_set (Edje_Object *obj, const char *part, Edje_Cursor cur, Evas_Coord x, Evas_Coord y)
	Position the given cursor to a X,Y position.
void	edje_object_part_text_cursor_end_set (Edje_Object *obj, const char *part, Edje_Cursor cur)
	Moves the cursor to the end of the text part. evas_textblock_cursor_paragraph_last.
Eina_Bool	edje_object_part_text_escaped_set (Edje_Object *obj, const char *part, const char *text)
	Sets the text for an object part, but converts HTML escapes to UTF8.
void	edje_object_item_provider_set (Edje_Object *obj, Edje_Item_Provider_Cb func, void *data)
	Sets the function that provides item objects for named items in an edje entry text.
void	edje_object_part_text_cursor_line_begin_set (Edje_Object *obj, const char *part, Edje_Cursor cur)
	Moves the cursor to the beginning of the line. evas_textblock_cursor_line_char_first.
void	edje_object_message_handler_set (Edje_Object *obj, Edje_Message_Handler_Cb func, void *data)
	Sets an Edje message handler function for a given Edje object.
void	edje_object_size_min_get (const Edje_Object *obj, Evas_Coord *minw, Evas_Coord *minh)
	Gets the minimum size specified -- as an EDC property -- for a given Edje object.
Eina_List *	edje_object_access_part_list_get (const Edje_Object *obj)
	Retrieves a list all accessibility part names.
Edje_Load_Error	edje_object_load_error_get (const Edje_Object *obj)
	Gets the (last) file loading error for a given Edje object.
void	edje_object_size_max_get (const Edje_Object *obj, Evas_Coord *maxw, Evas_Coord *maxh)
	Gets the maximum size specified -- as an EDC property -- for a given Edje object.
Eina_Bool	edje_object_size_class_set (Edje_Object *obj, const char *size_class, int minw, int minh, int maxw, int maxh)
	Sets the object size class.
Eina_Bool	edje_object_size_class_get (const Edje_Object *obj, const char *size_class, int *minw, int *minh, int *maxw, int *maxh)
	Gets the object size class.
void	edje_object_transition_duration_factor_set (Edje_Object *obj, double scale)
	Sets transition duration factor.
double	edje_object_transition_duration_factor_get (const Edje_Object *obj)
	Gets transition duration factor.
Eina_Bool	edje_object_part_table_clear (Edje_Object *obj, const char *part, Eina_Bool clear)
	Removes all object from the table.
Edje_External_Param_Type	edje_object_part_external_param_type_get (const Edje_Object *obj, const char *part, const char *param)
	Facility to query the type of the given parameter of the given part.
void	edje_object_part_text_select_allow_set (const Edje_Object *obj, const char *part, Eina_Bool allow)
	Enables selection if the entry is an EXPLICIT selection mode type.
const char *	edje_object_part_state_get (const Edje_Object *obj, const char *part, double *val_ret)
	Returns the state of the Edje part.
void *	edje_object_text_markup_filter_callback_del_full (Edje_Object *obj, const char *part, Edje_Markup_Filter_Cb func, void *data)
	Deletes a function and matching user data from the markup filter list.
Eina_Bool	edje_object_part_drag_step_set (Edje_Object *obj, const char *part, double dx, double dy)
	Sets the drag step increment.
Eina_Bool	edje_object_part_drag_step_get (const Edje_Object *obj, const char *part, double *dx, double *dy)
	Gets the drag step increment values.
void *	edje_object_part_text_imf_context_get (const Edje_Object *obj, const char *part)
	Gets the input method context in entry.
void	edje_object_part_text_select_begin (const Edje_Object *obj, const char *part)
	Starts selecting at current cursor position.
const char *	edje_object_part_text_style_user_peek (const Edje_Object *obj, const char *part)
	Returns the text of the object part.
Eina_Bool	edje_object_part_text_cursor_next (Edje_Object *obj, const char *part, Edje_Cursor cur)
	Advances the cursor to the next cursor position. evas_textblock_cursor_char_next.
void	edje_object_part_text_style_user_push (Edje_Object *obj, const char *part, const char *style)
	Sets the style of the.
void	edje_object_part_text_append (Edje_Object *obj, const char *part, const char *text)
	Inserts text for an object part.
Eina_Bool	edje_object_part_geometry_get (const Edje_Object *obj, const char *part, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
	Retrieves the geometry of a given Edje part, in a given Edje object's group definition, relative to the object's area.
void	edje_object_part_text_input_panel_hide (const Edje_Object *obj, const char *part)
	Hides the input panel (virtual keyboard). See also edje_object_part_text_input_panel_show.
Eina_Bool	edje_object_part_text_item_geometry_get (const Edje_Object *obj, const char *part, const char *item, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch)
	Returns item geometry.
Eina_Bool	edje_object_part_table_unpack (Edje_Object *obj, const char *part, Evas_Object *child_obj)
	Removes an object from the table.
void	edje_object_part_text_select_abort (const Edje_Object *obj, const char *part)
	Aborts any selection action on a part.
void *	edje_object_text_insert_filter_callback_del_full (Edje_Object *obj, const char *part, Edje_Text_Filter_Cb func, void *data)
	Deletes a function and matching user data from the filter list.
void	edje_object_part_text_style_user_pop (Edje_Object *obj, const char *part)
	Deletes the top style form the user style stack.
void	edje_object_part_text_input_panel_imdata_set (Edje_Object *obj, const char *part, const void *data, int len)
	Sets the input panel-specific data to deliver to the input panel.
void	edje_object_part_text_input_panel_imdata_get (const Edje_Object *obj, const char *part, void *data, int *len)
	Gets the specific data of the current active input panel.
void	edje_object_part_text_insert (Edje_Object *obj, const char *part, const char *text)
	Inserts text for an object part.
Evas_Object *	edje_object_part_box_remove_at (Edje_Object *obj, const char *part, unsigned int pos)
	Removes an object from the box.
void	edje_object_part_text_cursor_copy (Edje_Object *obj, const char *part, Edje_Cursor src, Edje_Cursor dst)
	Copies the cursor to another cursor.
Eina_Bool	edje_object_parts_extends_calc (Edje_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
	Calculates the geometry of the region, relative to a given Edje object's area, occupied by all parts in the object.
Eina_Bool	edje_object_part_drag_value_set (Edje_Object *obj, const char *part, double dx, double dy)
	Sets the dragable object location.
Eina_Bool	edje_object_part_drag_value_get (const Edje_Object *obj, const char *part, double *dx, double *dy)
	Gets the dragable object location.
void	edje_object_calc_force (Edje_Object *obj)
	Forces a Size/Geometry calculation.
void	edje_object_part_text_cursor_pos_set (Edje_Object *obj, const char *part, Edje_Cursor cur, int pos)
	Sets the cursor position to the given value.
int	edje_object_part_text_cursor_pos_get (const Edje_Object *obj, const char *part, Edje_Cursor cur)
	Retrieves the current position of the cursor.
int	edje_object_freeze (Edje_Object *obj)
	Freezes the Edje object.
char *	edje_object_part_text_cursor_content_get (const Edje_Object *obj, const char *part, Edje_Cursor cur)
	Returns the content (char) at the cursor position. evas_textblock_cursor_content_get.
void	edje_object_part_text_input_panel_layout_set (Edje_Object *obj, const char *part, Edje_Input_Panel_Layout layout)
	Sets the layout of the input panel.
Edje_Input_Panel_Layout	edje_object_part_text_input_panel_layout_get (const Edje_Object *obj, const char *part)
	Gets the layout of the input panel.
Eina_Bool	edje_object_part_table_pack (Edje_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.
void	edje_object_part_text_input_panel_language_set (Edje_Object *obj, const char *part, Edje_Input_Panel_Lang lang)
	Sets the language mode of the input panel.
Edje_Input_Panel_Lang	edje_object_part_text_input_panel_language_get (const Edje_Object *obj, const char *part)
	Gets the language mode of the input panel.
Eina_Bool	edje_object_part_table_col_row_size_get (const Edje_Object *obj, const char *part, int *cols, int *rows)
	Gets the number of columns and rows the table has.
Evas_Object *	edje_object_part_external_object_get (const Edje_Object *obj, const char *part)
	Gets the object created by this external part.
Evas_Object *	edje_object_part_external_content_get (const Edje_Object *obj, const char *part, const char *content)
	Gets an object contained in an part of type EXTERNAL.
Eina_Bool	edje_object_preload (Edje_Object *obj, Eina_Bool cancel)
	Preloads the images on the Edje Object in the background.
void	edje_object_part_text_input_panel_enabled_set (Edje_Object *obj, const char *part, Eina_Bool enabled)
	Sets the attribute to show the input panel automatically.
Eina_Bool	edje_object_part_text_input_panel_enabled_get (const Edje_Object *obj, const char *part)
	Retrieves the attribute to show the input panel automatically. See also edje_object_part_text_input_panel_enabled_set.
void	edje_object_part_text_select_extend (const Edje_Object *obj, const char *part)
	Extends the current selection to the current cursor position.
Eina_Bool	edje_object_part_box_insert_at (Edje_Object *obj, const char *part, Evas_Object *child, unsigned int pos)
	Inserts an object to the box.
const Eina_List *	edje_object_part_text_anchor_geometry_get (const Edje_Object *obj, const char *part, const char *anchor)
	Returns a list of Evas_Textblock_Rectangle anchor rectangles.
Eina_Bool	edje_object_part_text_cursor_down (Edje_Object *obj, const char *part, Edje_Cursor cur)
	Moves the cursor to the char below the current cursor position.
Eina_Bool	edje_object_part_drag_page_set (Edje_Object *obj, const char *part, double dx, double dy)
	Sets the page step increments.
Eina_Bool	edje_object_part_drag_page_get (const Edje_Object *obj, const char *part, double *dx, double *dy)
	Gets the page step increments.
Eina_Bool	edje_object_part_box_prepend (Edje_Object *obj, const char *part, Evas_Object *child)
	Prepends an object to the box.
void	edje_object_signal_emit (Edje_Object *obj, const char *emission, const char *source)
	Sends/emits an Edje signal to a given Edje object.
void	edje_object_part_text_input_panel_layout_variation_set (Edje_Object *obj, const char *part, int variation)
	Sets the layout variation of the input panel.
int	edje_object_part_text_input_panel_layout_variation_get (const Edje_Object *obj, const char *part)
	Gets the layout variation of the input panel.
void	edje_object_message_send (Edje_Object *obj, Edje_Message_Type type, int id, void *msg)
	Sends an (Edje) message to a given Edje object.
void	edje_object_part_text_select_none (const Edje_Object *obj, const char *part)
	Sets the selection to be none.
const Evas_Object *	edje_object_part_object_get (const Edje_Object *obj, const char *part)
	Gets a handle to the Evas object implementing a given Edje part, in an Edje object.
Eina_Bool	edje_object_part_drag_size_set (Edje_Object *obj, const char *part, double dw, double dh)
	Sets the dragable object size.
Eina_Bool	edje_object_part_drag_size_get (const Edje_Object *obj, const char *part, double *dw, double *dh)
	Gets the dragable object size.
void *	edje_object_text_insert_filter_callback_del (Edje_Object *obj, const char *part, Edje_Text_Filter_Cb func)
	Deletes a function from the filter list.
Edje_Drag_Dir	edje_object_part_drag_dir_get (const Edje_Object *obj, const char *part)
	Determines dragable directions.
Eina_Bool	edje_object_part_text_unescaped_set (Edje_Object *obj, const char *part, const char *text_to_escape)
	Sets the raw (non escaped) text for an object part.
char *	edje_object_part_text_unescaped_get (const Edje_Object *obj, const char *part)
	Returns the text of the object part, without escaping.
void	edje_object_signal_callback_add (Edje_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data)
	Adds a callback for an arriving Edje signal, emitted by a given Edje object.
void	edje_object_part_text_select_all (const Edje_Object *obj, const char *part)
	Sets the selection to be everything.
void	edje_object_part_text_input_panel_return_key_disabled_set (Edje_Object *obj, const char *part, Eina_Bool disabled)
	Sets the return key on the input panel to be disabled.
Eina_Bool	edje_object_part_text_input_panel_return_key_disabled_get (const Edje_Object *obj, const char *part)
	Gets whether the return key on the input panel should be disabled or not.
void	edje_object_part_text_autocapital_type_set (Edje_Object *obj, const char *part, Edje_Text_Autocapital_Type autocapital_type)
	Sets the autocapitalization type on the immodule.
Edje_Text_Autocapital_Type	edje_object_part_text_autocapital_type_get (const Edje_Object *obj, const char *part)
	Retrieves the autocapitalization type.
void	edje_object_part_unswallow (Edje_Object *obj, Evas_Object *obj_swallow)
	Unswallows an object.
void	edje_object_part_text_prediction_allow_set (Edje_Object *obj, const char *part, Eina_Bool prediction)
	Sets whether the prediction is allowed or not.
Eina_Bool	edje_object_part_text_prediction_allow_get (const Edje_Object *obj, const char *part)
	Gets whether the prediction is allowed or not.
const char *	edje_object_data_get (const Edje_Object *obj, const char *key)
	Retrives an EDC data field's value from a given Edje object's group.
void	edje_object_text_markup_filter_callback_add (Edje_Object *obj, const char *part, Edje_Markup_Filter_Cb func, void *data)
	Adds a markup filter function for newly inserted text.
Evas_Object *	edje_object_part_box_remove (Edje_Object *obj, const char *part, Evas_Object *child)
	Removes an object from the box.
int	edje_object_thaw (Edje_Object *obj)
	Thaws the Edje object.
Evas_Object *	edje_object_part_swallow_get (const Edje_Object *obj, const char *part)
	Gets the object currently swallowed by a part.
void	edje_object_part_text_imf_context_reset (const Edje_Object *obj, const char *part)
	Resets the input method context if needed.
void	edje_object_part_text_input_panel_return_key_type_set (Edje_Object *obj, const char *part, Edje_Input_Panel_Return_Key_Type return_key_type)
	Sets the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
Edje_Input_Panel_Return_Key_Type	edje_object_part_text_input_panel_return_key_type_get (const Edje_Object *obj, const char *part)
	Gets the "return" key type.
Evas_Object *	edje_object_part_table_child_get (const Edje_Object *obj, const char *part, unsigned int col, unsigned int row)
	Retrieves a child from a table.
Eina_Bool	edje_object_part_box_insert_before (Edje_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference)
	Adds an object to the box.
Eina_Bool	edje_object_part_external_param_set (Edje_Object *obj, const char *part, const Edje_External_Param *param)
	Sets the parameter for the external part.
Eina_Bool	edje_object_part_external_param_get (const Edje_Object *obj, const char *part, Edje_External_Param *param)
	Gets the parameter for the external part.
void	edje_object_size_min_calc (Edje_Object *obj, Evas_Coord *minw, Evas_Coord *minh)
	Calculates the minimum required size for a given Edje object.
Eina_Bool	edje_object_part_box_append (Edje_Object *obj, const char *part, Evas_Object *child)
	Appends an object to the box.
void	edje_object_size_min_restricted_calc (Edje_Object *obj, Evas_Coord *minw, Evas_Coord *minh, Evas_Coord restrictedw, Evas_Coord restrictedh)
	Calculates the minimum required size for a given Edje object.
Eina_Bool	edje_object_part_box_remove_all (Edje_Object *obj, const char *part, Eina_Bool clear)
	Removes all elements from the box.
Eina_Bool	edje_object_part_drag_page (Edje_Object *obj, const char *part, double dx, double dy)
	Pages x,y steps.
Eina_Bool	edje_object_part_text_set (Edje_Object *obj, const char *part, const char *text)
	Sets the text for an object part.
const char *	edje_object_part_text_get (const Edje_Object *obj, const char *part)
	Returns the text of the object part.
void	edje_object_part_text_input_panel_show_on_demand_set (Edje_Object *obj, const char *part, Eina_Bool ondemand)
	Sets the attribute to show the input panel in case of only an user's explicit Mouse Up event. It doesn't request to show the input panel even though it has focus.
Eina_Bool	edje_object_part_text_input_panel_show_on_demand_get (const Edje_Object *obj, const char *part)
	Gets the attribute to show the input panel in case of only an user's explicit Mouse Up event.
void	edje_object_part_text_input_hint_set (Edje_Object *obj, const char *part, Edje_Input_Hints input_hints)
	Sets the input hint which allows input methods to fine-tune their behavior.
Edje_Input_Hints	edje_object_part_text_input_hint_get (const Edje_Object *obj, const char *part)
	Gets the value of input hint.
const char *	edje_object_part_text_selection_get (const Edje_Object *obj, const char *part)
	Returns the selection text of the object part.
Eina_Bool	edje_object_part_text_cursor_is_format_get (const Edje_Object *obj, const char *part, Edje_Cursor cur)
	Returns whether the cursor points to a format. evas_textblock_cursor_is_format.
Eina_Bool	edje_object_text_class_get (const Edje_Object *obj, const char *text_class, const char **font, Evas_Font_Size *size)
	Gets font and font size from edje text class.
Eina_Bool	edje_object_color_class_set (Edje_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.
Eina_Bool	edje_object_color_class_get (const Edje_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.
const char *	edje_object_color_class_description_get (const Edje_Object *obj, const char *color_class)
	Gets the description of an object color class.
Eina_Bool	edje_object_color_class_clear (const Edje_Object *obj)
	Clear object color classes.
void	edje_object_size_class_del (Edje_Object *obj, const char *size_class)
	Deletes the object size class.
Eina_Bool	edje_object_part_drag_step (Edje_Object *obj, const char *part, double dx, double dy)
	Steps the dragable x,y steps.
Eina_Bool	edje_object_part_text_cursor_up (Edje_Object *obj, const char *part, Edje_Cursor cur)
	Moves the cursor to the char above the current cursor position.
void	edje_object_part_text_cursor_geometry_get (const Edje_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.
const Eina_List *	edje_object_part_text_anchor_list_get (const Edje_Object *obj, const char *part)
	Returns a list of char anchor names.
void	edje_object_text_insert_filter_callback_add (Edje_Object *obj, const char *part, Edje_Text_Filter_Cb func, void *data)
	Adds a filter function for newly inserted text.
void	edje_object_part_text_input_panel_show (const Edje_Object *obj, const char *part)
	Shows the input panel (virtual keyboard) based on the input panel property such as layout, autocapital types, and so on.
Eina_Bool	edje_object_part_exists (const Edje_Object *obj, const char *part)
	Checks if an Edje part exists in a given Edje object's group definition.
void *	edje_object_text_markup_filter_callback_del (Edje_Object *obj, const char *part, Edje_Markup_Filter_Cb func)
	Deletes a function from the markup filter list.
Eina_Bool	edje_object_part_text_cursor_is_visible_format_get (const Edje_Object *obj, const char *part, Edje_Cursor cur)
	Returns true if the cursor points to a visible format For example \t, \n, item and etc. @ evas_textblock_cursor_format_is_visible_get.
void	edje_object_part_text_user_insert (const Edje_Object *obj, const char *part, const char *text)
	This function inserts text as if the user has inserted it.
Eina_Bool	edje_object_part_text_cursor_prev (Edje_Object *obj, const char *part, Edje_Cursor cur)
	Moves the cursor to the previous char evas_textblock_cursor_char_prev.
const Eina_List *	edje_object_part_text_item_list_get (const Edje_Object *obj, const char *part)
	Returns a list of char item names.
Eina_Bool	edje_object_part_swallow (Edje_Object *obj, const char *part, Evas_Object *obj_swallow)
	"Swallows" an object into one of the Edje object SWALLOW parts.
Eina_Bool	edje_object_part_text_hide_visible_password (Edje_Object *obj, const char *part)
	Hides visible last character for password mode.
void	edje_object_part_text_prediction_hint_set (Edje_Object *obj, const char *part, const char *prediction_hint)
	Sets the prediction hint to use an intelligent reply suggestion service.

---

Function Documentation

Eina_List* edje_object_access_part_list_get

(

const Edje_Object *

obj

)

Retrieves a list all accessibility part names.

Since :

2.3

Parameters:

[in]

obj

The object.

Returns:

A list all accessibility part names on obj

Since (EFL) :

1.7.0

Eina_Bool edje_object_animation_get

(

const Edje_Object *

obj

)

Gets the Edje object's animation state.

This function returns if the animation is stopped or not. The animation state is set by edje_object_animation_set().

See also edje_object_animation_set().

Since :

2.3

Parameters:

[in]

obj

The object.

Returns:

The animation state. true to starts or false to stops.

void edje_object_animation_set	(	Edje_Object *	obj,
		Eina_Bool	on
	)

Sets the object's animation state.

This function starts or stops an Edje object's animation. The information if it's stopped can be retrieved by edje_object_animation_get().

See also edje_object_animation_get()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	on	The animation state. true to starts or false to stops.

double edje_object_base_scale_get

(

const Edje_Object *

obj

)

Gets a given Edje object's base_scale factor.

This function returns the base_scale factor set on the obj Edje object. The base_scale can be set in the collection of edc. If it isn't set, the default value is 1.0

Since :

2.3

Parameters:

[in]

obj

The object.

Returns:

The base_scale factor (the default value is @ 1.0, that means the edc file is made based on scale 1.0.

void edje_object_calc_force

(

Edje_Object *

obj

)

Forces a Size/Geometry calculation.

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

Since :

2.3

Parameters:

[in]

obj

The object.

Examples:

edje-perspective.c.

Eina_Bool edje_object_color_class_clear

(

const Edje_Object *

obj

)

Clear object color classes.

Since :

3.0

Parameters:

[in]

obj

The object.

Returns:

true, on success or false, on error

Since (EFL) :

1.17.0

const char* edje_object_color_class_description_get	(	const Edje_Object *	obj,
		const char *	color_class
	)

Gets the description of an object color class.

This function gets the description of a color class in use by an object.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	color_class	The color class name

Returns:

The description of the target color class or null if not found

Eina_Bool edje_object_color_class_get	(	const Edje_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.

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.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	color_class	The color class name
[out]	r	Object Red value
[out]	g	Object Green value
[out]	b	Object Blue value
[out]	a	Object Alpha value
[out]	r2	Outline Red value
[out]	g2	Outline Green value
[out]	b2	Outline Blue value
[out]	a2	Outline Alpha value
[out]	r3	Shadow Red value
[out]	g3	Shadow Green value
[out]	b3	Shadow Blue value
[out]	a3	Shadow Alpha value

Returns:

true if found, or false if not found and all values are zeroed.

Eina_Bool edje_object_color_class_set	(	Edje_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.

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.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	color_class	The color class name
[in]	r	Object Red value
[in]	g	Object Green value
[in]	b	Object Blue value
[in]	a	Object Alpha value
[in]	r2	Outline Red value
[in]	g2	Outline Green value
[in]	b2	Outline Blue value
[in]	a2	Outline Alpha value
[in]	r3	Shadow Red value
[in]	g3	Shadow Green value
[in]	b3	Shadow Blue value
[in]	a3	Shadow Alpha value

Returns:

true, on success or false, on error

Examples:

edje-color-class.c.

const char* edje_object_data_get	(	const Edje_Object *	obj,
		const char *	key
	)

Retrives an EDC data field's value from a given Edje object's group.

This function fetches an EDC data field's value, which is declared on the objects building EDC file, under its group. EDC data blocks are most commonly used to pass arbitrary parameters from an application's theme to its code.

EDC data fields always hold strings as values, hence the return type of this function. Check the complete syntax reference for EDC files.

Warning:

Do not confuse this call with edje_file_data_get(), which queries for a global EDC data field on an EDC declaration file.

edje_object_file_set()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	key	The data field's key string

Returns:

The data's value string. Must not be freed.

Examples:

edje-basic.c.

int edje_object_freeze

(

Edje_Object *

obj

)

Freezes the Edje object.

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

See also edje_object_thaw()

Since :

2.3

Parameters:

[in]

obj

The object.

Returns:

The frozen state or 0 on Error

void edje_object_item_provider_set	(	Edje_Object *	obj,
		Edje_Item_Provider_Cb	func,
		void *	data
	)

Sets the function that provides item objects for named items in an edje entry text.

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

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	func	The function to call (or null to disable) to get item objects
[in]	data	The data pointer to pass to the func callback

const char* edje_object_language_get

(

const Edje_Object *

obj

)

Gets the language for this object.

Since :

3.0

Parameters:

[in]

obj

The object.

Returns:

The language value

Since (EFL) :

1.1.0

void edje_object_language_set	(	Edje_Object *	obj,
		const char *	language
	)

Sets the language for this object.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	language	The language value

Since (EFL) :

1.1.0

Edje_Load_Error edje_object_load_error_get

(

const Edje_Object *

obj

)

Gets the (last) file loading error for a given Edje object.

This function is meant to be used after an Edje EDJ file loading, what takes place with the edje_object_file_set() function. If that function does not return true, one should check for the reason of failure with this one.

edje_load_error_str()

Since :

2.3

Parameters:

[in]

obj

The object.

Returns:

The Edje loading error, one of: - #EDJE_LOAD_ERROR_NONE - #EDJE_LOAD_ERROR_GENERIC - #EDJE_LOAD_ERROR_DOES_NOT_EXIST - #EDJE_LOAD_ERROR_PERMISSION_DENIED - #EDJE_LOAD_ERROR_RESOURCE_ALLOCATION_FAILED - #EDJE_LOAD_ERROR_CORRUPT_FILE

• #EDJE_LOAD_ERROR_UNKNOWN_FORMAT - #EDJE_LOAD_ERROR_INCOMPATIBLE_FILE - #EDJE_LOAD_ERROR_UNKNOWN_COLLECTION - #EDJE_LOAD_ERROR_RECURSIVE_REFERENCE

Examples:

edje-basic.c, edje-signals-messages.c, and evas-aspect-hints.c.

void edje_object_message_handler_set	(	Edje_Object *	obj,
		Edje_Message_Handler_Cb	func,
		void *	data
	)

Sets an Edje message handler function for a given Edje object.

For scriptable programs on an Edje object's defining EDC file which send messages with the send_message() primitive, one can attach handler functions, to be called in the code which creates that object (see the syntax for EDC files).

This function associates a message handler function and the attached data pointer to the object obj.

See also edje_object_message_send()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	func	The function to handle messages coming from obj
[in]	data	Auxiliary data to be passed to func

Examples:

edje-signals-messages.c.

void edje_object_message_send	(	Edje_Object *	obj,
		Edje_Message_Type	type,
		int	id,
		void *	msg
	)

Sends an (Edje) message to a given Edje object.

This function sends an Edje message to obj and to all of its child objects, if it has any (swallowed objects are one kind of child object). type and msg must be matched accordingly, as documented in #Edje_Message_Type.

The id argument as a form of code and theme defining a common interface on message communication. One should define the same IDs on both code and EDC declaration (see the syntax for EDC files), to individualize messages (binding them to a given context).

The function to handle messages arriving from obj is set with edje_object_message_handler_set().

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	type	The type of message to send to obj
[in]	id	A identification number for the message to be sent
[in]	msg	The message's body, a struct depending on type

Examples:

edje-signals-messages.c.

Eina_Bool edje_object_mirrored_get

(

const Edje_Object *

obj

)

Gets the RTL orientation for this object.

You can RTL orientation explicitly with edje_object_mirrored_set.

Since :

3.0

Parameters:

[in]

obj

The object.

Returns:

New value of flag true/$false

Since (EFL) :

1.1.0

void edje_object_mirrored_set	(	Edje_Object *	obj,
		Eina_Bool	rtl
	)

Sets the RTL orientation for this object.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	rtl	New value of flag true/$false

Since (EFL) :

1.1.0

Eina_Bool edje_object_part_box_append	(	Edje_Object *	obj,
		const char *	part,
		Evas_Object *	child
	)

Appends an object to the box.

Appends child to the box indicated by part.

See also edje_object_part_box_prepend(), edje_object_part_box_insert_before() and edje_object_part_box_insert_at()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	child	The object to append

Returns:

true: Successfully added. false: An error occurred.

Examples:

edje-box.c, and edje-box2.c.

Eina_Bool edje_object_part_box_insert_at	(	Edje_Object *	obj,
		const char *	part,
		Evas_Object *	child,
		unsigned int	pos
	)

Inserts an object to the box.

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

See also edje_object_part_box_append(), edje_object_part_box_prepend() and edje_object_part_box_insert_before()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	child	The object to insert
[in]	pos	The position where to insert child

Returns:

true: Successfully added. false: An error occurred.

Examples:

edje-box.c, and edje-box2.c.

Eina_Bool edje_object_part_box_insert_before	(	Edje_Object *	obj,
		const char *	part,
		Evas_Object *	child,
		const Evas_Object *	reference
	)

Adds an object to the box.

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

See also edje_object_part_box_append(), edje_object_part_box_prepend() and edje_object_part_box_insert_at()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	child	The object to insert
[in]	reference	The object to be used as reference

Returns:

true: Successfully added. false: An error occurred.

Examples:

edje-box.c.

Eina_Bool edje_object_part_box_prepend	(	Edje_Object *	obj,
		const char *	part,
		Evas_Object *	child
	)

Prepends an object to the box.

Prepends child to the box indicated by part.

See also edje_object_part_box_append(), edje_object_part_box_insert_before() and edje_object_part_box_insert_at()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	child	The object to prepend

Returns:

true: Successfully added. false: An error occurred.

Evas_Object* edje_object_part_box_remove	(	Edje_Object *	obj,
		const char *	part,
		Evas_Object *	child
	)

Removes an object from the box.

Removes child from the box indicated by part.

See also edje_object_part_box_remove_at() and edje_object_part_box_remove_all()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	child	The object to remove

Returns:

Pointer to the object removed, or null.

Examples:

edje-box.c.

Eina_Bool edje_object_part_box_remove_all	(	Edje_Object *	obj,
		const char *	part,
		Eina_Bool	clear
	)

Removes all elements from the box.

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

See also edje_object_part_box_remove() and edje_object_part_box_remove_at()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	clear	Delete objects on removal

Returns:

$1: Successfully cleared. $0: An error occurred.

Examples:

edje-box.c.

Evas_Object* edje_object_part_box_remove_at	(	Edje_Object *	obj,
		const char *	part,
		unsigned int	pos
	)

Removes an object from the box.

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

See also edje_object_part_box_remove() and edje_object_part_box_remove_all()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	pos	The position index of the object (starts counting from 0)

Returns:

Pointer to the object removed, or null.

Examples:

edje-box2.c.

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

Determines dragable directions.

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

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

#EDJE_DRAG_DIR_NONE: Not dragable #EDJE_DRAG_DIR_X: Dragable in X direction #EDJE_DRAG_DIR_Y: Dragable in Y direction #EDJE_DRAG_DIR_XY: Dragable in X & Y directions

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

Pages x,y steps.

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

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

Warning:

Paging is bugged!

See also edje_object_part_drag_step()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	dx	The x step
[in]	dy	The y step

Returns:

true, on success or false, on error

Examples:

edje-drag.c.

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

Gets the page step increments.

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

See also edje_object_part_drag_page_set()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[out]	dx	The dx page increment pointer
[out]	dy	The dy page increment pointer

Returns:

true, on success or false, on error

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

Sets the page step increments.

Sets the x,y page step increment values.

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

See also edje_object_part_drag_page_get()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	dx	The x page step increment
[in]	dy	The y page step increment

Returns:

true, on success or false, on error

Examples:

edje-drag.c.

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

Gets the dragable object size.

Gets the dragable object size.

See also edje_object_part_drag_size_set()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[out]	dw	The drag width pointer
[out]	dh	The drag height pointer

Returns:

true, on success or false, on error

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

Sets the dragable object size.

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

Sets the size of the dragable object.

See also edje_object_part_drag_size_get()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	dw	The drag width
[in]	dh	The drag height

Returns:

true, on success or false, on error

Examples:

edje-drag.c.

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

Steps the dragable x,y steps.

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

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

See also edje_object_part_drag_page()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	dx	The x step
[in]	dy	The y step

Returns:

true, on success or false, on error

Examples:

edje-drag.c.

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

Gets the drag step increment values.

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

See also edje_object_part_drag_step_set()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part
[out]	dx	The x step increment pointer
[out]	dy	The y step increment pointer

Returns:

true, on success or false, on error

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

Sets the drag step increment.

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

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

See also edje_object_part_drag_step_get()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	dx	The x step amount
[in]	dy	The y step amount

Returns:

true, on success or false, on error

Examples:

edje-drag.c.

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

Gets the dragable object location.

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

See also edje_object_part_drag_value_set()

Gets the drag location values.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[out]	dx	The X value pointer
[out]	dy	The Y value pointer

Returns:

true, on success or false, on error

Examples:

edje-drag.c.

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

Sets the dragable object location.

Places the dragable object at the given location.

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

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

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

See also edje_object_part_drag_value_get()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	dx	The x value
[in]	dy	The y value

Returns:

true, on success or false, on error

Examples:

edje-drag.c.

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

Checks if an Edje part exists in a given Edje object's group definition.

This function returns if a given part exists in the Edje group bound to object obj (with edje_object_file_set()).

This call is useful, for example, when one could expect or not a given GUI element, depending on the theme applied to obj.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part's name to check for existence in obj's group

Returns:

true if the Edje part exists in obj's group, or false otherwise (and on errors)

Examples:

edje-basic.c.

Evas_Object* edje_object_part_external_content_get	(	const Edje_Object *	obj,
		const char *	part,
		const char *	content
	)

Gets an object contained in an part of type EXTERNAL.

The content string must not be null. Its actual value depends on the code providing the EXTERNAL.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The name of the part holding the EXTERNAL
[out]	content	A string identifying which content from the EXTERNAL to get

Returns:

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

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

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

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

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

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

Gets 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 modified 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.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[out]	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 false will be returned.

Returns:

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

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

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

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	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 false will be returned.

Returns:

true if everything went fine, false on errors.

Edje_External_Param_Type edje_object_part_external_param_type_get	(	const Edje_Object *	obj,
		const char *	part,
		const char *	param
	)

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

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[out]	param	The parameter name to use.

Returns:

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

Eina_Bool edje_object_part_geometry_get	(	const Edje_Object *	obj,
		const char *	part,
		Evas_Coord *	x,
		Evas_Coord *	y,
		Evas_Coord *	w,
		Evas_Coord *	h
	)

Retrieves the geometry of a given Edje part, in a given Edje object's group definition, relative to the object's area.

This function gets the geometry of an Edje part within its group. The x and y coordinates are relative to the top left corner of the whole obj object's area.

Note:

Use null pointers on the geometry components you're not interested in: they'll be ignored by the function.

On failure, this function will make all non-$null geometry pointers' pointed variables be set to zero.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The Edje part's name
[out]	x	A pointer to a variable where to store the part's x coordinate
[out]	y	A pointer to a variable where to store the part's y coordinate
[out]	w	A pointer to a variable where to store the part's width
[out]	h	A pointer to a variable where to store the part's height

Returns:

true, on success or false, on error

Examples:

edje-basic.c.

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

Gets a handle to the Evas object implementing a given Edje part, in an Edje object.

This function gets a pointer of the Evas object corresponding to a given part in the obj object's group.

You should never modify the state of the returned object (with evas_object_move() or evas_object_hide() for example), because it's meant to be managed by Edje, solely. You are safe to query information about its current state (with evas_object_visible_get() or evas_object_color_get() for example), though.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The Edje part's name

Returns:

A pointer to the Evas object implementing the given part, or null on failure (e.g. the given part doesn't exist)

Examples:

edje-basic.c.

const char* edje_object_part_state_get	(	const Edje_Object *	obj,
		const char *	part,
		double *	val_ret
	)

Returns the state of the Edje part.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[out]	val_ret	The description state value

Returns:

The part state: "default" for the default state "" for other states

Eina_Bool edje_object_part_swallow	(	Edje_Object *	obj,
		const char *	part,
		Evas_Object *	obj_swallow
	)

"Swallows" an object into one of the Edje object SWALLOW parts.

Swallowing an object into an Edje object is, for a given part of type SWALLOW in the EDC group which gave life to obj, to set an external object to be controlled by obj, being displayed exactly over that part's region inside the whole Edje object's viewport.

From this point on, obj will have total control over obj_swallow's geometry and visibility. For instance, if obj is visible, as in evas_object_show(), the swallowed object will be visible too -- if the given SWALLOW part it's in is also visible. Other actions on obj will also reflect on the swallowed object as well (e.g. resizing, moving, raising/lowering, etc.).

Finally, all internal changes to part, specifically, will reflect on the displaying of obj_swallow, for example state changes leading to different visibility states, geometries, positions, etc.

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

Note:

obj won't delete the swallowed object once it is deleted -- obj_swallow will get to an unparented state again.

For more details on EDC SWALLOW parts, see syntax reference".

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The swallow part's name
[in]	obj_swallow	The object to occupy that part

Returns:

true, on success or false, on error

Examples:

edje-swallow.c, and evas-aspect-hints.c.

Evas_Object* edje_object_part_swallow_get	(	const Edje_Object *	obj,
		const char *	part
	)

Gets the object currently swallowed by a part.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

The swallowed object, or null if there is none.

Examples:

edje-swallow.c.

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

Retrieves a child from a table.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	col	The column of the child to get
[in]	row	The row of the child to get

Returns:

The child Evas.Object

Eina_Bool edje_object_part_table_clear	(	Edje_Object *	obj,
		const char *	part,
		Eina_Bool	clear
	)

Removes all object from the table.

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

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	clear	If set, will delete subobjs on remove

Returns:

true clear the table, false on failure

Examples:

edje-table.c.

Eina_Bool edje_object_part_table_col_row_size_get	(	const Edje_Object *	obj,
		const char *	part,
		int *	cols,
		int *	rows
	)

Gets the number of columns and rows the table has.

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

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[out]	cols	Pointer where to store number of columns (can be null)
[out]	rows	Pointer where to store number of rows (can be null)

Returns:

true get some data, false on failure

Examples:

edje-table.c.

Eina_Bool edje_object_part_table_pack	(	Edje_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.

Packs an object into the table indicated by part.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	child_obj	The object to pack in
[in]	col	The column to place it in
[in]	row	The row to place it in
[in]	colspan	Columns the child will take
[in]	rowspan	Rows the child will take

Returns:

true object was added, false on failure

Examples:

edje-table.c.

Eina_Bool edje_object_part_table_unpack	(	Edje_Object *	obj,
		const char *	part,
		Evas_Object *	child_obj
	)

Removes an object from the table.

Removes an object from the table indicated by part.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	child_obj	The object to pack in

Returns:

true object removed, false on failure

Examples:

edje-table.c.

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

Returns a list of Evas_Textblock_Rectangle anchor rectangles.

This function return a list of Evas_Textblock_Rectangle anchor rectangles.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	anchor	The anchor name

Returns:

The list of anchor rects (const Evas_Textblock_Rectangle *), do not modify! Geometry is relative to entry part.

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

Returns a list of char anchor names.

This function returns a list of char anchor names.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

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

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

Inserts text for an object part.

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

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	text	The text string

Since (EFL) :

1.1

Edje_Text_Autocapital_Type edje_object_part_text_autocapital_type_get	(	const Edje_Object *	obj,
		const char *	part
	)

Retrieves the autocapitalization type.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

The autocapitalization type

Since (EFL) :

1.1.0

void edje_object_part_text_autocapital_type_set	(	Edje_Object *	obj,
		const char *	part,
		Edje_Text_Autocapital_Type	autocapital_type
	)

Sets the autocapitalization type on the immodule.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	autocapital_type	The type of autocapitalization

Since (EFL) :

1.1.0

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

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

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The edje cursor to work on

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

Returns the content (char) at the cursor position. evas_textblock_cursor_content_get.

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

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The cursor to use

Returns:

The character string pointed to (may be a multi-byte utf8 sequence) terminated by a nul byte.

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

Position the given cursor to a X,Y position.

This is frequently used with the user cursor.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part containing the object.
[in]	cur	The cursor to adjust.
[in]	x	X Coordinate.
[in]	y	Y Coordinate.

Returns:

true on success, false on error.

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

Copies the cursor to another cursor.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	src	The cursor to copy from
[in]	dst	The cursor to copy to

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

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

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The edje cursor to work on

Returns:

true, on success or false, on error

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

Moves the cursor to the end of the text part. evas_textblock_cursor_paragraph_last.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The edje cursor to work on

void edje_object_part_text_cursor_geometry_get	(	const Edje_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.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[out]	x	Cursor X position
[out]	y	Cursor Y position
[out]	w	Cursor width
[out]	h	Cursor height

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

Returns whether the cursor points to a format. evas_textblock_cursor_is_format.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The cursor to adjust.

Returns:

true if it's true, false otherwise.

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

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

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The cursor to adjust.

Returns:

Returns true if the cursor points to a visible format or false on error

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

Moves the cursor to the beginning of the line. evas_textblock_cursor_line_char_first.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The edje cursor to work on

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

Moves the cursor to the end of the line. evas_textblock_cursor_line_char_last.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The edje cursor to work on

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

Advances the cursor to the next cursor position. evas_textblock_cursor_char_next.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The edje cursor to advance

Returns:

true, on success or false, on error

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

Retrieves the current position of the cursor.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The cursor to get the position

Returns:

The cursor position

Since (EFL) :

1.1.0

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

Sets the cursor position to the given value.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The cursor to move
[in]	pos	The position of the cursor

Since (EFL) :

1.1.0

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

Moves the cursor to the previous char evas_textblock_cursor_char_prev.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The edje cursor to work on

Returns:

true, on success or false, on error

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

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

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	cur	The edje cursor to work on

Returns:

true, on success or false, on error

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

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

This converts the given string text to UTF8 assuming it contains HTML style escapes like "&" and "©" etc. IF the part is of type TEXT, as opposed to TEXTBLOCK.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	text	The text string

Returns:

true on success, false otherwise

Since (EFL) :

1.2

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

Returns the text of the object part.

This function returns the text associated to the object part.

See also edje_object_part_text_set().

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

The text string

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

Hides visible last character for password mode.

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

true if the visible character is hidden. false if there is no visible character or the object is not set for password mode.

Since (EFL) :

1.18.0

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

Gets the input method context in entry.

If ecore_imf was not available when edje was compiled, this function returns null otherwise, the returned pointer is an Ecore_IMF

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

The input method context (Ecore_IMF_Context *) in entry

Since (EFL) :

1.2.0

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

Resets the input method context if needed.

This can be necessary in the case where modifying the buffer would confuse on-going input method behavior

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Since (EFL) :

1.2.0

Edje_Input_Hints edje_object_part_text_input_hint_get	(	const Edje_Object *	obj,
		const char *	part
	)

Gets the value of input hint.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

The value of input hint

Since (EFL) :

1.12.0

void edje_object_part_text_input_hint_set	(	Edje_Object *	obj,
		const char *	part,
		Edje_Input_Hints	input_hints
	)

Sets the input hint which allows input methods to fine-tune their behavior.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	input_hints	Input hints

Since (EFL) :

1.12.0

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

Retrieves the attribute to show the input panel automatically. See also edje_object_part_text_input_panel_enabled_set.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

true if it supports, or false otherwise

Since (EFL) :

1.1.0

void edje_object_part_text_input_panel_enabled_set	(	Edje_Object *	obj,
		const char *	part,
		Eina_Bool	enabled
	)

Sets the attribute to show the input panel automatically.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	enabled	If true, the input panel is appeared when entry is clicked or has a focus

Since (EFL) :

1.1.0

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

Hides the input panel (virtual keyboard). See also edje_object_part_text_input_panel_show.

Note that input panel is shown or hidden automatically according to the focus state. This API can be used in the case of manually controlling by using edje_object_part_text_input_panel_enabled_set.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Since (EFL) :

1.2.0

void edje_object_part_text_input_panel_imdata_get	(	const Edje_Object *	obj,
		const char *	part,
		void *	data,
		int *	len
	)

Gets the specific data of the current active input panel.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	data	The specific data to be got from the input panel
[in]	len	The length of data

Since (EFL) :

1.2.0

void edje_object_part_text_input_panel_imdata_set	(	Edje_Object *	obj,
		const char *	part,
		const void *	data,
		int	len
	)

Sets the input panel-specific data to deliver to the input panel.

This API is used by applications to deliver specific data to the input panel. The data format MUST be negotiated by both application and the input panel. The size and format of data are defined by the input panel.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	data	The specific data to be set to the input panel.
[in]	len	the length of data, in bytes, to send to the input panel

Since (EFL) :

1.2.0

Edje_Input_Panel_Lang edje_object_part_text_input_panel_language_get	(	const Edje_Object *	obj,
		const char *	part
	)

Gets the language mode of the input panel.

See also edje_object_part_text_input_panel_language_set for more details.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

Input panel language type

Since (EFL) :

1.2.0

void edje_object_part_text_input_panel_language_set	(	Edje_Object *	obj,
		const char *	part,
		Edje_Input_Panel_Lang	lang
	)

Sets the language mode of the input panel.

This API can be used if you want to show the Alphabet keyboard.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	lang	The language to be set to the input panel.

Since (EFL) :

1.2.0

Edje_Input_Panel_Layout edje_object_part_text_input_panel_layout_get	(	const Edje_Object *	obj,
		const char *	part
	)

Gets the layout of the input panel.

See also edje_object_part_text_input_panel_layout_set

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

Layout type of the input panel

Since (EFL) :

1.1

void edje_object_part_text_input_panel_layout_set	(	Edje_Object *	obj,
		const char *	part,
		Edje_Input_Panel_Layout	layout
	)

Sets the layout of the input panel.

The layout of the input panel or virtual keyboard can make it easier or harder to enter content. This allows you to hint what kind of input you are expecting to enter and thus have the input panel automatically come up with the right mode.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	layout	Layout type

Since (EFL) :

1.1

int edje_object_part_text_input_panel_layout_variation_get	(	const Edje_Object *	obj,
		const char *	part
	)

Gets the layout variation of the input panel.

See also edje_object_part_text_input_panel_layout_variation_set

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

Layout variation type of the input panel

Since (EFL) :

1.8

void edje_object_part_text_input_panel_layout_variation_set	(	Edje_Object *	obj,
		const char *	part,
		int	variation
	)

Sets the layout variation of the input panel.

The layout variation of the input panel or virtual keyboard can make it easier or harder to enter content. This allows you to hint what kind of input you are expecting to enter and thus have the input panel automatically come up with the right mode.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	variation	Layout variation type

Since (EFL) :

1.8

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

Gets whether the return key on the input panel should be disabled or not.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

true if it should be disabled

Since (EFL) :

1.2.0

void edje_object_part_text_input_panel_return_key_disabled_set	(	Edje_Object *	obj,
		const char *	part,
		Eina_Bool	disabled
	)

Sets the return key on the input panel to be disabled.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	disabled	The state

Since (EFL) :

1.2.0

Edje_Input_Panel_Return_Key_Type edje_object_part_text_input_panel_return_key_type_get	(	const Edje_Object *	obj,
		const char *	part
	)

Gets the "return" key type.

See also edje_object_part_text_input_panel_return_key_type_set() for more details

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

The type of "return" key on the input panel

Since (EFL) :

1.2.0

void edje_object_part_text_input_panel_return_key_type_set	(	Edje_Object *	obj,
		const char *	part,
		Edje_Input_Panel_Return_Key_Type	return_key_type
	)

Sets the "return" key type. This type is used to set string or icon on the "return" key of the input panel.

An input panel displays the string or icon associated with this type

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	return_key_type	The type of "return" key on the input panel

Since (EFL) :

1.2.0

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

Shows the input panel (virtual keyboard) based on the input panel property such as layout, autocapital types, and so on.

Note that input panel is shown or hidden automatically according to the focus state. This API can be used in the case of manually controlling by using edje_object_part_text_input_panel_enabled_set.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Since (EFL) :

1.2.0

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

Gets the attribute to show the input panel in case of only an user's explicit Mouse Up event.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

true if the input panel will be shown in case of only Mouse up event.

Since (EFL) :

1.9.0

void edje_object_part_text_input_panel_show_on_demand_set	(	Edje_Object *	obj,
		const char *	part,
		Eina_Bool	ondemand
	)

Sets the attribute to show the input panel in case of only an user's explicit Mouse Up event. It doesn't request to show the input panel even though it has focus.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	ondemand	If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)

Since (EFL) :

1.9.0

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

Inserts text for an object part.

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

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	text	The text string

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

Returns item geometry.

This function return a list of Evas_Textblock_Rectangle item rectangles.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	item	The item name
[out]	cx	Item x return (relative to entry part)
[out]	cy	Item y return (relative to entry part)
[out]	cw	Item width return
[out]	ch	Item height return

Returns:

1 if item exists, 0 if not

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

Returns a list of char item names.

This function returns a list of char item names.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

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

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

Gets whether the prediction is allowed or not.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

true if prediction feature is allowed.

Since (EFL) :

1.2.0

void edje_object_part_text_prediction_allow_set	(	Edje_Object *	obj,
		const char *	part,
		Eina_Bool	prediction
	)

Sets whether the prediction is allowed or not.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	prediction	If true, the prediction feature is allowed.

Since (EFL) :

1.2.0

void edje_object_part_text_prediction_hint_set	(	Edje_Object *	obj,
		const char *	part,
		const char *	prediction_hint
	)

Sets the prediction hint to use an intelligent reply suggestion service.

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	prediction_hint	Prediction hint

Since (EFL) :

1.20.0

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

Aborts any selection action on a part.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

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

Sets the selection to be everything.

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

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Examples:

edje-text.c.

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

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

The default is to not allow selection. This function only affects user selection, functions such as edje_object_part_text_select_all() and edje_object_part_text_select_none() are not affected.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	allow	true to enable, false otherwise

Examples:

edje-text.c.

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

Starts selecting at current cursor position.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

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

Extends the current selection to the current cursor position.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

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

Sets the selection to be none.

This function sets the selection text to be none.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Examples:

edje-text.c.

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

Returns the selection text of the object part.

This function returns selection text of the object part.

See also edje_object_part_text_select_all() and edje_object_part_text_select_none()

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

The text string

Examples:

edje-text.c.

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

Sets the text for an object part.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	text	The text string

Returns:

true on success, false otherwise

Examples:

edje-color-class.c, and edje-text.c.

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

Returns the text of the object part.

This function returns the style associated with the textblock part.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

The text string

Since (EFL) :

1.2.0

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

Deletes the top style form the user style stack.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name

Since (EFL) :

1.2.0

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

Sets the style of the.

This function sets the style associated with the textblock part.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	style	The style to set (textblock conventions).

Since (EFL) :

1.2.0

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

Returns the text of the object part, without escaping.

This function is the counterpart of edje_object_part_text_unescaped_set(). Please notice that the result is newly allocated memory and should be released with free() when done.

See also edje_object_part_text_unescaped_set().

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name

Returns:

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

Examples:

edje-text.c.

Eina_Bool edje_object_part_text_unescaped_set	(	Edje_Object *	obj,
		const char *	part,
		const char *	text_to_escape
	)

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

This function will not do escape for you if it is a TEXTBLOCK part, that is, if text contain tags, these tags will not be interpreted/parsed by TEXTBLOCK.

See also edje_object_part_text_unescaped_get().

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	text_to_escape	The text string

Returns:

true, on success or false, on error

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

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

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

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	text	The text string

Since (EFL) :

1.2.0

void edje_object_part_unswallow	(	Edje_Object *	obj,
		Evas_Object *	obj_swallow
	)

Unswallows an object.

Causes the edje to regurgitate a previously swallowed object. :)

Note:

obj_swallow will not be deleted or hidden. Note: obj_swallow may appear shown on the evas depending on its state when it got unswallowed. Make sure you delete it or hide it if you do not want it to.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	obj_swallow	The swallowed object

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

Calculates the geometry of the region, relative to a given Edje object's area, occupied by all parts in the object.

This function gets the geometry of the rectangle equal to the area required to group all parts in obj's group/collection. The x and y coordinates are relative to the top left corner of the whole obj object's area. Parts placed out of the group's boundaries will also be taken in account, so that x and y may be negative.

Note:

Use null pointers on the geometry components you're not interested in: they'll be ignored by the function.

On failure, this function will make all non-$null geometry pointers' pointed variables be set to zero.

Since :

2.3

Parameters:

[in]	obj	The object.
[out]	x	A pointer to a variable where to store the parts region's x coordinate
[out]	y	A pointer to a variable where to store the parts region's y coordinate
[out]	w	A pointer to a variable where to store the parts region's width
[out]	h	A pointer to a variable where to store the parts region's height

Returns:

true, on success or false, on error

Examples:

edje-basic.c.

const Edje_Perspective* edje_object_perspective_get

(

const Edje_Object *

obj

)

Gets the current perspective used on this Edje object.

See also edje_object_perspective_set()

Since :

2.3

Parameters:

[in]

obj

The object.

Returns:

The perspective object that will be used.

void edje_object_perspective_set	(	Edje_Object *	obj,
		Edje_Perspective *	ps
	)

Sets the given perspective object on this Edje object.

Make the given perspective object be the default perspective for this Edje object.

There can be only one perspective object per Edje object, and if a previous one was set, it will be removed and the new perspective object will be used.

An Edje perspective will only affect a part if it doesn't point to another part to be used as perspective.

edje_object_perspective_new() See also edje_object_perspective_get() edje_perspective_set()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	ps	The perspective object that will be used.

Eina_Bool edje_object_play_get

(

const Edje_Object *

obj

)

Gets the Edje object's state.

This function tells if an Edje object is playing or not. This state is set by edje_object_play_set().

See also edje_object_play_set().

Since :

2.3

Parameters:

[in]

obj

The object.

Returns:

Object state ($true to playing, false to paused).

void edje_object_play_set	(	Edje_Object *	obj,
		Eina_Bool	play
	)

Sets the Edje object to playing or paused states.

This function sets the Edje object obj to playing or paused states, depending on the parameter play. This has no effect if the object was already at that state.

See also edje_object_play_get().

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	play	Object state ($true to playing, false to paused).

Eina_Bool edje_object_preload	(	Edje_Object *	obj,
		Eina_Bool	cancel
	)

Preloads the images on the Edje Object in the background.

This function requests the preload of all data images (on the given object) in the background. The work is queued before being processed (because there might be other pending requests of this type). It emits a signal "preload,done" when finished.

Note:

Use true on scenarios where you don't need the image data preloaded anymore.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	cancel	false will add it the preloading work queue, true will remove it (if it was issued before).

Returns:

false if obj was not a valid Edje object otherwise true

double edje_object_scale_get

(

const Edje_Object *

obj

)

Gets a given Edje object's scaling factor.

This function returns the individual scaling factor set on the obj Edje object.

See also edje_object_scale_set() for more details

Since :

2.3

Parameters:

[in]

obj

The object.

Returns:

The scaling factor (the default value is @0.0, meaning individual scaling not set)

Examples:

edje-basic.c.

Eina_Bool edje_object_scale_set	(	Edje_Object *	obj,
		double	scale
	)

Sets the scaling factor for a given Edje object.

This function sets an individual scaling factor on the obj Edje object. This property (or Edje's global scaling factor, when applicable), will affect this object's part sizes. If scale is not zero, than the individual scaling will override any global scaling set, for the object obj's parts. Put it back to zero to get the effects of the global scaling again.

Warning:

Only parts which, at EDC level, had the "scale" property set to @1, will be affected by this function. Check the complete syntax reference for EDC files.

See also edje_object_scale_get() edje_scale_get() for more details

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	scale	The scaling factor (the default value is @0.0, meaning individual scaling not set)

Returns:

true, on success or false, on error

Examples:

edje-basic.c.

void edje_object_signal_callback_add	(	Edje_Object *	obj,
		const char *	emission,
		const char *	source,
		Edje_Signal_Cb	func,
		void *	data
	)

Adds a callback for an arriving Edje signal, emitted by a given Edje object.

Edje signals are one of the communication interfaces between code and a given Edje object's theme. With signals, one can communicate two string values at a time, which are: - "emission" value: the name of the signal, in general - "source" value: a name for the signal's context, in general

Though there are those common uses for the two strings, one is free to use them however they like.

Signal callback registration is powerful, in the way that blobs may be used to match multiple signals at once. All the "*?[\" set of fnmatch() operators can be used, both for emission and source.

Edje has internal signals it will emit, automatically, on various actions taking place on group parts. For example, the mouse cursor being moved, pressed, released, etc., over a given part's area, all generate individual signals.

By using something like edje_object_signal_callback_add(obj, "mouse,down,*", "button.*", signal_cb, NULL); being "button.*" the pattern for the names of parts implementing buttons on an interface, you'd be registering for notifications on events of mouse buttons being pressed down on either of those parts (those events all have the "mouse,down," common prefix on their names, with a suffix giving the button number). The actual emission and source strings of an event will be passed in as the emission and source parameters of the callback function (e.g. "mouse,down,2" and "button.close"), for each of those events.

Note:

See the syntax for EDC files See also edje_object_signal_emit() on how to emits Edje signals from code to a an object edje_object_signal_callback_del_full()

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	emission	The signal's "emission" string
[in]	source	The signal's "source" string
[in]	func	The callback function to be executed when the signal is emitted.
[in]	data	A pointer to data to pass in to func.

Examples:

edje-color-class.c, edje-drag.c, edje-perspective.c, and edje-signals-messages.c.

void edje_object_signal_emit	(	Edje_Object *	obj,
		const char *	emission,
		const char *	source
	)

Sends/emits an Edje signal to a given Edje object.

This function sends a signal to the object obj. An Edje program, at obj's EDC specification level, can respond to a signal by having declared matching @'signal' and @'source' fields on its block (see the syntax for EDC files).

See also edje_object_signal_callback_add() for more on Edje signals.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	emission	The signal's "emission" string
[in]	source	The signal's "source" string

Examples:

edje-perspective.c, and edje-signals-messages.c.

void edje_object_size_class_del	(	Edje_Object *	obj,
		const char *	size_class
	)

Deletes the object size class.

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

Deleting the size class will revert it to the values defined by edje_size_class_set() or the color class defined in the theme file.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	size_class

Since (EFL) :

1.17

Eina_Bool edje_object_size_class_get	(	const Edje_Object *	obj,
		const char *	size_class,
		int *	minw,
		int *	minh,
		int *	maxw,
		int *	maxh
	)

Gets the object size class.

This function gets the min and max values for an object level size class. These values will only be valid until the size class is changed or the edje object is deleted.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	size_class	The size class name
[out]	minw	The min width
[out]	minh	The min height
[out]	maxw	The max width
[out]	maxh	The max height

Returns:

true on success, or false on error

Since (EFL) :

1.17

Eina_Bool edje_object_size_class_set	(	Edje_Object *	obj,
		const char *	size_class,
		int	minw,
		int	minh,
		int	maxw,
		int	maxh
	)

Sets the object size class.

This function sets the min and max values for an object level size class. This will make all edje parts in the specified object that have the specified size class update their min and max size with given values.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	size_class	The size class name
[in]	minw	The min width
[in]	minh	The min height
[in]	maxw	The max width
[in]	maxh	The max height

Returns:

true on success, or false on error

Since (EFL) :

1.17

void edje_object_size_max_get	(	const Edje_Object *	obj,
		Evas_Coord *	maxw,
		Evas_Coord *	maxh
	)

Gets the maximum size specified -- as an EDC property -- for a given Edje object.

This function retrieves the obj object's maximum size values, as declared in its EDC group definition.

Note:

If the max EDC property was not declared for obj, this call will return the maximum size a given Edje object may have, for each axis.

On failure, this function will make all non-$null size pointers' pointed variables be set to zero.

See also edje_object_size_min_get()

Since :

2.3

Parameters:

[in]	obj	The object.
[out]	maxw	Pointer to a variable where to store the maximum width
[out]	maxh	Pointer to a variable where to store the maximum height

Examples:

edje-basic.c.

void edje_object_size_min_calc	(	Edje_Object *	obj,
		Evas_Coord *	minw,
		Evas_Coord *	minh
	)

Calculates the minimum required size for a given Edje object.

This call works exactly as edje_object_size_min_restricted_calc(), with the last two arguments set to 0. Please refer to its documentation, then.

Since :

2.3

Parameters:

[in]	obj	The object.
[out]	minw	Pointer to a variable where to store the minimum required width
[out]	minh	Pointer to a variable where to store the minimum required height

Examples:

edje-basic.c.

void edje_object_size_min_get	(	const Edje_Object *	obj,
		Evas_Coord *	minw,
		Evas_Coord *	minh
	)

Gets the minimum size specified -- as an EDC property -- for a given Edje object.

This function retrieves the obj object's minimum size values, as declared in its EDC group definition.

Note:

If the min EDC property was not declared for obj, this call will return the value 0, for each axis.

On failure, this function will make all non-$null size pointers' pointed variables be set to zero.

See also edje_object_size_max_get()

Since :

2.3

Parameters:

[in]	obj	The object.
[out]	minw	Pointer to a variable where to store the minimum width
[out]	minh	Pointer to a variable where to store the minimum height

Examples:

edje-basic.c.

void edje_object_size_min_restricted_calc	(	Edje_Object *	obj,
		Evas_Coord *	minw,
		Evas_Coord *	minh,
		Evas_Coord	restrictedw,
		Evas_Coord	restrictedh
	)

Calculates the minimum required size for a given Edje object.

This call will trigger an internal recalculation of all parts of the obj object, in order to return its minimum required dimensions for width and height. The user might choose to impose those minimum sizes, making the resulting calculation to get to values equal or bigger than restrictedw and restrictedh, for width and height, respectively.

Note:

At the end of this call, obj won't be automatically resized to new dimensions, but just return the calculated sizes. The caller is the one up to change its geometry or not.

Warning:

Be advised that invisible parts in obj will be taken into account in this calculation.

Since :

2.3

Parameters:

[in]	obj	The object.
[out]	minw	Pointer to a variable where to store the minimum required width
[out]	minh	Pointer to a variable where to store the minimum required height
[in]	restrictedw	Do not allow object's calculated (minimum) width to be less than this value
[in]	restrictedh	Do not allow object's calculated (minimum) height to be less than this value

Examples:

edje-basic.c.

void edje_object_text_change_cb_set	(	Edje_Object *	obj,
		Edje_Text_Change_Cb	func,
		void *	data
	)

Sets the object text callback.

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

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	func	The callback function to handle the text change
[in]	data	The data associated to the callback function.

Examples:

edje-text.c.

Eina_Bool edje_object_text_class_get	(	const Edje_Object *	obj,
		const char *	text_class,
		const char **	font,
		Evas_Font_Size *	size
	)

Gets font and font size from edje text class.

This function gets the font and the font size from the object text class. The font string will only be valid until the text class is changed or the edje object is deleted.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	text_class	The text class name
[out]	font	Font name
[out]	size	Font Size

Returns:

true, on success or false, on error

Eina_Bool edje_object_text_class_set	(	Edje_Object *	obj,
		const char *	text_class,
		const char *	font,
		Evas_Font_Size	size
	)

Sets Edje text class.

This function sets the text class for the Edje.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	text_class	The text class name
[in]	font	Font name
[in]	size	Font Size

Returns:

true, on success or false, on error

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

Adds a filter function for newly inserted text.

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

Warning:

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

See also edje_object_text_insert_filter_callback_del, edje_object_text_insert_filter_callback_del_full and edje_object_text_markup_filter_callback_add

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	func	The callback function that will act as filter
[in]	data	User provided data to pass to the filter function

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

Deletes a function from the filter list.

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

See also edje_object_text_insert_filter_callback_add and edje_object_text_insert_filter_callback_del_full

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	func	The function callback to remove

Returns:

The user data pointer if successful, or null otherwise

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

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

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

See also edje_object_text_insert_filter_callback_add and edje_object_text_insert_filter_callback_del

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	func	The function callback to remove
[in]	data	The data passed to the callback function

Returns:

The same data pointer if successful, or null otherwise

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

Adds a markup filter function for newly inserted text.

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

Warning:

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

See also edje_object_text_markup_filter_callback_del, edje_object_text_markup_filter_callback_del_full and edje_object_text_insert_filter_callback_add

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	func	The callback function that will act as markup filter
[in]	data	User provided data to pass to the filter function

Since (EFL) :

1.2.0

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

Deletes a function from the markup filter list.

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

See also edje_object_text_markup_filter_callback_add and edje_object_text_markup_filter_callback_del_full

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	func	The function callback to remove

Returns:

The user data pointer if successful, or null otherwise

Since (EFL) :

1.2.0

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

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

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

See also edje_object_text_markup_filter_callback_add and edje_object_text_markup_filter_callback_del

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	part	The part name
[in]	func	The function callback to remove
[in]	data	The data passed to the callback function

Returns:

The same data pointer if successful, or null otherwise

Since (EFL) :

1.2.0

int edje_object_thaw

(

Edje_Object *

obj

)

Thaws the Edje object.

This function thaws the given Edje object.

Note:: If sucessives freezes were done, an equal number of thaws will be required.

See also edje_object_freeze()

Since :

2.3

Parameters:

[in]

obj

The object.

Returns:

The frozen state or 0 if the object is not frozen or on error.

double edje_object_transition_duration_factor_get

(

const Edje_Object *

obj

)

Gets transition duration factor.

This define the transition duration factor on this specific object. By default all animation are run at a speed factor of 1.0.

Since :

3.0

Parameters:

[in]

obj

The object.

Returns:

The transition duration factor

void edje_object_transition_duration_factor_set	(	Edje_Object *	obj,
		double	scale
	)

Sets transition duration factor.

This define the transition duration factor on this specific object. By default all animation are run at a speed factor of 1.0.

Since :

3.0

Parameters:

[in]	obj	The object.
[in]	scale	The transition duration factor

Eina_Bool edje_object_update_hints_get

(

const Edje_Object *

obj

)

Whether or not Edje will update size hints on itself.

Since :

2.3

Parameters:

[in]

obj

The object.

Returns:

Whether or not update the size hints.

void edje_object_update_hints_set	(	Edje_Object *	obj,
		Eina_Bool	update
	)

Edje will automatically update the size hints on itself.

By default edje doesn't set size hints on itself. With this function call, it will do so if update is true. Be carefully, it cost a lot to trigger this feature as it will recalc the object every time it make sense to be sure that's its minimal size hint is always accurate.

Since :

2.3

Parameters:

[in]	obj	The object.
[in]	update	Whether or not update the size hints.