Main Page | File List | Globals | Related Pages

edje.c File Reference

Edje Graphical Design Library. More...


Functions

EAPI int edje_init (void)
 Initialize the EDJE library.
EAPI int edje_shutdown (void)
 Shutdown the EDJE library.
EAPI void edje_frametime_set (double t)
 Set the frametime.
EAPI double edje_frametime_get (void)
 Get the frametime.
EAPI void edje_freeze (void)
 Freeze all objects in the Edje.
EAPI void edje_thaw (void)
 Thaw all objects in Edje.
EAPI Evas_List * edje_file_collection_list (const char *file)
 Get the collection list from the edje file ?
EAPI void edje_file_collection_list_free (Evas_List *lst)
 Free file collection.
EAPI char * edje_file_data_get (const char *file, const char *key)
 Get edje file data.
EAPI void edje_color_class_set (const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3)
 Set Edje color class.
EAPI void edje_text_class_set (const char *text_class, const char *font, Evas_Font_Size size)
 Set the Edje text class.
EAPI void edje_extern_object_min_size_set (Evas_Object *obj, Evas_Coord minw, Evas_Coord minh)
 Set the object minimum size.
EAPI void edje_extern_object_max_size_set (Evas_Object *obj, Evas_Coord maxw, Evas_Coord maxh)
 Set the object maximum size.
EAPI Evas_Object * edje_object_add (Evas *evas)
 Contructs the edje object.
EAPI const char * edje_object_data_get (Evas_Object *obj, const char *key)
 Get Edje object data.
EAPI int edje_object_file_set (Evas_Object *obj, const char *file, const char *part)
 Sets the EET file to be used.
EAPI void edje_object_file_get (Evas_Object *obj, const char **file, const char **part)
 Get the EET location and group for the Evas Object.
EAPI int edje_object_load_error_get (Evas_Object *obj)
 Gets the Edje load error.
EAPI void edje_object_signal_emit (Evas_Object *obj, const char *emission, const char *source)
 Send a signal to the Edje.
EAPI void edje_object_play_set (Evas_Object *obj, int play)
 Set the Edje to play or pause.
EAPI int edje_object_play_get (Evas_Object *obj)
 Get the Edje play/pause state.
EAPI void edje_object_animation_set (Evas_Object *obj, int on)
 Set Animation state.
EAPI int edje_object_animation_get (Evas_Object *obj)
 Get the animation state.
EAPI int edje_object_freeze (Evas_Object *obj)
 Freeze object.
EAPI int edje_object_thaw (Evas_Object *obj)
 Thaw object.
EAPI void edje_object_color_class_set (Evas_Object *obj, const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3)
 Sets the object color class.
EAPI void edje_object_text_class_set (Evas_Object *obj, const char *text_class, const char *font, Evas_Font_Size size)
 Sets Edje text class.
EAPI void edje_object_size_min_get (Evas_Object *obj, Evas_Coord *minw, Evas_Coord *minh)
 Get the minimum size for an object.
EAPI void edje_object_size_max_get (Evas_Object *obj, Evas_Coord *maxw, Evas_Coord *maxh)
 Get the maximum size for an object.
EAPI void edje_object_calc_force (Evas_Object *obj)
 Force a Size/Geometry Calc.
EAPI void edje_object_size_min_calc (Evas_Object *obj, Evas_Coord *minw, Evas_Coord *minh)
 Calculate minimum size.
EAPI int edje_object_part_exists (Evas_Object *obj, const char *part)
 Check if Edje part exists.
