Extra Object Manipulation
[Generic Object Functions]

Miscellaneous functions that also apply to any object, but are less used or not implemented by all objects. More...

Typedefs
typedef enum _Evas_Render_Op	Evas_Render_Op
typedef enum _Evas_Object_Pointer_Mode	Evas_Object_Pointer_Mode
	How mouse pointer should be handled by Evas.
Enumerations
enum	_Evas_Render_Op { EVAS_RENDER_BLEND = 0, EVAS_RENDER_BLEND_REL = 1, EVAS_RENDER_COPY = 2, EVAS_RENDER_COPY_REL = 3, EVAS_RENDER_ADD = 4, EVAS_RENDER_ADD_REL = 5, EVAS_RENDER_SUB = 6, EVAS_RENDER_SUB_REL = 7, EVAS_RENDER_TINT = 8, EVAS_RENDER_TINT_REL = 9, EVAS_RENDER_MASK = 10, EVAS_RENDER_MUL = 11 }
	How the object should be rendered to output. More...
enum	_Evas_Object_Pointer_Mode { EVAS_OBJECT_POINTER_MODE_AUTOGRAB }
	How mouse pointer should be handled by Evas. More...
Functions
EAPI void	evas_object_data_set (Evas_Object obj, const char key, const void *data)
	Set an attached data pointer to an object with a given string key.
EAPI void *	evas_object_data_get (const Evas_Object obj, const char key)
	Return an attached data pointer by its given string key.
EAPI void *	evas_object_data_del (Evas_Object obj, const char key)
	Delete at attached data pointer from an object.
EAPI void	evas_object_pointer_mode_set (Evas_Object *obj, Evas_Object_Pointer_Mode setting)
	Set pointer behavior.
EAPI Evas_Object_Pointer_Mode	evas_object_pointer_mode_get (const Evas_Object *obj)
	Determine how pointer will behave.
EAPI void	evas_object_anti_alias_set (Evas_Object *obj, Eina_Bool anti_alias)
	Sets whether or not the given evas object is to be drawn anti-aliased.
EAPI Eina_Bool	evas_object_anti_alias_get (const Evas_Object *obj)
	Retrieves whether or not the given evas object is to be drawn anti_aliased.
EAPI void	evas_object_scale_set (Evas_Object *obj, double scale)
	Sets the scaling factor for an evas object.
EAPI double	evas_object_scale_get (const Evas_Object *obj)
	Retrieves the scaling factor for the given evas object.
EAPI void	evas_object_render_op_set (Evas_Object *obj, Evas_Render_Op render_op)
	Sets the render_op to be used for rendering the evas object.
EAPI Evas_Render_Op	evas_object_render_op_get (const Evas_Object *obj)
	Retrieves the current value of the operation used for rendering the evas object.
EAPI void	evas_object_precise_is_inside_set (Evas_Object *obj, Eina_Bool precise)
	Set whether to use a precise (usually expensive) point collision detection.
EAPI Eina_Bool	evas_object_precise_is_inside_get (const Evas_Object *obj)
	Determine whether an object is set to use a precise point collision detection.
EAPI void	evas_object_static_clip_set (Evas_Object *obj, Eina_Bool is_static_clip)
	Set a hint flag on the object that this is used as a static "clipper".
EAPI Eina_Bool	evas_object_static_clip_get (const Evas_Object *obj)
	Get static "clipper" hint flag.

Detailed Description

Miscellaneous functions that also apply to any object, but are less used or not implemented by all objects.

Typedef Documentation

typedef enum _Evas_Object_Pointer_Mode Evas_Object_Pointer_Mode

How mouse pointer should be handled by Evas.

If EVAS_OBJECT_POINTER_MODE_AUTOGRAB, then when mouse is down an object, then moves outside of it, the pointer still behaves as being bound to the object, albeit out of its drawing region. On mouse up, the event will be feed to the object, that may check if the final position is over or not and do something about it. How mouse pointer should be handled by Evas.

