Evas.h File Reference

Returns:: The object that has focus or NULL is there is not one.

EAPI Evas_List* evas_font_available_list ( const Evas * e )

To be documented.

FIXME: To be fixed.

EAPI void evas_font_available_list_free	(	Evas *	e,
		Evas_List *	available
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_font_cache_flush ( Evas * e )

To be documented.

FIXME: To be fixed.

EAPI int evas_font_cache_get ( const Evas * e )

To be documented.

FIXME: To be fixed.

EAPI void evas_font_cache_set	(	Evas *	e,
		int	size
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_image_cache_flush ( Evas * e )

To be documented.

FIXME: To be fixed.

EAPI int evas_image_cache_get ( const Evas * e )

To be documented.

FIXME: To be fixed.

EAPI void evas_image_cache_reload ( Evas * e )

To be documented.

FIXME: To be fixed.

EAPI void evas_image_cache_set	(	Evas *	e,
		int	size
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_key_lock_add	(	Evas *	e,
		const char *	keyname
	)

Adds the keyname to the current list of locks.

Locks can be keys like caps lock, num lock or scroll lock, as well as user defined. This allows custom locks to be added to the evas system at run time. It is then possible to set and unset the lock for other parts of the program to check and act on.

See also:

Parameters:

	e	The pointer to the Evas Canvas
	keyname	The name of the key to remove from the modifier list.

EAPI void evas_key_lock_del	(	Evas *	e,
		const char *	keyname
	)

Removes The keyname from the current list of locks.

See also:

Parameters:

	e	The pointer to the Evas Canvas
	keyname	The name of the key to remove from the lock list.

EAPI const Evas_Lock* evas_key_lock_get ( const Evas * e )

Returns a handle to the locks available in the system.

This is required to check for locks with the evas_key_lock_is_set_get function.

See also:

evas_key_lock_is_set_get

Parameters:

e

The pointer to the Evas Canvas

Returns:: An Evas_Lock handle to query the lock subsystem with evas_key_lock_is_set_get, or NULL on error.

EAPI Evas_Bool evas_key_lock_is_set	(	const Evas_Lock *	l,
		const char *	keyname
	)

Checks the state of a given lock.

If the lock is set, such as caps lock, this function returns true.

See also:

Parameters:

	l	The current lock set as returned by evas_key_lock_get.
	keyname	The name of the lock to add the the list.
	1	if the `keyname` kock is set, 0 otherwise.

EAPI void evas_key_lock_off	(	Evas *	e,
		const char *	keyname
	)

Disables or turns off the lock with name keyname.

See also:

Parameters:

	e	The pointer to the Evas Canvas
	keyname	The name of the lock to un-set.

EAPI void evas_key_lock_on	(	Evas *	e,
		const char *	keyname
	)

Enables or turns on the lock with name keyname.

See also:

Parameters:

	e	The pointer to the Evas Canvas
	keyname	The name of the lock to set.

EAPI void evas_key_modifier_add	(	Evas *	e,
		const char *	keyname
	)

Adds the keyname to the current list of modifiers.

Modifiers can be keys like shift, alt and ctrl, as well as user defined. This allows custom modifiers to be added to the evas system as run time. It is then possible to set and unset the modifier for other parts of the program to check and act on.

See also:

evas_key_modifier_del

evas_key_modifier_is_set_get

Parameters:

	e	The pointer to the Evas Canvas
	keyname	The name of the modifier to add to the list.

EAPI void evas_key_modifier_del	(	Evas *	e,
		const char *	keyname
	)

Removes the keyname from the current list of modifiers.

See also:

evas_key_modifier_is_set_get

Parameters:

	e	The pointer to the Evas Canvas
	keyname	The name of the key to remove from the modifiers list.

EAPI const Evas_Modifier* evas_key_modifier_get ( const Evas * e )

Returns a handle to the modifiers available in the system.

This is required to check for modifiers with the evas_key_modifier_is_set_get function.

See also:

evas_key_modifier_del

evas_key_modifier_is_set_get

Parameters:

e

The pointer to the Evas Canvas

Returns:: An Evas_Modifier handle to query the modifier subsystem with evas_key_modifier_is_set_get, or NULL on error.

EAPI Evas_Bool evas_key_modifier_is_set	(	const Evas_Modifier *	m,
		const char *	keyname
	)

Checks the state of a given modifier.

If the modifier is set, such as shift being pressed this function returns true.

See also:

evas_key_modifier_del

Parameters:

	m	The current modifier set as returned by evas_key_modifier_get.
	keyname	The name of the key to check its status.

Returns:: 1 if the keyname is on, 0 otherwise.

EAPI Evas_Modifier_Mask evas_key_modifier_mask_get	(	const Evas *	e,
		const char *	keyname
	)

Creates a bit mask from the keyname for use with events to check for the presence of the keyname modifier.

See also:

evas_key_modifier_is_set_get

Parameters:

keyname

The name of the modifier to create the mask for.

Returns:: the bit mask or 0 if the keyname wasn't registered as a modifier.

EAPI void evas_key_modifier_off	(	Evas *	e,
		const char *	keyname
	)

Disables or turns off the modifier with name keyname.

See also:

evas_key_modifier_is_set_get

Parameters:

	e	The pointer to the Evas Canvas
	keyname	The name of the modifier to un-set.

EAPI void evas_key_modifier_on	(	Evas *	e,
		const char *	keyname
	)

Enables or turns on the modifier with name keyname.

See also:

evas_key_modifier_is_set_get

Parameters:

	e	The pointer to the Evas Canvas
	keyname	The name of the modifier to set.

EAPI Evas_List* evas_list_promote_list	(	Evas_List *	list,
		Evas_List *	move_list
	)

Moves the specified data to the head of the list.

Move a specified member to the head of the list

Parameters:

	list	The list handle to move `inside`
	move_list	The list node which is to be moved

Returns:: A new list handle to replace the old one

Calling this function takes the list node move_list and moves it to the front of the list.

Example:

 extern Evas_List *list;
 Evas_List *l;
 extern void *my_data;

 for (l = list; l; l= l->next)
   {
     if (l->data == my_data)
       {
         list = evas_list_promote_list(list, l);
         break;
       }
   }

References _Evas_List::accounting, _Evas_List::next, and _Evas_List::prev.

EAPI void evas_norender ( Evas * e )

To be documented.

FIXME: To be fixed.

EAPI Evas_Object* evas_object_above_get ( const Evas_Object * obj )

Get the evas object above obj.

Parameters:

obj

an Evas_Object

Returns:: the Evas_Object directly above

EAPI Evas_Object* evas_object_below_get ( const Evas_Object * obj )

Get the evas object below obj.

Parameters:

obj

an Evas_Object

Returns:: the Evas_Object directly below

EAPI Evas_Object* evas_object_bottom_get ( const Evas * e )

Get the lowest evas object on the Evas e.

Parameters:

e

an Evas

Returns:: the lowest object

EAPI Evas_Bool evas_object_focus_get ( const Evas_Object * obj )

Test if the object has focus.

Parameters:

obj

The object to be tested.

If the passed object is the currently focused object 1 is returned, 0 otherwise.

See also:

Returns:: 1 if the object has the focus, 0 otherwise.

EAPI void evas_object_focus_set	(	Evas_Object *	obj,
		Evas_Bool	focus
	)

Sets focus to the given object.

Parameters:

	obj	The object to be focused or unfocused.
	focus	set or remove focus to the object.

Changing focus only affects where key events go. There can be only one object focused at any time.

If the parameter (focus) is set, the passed object will be set as the currently focused object. It will receive all keyboard events that are not exclusive key grabs on other objects.

See also:

References EVAS_CALLBACK_FOCUS_IN, and EVAS_CALLBACK_FOCUS_OUT.

EAPI Evas_Colorspace evas_object_image_colorspace_get ( const Evas_Object * obj )

To be documented.

FIXME: To be fixed.

References EVAS_COLORSPACE_ARGB8888.

EAPI void evas_object_image_colorspace_set	(	Evas_Object *	obj,
		Evas_Colorspace	cspace
	)

To be documented.

FIXME: To be fixed.

EAPI double evas_object_image_load_dpi_get ( const Evas_Object * obj )

To be documented.

FIXME: To be fixed.

EAPI void evas_object_image_load_dpi_set	(	Evas_Object *	obj,
		double	dpi
	)

To be documented.

FIXME: To be fixed.

EAPI int evas_object_image_load_scale_down_get ( const Evas_Object * obj )

To be documented.

FIXME: To be fixed.

EAPI void evas_object_image_load_scale_down_set	(	Evas_Object *	obj,
		int	scale_down
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_image_load_size_set	(	Evas_Object *	obj,
		int	w,
		int	h
	)

To be documented.

FIXME: To be fixed.

EAPI Evas_Native_Surface* evas_object_image_native_surface_get ( const Evas_Object * obj )

To be documented.

FIXME: To be fixed.

EAPI void evas_object_image_native_surface_set	(	Evas_Object *	obj,
		Evas_Native_Surface *	surf
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_image_pixels_get_callback_set	(	Evas_Object *	obj,
		void()(void data, Evas_Object *o)	func,
		void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI Evas_Bool evas_object_image_pixels_import	(	Evas_Object *	obj,
		Evas_Pixel_Import_Source *	pixels
	)

To be documented.

FIXME: To be fixed.

References EVAS_PIXEL_FORMAT_ARGB32, and EVAS_PIXEL_FORMAT_YUV420P_601.

EAPI void evas_object_image_reload ( Evas_Object * obj )

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_clip_set_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object obj, Evas_Object clip)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_clip_set_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object obj, Evas_Object clip)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_clip_unset_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_clip_unset_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_color_set_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj, int r, int g, int b, int a)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_color_set_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj, int r, int g, int b, int a)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_hide_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_hide_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_layer_set_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj, int l)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_layer_set_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj, int l)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_lower_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_lower_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_move_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj, Evas_Coord x, Evas_Coord y)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_move_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj, Evas_Coord x, Evas_Coord y)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_raise_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_raise_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_resize_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj, Evas_Coord w, Evas_Coord h)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_resize_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj, Evas_Coord w, Evas_Coord h)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_show_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_show_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object *obj)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_stack_above_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object obj, Evas_Object above)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_stack_above_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object obj, Evas_Object above)	func
	)

