Modules | Typedefs | Enumerations | Functions
Edje Object

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

Modules

 Edje Communication Interface: Message
 Functions that deal with messages.
 
 Edje Communication Interface: Signal
 Functions that deal with signals.
 
 Edje Scale
 Functions that deal with scaling objects.
 
 Edje Class: Color
 Functions that deal with Color Classes.
 
 Edje Class: Size
 Functions that deal with Size Classes.
 
 Edje Class: Text
 Functions that deal with Text Classes.
 
 Edje Object File
 Functions to deals with EDJ files.
 
 Edje Object Animation
 Functions that deal with animations.
 
 Edje Object Geometry
 Functions that deal with object's geometry.
 
 Edje Part
 Functions that deal with layout components.
 
 Edje Perspective
 Functions that deal with 3D projection of an 2D object.
 

Typedefs

typedef enum _Edje_Aspect_Control Edje_Aspect_Control
 All Edje aspect control values.
 

Enumerations

enum  _Edje_Aspect_Control {
  EDJE_ASPECT_CONTROL_NONE = 0 ,
  EDJE_ASPECT_CONTROL_NEITHER = 1 ,
  EDJE_ASPECT_CONTROL_HORIZONTAL = 2 ,
  EDJE_ASPECT_CONTROL_VERTICAL = 3 ,
  EDJE_ASPECT_CONTROL_BOTH = 4
}
 

Functions

const char * edje_object_part_object_name_get (const Evas_Object *obj)
 Gets the part name of an edje part object. More...
 
void edje_object_animation_set (Efl_Canvas_Layout *obj, Eina_Bool on)
 Whether this object is animating or not. More...
 
Eina_Bool edje_object_animation_get (const Efl_Canvas_Layout *obj)
 Whether this object is animating or not. More...
 
Efl_Input_Device * edje_object_seat_get (const Efl_Canvas_Layout *obj, Eina_Stringshare *name)
 Returns the seat device given its Edje's name. More...
 
Eina_Stringshareedje_object_seat_name_get (const Efl_Canvas_Layout *obj, Efl_Input_Device *device)
 Gets the name given to a set by Edje. More...
 
Eina_Error edje_object_layout_load_error_get (const Efl_Canvas_Layout *obj)
 Gets the (last) file loading error for a given object. More...
 
Eina_Bool edje_object_content_remove (Efl_Canvas_Layout *obj, Efl_Gfx_Entity *content)
 Unswallow an object from this Edje. More...
 

Detailed Description

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.

Function Documentation

◆ edje_object_part_object_name_get()

const char* edje_object_part_object_name_get ( const Evas_Object obj)

Gets the part name of an edje part object.

Parameters
objAn 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
1.10

References evas_object_data_get().

◆ edje_object_animation_set()

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]objThe object.
[in]onThe animation state, true by default.

◆ edje_object_animation_get()

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]objThe object.
Returns
The animation state, true by default.

◆ edje_object_seat_get()

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]objThe object.
[in]nameThe name's character string.
Returns
The seat device or null if not found.
Since
1.19

◆ edje_object_seat_name_get()

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]objThe object.
[in]deviceThe seat device
Returns
The name's character string or null if not found.
Since
1.19

◆ edje_object_layout_load_error_get()

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]objThe object.
Returns
The load error code.

◆ edje_object_content_remove()

Eina_Bool edje_object_content_remove ( Efl_Canvas_Layout *  obj,
Efl_Gfx_Entity *  content 
)

Unswallow an object from this Edje.

Parameters
[in]objThe object.
[in]contentTo be removed content.
Returns
false if content was not a child or can not be removed.