Tizen Native API  7.0

Functions that deal with layout components.

Parts are layout components, but as a layout, they are objects too.

There are several types of parts, these types can be divided into two main categories, the first being containers. Containers are parts that are in effect a group of elements. The second group is that of the elements, these part types may not contain others.

This section has some functions specific for some types and others that could be applied to any type.

Functions

Eina_Bool edje_object_part_swallow (Evas_Object *obj, const char *part, Evas_Object *obj_swallow)
 "Swallows" an object into one of the Edje object SWALLOW parts.
Evas_Objectedje_object_part_swallow_get (const Evas_Object *obj, const char *part)
 Gets the object currently swallowed by a part.
void edje_object_part_unswallow (Evas_Object *obj, Evas_Object *obj_swallow)
 Unswallows an object.
Eina_Listedje_object_access_part_list_get (const Evas_Object *obj)
 Retrieves a list all accessibility part names.
Eina_Bool edje_object_part_box_append (Evas_Object *obj, const char *part, Evas_Object *child)
 Appends an object to the box.
Eina_Bool edje_object_part_box_prepend (Evas_Object *obj, const char *part, Evas_Object *child)
 Prepends an object to the box.
Eina_Bool edje_object_part_box_insert_before (Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference)
 Adds an object to the box.
Eina_Bool edje_object_part_box_insert_at (Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos)
 Inserts an object to the box.
Evas_Objectedje_object_part_box_remove_at (Evas_Object *obj, const char *part, unsigned int pos)
 Removes an object from the box.
Evas_Objectedje_object_part_box_remove (Evas_Object *obj, const char *part, Evas_Object *child)
 Removes an object from the box.
Eina_Bool edje_object_part_box_remove_all (Evas_Object *obj, const char *part, Eina_Bool clear)
 Removes all elements from the box.
Eina_Bool edje_object_part_table_pack (Evas_Object *obj, const char *part, Evas_Object *child_obj, unsigned short col, unsigned short row, unsigned short colspan, unsigned short rowspan)
 Packs an object into the table.
Eina_Bool edje_object_part_table_unpack (Evas_Object *obj, const char *part, Evas_Object *child_obj)
 Removes an object from the table.
Eina_Bool edje_object_part_table_col_row_size_get (const Evas_Object *obj, const char *part, int *cols, int *rows)
 Gets the number of columns and rows the table has.
Evas_Objectedje_object_part_table_child_get (const Evas_Object *obj, const char *part, unsigned int col, unsigned int row)
 Retrieves a child from a table.
Eina_Bool edje_object_part_table_clear (Evas_Object *obj, const char *part, Eina_Bool clear)
 Removes all object from the table.
void edje_object_part_text_select_allow_set (const Evas_Object *obj, const char *part, Eina_Bool allow)
 Enables selection if the entry is an EXPLICIT selection mode type.
void edje_object_part_text_select_disable_set (const Edje_Object *obj, const char *part, Eina_Bool disable)
 Disable selection if the entry is an EXPLICIT selection mode type include keyboard input.
Eina_Bool edje_object_part_text_set (const Evas_Object *obj, const char *part, const char *text)
 Sets a given text to an Edje object TEXT or TEXTBLOCK parts.
const char * edje_object_part_text_get (const Evas_Object *obj, const char *part)
 Gets the text currntly set to the given part.
void edje_object_part_text_cursor_begin_set (Evas_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_end_set (Evas_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the end of the text part. evas_textblock_cursor_paragraph_last.
void edje_object_part_text_cursor_pos_set (Evas_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 Evas_Object *obj, const char *part, Edje_Cursor cur)
 Retrieves the current position of the cursor.
Eina_Bool edje_object_part_text_cursor_coord_set (Evas_Object *obj, const char *part, Edje_Cursor cur, int x, int y)
 Position the given cursor to a X,Y position.
void edje_object_part_text_cursor_line_begin_set (Evas_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_part_text_cursor_line_end_set (Evas_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_part_text_cursor_prev (Evas_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the previous char evas_textblock_cursor_char_prev.
Eina_Bool edje_object_part_text_cursor_next (Evas_Object *obj, const char *part, Edje_Cursor cur)
 Advances the cursor to the next cursor position. evas_textblock_cursor_char_next.
Eina_Bool edje_object_part_text_cursor_up (Evas_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the char above the current cursor position.
Eina_Bool edje_object_part_text_cursor_down (Evas_Object *obj, const char *part, Edje_Cursor cur)
 Moves the cursor to the char below the current cursor position.
void edje_object_part_text_cursor_copy (Evas_Object *obj, const char *part, Edje_Cursor src, Edje_Cursor dst)
 Copies the cursor to another cursor.
char * edje_object_part_text_cursor_content_get (const Evas_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_cursor_geometry_get (const Evas_Object *obj, const char *part, int *x, int *y, int *w, int *h)
 Returns the cursor geometry of the part relative to the edje object.
Eina_Bool edje_object_part_text_hide_visible_password (Evas_Object *obj, const char *part)
 Hides visible last character for password mode.
Eina_Bool edje_object_part_text_cursor_is_format_get (const Evas_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_part_text_cursor_is_visible_format_get (const Evas_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.
const Eina_Listedje_object_part_text_anchor_geometry_get (const Evas_Object *obj, const char *part, const char *anchor)
 Returns a list of Evas_Textblock_Rectangle anchor rectangles.
const Eina_Listedje_object_part_text_anchor_list_get (const Evas_Object *obj, const char *part)
 Returns a list of char anchor names.
const char * edje_object_part_text_style_user_peek (const Evas_Object *obj, const char *part)
 Returns the text of the object part.
void edje_object_part_text_style_user_push (Evas_Object *obj, const char *part, const char *style)
 Sets the style of the.
void edje_object_part_text_style_user_pop (Evas_Object *obj, const char *part)
 Deletes the top style form the user style stack.
Eina_Bool edje_object_part_text_item_geometry_get (const Evas_Object *obj, const char *part, const char *item, int *cx, int *cy, int *cw, int *ch)
 Returns item geometry.
const Eina_Listedje_object_part_text_item_list_get (const Evas_Object *obj, const char *part)
 Returns a list of char item names.
void edje_object_part_text_user_insert (const Evas_Object *obj, const char *part, const char *text)
 This function inserts text as if the user has inserted it.
void edje_object_part_text_append (Evas_Object *obj, const char *part, const char *text)
 Inserts text for an object part.
Eina_Bool edje_object_part_text_escaped_set (Evas_Object *obj, const char *part, const char *text)
 Sets the text for an object part, but converts HTML escapes to UTF8.
Eina_Bool edje_object_part_text_unescaped_set (Evas_Object *obj, const char *part, const char *text_to_escape)
 Sets the raw (non escaped) text for an object part.
char * edje_object_part_text_unescaped_get (const Evas_Object *obj, const char *part)
 Returns the text of the object part, without escaping.
void edje_object_part_text_insert (Evas_Object *obj, const char *part, const char *text)
 Inserts text for an object part.
void edje_object_part_text_autocapital_type_set (Evas_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 Evas_Object *obj, const char *part)
 Retrieves the autocapitalization type.
void edje_object_part_text_prediction_allow_set (Evas_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 Evas_Object *obj, const char *part)
 Gets whether the prediction is allowed or not.
void * edje_object_part_text_imf_context_get (const Evas_Object *obj, const char *part)
 Gets the input method context in entry.
void edje_object_part_text_imf_context_reset (const Evas_Object *obj, const char *part)
 Resets the input method context if needed.
void edje_object_part_text_input_hint_set (Evas_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 Evas_Object *obj, const char *part)
 Gets the value of input hint.
void edje_object_part_text_input_panel_show (const Evas_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.
void edje_object_part_text_input_panel_hide (const Evas_Object *obj, const char *part)
 Hides the input panel (virtual keyboard). See also edje_object_part_text_input_panel_show.
void edje_object_part_text_input_panel_imdata_set (Evas_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 Evas_Object *obj, const char *part, void *data, int *len)
 Gets the specific data of the current active input panel.
void edje_object_part_text_input_panel_layout_set (Evas_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 Evas_Object *obj, const char *part)
 Gets the layout of the input panel.
void edje_object_part_text_input_panel_language_set (Evas_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 Evas_Object *obj, const char *part)
 Gets the language mode of the input panel.
void edje_object_part_text_input_panel_layout_variation_set (Evas_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 Evas_Object *obj, const char *part)
 Gets the layout variation of the input panel.
void edje_object_part_text_input_panel_enabled_set (Evas_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 Evas_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_input_panel_return_key_disabled_set (Evas_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 Evas_Object *obj, const char *part)
 Gets whether the return key on the input panel should be disabled or not.
void edje_object_part_text_input_panel_return_key_type_set (Evas_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 Evas_Object *obj, const char *part)
 Gets the "return" key type.
void edje_object_part_text_input_panel_show_on_demand_set (Evas_Object *obj, const char *part, Eina_Bool ondemand)
 Sets the attribute to show the input panel in case of only a 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 Evas_Object *obj, const char *part)
 Gets the attribute to show the input panel in case of only a user's explicit Mouse Up event.
void edje_object_part_text_prediction_hint_set (Evas_Object *obj, const char *part, const char *prediction_hint)
 Sets the prediction hint to use an intelligent reply suggestion service.
Eina_Bool edje_object_part_text_prediction_hint_hash_set (Evas_Object *obj, const char *part, const char *key, const char *value)
 Sets the prediction hint data at the specified key.
Eina_Bool edje_object_part_text_prediction_hint_hash_del (Evas_Object *obj, const char *part, const char *key)
 Removes the prediction hint data identified by a key.
void edje_object_part_text_select_begin (const Evas_Object *obj, const char *part)
 Starts selecting at current cursor position.
void edje_object_part_text_select_abort (const Evas_Object *obj, const char *part)
 Aborts any selection action on a part.
void edje_object_part_text_select_extend (const Evas_Object *obj, const char *part)
 Extends the current selection to the current cursor position.
void edje_object_part_text_select_all (const Evas_Object *obj, const char *part)
 Sets the selection to be everything.
void edje_object_part_text_select_none (const Evas_Object *obj, const char *part)
 Sets the selection to be none.
const char * edje_object_part_text_selection_get (const Evas_Object *obj, const char *part)
 Returns the selection text of the object part.
Eina_Bool edje_object_part_exists (const Evas_Object *obj, const char *part)
 Checks if a part exists in a given Edje object's group definition.

Typedefs

typedef enum _Edje_Part_Type Edje_Part_Type

Typedef Documentation

All possible "part" types in Edje


Enumeration Type Documentation

Enumerator:
EDJE_PART_TYPE_NONE 

None type value

EDJE_PART_TYPE_RECTANGLE 

Rectangle type value

EDJE_PART_TYPE_TEXT 

Text type value

EDJE_PART_TYPE_IMAGE 

Image type value

EDJE_PART_TYPE_SWALLOW 

Swallow type value

EDJE_PART_TYPE_TEXTBLOCK 

Text block type value

EDJE_PART_TYPE_GRADIENT 

Gradient type value

EDJE_PART_TYPE_GROUP 

Group type value

EDJE_PART_TYPE_BOX 

Box type value

EDJE_PART_TYPE_TABLE 

Table type value

EDJE_PART_TYPE_EXTERNAL 

External type value

EDJE_PART_TYPE_PROXY 

Proxy type value

EDJE_PART_TYPE_SPACER 

Spacer type value

Since (EFL) :
1.7
EDJE_PART_TYPE_SNAPSHOT 

Snapshot

Since (EFL) :
1.16
EDJE_PART_TYPE_VECTOR 

Vector

Since (EFL) :
1.18
EDJE_PART_TYPE_LAST 

Last type value


Function Documentation

Retrieves a list all accessibility part names.

Returns:
A list all accessibility part names on obj
Since (EFL) :
1.7.0
Since :
2.3
Eina_Bool edje_object_part_box_append ( Evas_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(), edje_object_part_box_insert_after() and edje_object_part_box_insert_at()

Parameters:
[in]childThe object to append
Returns:
true: Successfully added. false: An error occurred.
Since :
2.3
Examples:
edje-box.c, and edje-box2.c.
Eina_Bool edje_object_part_box_insert_at ( Evas_Object obj,
const char *  part,
Evas_Object child,
unsigned int  pos 
)

Inserts an object to the box.

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(), edje_object_part_box_insert_before() and edje_object_part_box_insert_after()

Parameters:
[in]childThe object to insert
[in]posThe position where to insert child
Returns:
true: Successfully added. false: An error occurred.
Since :
2.3
Examples:
edje-box.c, and edje-box2.c.
Eina_Bool edje_object_part_box_insert_before ( Evas_Object obj,
const char *  part,
Evas_Object child,
const Evas_Object reference 
)

Adds an object to the box.

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(), edje_object_part_box_insert_after() and edje_object_part_box_insert_at()

Parameters:
[in]childThe object to insert
[in]referenceThe object to be used as reference
Returns:
true: Successfully added. false: An error occurred.
Since :
2.3
Examples:
edje-box.c.
Eina_Bool edje_object_part_box_prepend ( Evas_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(), edje_object_part_box_insert_after and edje_object_part_box_insert_at()

Parameters:
[in]childThe object to prepend
Returns:
true: Successfully added. false: An error occurred.
Since :
2.3
Evas_Object* edje_object_part_box_remove ( Evas_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()

Parameters:
[in]childThe object to remove
Returns:
Pointer to the object removed, or null.
Since :
2.3
Examples:
edje-box.c.
Eina_Bool edje_object_part_box_remove_all ( Evas_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()

Parameters:
[in]clearDelete objects on removal
Returns:
1: Successfully cleared. 0: An error occurred.
Since :
2.3
Examples:
edje-box.c.
Evas_Object* edje_object_part_box_remove_at ( Evas_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()

Parameters:
[in]posThe position index of the object (starts counting from 0)
Returns:
Pointer to the object removed, or null.
Since :
2.3
Examples:
edje-box2.c.
Eina_Bool edje_object_part_exists ( const Evas_Object obj,
const char *  part 
)

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

This function returns if a given part exists in the Edje group bound to this object (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 the object.

Parameters:
[in]partThe 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)
Since :
2.3
Examples:
edje-basic.c.
Evas_Object* edje_object_part_external_content_get ( const Evas_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.

Parameters:
[in]partThe name of the part holding the EXTERNAL
[in]contentA string identifying which content from the EXTERNAL to get
Returns:
Canvas object
Since :
3.0
Evas_Object* edje_object_part_external_object_get ( const Evas_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!
Parameters:
[in]partThe part name
Returns:
The externally created object, or null if there is none or part is not an external.
Since :
3.0
Eina_Bool edje_object_part_external_param_get ( const Evas_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.

Parameters:
[in]partThe part name
[out]paramThe 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.
Since :
3.0
Eina_Bool edje_object_part_external_param_set ( Evas_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.
Parameters:
[in]partThe part name
[in]paramThe 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.
Since :
3.0
Edje_External_Param_Type edje_object_part_external_param_type_get ( const Evas_Object obj,
const char *  part,
const char *  param 
)

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

Edje_Object_Group

Parameters:
[in]partThe part name
[in]paramThe parameter name to use
Returns:
EDJE_EXTERNAL_PARAM_TYPE_MAX on errors, or another value from Edje_External_Param_Type on success.
Since :
3.0
Eina_Bool edje_object_part_swallow ( Evas_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".

Parameters:
[in]obj_swallowThe object to occupy that part
Since :
2.3
Examples:
edje-swallow.c, and evas-aspect-hints.c.
Evas_Object* edje_object_part_swallow_get ( const Evas_Object obj,
const char *  part 
)

Gets the object currently swallowed by a part.

Parameters:
[in]partThe part name
Returns:
The swallowed object, or null if there is none.
Since :
2.3
Examples:
edje-swallow.c.
Evas_Object* edje_object_part_table_child_get ( const Evas_Object obj,
const char *  part,
unsigned int  col,
unsigned int  row 
)

Retrieves a child from a table.

Parameters:
[in]colThe column of the child to get
[in]rowThe row of the child to get
Returns:
The child Efl.Canvas.Object
Since :
2.3
Eina_Bool edje_object_part_table_clear ( Evas_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.

Parameters:
[in]clearIf set, will delete subobjs on remove
Returns:
true clear the table, false on failure
Since :
2.3
Examples:
edje-table.c.
Eina_Bool edje_object_part_table_col_row_size_get ( const Evas_Object obj,
const char *  part,
int *  cols,
int *  rows 
)

Gets the number of columns and rows the table has.

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

Parameters:
[out]colsPointer where to store number of columns (can be null)
[out]rowsPointer where to store number of rows (can be null)
Returns:
true get some data, false on failure
Since :
2.3
Examples:
edje-table.c.
Eina_Bool edje_object_part_table_pack ( Evas_Object obj,
const char *  part,
Evas_Object child_obj,
unsigned short  col,
unsigned short  row,
unsigned short  colspan,
unsigned short  rowspan 
)

Packs an object into the table.

Packs an object into the table indicated by part.

Parameters:
[in]child_objThe object to pack in
[in]colThe column to place it in
[in]rowThe row to place it in
[in]colspanColumns the child will take
[in]rowspanRows the child will take
Returns:
true object was added, false on failure
Since :
2.3
Examples:
edje-table.c.
Eina_Bool edje_object_part_table_unpack ( Evas_Object obj,
const char *  part,
Evas_Object child_obj 
)

Removes an object from the table.

Removes an object from the table indicated by part.

Parameters:
[in]child_objThe object to pack in
Returns:
true object removed, false on failure
Since :
2.3
Examples:
edje-table.c.
const Eina_List* edje_object_part_text_anchor_geometry_get ( const Evas_Object obj,
const char *  part,
const char *  anchor 
)

Returns a list of Evas_Textblock_Rectangle anchor rectangles.

This function return a list of Evas_Textblock_Rectangle anchor rectangles.

Parameters:
[in]partThe part name
[in]anchorThe anchor name
Returns:
The list of anchor rects (const Evas_Textblock_Rectangle *), do not modify! Geometry is relative to entry part.
Since :
2.3
const Eina_List* edje_object_part_text_anchor_list_get ( const Evas_Object obj,
const char *  part 
)

Returns a list of char anchor names.

This function returns a list of char anchor names.

Parameters:
[in]partThe part name
Returns:
The list of anchors (const char *), do not modify!
Since :
2.3
void edje_object_part_text_append ( Evas_Object obj,
const char *  part,
const char *  text 
)

Inserts text for an object part.

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

Parameters:
[in]partThe part name
[in]textThe text string
Since (EFL) :
1.1
Since :
2.3
Edje_Text_Autocapital_Type edje_object_part_text_autocapital_type_get ( const Evas_Object obj,
const char *  part 
)

Retrieves the autocapitalization type.

Parameters:
[in]partThe part name
Returns:
The type of autocapitalization
Since (EFL) :
1.1.0
Since :
3.0
void edje_object_part_text_autocapital_type_set ( Evas_Object obj,
const char *  part,
Edje_Text_Autocapital_Type  autocapital_type 
)

Sets the autocapitalization type on the immodule.

Parameters:
[in]partThe part name
[in]autocapital_typeThe type of autocapitalization
Since (EFL) :
1.1.0
Since :
3.0
void edje_object_part_text_cursor_begin_set ( Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

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

Parameters:
[in]partThe part name
[in]curThe edje cursor to work on
Since :
3.0
char* edje_object_part_text_cursor_content_get ( const Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

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

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

Parameters:
[in]partThe part name
[in]curThe cursor to use
Returns:
The character string pointed to (may be a multi-byte utf8 sequence) terminated by a null byte.
Since :
3.0
Eina_Bool edje_object_part_text_cursor_coord_set ( Evas_Object obj,
const char *  part,
Edje_Cursor  cur,
int  x,
int  y 
)

Position the given cursor to a X,Y position.

This is frequently used with the user cursor.

Parameters:
[in]partThe part containing the object.
[in]curThe cursor to adjust.
[in]xX Coordinate.
[in]yY Coordinate.
Returns:
true on success, false otherwise
Since :
3.0
void edje_object_part_text_cursor_copy ( Evas_Object obj,
const char *  part,
Edje_Cursor  src,
Edje_Cursor  dst 
)

Copies the cursor to another cursor.

Parameters:
[in]partThe part name
[in]srcThe cursor to copy from
[in]dstThe cursor to copy to
Since :
3.0
Eina_Bool edje_object_part_text_cursor_down ( Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

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

Parameters:
[in]partThe part name
[in]curThe edje cursor to work on
Returns:
true on success, false otherwise
Since :
3.0
void edje_object_part_text_cursor_end_set ( Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

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

Parameters:
[in]partThe part name
[in]curThe edje cursor to work on
Since :
3.0
void edje_object_part_text_cursor_geometry_get ( const Evas_Object obj,
const char *  part,
int *  x,
int *  y,
int *  w,
int *  h 
)

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

Parameters:
[in]partThe part name
[out]xCursor X position
[out]yCursor Y position
[out]wCursor width
[out]hCursor height
Since :
3.0
Eina_Bool edje_object_part_text_cursor_is_format_get ( const Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

Returns whether the cursor points to a format. evas_textblock_cursor_is_format.

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

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

Parameters:
[in]partThe part name
[in]curThe cursor to adjust.
Returns:
true if the cursor points to a visible format, false otherwise.
Since :
3.0
void edje_object_part_text_cursor_line_begin_set ( Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

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

Parameters:
[in]partThe part name
[in]curThe edje cursor to work on
Since :
3.0
void edje_object_part_text_cursor_line_end_set ( Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

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

Parameters:
[in]partThe part name
[in]curThe edje cursor to work on
Since :
3.0
Eina_Bool edje_object_part_text_cursor_next ( Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

Advances the cursor to the next cursor position. evas_textblock_cursor_char_next.

Parameters:
[in]partThe part name
[in]curThe edje cursor to advance
Returns:
true on success, false otherwise
Since :
3.0
int edje_object_part_text_cursor_pos_get ( const Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

Retrieves the current position of the cursor.

Parameters:
[in]partThe part name
[in]curThe cursor to move
Returns:
The position of the cursor
Since (EFL) :
1.1.0
Since :
3.0
void edje_object_part_text_cursor_pos_set ( Evas_Object obj,
const char *  part,
Edje_Cursor  cur,
int  pos 
)

Sets the cursor position to the given value.

Parameters:
[in]partThe part name
[in]curThe cursor to move
[in]posThe position of the cursor
Since (EFL) :
1.1.0
Since :
3.0
Eina_Bool edje_object_part_text_cursor_prev ( Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

Moves the cursor to the previous char evas_textblock_cursor_char_prev.

Parameters:
[in]partThe part name
[in]curThe edje cursor to work on
Returns:
true on success, false otherwise
Since :
3.0
Eina_Bool edje_object_part_text_cursor_up ( Evas_Object obj,
const char *  part,
Edje_Cursor  cur 
)

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

Parameters:
[in]partThe part name
[in]curThe edje cursor to work on
Returns:
true on success, false otherwise
Since :
3.0
Eina_Bool edje_object_part_text_escaped_set ( Evas_Object obj,
const char *  part,
const char *  text 
)

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

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

Parameters:
[in]partThe part name
[in]textThe text string
Returns:
true on success, false otherwise
Since (EFL) :
1.2
Since :
2.3
const char* edje_object_part_text_get ( const Evas_Object obj,
const char *  part 
)

Gets the text currntly set to the given part.

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

Hides visible last character for password mode.

Parameters:
[in]partThe part name
Returns:
true if the visible character is hidden. false if there is no visible character or the object is not set for password mode.
Since (EFL) :
1.18.0
void* edje_object_part_text_imf_context_get ( const Evas_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

Parameters:
[in]partThe part name
Returns:
The input method context (Ecore_IMF_Context *) in entry
Since (EFL) :
1.2.0
Since :
3.0
void edje_object_part_text_imf_context_reset ( const Evas_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

Parameters:
[in]partThe part name
Since (EFL) :
1.2.0
Since :
3.0
Edje_Input_Hints edje_object_part_text_input_hint_get ( const Evas_Object obj,
const char *  part 
)

Gets the value of input hint.

Parameters:
[in]partThe part name
Returns:
Input hints
Since (EFL) :
1.12.0
Since :
3.0
void edje_object_part_text_input_hint_set ( Evas_Object obj,
const char *  part,
Edje_Input_Hints  input_hints 
)

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

Parameters:
[in]partThe part name
[in]input_hintsInput hints
Since (EFL) :
1.12.0
Since :
3.0
Eina_Bool edje_object_part_text_input_panel_enabled_get ( const Evas_Object obj,
const char *  part 
)

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

Parameters:
[in]partThe part name
Returns:
If true, the input panel is appeared when entry is clicked or has a focus
Since (EFL) :
1.1.0
Since :
3.0
void edje_object_part_text_input_panel_enabled_set ( Evas_Object obj,
const char *  part,
Eina_Bool  enabled 
)

Sets the attribute to show the input panel automatically.

Parameters:
[in]partThe part name
[in]enabledIf true, the input panel is appeared when entry is clicked or has a focus
Since (EFL) :
1.1.0
Since :
3.0
void edje_object_part_text_input_panel_hide ( const Evas_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.

Parameters:
[in]partThe part name
Since (EFL) :
1.2.0
Since :
3.0
void edje_object_part_text_input_panel_imdata_get ( const Evas_Object obj,
const char *  part,
void *  data,
int *  len 
)

Gets the specific data of the current active input panel.

Parameters:
[in]partThe part name
[in]dataThe specific data to be set to the input panel.
[out]lenThe length of data, in bytes, to send to the input panel
Returns:
FIXME: void needed here?
Since (EFL) :
1.2.0
Since :
3.0
void edje_object_part_text_input_panel_imdata_set ( Evas_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.

Parameters:
[in]partThe part name
[in]dataThe specific data to be set to the input panel.
[in]lenThe length of data, in bytes, to send to the input panel
Since (EFL) :
1.2.0
Since :
3.0
Edje_Input_Panel_Lang edje_object_part_text_input_panel_language_get ( const Evas_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.

Parameters:
[in]partThe part name
Returns:
The language to be set to the input panel.
Since (EFL) :
1.2.0
Since :
3.0
void edje_object_part_text_input_panel_language_set ( Evas_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.

Parameters:
[in]partThe part name
[in]langThe language to be set to the input panel.
Since (EFL) :
1.2.0
Since :
3.0
Edje_Input_Panel_Layout edje_object_part_text_input_panel_layout_get ( const Evas_Object obj,
const char *  part 
)

Gets the layout of the input panel.

See also edje_object_part_text_input_panel_layout_set

Parameters:
[in]partThe part name
Returns:
Layout type of the input panel
Since (EFL) :
1.1
Since :
3.0
void edje_object_part_text_input_panel_layout_set ( Evas_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.

Parameters:
[in]partThe part name
[in]layoutLayout type of the input panel
Since (EFL) :
1.1
Since :
3.0
int edje_object_part_text_input_panel_layout_variation_get ( const Evas_Object obj,
const char *  part 
)

Gets the layout variation of the input panel.

See also edje_object_part_text_input_panel_layout_variation_set

Parameters:
[in]partThe part name
Returns:
Layout variation type
Since (EFL) :
1.8
Since :
3.0
void edje_object_part_text_input_panel_layout_variation_set ( Evas_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.

Parameters:
[in]partThe part name
[in]variationLayout variation type
Since (EFL) :
1.8
Since :
3.0

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

Parameters:
[in]partThe part name
Returns:
The state
Since (EFL) :
1.2.0
Since :
3.0
void edje_object_part_text_input_panel_return_key_disabled_set ( Evas_Object obj,
const char *  part,
Eina_Bool  disabled 
)

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

Parameters:
[in]partThe part name
[in]disabledThe state
Since (EFL) :
1.2.0
Since :
3.0
Edje_Input_Panel_Return_Key_Type edje_object_part_text_input_panel_return_key_type_get ( const Evas_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

Parameters:
[in]partThe part name
Returns:
The type of "return" key on the input panel
Since (EFL) :
1.2.0
Since :
3.0
void edje_object_part_text_input_panel_return_key_type_set ( Evas_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

Parameters:
[in]partThe part name
[in]return_key_typeThe type of "return" key on the input panel
Since (EFL) :
1.2.0
Since :
3.0
void edje_object_part_text_input_panel_show ( const Evas_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.

Parameters:
[in]partThe part name
Since (EFL) :
1.2.0
Since :
3.0

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

Parameters:
[in]partThe part name
Returns:
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
Since :
3.0
void edje_object_part_text_input_panel_show_on_demand_set ( Evas_Object obj,
const char *  part,
Eina_Bool  ondemand 
)

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

Parameters:
[in]partThe part name
[in]ondemandIf true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)
Since (EFL) :
1.9.0
Since :
3.0
void edje_object_part_text_insert ( Evas_Object obj,
const char *  part,
const char *  text 
)

Inserts text for an object part.

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

Parameters:
[in]partThe part name
[in]textThe text string
Since :
2.3
Eina_Bool edje_object_part_text_item_geometry_get ( const Evas_Object obj,
const char *  part,
const char *  item,
int *  cx,
int *  cy,
int *  cw,
int *  ch 
)

Returns item geometry.

This function return a list of Evas_Textblock_Rectangle item rectangles.

Parameters:
[in]partThe part name
[in]itemThe item name
[out]cxItem x return (relative to entry part)
[out]cyItem y return (relative to entry part)
[out]cwItem width return
[out]chItem height return
Returns:
$1 if item exists, $0 if not
Since :
2.3
const Eina_List* edje_object_part_text_item_list_get ( const Evas_Object obj,
const char *  part 
)

Returns a list of char item names.

This function returns a list of char item names.

Parameters:
[in]partThe part name
Returns:
The list of items (const char *), do not modify!
Since :
2.3
Eina_Bool edje_object_part_text_prediction_allow_get ( const Evas_Object obj,
const char *  part 
)

Gets whether the prediction is allowed or not.

Parameters:
[in]partThe part name
Returns:
If true, the prediction feature is allowed.
Since (EFL) :
1.2.0
Since :
3.0
void edje_object_part_text_prediction_allow_set ( Evas_Object obj,
const char *  part,
Eina_Bool  prediction 
)

Sets whether the prediction is allowed or not.

Parameters:
[in]partThe part name
[in]predictionIf true, the prediction feature is allowed.
Since (EFL) :
1.2.0
Since :
3.0
Eina_Bool edje_object_part_text_prediction_hint_hash_del ( Evas_Object obj,
const char *  part,
const char *  key 
)

Removes the prediction hint data identified by a key.

Parameters:
[in]partThe part name
[in]keyThe key of the prediction hint
Returns:
true on success, false otherwise
Since (EFL) :
1.21.0
Eina_Bool edje_object_part_text_prediction_hint_hash_set ( Evas_Object obj,
const char *  part,
const char *  key,
const char *  value 
)

Sets the prediction hint data at the specified key.

Parameters:
[in]partThe part name
[in]keyThe key of the prediction hint
[in]valueThe data to replace
Returns:
true on success, false otherwise
Since (EFL) :
1.21.0
void edje_object_part_text_prediction_hint_set ( Evas_Object obj,
const char *  part,
const char *  prediction_hint 
)

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

Parameters:
[in]partThe part name
[in]prediction_hintPrediction hint
Since (EFL) :
1.20.0
void edje_object_part_text_select_abort ( const Evas_Object obj,
const char *  part 
)

Aborts any selection action on a part.

Parameters:
[in]partThe part name
Since :
3.0
void edje_object_part_text_select_all ( const Evas_Object obj,
const char *  part 
)

Sets the selection to be everything.

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

Parameters:
[in]partThe part name
Since :
3.0
Examples:
edje-text.c.
void edje_object_part_text_select_allow_set ( const Evas_Object obj,
const char *  part,
Eina_Bool  allow 
)

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

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.

Parameters:
[in]partThe part name
[in]allowtrue to enable, false otherwise
Since :
3.0
Examples:
edje-text.c.
void edje_object_part_text_select_begin ( const Evas_Object obj,
const char *  part 
)

Starts selecting at current cursor position.

Parameters:
[in]partThe part name
Since :
3.0
void edje_object_part_text_select_disable_set ( const Edje_Object *  obj,
const char *  part,
Eina_Bool  disable 
)

Disable selection if the entry is an EXPLICIT selection mode type include keyboard input.

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]partThe part name
[in]disabletrue to disble, false otherwise
void edje_object_part_text_select_extend ( const Evas_Object obj,
const char *  part 
)

Extends the current selection to the current cursor position.

Parameters:
[in]partThe part name
Since :
3.0
void edje_object_part_text_select_none ( const Evas_Object obj,
const char *  part 
)

Sets the selection to be none.

This function sets the selection text to be none.

Parameters:
[in]partThe part name
Since :
3.0
Examples:
edje-text.c.
const char* edje_object_part_text_selection_get ( const Evas_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()

Parameters:
[in]partThe part name
Returns:
The text string
Since :
3.0
Examples:
edje-text.c.
Eina_Bool edje_object_part_text_set ( const Evas_Object obj,
const char *  part,
const char *  text 
)

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

Parameters:
[in]partThe part name
[in]textThe text to set on that part
Since :
2.3
Examples:
edje-color-class.c, and edje-text.c.
const char* edje_object_part_text_style_user_peek ( const Evas_Object obj,
const char *  part 
)

Returns the text of the object part.

This function returns the style associated with the textblock part.

Parameters:
[in]partThe part name
Returns:
The text string
Since (EFL) :
1.2.0
Since :
2.3
void edje_object_part_text_style_user_pop ( Evas_Object obj,
const char *  part 
)

Deletes the top style form the user style stack.

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

Sets the style of the.

This function sets the style associated with the textblock part.

Parameters:
[in]partThe part name
[in]styleThe style to set (textblock conventions).
Since (EFL) :
1.2.0
Since :
2.3
char* edje_object_part_text_unescaped_get ( const Evas_Object obj,
const char *  part 
)

Returns the text of the object part, without escaping.

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

See also edje_object_part_text_unescaped_set().

Parameters:
[in]partThe part name
Returns:
The text string
Since :
2.3
Examples:
edje-text.c.
Eina_Bool edje_object_part_text_unescaped_set ( Evas_Object obj,
const char *  part,
const char *  text_to_escape 
)

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

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

See also edje_object_part_text_unescaped_get().

Parameters:
[in]partThe part name
[in]text_to_escapeThe text string
Returns:
true on success, false otherwise
Since :
2.3
void edje_object_part_text_user_insert ( const Evas_Object obj,
const char *  part,
const char *  text 
)

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

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

Parameters:
[in]partThe part name
[in]textThe text string
Since (EFL) :
1.2.0
Since :
2.3
void edje_object_part_unswallow ( Evas_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.
Parameters:
[in]obj_swallowThe swallowed object
Since :
2.3