EAPI void edje_object_part_geometry_get (Evas_Object *obj, const char *part, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
 Get Edje part geometry.
EAPI void edje_object_part_text_set (Evas_Object *obj, const char *part, const char *text)
 Sets the text for an object part.
EAPI const char * edje_object_part_text_get (Evas_Object *obj, const char *part)
 Returns the text of the object part.
EAPI void edje_object_part_swallow (Evas_Object *obj, const char *part, Evas_Object *obj_swallow)
 Swallows an object into the edje.
EAPI void edje_object_part_unswallow (Evas_Object *obj, Evas_Object *obj_swallow)
 Unswallow an object.
EAPI Evas_Object * edje_object_part_swallow_get (Evas_Object *obj, const char *part)
 Get the swallowed part ?!
EAPI const char * edje_object_part_state_get (Evas_Object *obj, const char *part, double *val_ret)
 Returns the state of the edje part.
EAPI int edje_object_part_drag_dir_get (Evas_Object *obj, const char *part)
 Determine dragable directions.
EAPI void edje_object_part_drag_value_set (Evas_Object *obj, const char *part, double dx, double dy)
 Set the dragable object location.
EAPI void edje_object_part_drag_value_get (Evas_Object *obj, const char *part, double *dx, double *dy)
 Get the dragable object location.
EAPI void edje_object_part_drag_size_set (Evas_Object *obj, const char *part, double dw, double dh)
 Set the dragable object size.
EAPI void edje_object_part_drag_size_get (Evas_Object *obj, const char *part, double *dw, double *dh)
 Get the dragable object size.
EAPI void edje_object_part_drag_step_set (Evas_Object *obj, const char *part, double dx, double dy)
 Sets the drag step increment.
EAPI void edje_object_part_drag_step_get (Evas_Object *obj, const char *part, double *dx, double *dy)
 Gets the drag step increment values.
EAPI void edje_object_part_drag_page_set (Evas_Object *obj, const char *part, double dx, double dy)
 Sets the page step increments.
EAPI void edje_object_part_drag_page_get (Evas_Object *obj, const char *part, double *dx, double *dy)
 Gets the page step increments.
EAPI void edje_object_part_drag_step (Evas_Object *obj, const char *part, double dx, double dy)
 Steps the dragable x,y steps.
EAPI void edje_object_part_drag_page (Evas_Object *obj, const char *part, double dx, double dy)
 Pages x,y steps.
void edje_object_signal_callback_add (Evas_Object *obj, const char *emission, const char *source, void(*func)(void *data, Evas_Object *o, const char *emission, const char *source), void *data)
 Adds a callback for the object.
void * edje_object_signal_callback_del (Evas_Object *obj, const char *emission, const char *source, void(*func)(void *data, Evas_Object *o, const char *emission, const char *source))
 Delete an object's callback.


Detailed Description

Edje Graphical Design Library.

These routines are used for Edje.


Function Documentation

void edje_color_class_set const char *  color_class,
int  r,
int  g,
int  b,
int  a,
int  r2,
int  g2,
int  b2,
int  a2,
int  r3,
int  g3,
int  b3,
int  a3
 

Set Edje color class.

Parameters:
color_class 
r Object Red value
g Object Green value
b Object Blue value
a Object Alpha value
r2 Outline Red value
g2 Outline Green value
b2 Outline Blue value
a2 Outline Alpha value
r3 Shadow Red value
g3 Shadow Green value
b3 Shadow Blue value
a3 Shadow Alpha value
Sets the color class for the Edje.

void edje_extern_object_max_size_set Evas_Object *  obj,
Evas_Coord  maxw,
Evas_Coord  maxh
 

Set the object maximum size.

Parameters:
obj A vaild Evas_Object handle
maxw The maximum width
maxh The maximum height
This sets the maximum size restriction for the object.

void edje_extern_object_min_size_set Evas_Object *  obj,
Evas_Coord  minw,
Evas_Coord  minh
 

Set the object minimum size.

Parameters:
obj A valid Evas_Object handle
minw The minimum width
minh The minimum height
This sets the minimum size restriction for the object.

Evas_List * edje_file_collection_list const char *  file  ) 
 

Get the collection list from the edje file ?

Parameters:
file The file path?
Returns:
The Evas_List of files

void edje_file_collection_list_free Evas_List *  lst  ) 
 

Free file collection.

Parameters:
lst The Evas_List of files
Frees the file collection.

char * edje_file_data_get const char *  file,
const char *  key
 

Get edje file data.

Parameters:
file The file
key The data key
Returns:
The file data string

double edje_frametime_get void   ) 
 

Get the frametime.