typedef enum _Evas_Render_Op Evas_Render_Op

How the object should be rendered to output.

Enumeration Type Documentation

enum _Evas_Object_Pointer_Mode

How mouse pointer should be handled by Evas.

If EVAS_OBJECT_POINTER_MODE_AUTOGRAB, then when mouse is down an object, then moves outside of it, the pointer still behaves as being bound to the object, albeit out of its drawing region. On mouse up, the event will be feed to the object, that may check if the final position is over or not and do something about it.

Enumerator:

EVAS_OBJECT_POINTER_MODE_AUTOGRAB

default, X11-like

enum _Evas_Render_Op

How the object should be rendered to output.

Enumerator:

EVAS_RENDER_BLEND	default op: d = d*(1-sa) + s
EVAS_RENDER_BLEND_REL	d = d(1 - sa) + sda
EVAS_RENDER_COPY	d = s
EVAS_RENDER_COPY_REL	d = s*da
EVAS_RENDER_ADD	d = d + s
EVAS_RENDER_ADD_REL	d = d + s*da
EVAS_RENDER_SUB	d = d - s
EVAS_RENDER_SUB_REL	d = d - s*da
EVAS_RENDER_TINT	d = ds + d(1 - sa) + s*(1 - da)
EVAS_RENDER_TINT_REL	d = d*(1 - sa + s)
EVAS_RENDER_MASK	d = d*sa
EVAS_RENDER_MUL	d = d*s

Function Documentation

EAPI Eina_Bool evas_object_anti_alias_get ( const Evas_Object * obj )

Retrieves whether or not the given evas object is to be drawn anti_aliased.

Parameters:

obj

The given evas object.

Returns:: 1 if the object is to be anti_aliased. 0 otherwise.

EAPI void evas_object_anti_alias_set	(	Evas_Object *	obj,
		Eina_Bool	anti_alias
	)

Sets whether or not the given evas object is to be drawn anti-aliased.

Parameters:

	obj	The given evas object.
	anti_alias	1 if the object is to be anti_aliased, 0 otherwise.

EAPI void* evas_object_data_del	(	Evas_Object *	obj,
		const char *	key
	)

Delete at attached data pointer from an object.

Parameters:

	obj	The object to delete the data pointer from
	key	The string key the data was stored under

Returns:: The original data pointer stored at key on obj

This will remove thee stored data pointer from obj stored under key, and return the original pointer stored under key, if any, nor NULL if nothing was stored under that key.

Example:

 int *my_data;
 extern Evas_Object *obj;

 my_data = evas_object_data_del(obj, "name_of_my_data");

Referenced by evas_object_data_set().

EAPI void* evas_object_data_get	(	const Evas_Object *	obj,
		const char *	key
	)

Return an attached data pointer by its given string key.

Parameters:

	obj	The object to which the data was attached
	key	The string key the data was stored under

Returns:: The data pointer stored, or NULL if none was stored

This function will return the data pointer attached to the object obj stored using the string key key. If the object is valid and data was stored under the given key, the pointer that was stored will be reuturned. If this is not the case, NULL will be returned, signifying an invalid object or non-existent key. It is possible a NULL pointer was stored given that key, but this situation is non-sensical and thus can be considered an error as well. NULL pointers are never stored as this is the return value if an error occurs.

Example:

 int *my_data;
 extern Evas_Object *obj;

 my_data = evas_object_data_get(obj, "name_of_my_data");
 if (my_data) printf("Data stored was %p\n", my_data);
 else printf("No data was stored on the object\n");

EAPI void evas_object_data_set	(	Evas_Object *	obj,
		const char *	key,
		const void *	data
	)

Set an attached data pointer to an object with a given string key.

Parameters:

	obj	The object to attach the data pointer to
	key	The string key for the data to access it
	data	The ponter to the data to be attached

This attaches the pointer data to the object obj given the string key. This pointer will stay "hooked" to the object until a new pointer with the same string key is attached with evas_object_data_set() or it is deleted with evas_object_data_del(). On deletion of the object obj, the pointers will not be accessible from the object anymore.

You can find the pointer attached under a string key using evas_object_data_get(). It is the job of the calling application to free any data pointed to by data when it is no longer required.

If data is NULL, the old value stored at key will be removed but no new value will be stored. This is synonymous with calling evas_object_data_del() with obj and key.

Example:

 int *my_data;
 extern Evas_Object *obj;

 my_data = malloc(500);
 evas_object_data_set(obj, "name_of_data", my_data);
 printf("The data that was attached was %p\n", evas_object_data_get(obj, "name_of_data"));

References evas_object_data_del().

EAPI Evas_Object_Pointer_Mode evas_object_pointer_mode_get ( const Evas_Object * obj )

Determine how pointer will behave.

Parameters:

obj

Returns:: pointer behavior.

EAPI void evas_object_pointer_mode_set	(	Evas_Object *	obj,
		Evas_Object_Pointer_Mode	setting
	)

Set pointer behavior.

Parameters:

	obj
	setting	desired behavior.

This function has direct effect on event callbacks related to mouse.

If setting is EVAS_OBJECT_POINTER_MODE_AUTOGRAB, then when mouse is down at this object, events will be restricted to it as source, mouse moves, for example, will be emitted even if outside this object area.

If setting is EVAS_OBJECT_POINTER_MODE_NOGRAB, then events will be emitted just when inside this object area.

The default value is EVAS_OBJECT_POINTER_MODE_AUTOGRAB.

EAPI Eina_Bool evas_object_precise_is_inside_get ( const Evas_Object * obj )

Determine whether an object is set to use a precise point collision detection.

Parameters:

obj

The given object.

EAPI void evas_object_precise_is_inside_set	(	Evas_Object *	obj,
		Eina_Bool	precise
	)

Set whether to use a precise (usually expensive) point collision detection.

Parameters:

	obj	The given object.
	precise	wheter to use a precise point collision detection or not The default value is false.

EAPI Evas_Render_Op evas_object_render_op_get ( const Evas_Object * obj )

Retrieves the current value of the operation used for rendering the evas object.

Parameters:

obj

The given evas object.

Returns:: one of the enumerated values in Evas_Render_Op.

References EVAS_RENDER_BLEND.

EAPI void evas_object_render_op_set	(	Evas_Object *	obj,
		Evas_Render_Op	render_op
	)

Sets the render_op to be used for rendering the evas object.

Parameters:

	obj	The given evas object.
	render_op	one of the Evas_Render_Op values.

EAPI double evas_object_scale_get ( const Evas_Object * obj )

Retrieves the scaling factor for the given evas object.

Parameters:

obj

The given evas object.

Returns:: The scaling factor.

EAPI void evas_object_scale_set	(	Evas_Object *	obj,
		double	scale
	)

Sets the scaling factor for an evas object.

Does not affect all objects.

Parameters:

	obj	The given evas object.
	scale	The scaling factor. 1.0 == none.

EAPI Eina_Bool evas_object_static_clip_get ( const Evas_Object * obj )

Get static "clipper" hint flag.

See also:: evas_object_static_clip_set()

Parameters:

obj

The given object.

Returns:: The static clip flag (on or off)

EAPI void evas_object_static_clip_set	(	Evas_Object *	obj,
		Eina_Bool	is_static_clip
	)

Set a hint flag on the object that this is used as a static "clipper".

This is a hint to evas that this object is used as a big static clipper and shouldnt be moved with children and otherwise considered specially. The Default is off.

Parameters:

	obj	The given object.
	is_static_clip	The static clip flag (on or off)

Enlightenment

Beauty at your fingertips

Extra Object Manipulation
[Generic Object Functions]

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Enlightenment

Beauty at your fingertips

Extra Object Manipulation [Generic Object Functions]

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Extra Object Manipulation
[Generic Object Functions]