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 |
How the object should be rendered to output. More... | |
typedef enum _Evas_Object_Pointer_Mode | Evas_Object_Pointer_Mode |
How the mouse pointer should be handled by Evas. More... | |
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, EVAS_OBJECT_POINTER_MODE_NOGRAB, EVAS_OBJECT_POINTER_MODE_NOGRAB_NO_REPEAT_UPDOWN } |
How the mouse pointer should be handled by Evas. More... | |
#define | evas_obj_anti_alias_set(anti_alias) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_ANTI_ALIAS_SET), EO_TYPECHECK(Eina_Bool, anti_alias) |
#define | evas_obj_anti_alias_get(anti_alias) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_ANTI_ALIAS_GET), EO_TYPECHECK(Eina_Bool *, anti_alias) |
#define | evas_obj_scale_set(scale) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_SCALE_SET), EO_TYPECHECK(double, scale) |
#define | evas_obj_scale_get(scale) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_SCALE_GET), EO_TYPECHECK(double *, scale) |
#define | evas_obj_render_op_set(render_op) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_RENDER_OP_SET), EO_TYPECHECK(Evas_Render_Op, render_op) |
#define | evas_obj_render_op_get(render_op) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_RENDER_OP_GET), EO_TYPECHECK(Evas_Render_Op *, render_op) |
#define | evas_obj_precise_is_inside_set(precise) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_PRECISE_IS_INSIDE_SET), EO_TYPECHECK(Eina_Bool, precise) |
#define | evas_obj_precise_is_inside_get(precise) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_PRECISE_IS_INSIDE_GET), EO_TYPECHECK(Eina_Bool *, precise) |
#define | evas_obj_static_clip_set(is_static_clip) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_STATIC_CLIP_SET), EO_TYPECHECK(Eina_Bool, is_static_clip) |
#define | evas_obj_static_clip_get(is_static_clip) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_STATIC_CLIP_GET), EO_TYPECHECK(Eina_Bool *, is_static_clip) |
#define | evas_obj_pointer_mode_set(pointer_mode) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_POINTER_MODE_SET), EO_TYPECHECK(Evas_Object_Pointer_Mode, pointer_mode) |
#define | evas_obj_pointer_mode_get(pointer_mode) EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_POINTER_MODE_GET), EO_TYPECHECK(Evas_Object_Pointer_Mode *, pointer_mode) |
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. More... | |
void | evas_object_pointer_mode_set (Evas_Object *obj, Evas_Object_Pointer_Mode setting) |
Set pointer behavior. More... | |
Evas_Object_Pointer_Mode | evas_object_pointer_mode_get (const Evas_Object *obj) |
Determine how pointer will behave. More... | |
void | evas_object_anti_alias_set (Evas_Object *obj, Eina_Bool antialias) |
Sets whether or not the given Evas object is to be drawn anti-aliased. More... | |
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. More... | |
void | evas_object_scale_set (Evas_Object *obj, double scale) |
Sets the scaling factor for an Evas object. More... | |
double | evas_object_scale_get (const Evas_Object *obj) |
Retrieves the scaling factor for the given Evas object. More... | |
void | evas_object_render_op_set (Evas_Object *obj, Evas_Render_Op op) |
Sets the render_op to be used for rendering the Evas object. More... | |
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. More... | |
void | evas_object_precise_is_inside_set (Evas_Object *obj, Eina_Bool precise) |
Set whether to use precise (usually expensive) point collision detection for a given Evas object. More... | |
Eina_Bool | evas_object_precise_is_inside_get (const Evas_Object *obj) |
Determine whether an object is set to use precise point collision detection. More... | |
void | evas_object_static_clip_set (Evas_Object *obj, Eina_Bool is_static_clip) |
Set a hint flag on the given Evas object that it's used as a "static
clipper". More... | |
Eina_Bool | evas_object_static_clip_get (const Evas_Object *obj) |
Get the "static clipper" hint flag for a given Evas object. More... | |
void * | evas_object_data_get (const Evas_Object *obj, const char *key) |
Return an attached data pointer on an Evas object by its given string key. More... | |
void * | evas_object_data_del (Evas_Object *obj, const char *key) |
Delete an attached data pointer from an object. More... | |
Miscellaneous functions that also apply to any object, but are less used or not implemented by all objects.
Examples on this group of functions can be found here and here.
#define evas_obj_anti_alias_set | ( | anti_alias | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_ANTI_ALIAS_SET), EO_TYPECHECK(Eina_Bool, anti_alias) |
Sets whether or not the given Evas object is to be drawn anti-aliased.
[in] | anti_alias | in |
Referenced by evas_object_anti_alias_set().
#define evas_obj_pointer_mode_set | ( | pointer_mode | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_POINTER_MODE_SET), EO_TYPECHECK(Evas_Object_Pointer_Mode, pointer_mode) |
Set pointer behavior.
[in] | pointer_mode | in |
Referenced by evas_object_pointer_mode_set().
#define evas_obj_anti_alias_get | ( | anti_alias | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_ANTI_ALIAS_GET), EO_TYPECHECK(Eina_Bool *, anti_alias) |
Retrieves whether or not the given Evas object is to be drawn anti_aliased.
[out] | anti_alias | out |
Referenced by evas_object_anti_alias_get().
#define evas_obj_scale_set | ( | scale | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_SCALE_SET), EO_TYPECHECK(double, scale) |
Sets the scaling factor for an Evas object. Does not affect all objects.
[in] | scale | in |
Referenced by evas_object_scale_set().
#define evas_obj_scale_get | ( | scale | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_SCALE_GET), EO_TYPECHECK(double *, scale) |
Retrieves the scaling factor for the given Evas object.
[out] | scale | out |
Referenced by evas_object_evas_get(), and evas_object_scale_get().
#define evas_obj_render_op_set | ( | render_op | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_RENDER_OP_SET), EO_TYPECHECK(Evas_Render_Op, render_op) |
Sets the render_op to be used for rendering the Evas object.
[in] | render_op | in |
Referenced by evas_object_render_op_set().
#define evas_obj_render_op_get | ( | render_op | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_RENDER_OP_GET), EO_TYPECHECK(Evas_Render_Op *, render_op) |
[out] | render_op |
Referenced by evas_object_render_op_get().
#define evas_obj_precise_is_inside_set | ( | precise | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_PRECISE_IS_INSIDE_SET), EO_TYPECHECK(Eina_Bool, precise) |
Set whether to use precise (usually expensive) point collision detection for a given Evas object.
[in] | precise | in |
Referenced by evas_object_precise_is_inside_set().
#define evas_obj_precise_is_inside_get | ( | precise | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_PRECISE_IS_INSIDE_GET), EO_TYPECHECK(Eina_Bool *, precise) |
Determine whether an object is set to use precise point collision detection.
[out] | precise | out |
Referenced by evas_object_precise_is_inside_get().
#define evas_obj_static_clip_set | ( | is_static_clip | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_STATIC_CLIP_SET), EO_TYPECHECK(Eina_Bool, is_static_clip) |
Set a hint flag on the given Evas object that it's used as a "static clipper".
[in] | is_static_clip | in |
Referenced by evas_object_static_clip_set().
#define evas_obj_static_clip_get | ( | is_static_clip | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_STATIC_CLIP_GET), EO_TYPECHECK(Eina_Bool *, is_static_clip) |
Get the "static clipper" hint flag for a given Evas object.
[out] | is_static_clip | out |
Referenced by evas_object_static_clip_get().
#define evas_obj_pointer_mode_get | ( | pointer_mode | ) | EVAS_OBJ_ID(EVAS_OBJ_SUB_ID_POINTER_MODE_GET), EO_TYPECHECK(Evas_Object_Pointer_Mode *, pointer_mode) |
Determine how pointer will behave.
[out] | pointer_mode | out |
Referenced by evas_object_evas_get(), and evas_object_pointer_mode_get().
typedef enum _Evas_Render_Op Evas_Render_Op |
How the object should be rendered to output.
How the object should be rendered to output.
typedef enum _Evas_Object_Pointer_Mode Evas_Object_Pointer_Mode |
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.
enum _Evas_Render_Op |
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.
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.
obj | The object to attach the data pointer to |
key | The string key for the data to access it |
data | The pointer to the data to be attached |
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
.
Example:
References EAPI.
Referenced by ecore_evas_ews_new(), ecore_evas_object_image_new(), edje_external_type_get(), edje_file_data_get(), edje_object_access_part_list_get(), edje_object_update_hints_get(), and edje_perspective_new().
void evas_object_pointer_mode_set | ( | Evas_Object * | obj, |
Evas_Object_Pointer_Mode | setting | ||
) |
Set pointer behavior.
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.
References EAPI, and evas_obj_pointer_mode_set.
Referenced by edje_edit_part_clip_to_set(), edje_edit_part_name_set(), edje_file_data_get(), and edje_object_update_hints_get().
Evas_Object_Pointer_Mode evas_object_pointer_mode_get | ( | const Evas_Object * | obj | ) |
Determine how pointer will behave.
obj |
References EAPI, evas_obj_pointer_mode_get, and EVAS_OBJECT_POINTER_MODE_AUTOGRAB.
void evas_object_anti_alias_set | ( | Evas_Object * | obj, |
Eina_Bool | antialias | ||
) |
Sets whether or not the given Evas object is to be drawn anti-aliased.
obj | The given Evas object. |
antialias | 1 if the object is to be anti_aliased, 0 otherwise. |
References EAPI, and evas_obj_anti_alias_set.
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.
obj | The given Evas object. |
1
if the object is to be anti_aliased. 0
otherwise. References EAPI, EINA_FALSE, and evas_obj_anti_alias_get.
void evas_object_scale_set | ( | Evas_Object * | obj, |
double | scale | ||
) |
Sets the scaling factor for an Evas object.
Does not affect all objects.
obj | The given Evas object. |
scale | The scaling factor. 1.0 means no scaling, default size. |
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.
References EAPI, and evas_obj_scale_set.
double evas_object_scale_get | ( | const Evas_Object * | obj | ) |
Retrieves the scaling factor for the given Evas object.
obj | The given Evas object. |
References EAPI, and evas_obj_scale_get.
void evas_object_render_op_set | ( | Evas_Object * | obj, |
Evas_Render_Op | op | ||
) |
Sets the render_op to be used for rendering the Evas object.
obj | The given Evas object. |
op | one of the Evas_Render_Op values. |
References EAPI, and evas_obj_render_op_set.
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.
obj | The given Evas object. |
References EAPI, evas_obj_render_op_get, and EVAS_RENDER_BLEND.
void evas_object_precise_is_inside_set | ( | Evas_Object * | obj, |
Eina_Bool | precise | ||
) |
Set whether to use precise (usually expensive) point collision detection for a given Evas object.
obj | The given object. |
precise | Whether to use precise point collision detection or not. The default value is false. |
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.
Example code follows.
See the full example here.
References EAPI, and evas_obj_precise_is_inside_set.
Referenced by edje_edit_part_name_set(), edje_file_data_get(), and edje_object_update_hints_get().
Eina_Bool evas_object_precise_is_inside_get | ( | const Evas_Object * | obj | ) |
Determine whether an object is set to use precise point collision detection.
obj | The given object. |
obj
is set to use precise point collision detection or not The default value is false.References EAPI, EINA_FALSE, and evas_obj_precise_is_inside_get.
void evas_object_static_clip_set | ( | Evas_Object * | obj, |
Eina_Bool | is_static_clip | ||
) |
Set a hint flag on the given Evas object that it's used as a "static clipper".
obj | The given object. |
is_static_clip | EINA_TRUE if it's to be used as a static clipper, EINA_FALSE otherwise. |
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
.
References EAPI, and evas_obj_static_clip_set.
Referenced by edje_object_add(), and evas_object_smart_clipped_clipper_get().
Eina_Bool evas_object_static_clip_get | ( | const Evas_Object * | obj | ) |
Get the "static clipper" hint flag for a given Evas object.
obj | The given object. |
EINA_TRUE
if it's set as a static clipper, EINA_FALSE
otherwise.References EAPI, EINA_FALSE, EINA_INLIST_FOREACH, evas_obj_static_clip_get, evas_object_geometry_get(), and evas_object_move().
void* evas_object_data_get | ( | const Evas_Object * | obj, |
const char * | key | ||
) |
Return an attached data pointer on an Evas object by its given string key.
obj | The object to which the data was attached |
key | The string key the data was stored under |
NULL
if none was storedThis 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:
References EAPI.
Referenced by ecore_evas_object_ecore_evas_get(), ecore_evas_object_evas_get(), edje_evas_global_perspective_get(), edje_extern_object_aspect_set(), edje_extern_object_max_size_set(), edje_extern_object_min_size_set(), edje_external_type_get(), edje_file_data_get(), edje_object_access_part_list_get(), edje_object_part_external_param_type_get(), edje_object_part_swallow(), edje_object_part_unswallow(), edje_object_signal_callback_extra_data_get(), and edje_object_update_hints_get().
void* evas_object_data_del | ( | Evas_Object * | obj, |
const char * | key | ||
) |
Delete an attached data pointer from an object.
obj | The object to delete the data pointer from |
key | The string key the data was stored under |
key
on obj
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:
Referenced by edje_edit_object_add(), edje_object_access_part_list_get(), and edje_object_update_hints_get().