To be documented.

FIXME: To be fixed.

EAPI void evas_object_intercept_stack_below_callback_add	(	Evas_Object *	obj,
		void()(void data, Evas_Object obj, Evas_Object below)	func,
		const void *	data
	)

To be documented.

FIXME: To be fixed.

EAPI void* evas_object_intercept_stack_below_callback_del	(	Evas_Object *	obj,
		void()(void data, Evas_Object obj, Evas_Object below)	func
	)

To be documented.

FIXME: To be fixed.

EAPI Evas_Bool evas_object_key_grab	(	Evas_Object *	obj,
		const char *	keyname,
		Evas_Modifier_Mask	modifiers,
		Evas_Modifier_Mask	not_modifiers,
		Evas_Bool	exclusive
	)

Requests keyname key events be directed to obj.

Key grabs allow an object to receive key events for specific key strokes even if another object has focus. If the grab is non-exclusive then all objects that have grabs on the key will get the event, however if the grab is exclusive, no other object can get a grab on the key and only that object will get the event.

keyname is a platform dependent symbolic name for the key pressed. It is sometimes possible to convert the string to an ASCII value of the key, but not always for example the enter key may be returned as the string 'Enter'.

Typical platforms are Linux frame buffer (Ecore_FB) and X server (Ecore_X) when using Evas with Ecore and Ecore_Evas.

For a list of keynames for the Linux frame buffer, please refer to the Ecore_FB documentation.

modifiers and not_modifiers are bit masks of all the modifiers that are required and not required respectively for the new grab. Modifiers can be things such as shift and ctrl as well as user defigned types via evas_key_modifier_add.

See also:

Parameters:

	obj	the object to direct `keyname` events to.
	keyname	the key to request events for.
	modifiers	a mask of modifiers that should be present to trigger the event.
	not_modifiers	a mask of modifiers that should not be present to trigger the event.
	exclusive	request that the `obj` is the only object receiving the `keyname` events.

Returns:: Boolean indicating whether the grab succeeded

EAPI void evas_object_key_ungrab	(	Evas_Object *	obj,
		const char *	keyname,
		Evas_Modifier_Mask	modifiers,
		Evas_Modifier_Mask	not_modifiers
	)

Request that the grab on obj be removed.

Removes the grab on obj if keyname, modifiers, and not_modifiers match.

See also: