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
const char *	edje_object_part_object_name_get (const Evas_Object *obj)
	Gets the part name of an edje part object.
void	edje_object_animation_set (Efl_Canvas_Layout *obj, Eina_Bool on)
	Whether this object is animating or not.
Eina_Bool	edje_object_animation_get (const Efl_Canvas_Layout *obj)
	Whether this object is animating or not.
Efl_Input_Device *	edje_object_seat_get (const Efl_Canvas_Layout obj, Eina_Stringshare name)
	Returns the seat device given its Edje's name.
Eina_Stringshare *	edje_object_seat_name_get (const Efl_Canvas_Layout obj, Efl_Input_Device device)
	Gets the name given to a set by Edje.
Eina_Error	edje_object_layout_load_error_get (const Efl_Canvas_Layout *obj)
	Gets the (last) file loading error for a given object.
Eina_Bool	edje_object_content_remove (Efl_Canvas_Layout obj, Efl_Gfx_Entity content)
	Unswallow an object from this Edje.
Typedefs
typedef enum _Edje_Aspect_Control	Edje_Aspect_Control

Typedef Documentation

Edje_Aspect_Control

All Edje aspect control values.

Function Documentation

Eina_Bool edje_object_animation_get ( const Efl_Canvas_Layout * obj )

Whether this object is animating or not.

This property indicates whether animations are stopped or not. Animations here refer to transitions between states.

If animations are disabled, transitions between states (as defined in EDC) are then instantaneous. This is conceptually similar to setting the Efl::Player::playback_speed to an infinitely high value.

Get the current state of animation, true by default.

Parameters:

[in] obj The object.

Returns:: The animation state, true by default.

Since :: 2.3

void edje_object_animation_set	(	Efl_Canvas_Layout *	obj,
		Eina_Bool	on
	)

Whether this object is animating or not.

This property indicates whether animations are stopped or not. Animations here refer to transitions between states.

If animations are disabled, transitions between states (as defined in EDC) are then instantaneous. This is conceptually similar to setting the Efl::Player::playback_speed to an infinitely high value.

Start or stop animating this object.

Parameters:

[in]	obj	The object.
[in]	on	The animation state, `true` by default.

Since :: 2.3

Eina_Bool edje_object_content_remove	(	Efl_Canvas_Layout *	obj,
		Efl_Gfx_Entity *	content
	)

Unswallow an object from this Edje.

Parameters:

[in]	obj	The object.
[in]	content	To be removed content.

Returns:: false if content was not a child or can not be removed.

Eina_Error edje_object_layout_load_error_get ( const Efl_Canvas_Layout * obj )

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

Parameters:

[in] obj The object.

Returns:: The load error code.

const char* edje_object_part_object_name_get ( const Evas_Object * obj )

Gets the part name of an edje part object.

Parameters:

obj	An edje part object

Returns:: The name of the part, if the object is an edje part, or NULL

Note:: If this function returns NULL, obj was not an Edje part object

See also:: edje_object_part_object_get()

Since (EFL) :: 1.10

Since :: 3.0

Efl_Input_Device* edje_object_seat_get	(	const Efl_Canvas_Layout *	obj,
		Eina_Stringshare *	name
	)

Returns the seat device given its Edje's name.

Edje references seats by a name that differs from Evas. Edje naming follows a incrementional convention: first registered name is "seat1", second is "seat2", differently from Evas.

Parameters:

[in]	obj	The object.
[in]	name	The name's character string.

Returns:: The seat device or null if not found.

Since (EFL) :: 1.19

Eina_Stringshare* edje_object_seat_name_get	(	const Efl_Canvas_Layout *	obj,
		Efl_Input_Device *	device
	)

Gets the name given to a set by Edje.

Edje references seats by a name that differs from Evas. Edje naming follows a incrementional convention: first registered name is "seat1", second is "seat2", differently from Evas.

Parameters:

[in]	obj	The object.
[in]	device	The seat device

Returns:: The name's character string or null if not found.

Since (EFL) :: 1.19

Functions

Typedefs

Typedef Documentation

Function Documentation