Finding Objects
[Generic Object Functions]

Functions that allows finding objects by their position, name or other properties. More...

Functions
EAPI Evas_Object *	evas_focus_get (const Evas *e)
	Retrieve the object that currently has focus.
EAPI Evas_Object *	evas_object_name_find (const Evas *e, const char *name)
	Retrieves the object on the given evas with the given name.
EAPI Evas_Object *	evas_object_top_at_xy_get (const Evas *e, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
	Retrieves the top object at the given position (x,y).
EAPI Evas_Object *	evas_object_top_at_pointer_get (const Evas *e)
	Retrieves the top object at mouse pointer position.
EAPI Evas_Object *	evas_object_top_in_rectangle_get (const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
	Retrieves the top object in the given rectangle region.
EAPI Eina_List *	evas_objects_at_xy_get (const Evas *e, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
	Retrieves the objects at the given position.
EAPI Eina_List *	evas_objects_in_rectangle_get (const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects)
	To be documented.
EAPI Evas_Object *	evas_object_bottom_get (const Evas *e)
	Get the lowest evas object on the Evas e.
EAPI Evas_Object *	evas_object_top_get (const Evas *e)
	Get the highest evas object on the Evas e.

---

Detailed Description

Functions that allows finding objects by their position, name or other properties.

---

Function Documentation

EAPI Evas_Object* evas_focus_get

(

const Evas *

e

)

Retrieve the object that currently has focus.

Parameters:

e

The Evas canvas to query focus on.

Returns the object that currently has focus, NULL otherwise.

See also:

evas_object_focus_set

evas_object_focus_get

evas_object_key_grab

evas_object_key_ungrab

Returns:

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

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_Object* evas_object_name_find	(	const Evas *	e,
		const char *	name
	)

Retrieves the object on the given evas with the given name.

Parameters:

	e	The given evas.
	name	The given name.

Returns:

If successful, the evas object with the given name. Otherwise, NULL.

EAPI Evas_Object* evas_object_top_at_pointer_get

(

const Evas *

e

)

Retrieves the top object at mouse pointer position.

Parameters:

e

The given evas object.

Returns:

The evas object that is over all others objects at the pointer position.

References evas_object_top_at_xy_get().

EAPI Evas_Object* evas_object_top_at_xy_get	(	const Evas *	e,
		Evas_Coord	x,
		Evas_Coord	y,
		Eina_Bool	include_pass_events_objects,
		Eina_Bool	include_hidden_objects
	)

Retrieves the top object at the given position (x,y).

Parameters:

	e	The given evas object.
	x	The horizontal coordinate
	y	The vertical coordinate
	include_pass_events_objects	Boolean Flag to include or not pass events objects
	include_hidden_objects	Boolean Flag to include or not hidden objects

Returns:

The evas object that is over all others objects at the given position.

Referenced by evas_object_top_at_pointer_get().

EAPI Evas_Object* evas_object_top_get

(

const Evas *

e

)

Get the highest evas object on the Evas e.

Parameters:

e

an Evas

Returns:

the highest object

EAPI Evas_Object* evas_object_top_in_rectangle_get	(	const Evas *	e,
		Evas_Coord	x,
		Evas_Coord	y,
		Evas_Coord	w,
		Evas_Coord	h,
		Eina_Bool	include_pass_events_objects,
		Eina_Bool	include_hidden_objects
	)

Retrieves the top object in the given rectangle region.

Parameters:

	e	The given evas object.
	x	The horizontal coordinate.
	y	The vertical coordinate.
	w	The width size.
	h	The height size.
	include_pass_events_objects	Boolean Flag to include or not pass events objects
	include_hidden_objects	Boolean Flag to include or not hidden objects

Returns:

The evas object that is over all others objects at the pointer position.

EAPI Eina_List* evas_objects_at_xy_get	(	const Evas *	e,
		Evas_Coord	x,
		Evas_Coord	y,
		Eina_Bool	include_pass_events_objects,
		Eina_Bool	include_hidden_objects
	)

Retrieves the objects at the given position.

Parameters:

	e	The given evas object.
	x	The horizontal coordinate.
	y	The vertical coordinate.
	include_pass_events_objects	Boolean Flag to include or not pass events objects
	include_hidden_objects	Boolean Flag to include or not hidden objects

Returns:

The list of evas objects at the pointer position.

EAPI Eina_List* evas_objects_in_rectangle_get	(	const Evas *	e,
		Evas_Coord	x,
		Evas_Coord	y,
		Evas_Coord	w,
		Evas_Coord	h,
		Eina_Bool	include_pass_events_objects,
		Eina_Bool	include_hidden_objects
	)

To be documented.

FIXME: To be fixed. Retrieves the objects in the given rectangle region

Parameters:

	e	The given evas object.
	x	The horizontal coordinate.
	y	The vertical coordinate.
	w	The width size.
	h	The height size.
	include_pass_events_objects	Boolean Flag to include or not pass events objects
	include_hidden_objects	Boolean Flag to include or not hidden objects

Returns:

The list of evas object in the rectangle region.