How the mouse pointer should be handled by Evas.

In the mode EVAS_OBJECT_POINTER_MODE_AUTOGRAB, when a mouse button is pressed down over an object and held, with the mouse pointer being moved outside of it, the pointer still behaves as being bound to that object, albeit out of its drawing region. When the button is released, the event will be fed to the object, that may check if the final position is over it or not and do something about it.

In the mode EVAS_OBJECT_POINTER_MODE_NOGRAB, the pointer will always be bound to the object right below it. How the mouse pointer should be handled by Evas.

How the object should be rendered to output. How the object should be rendered to output.

How the mouse pointer should be handled by Evas.

In the mode EVAS_OBJECT_POINTER_MODE_AUTOGRAB, when a mouse button is pressed down over an object and held, with the mouse pointer being moved outside of it, the pointer still behaves as being bound to that object, albeit out of its drawing region. When the button is released, the event will be fed to the object, that may check if the final position is over it or not and do something about it.

In the mode EVAS_OBJECT_POINTER_MODE_NOGRAB, the pointer will always be bound to the object right below it.

Enumerator:

EVAS_OBJECT_POINTER_MODE_AUTOGRAB	default, X11-like
EVAS_OBJECT_POINTER_MODE_NOGRAB	pointer always bound to the object right below it
EVAS_OBJECT_POINTER_MODE_NOGRAB_NO_REPEAT_UPDOWN	useful on object with repeat events enabled, where mouse/touch up and down events WONT be repeated to objects and these objects wont be auto-grabbed. Since (EFL) : 1.2

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) + s*da
EVAS_RENDER_COPY	d = s
EVAS_RENDER_COPY_REL	d = s*da
EVAS_RENDER_ADD_REL	d = d + s*da
EVAS_RENDER_SUB	d = d - s
EVAS_RENDER_TINT	d = d*s + 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

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

Since :

2.3

Returns:

(EINA_TRUE) if the object is to be anti_aliased. (EINA_FALSE) otherwise.

Parameters:

[in]

obj

The evas object

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

Since :

2.3

Parameters:

[in]	obj	The evas object
[in]	anti_alias	(EINA_TRUE) if the object is to be anti_aliased, (EINA_FALSE) otherwise.

Delete an attached data pointer from an object.

Since :

2.3

Parameters:

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

Returns:

The original data pointer stored at key on obj

Remarks:

This will remove the stored data pointer from obj stored under key and return this same pointer, if actually there was data there, or 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");

Return an attached data pointer on an Evas object by its given string key.

Since :

2.3

Parameters:

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

Returns:

The data pointer stored, or NULL if none was stored

Remarks:

This function will return the data pointer attached to the object obj, stored using the string key key. If the object is valid and a data pointer was stored under the given key, that pointer will be returned. If this is not the case, NULL will be returned, signifying an invalid object or a non-existent key. It is possible that 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");

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

Since :

2.3

Parameters:

[in]	obj	The object to attach the data pointer to
[in]	key	The string key for the data to access it
[in]	data	The pointer to the data to be attached

Remarks:

This attaches the pointer data to the object obj, given the access 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.

This function is very handy when you have data associated specifically to an Evas object, being of use only when dealing with it. Than you don't have the burden to a pointer to it elsewhere, using this family of functions.

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"));

Determine how pointer will behave.

Since :

2.3

Returns:

pointer behavior.

Parameters:

[in]

obj

The evas object

Set pointer behavior.

Since :

2.3

Remarks:

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.

Parameters:

[in]	obj	The evas object
[in]	pointer_mode	desired behavior.

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

Since :

2.3

Returns:

whether obj is set to use precise point collision detection or not The default value is false.

See also:

evas_object_precise_is_inside_set() for an example

Parameters:

[in]

obj

The evas object

Set whether to use precise (usually expensive) point collision detection for a given Evas object.

Since :

2.3

Remarks:

Use this function to make Evas treat objects' transparent areas as not belonging to it with regard to mouse pointer events. By default, all of the object's boundary rectangle will be taken in account for them.

Warning:

By using precise point collision detection you'll be making Evas more resource intensive.

Remarks:

Example code follows.

See the full example here.

See also:

evas_object_precise_is_inside_get()

Parameters:

[in]	obj	The evas object
[in]	precise	Whether to use precise point collision detection or not. The default value is false.

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

Since :

2.3

Returns:

one of the enumerated values in Evas_Render_Op.

Parameters:

[in]

obj

The evas object

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

Since :

2.3

Parameters:

[in]	obj	The evas object
[in]	render_op	one of the Evas_Render_Op values.

Retrieves the scaling factor for the given Evas object.

Since :

2.3

Returns:

The scaling factor.

See also:

evas_object_scale_set()

Parameters:

[in]

obj

The evas object

Sets the scaling factor for an Evas object. Does not affect all objects.

Since :

2.3

Remarks:

This will multiply the object's dimension by the given factor, thus altering its geometry (width and height). Useful when you want scalable UI elements, possibly at run time.

Only text and textblock objects have scaling change handlers. Other objects won't change visually on this call.

See also:

evas_object_scale_get()

Parameters:

[in]	obj	The evas object
[in]	scale	The scaling factor. 1.0 means no scaling, default size.

Get the "static clipper" hint flag for a given Evas object.

Since :

2.3

Returns:

EINA_TRUE if it's set as a static clipper, EINA_FALSE otherwise.

See also:

evas_object_static_clip_set() for more details

Parameters:

[in]

obj

The evas object

Set a hint flag on the given Evas object that it's used as a "static clipper".

Since :

2.3

Remarks:

This is a hint to Evas that this object is used as a big static clipper and shouldn't be moved with children and otherwise considered specially. The default value for new objects is EINA_FALSE.

See also:

evas_object_static_clip_get()

Parameters:

[in]	obj	The evas object
[in]	is_static_clip	EINA_TRUE if it's to be used as a static clipper, EINA_FALSE otherwise.