Returns:
The frametime
Returns the frametime in seconds, by default this is 1/30.

void edje_frametime_set double  t  ) 
 

Set the frametime.

Parameters:
t The frametime
Sets the frametime in seconds, by default this is 1/30.

int edje_init void   ) 
 

Initialize the EDJE library.

Returns:
The new init count.

Evas_Object * edje_object_add Evas *  evas  ) 
 

Contructs the edje object.

Parameters:
evas A valid Evas handle
Returns:
The Evas_Object pointer.
Creates the edje smart object, returning the Evas_Object handle.

int edje_object_animation_get Evas_Object *  obj  ) 
 

Get the animation state.

Parameters:
obj A valid Evas_Object handle
Returns:
0 on Error or if not animated
1 if animated

void edje_object_animation_set Evas_Object *  obj,
int  on
 

Set Animation state.

Parameters:
obj A valid Evas_Object handle
on Animation State
Stop or start an Edje animation.

void edje_object_calc_force Evas_Object *  obj  ) 
 

Force a Size/Geometry Calc.

Parameters:
obj A valid Evas_Object handle
Forces the object obj to recalc layout regardless of freeze/thaw

void edje_object_color_class_set Evas_Object *  obj,
const char *  color_class,
int  r,
int  g,
int  b,
int  a,
int  r2,
int  g2,
int  b2,
int  a2,
int  r3,
int  g3,
int  b3,
int  a3
 

Sets the object color class.

Parameters:
obj A valid Evas_Object handle
color_class 
r Object Red value
g Object Green value
b Object Blue value
a Object Alpha value
r2 Outline Red value
g2 Outline Green value
b2 Outline Blue value
a2 Outline Alpha value
r3 Shadow Red value
g3 Shadow Green value
b3 Shadow Blue value
a3 Shadow Alpha value
Applys the color class to the object, where the first color is the object, the second is the outline, and the third is the shadow.

const char * edje_object_data_get Evas_Object *  obj,
const char *  key
 

Get Edje object data.

Parameters:
obj A valid Evas_Object handle
key The data key
Returns:
The data string

void edje_object_file_get Evas_Object *  obj,
const char **  file,
const char **  part
 

Get the EET location and group for the Evas Object.

?! Assuming eet file

Parameters:
obj A valid Evas_Object handle
file The EET file location pointer
part The EET part pointer
This gets the EET file location and group for the given Evas_Object.

int edje_object_file_set Evas_Object *  obj,
const char *  file,
const char *  part
 

Sets the EET file to be used.

Parameters:
obj A valid Evas_Object handle
file The path to the EET file
part The group name in the Edje
Returns:
0 on Error
1 on Success and sets EDJE_LOAD_ERROR_NONE
This loads the EET file and sets up the Edje.

int edje_object_freeze Evas_Object *  obj  ) 
 

Freeze object.

Parameters:
obj A valid Evas_Object handle
Returns:
The frozen state
0 on Error
This puts all changes on hold. Successive freezes will nest, requiring an equal number of thaws.

int edje_object_load_error_get Evas_Object *  obj  ) 
 

Gets the Edje load error.

Parameters:
obj A valid Evas_Object handle
Returns:
The Edje load error:
0: No Error
1: Generic Error
2: Does not Exist
3: Permission Denied
4: Resource Allocation Failed
5: Corrupt File
6: Unknown Format
7: Incompatible File

int edje_object_part_drag_dir_get Evas_Object *  obj,
const char *  part
 

Determine dragable directions.

Parameters:
obj A valid Evas_Object handle
part The part name
Returns:
0: Not dragable
1: Dragable in X direction
2: Dragable in Y direction
3: Dragable in X & Y directions

void edje_object_part_drag_page Evas_Object *  obj,
const char *  part,
double  dx,
double  dy
 

Pages x,y steps.

Parameters:
obj A valid Evas_Object handle
part The part name
dx The x step
dy The y step
Pages x,y where the increment is defined by edje_object_part_drag_page_set.
WARNING: Paging is bugged!

void edje_object_part_drag_page_get Evas_Object *  obj,
const char *  part,
double *  dx,
double *  dy
 

