Edje Class: Color

---

Functions that deal with Color Classes.

Sometimes we want to change the color of two or more parts equally and that's when we use color classes.

If one or more parts are assigned with a color class, when we set color values to this class it will cause all these parts to have their colors multiplied by the values. Setting values to a color class at a process level will affect all parts with that color class, while at a object level will affect only the parts inside an specified object.

Functions
Eina_Bool	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)
	Sets Edje color class.
Eina_Bool	edje_color_class_get (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 Edje color class.
void	edje_color_class_del (const char *color_class)
	Deletes edje color class.
Eina_List *	edje_color_class_list (void)
	Lists color classes.
Eina_Iterator *	edje_color_class_active_iterator_new (void)
	Iterates over all the active class of an application.
Eina_Iterator *	edje_mmap_color_class_iterator_new (Eina_File *f)
	Iterates over all the color class provided by an Edje file.

---

Function Documentation

Eina_Iterator* edje_color_class_active_iterator_new

(

void

)

Iterates over all the active class of an application.

Returns:

an iterator of Edje_Color_Class of the currently active color class

This function only iterate over the Edje_Color_Class in use by an application.

Since (EFL) :

1.14

Since :

3.0

void edje_color_class_del

(

const char *

color_class

)

Deletes edje color class.

Parameters:

color_class

This function deletes any values at the process level for the specified color class.

Note:

Deleting the color class will revert it to the values defined in the theme file.

Deleting the color class will emit the signal "color_class,del" to all the Edje objects in the running program.

Since :

2.3

Examples:

edje-color-class.c.

Eina_Bool edje_color_class_get	(	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 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

Returns:

EINA_TRUE if found or EINA_FALSE if not found and all values are zeroed.

This function gets the color values for a process level color class. This value is the globally set and not per-object, that is, the value that would be used by objects if they did not override with edje_object_color_class_set().

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

See also:

edje_color_class_set().

Note:

Unlike Evas, Edje colors are not pre-multiplied. That is, half-transparent white is 255 255 255 128.

Since :

2.3

Examples:

edje-color-class.c.

Eina_List* edje_color_class_list

(

void

)

Lists color classes.

Returns:

A list of color class names (strings). These strings and the list must be free()'d by the caller.

This function lists all color classes known about by the current process.

Since :

2.3

Examples:

edje-color-class.c.

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

Sets 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

This function sets the color values for a process level color class. This will cause all edje parts in the current process that have the specified color class to have their colors multiplied by these values. (Object level color classes set by edje_object_color_class_set() will override the values set by this function).

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 class in all objects.

See also:

edje_color_class_set().

Note:

Unlike Evas, Edje colors are not pre-multiplied. That is, half-transparent white is 255 255 255 128.

Returns:

Eina_Bool, EINA_TRUE on success and EINA_FALSE on failure.

Since :

2.3

Examples:

edje-color-class.c.

Eina_Iterator* edje_mmap_color_class_iterator_new

(

Eina_File *

f

)

Iterates over all the color class provided by an Edje file.

Parameters:

f	The mapped edje file.

Returns:

an iterator of Edje_Color_Class provided by the Edje file.

Since (EFL) :

1.14

Since :

3.0