Gets the page step increments.

Parameters:
obj A valid Evas_Object handle
part The part name
dx The dx page increment pointer
dy The dy page increment pointer
Gets the x,y page step increments for the dragable object.

void edje_object_part_drag_page_set Evas_Object *  obj,
const char *  part,
double  dx,
double  dy
 

Sets the page step increments.

Parameters:
obj A valid Evas_Object handle
part The part name
dx The x page step increment
dy The y page step increment
Sets the x,y page step increment values.

void edje_object_part_drag_size_get Evas_Object *  obj,
const char *  part,
double *  dw,
double *  dh
 

Get the dragable object size.

Parameters:
obj A valid Evas_Object handle
part The part name
dw The drag width pointer
dh The drag height pointer
Gets the dragable object size.

void edje_object_part_drag_size_set Evas_Object *  obj,
const char *  part,
double  dw,
double  dh
 

Set the dragable object size.

Parameters:
obj A valid Evas_Object handle
part The part name
dw The drag width
dh The drag height
Sets the size of the dragable object

void edje_object_part_drag_step Evas_Object *  obj,
const char *  part,
double  dx,
double  dy
 

Steps the dragable x,y steps.

Parameters:
obj A valid Evas_Object handle
part The part name
dx The x step
dy The y step
Steps x,y where the step increment is the ammount set by edje_object_part_drag_step_set.

void edje_object_part_drag_step_get Evas_Object *  obj,
const char *  part,
double *  dx,
double *  dy
 

Gets the drag step increment values.

Parameters:
obj A valid Evas_Object handle
part The part
dx The x step increment pointer
dy The y step increment pointer
Gets the x and y step increments for the dragable object.

void edje_object_part_drag_step_set Evas_Object *  obj,
const char *  part,
double  dx,
double  dy
 

Sets the drag step increment.

Parameters:
obj A valid Evas_Object handle
part The part name
dx The x step ammount
dy The y step ammount
Sets the x,y step increments for a dragable object.

void edje_object_part_drag_value_get Evas_Object *  obj,
const char *  part,
double *  dx,
double *  dy
 

Get the dragable object location.

Parameters:
obj A valid Evas_Object handle
part The part name
dx The X value pointer
dy The Y value pointer
Gets the drag location values.

void edje_object_part_drag_value_set Evas_Object *  obj,
const char *  part,
double  dx,
double  dy
 

Set the dragable object location.

Parameters:
obj A valid Evas_Object handle
part The part name
dx The x value
dy The y value
Places the dragable object at the given location.

int edje_object_part_exists Evas_Object *  obj,
const char *  part
 

Check if Edje part exists.

Parameters:
obj A valid Evas_Object handle
part The part name to check
Returns:
0 on Error
1 if Edje part exists

void edje_object_part_geometry_get Evas_Object *  obj,
const char *  part,
Evas_Coord *  x,
Evas_Coord *  y,
Evas_Coord *  w,
Evas_Coord *  h
 

Get Edje part geometry.

Parameters:
obj A valid Evas_Object handle
part The Edje part
x The x coordinate pointer
y The y coordinate pointer
w The width pointer
h The height pointer
Gets the Edje part geometry

const char * edje_object_part_state_get Evas_Object *  obj,
const char *  part,
double *  val_ret
 

Returns the state of the edje part.

Parameters:
obj A valid Evas_Objectart handle
part The part name
val_ret 
Returns:
The part state:
"default" for the default state
"" for other states

void edje_object_part_swallow Evas_Object *  obj,
const char *  part,
Evas_Object *  obj_swallow
 

Swallows an object into the edje.

Parameters:
obj A valid Evas_Object handle
part The part name
obj_swallow The object to swallow
Swallows the object into the edje part so that all geometry changes for the part affect the swallowed object. (e.g. resize, move, show, raise/lower, etc.)

Evas_Object * edje_object_part_swallow_get Evas_Object *  obj,
const char *  part
 

Get the swallowed part ?!

Parameters:
obj A valid Evas_Object handle
part The part name
Returns:
The swallowed object

const char * edje_object_part_text_get Evas_Object *  obj,
const char *  part
 

Returns the text of the object part.

Parameters:
obj A valid Evas_Object handle
part The part name
Returns:
The text string

void edje_object_part_text_set Evas_Object *  obj,
const char *  part,
const char *  text
 

Sets the text for an object part.

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

void edje_object_part_unswallow Evas_Object *  obj,
Evas_Object *  obj_swallow
 

Unswallow an object.

Parameters:
obj A valid Evas_Object handle
obj_swallow The swallowed object
Causes the edje to regurgitate a previously swallowed object. :)

int edje_object_play_get Evas_Object *  obj  ) 
 

Get the Edje play/pause state.

Parameters:
obj A valid Evas_Object handle
Returns:
0 if Edje not connected, Edje delete_me, or Edje paused
1 if Edje set to play

void edje_object_play_set Evas_Object *  obj,
int  play
 

Set the Edje to play or pause.

Parameters:
obj A vaild Evas_Object handle
play Play instruction (1 to play, 0 to pause)
This sets the Edje to play or pause depending on the parameter. This has no effect if the Edje is already in that state.

void edje_object_signal_callback_add Evas_Object *  obj,
const char *  emission,
const char *  source,
void(*)(void *data, Evas_Object *o, const char *emission, const char *source)  func,
void *  data
 

Adds a callback for the object.

Parameters:
obj A valid Evas_Object handle
emission Signal to activate callback FIXDOC: Naming Convention?
source Source of signal
func The function to be executed when the callback is signaled
data ? FIXDOC
Creates a callback for the object to execute the given function.

void* edje_object_signal_callback_del Evas_Object *  obj,
const char *  emission,
const char *  source,
void(*)(void *data, Evas_Object *o, const char *emission, const char *source)  func
 

Delete an object's callback.

Parameters:
obj A valid Evas_Object handle
emission ? FIXDOC
source ? FIXDOC
func ? FIXDOC
Deletes an existing callback

void edje_object_signal_emit Evas_Object *  obj,
const char *  emission,
const char *  source
 

Send a signal to the Edje.

Parameters:
obj A vaild Evas_Object handle
emission The signal
source The signal source
This sends a signal to the edje. These are defined in the programs section of an edc.

void edje_object_size_max_get Evas_Object *  obj,
Evas_Coord *  maxw,
Evas_Coord *  maxh
 

Get the maximum size for an object.

Parameters:
obj A valid Evas_Object handle
maxw Maximum width pointer
maxh Maximum height pointer
Gets the object's maximum size values from the Edje. These are set to zero if no Edje is connected to the Evas Object.

void edje_object_size_min_calc Evas_Object *  obj,
Evas_Coord *  minw,
Evas_Coord *  minh
 

Calculate minimum size.

Parameters:
obj A valid Evas_Object handle
minw Minimum width pointer
minh Minimum height pointer
Calculates the object's minimum size ?!

void edje_object_size_min_get Evas_Object *  obj,
Evas_Coord *  minw,
Evas_Coord *  minh
 

Get the minimum size for an object.

Parameters:
obj A valid Evas_Object handle
minw Minimum width pointer
minh Minimum height pointer
Gets the object's minimum size values from the Edje. These are set to zero if no Edje is connected to the Evas Object.

void edje_object_text_class_set Evas_Object *  obj,
const char *  text_class,
const char *  font,
Evas_Font_Size  size
 

Sets Edje text class.

Parameters:
obj A vaild Evas_Object handle
text_class The text class name
font Font name
size Font Size
Sets the text class for the Edje.

int edje_object_thaw Evas_Object *  obj  ) 
 

Thaw object.

Parameters:
obj A valid Evas_Object handle
Returns:
The frozen state
0 on Error
This allows frozen changes to occur.

int edje_shutdown void   ) 
 

Shutdown the EDJE library.

Returns:
The new init count.

void edje_text_class_set const char *  text_class,
const char *  font,
Evas_Font_Size  size
 

Set the Edje text class.

Parameters:
text_class The text class name ?!
font The font name
size The font size
This sets the Edje text class ?!