Ecore_Evas wrapper/helper set of functions

---

Ecore evas is a set of functions that makes it easy to tie together ecore's main loop and input handling to evas. As such it's a natural base for EFL applications. While this combination makes it easy to create the basic aspects all applications need, for normal applications(ones with buttons, checkboxes and layouts) one should consider using Elementary.

Ecore evas is extremely well suited for applications that are not based on widgets. It has a main loop that delivers events, does basic window handling and leaves all of the drawing up to the user. This works very well if used in conjunction with Edje or if doing custom drawing as, for example, is done in games.

This is a list of examples of these functions:

• Ecore Evas basics example
• Ecore Evas Object example
• Ecore Evas Callbacks
• Ecore_Evas window size hints
• Ecore_Evas buffer example
• Ecore_Evas (image) buffer example

Functions
int	ecore_evas_init (void)
	Inits the Ecore_Evas system.
int	ecore_evas_shutdown (void)
	Shuts down the Ecore_Evas system.
void	ecore_evas_alpha_set (Ecore_Evas *ee, Eina_Bool alpha)
	Sets whether an Ecore_Evas has an alpha channel or not.
Eina_Bool	ecore_evas_alpha_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas has an alpha channel.
void	ecore_evas_transparent_set (Ecore_Evas *ee, Eina_Bool transparent)
	Sets whether an Ecore_Evas has an transparent window or not.
Eina_Bool	ecore_evas_transparent_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas is transparent.
void	ecore_evas_geometry_get (const Ecore_Evas *ee, int *x, int *y, int *w, int *h)
	Gets the geometry of an Ecore_Evas.
void	ecore_evas_request_geometry_get (const Ecore_Evas *ee, int *x, int *y, int *w, int *h)
	Gets the geometry which an Ecore_Evas was latest recently requested.
void	ecore_evas_focus_set (Ecore_Evas *ee, Eina_Bool on)
	Sets the focus of an Ecore_Evas' window.
Eina_Bool	ecore_evas_focus_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas' window is focused or not.
void	ecore_evas_iconified_set (Ecore_Evas *ee, Eina_Bool on)
	Iconifies or uniconifies an Ecore_Evas' window.
Eina_Bool	ecore_evas_iconified_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas' window is iconified or not.
void	ecore_evas_borderless_set (Ecore_Evas *ee, Eina_Bool on)
	Sets whether an Ecore_Evas' window is borderless or not.
Eina_Bool	ecore_evas_borderless_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas' window is borderless or not.
void	ecore_evas_fullscreen_set (Ecore_Evas *ee, Eina_Bool on)
	Sets whether or not an Ecore_Evas' window is fullscreen.
Eina_Bool	ecore_evas_fullscreen_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas' window is fullscreen or not.
void	ecore_evas_window_group_set (Ecore_Evas *ee, const Ecore_Evas *ee_group)
	Sets another window that this window is a group member of.
const Ecore_Evas *	ecore_evas_window_group_get (const Ecore_Evas *ee)
	Gets the canvas group set.
void	ecore_evas_aspect_set (Ecore_Evas *ee, double aspect)
	Sets the aspect ratio of a canvas window.
double	ecore_evas_aspect_get (const Ecore_Evas *ee)
	Gets the aspect ratio of a canvas window.
void	ecore_evas_urgent_set (Ecore_Evas *ee, Eina_Bool urgent)
	Sets The urgent hint flag.
Eina_Bool	ecore_evas_urgent_get (const Ecore_Evas *ee)
	Gets the urgent state on the canvas window.
void	ecore_evas_modal_set (Ecore_Evas *ee, Eina_Bool modal)
	Sets the modal state flag on the canvas window.
Eina_Bool	ecore_evas_modal_get (const Ecore_Evas *ee)
	Gets The modal flag.
void	ecore_evas_demand_attention_set (Ecore_Evas *ee, Eina_Bool demand)
	Sets the "i demand attention" flag on a canvas window.
Eina_Bool	ecore_evas_demand_attention_get (const Ecore_Evas *ee)
	Gets the "i demand attention" flag.
void	ecore_evas_focus_skip_set (Ecore_Evas *ee, Eina_Bool skip)
	Sets the "focus skip" flag.
Eina_Bool	ecore_evas_focus_skip_get (const Ecore_Evas *ee)
	Gets the "focus skip" flag.
void	ecore_evas_ignore_events_set (Ecore_Evas *ee, Eina_Bool ignore)
	Sets if this evas should ignore all events.
Eina_Bool	ecore_evas_ignore_events_get (const Ecore_Evas *ee)
	Returns the ignore state of an Ecore_Evas' window.
int	ecore_evas_visibility_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas' window is visible or not.
void	ecore_evas_layer_set (Ecore_Evas *ee, int layer)
	Sets the layer of an Ecore_Evas' window.
int	ecore_evas_layer_get (const Ecore_Evas *ee)
	Gets the layer of an Ecore_Evas' window.
void	ecore_evas_maximized_set (Ecore_Evas *ee, Eina_Bool on)
	Maximizes (or unmaximizes) an Ecore_Evas' window.
Eina_Bool	ecore_evas_maximized_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas' window is maximized or not.
Eina_Bool	ecore_evas_window_profile_supported_get (const Ecore_Evas *ee)
	Queries if the underlying windowing system supports the window profile.
void	ecore_evas_window_profile_set (Ecore_Evas *ee, const char *profile)
	Sets the window profile.
const char *	ecore_evas_window_profile_get (const Ecore_Evas *ee)
	Gets the window profile.
void	ecore_evas_window_available_profiles_set (Ecore_Evas *ee, const char **profiles, const unsigned int count)
	Sets the array of available window profiles.
Eina_Bool	ecore_evas_window_available_profiles_get (Ecore_Evas *ee, char ***profiles, unsigned int *count)
	Gets the array of available window profiles.
Eina_Bool	ecore_evas_wm_rotation_supported_get (const Ecore_Evas *ee)
	Queries if the underlying windowing system supports the window manager rotation.
void	ecore_evas_wm_rotation_preferred_rotation_set (Ecore_Evas *ee, int rotation)
	Sets the preferred rotation hint.
int	ecore_evas_wm_rotation_preferred_rotation_get (const Ecore_Evas *ee)
	Gets the preferred rotation hint.
void	ecore_evas_wm_rotation_available_rotations_set (Ecore_Evas *ee, const int *rotations, unsigned int count)
	Sets the array of available window rotations.
Eina_Bool	ecore_evas_wm_rotation_available_rotations_get (const Ecore_Evas *ee, int **rotations, unsigned int *count)
	Gets the array of available window rotations.
void	ecore_evas_wm_rotation_manual_rotation_done_set (Ecore_Evas *ee, Eina_Bool set)
	Sets manual rotation done mode of Ecore_Evas's window.
Eina_Bool	ecore_evas_wm_rotation_manual_rotation_done_get (const Ecore_Evas *ee)
	Gets manual rotation done mode of Ecore_Evas's window.
void	ecore_evas_wm_rotation_manual_rotation_done (Ecore_Evas *ee)
	Sets rotation finish manually.
const Eina_List *	ecore_evas_aux_hints_supported_get (const Ecore_Evas *ee)
	Gets the list of supported auxiliary hint strings.
Eina_List *	ecore_evas_aux_hints_allowed_get (const Ecore_Evas *ee)
	Gets the list of allowed auxiliary hint ID.
int	ecore_evas_aux_hint_add (Ecore_Evas *ee, const char *hint, const char *val)
	Creates an auxiliary hint of the Ecore_Evas.
Eina_Bool	ecore_evas_aux_hint_del (Ecore_Evas *ee, const int id)
	Deletes an auxiliary hint of the Ecore_Evas.
Eina_Bool	ecore_evas_aux_hint_val_set (Ecore_Evas *ee, const int id, const char *val)
	Changes a value of the auxiliary hint.
const char *	ecore_evas_aux_hint_val_get (const Ecore_Evas *ee, int id)
	Gets a value of the auxiliary hint.
int	ecore_evas_aux_hint_id_get (const Ecore_Evas *ee, const char *hint)
	Gets a ID of the auxiliary hint string.
void	ecore_evas_input_rect_set (Ecore_Evas *ee, Eina_Rectangle *input_rect)
	Sets an input rect of surface.
void	ecore_evas_input_rect_add (Ecore_Evas *ee, Eina_Rectangle *input_rect)
	Sets an input rect of surface.
void	ecore_evas_input_rect_subtract (Ecore_Evas *ee, Eina_Rectangle *input_rect)
	Sets an input rect of surface.
Eina_Bool	ecore_evas_obscured_get (const Ecore_Evas *ee)
	Queries if the ecore evas is obscured or unobscured.
void	ecore_evas_msg_parent_send (Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size)
	Sends message to parent ecore.
void	ecore_evas_msg_send (Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size)
	Sends message to child ecore.
void	ecore_evas_callback_msg_parent_handle_set (Ecore_Evas *ee, void(*func_parent_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size))
	Sets a callback for parent Ecore_Evas message.
void	ecore_evas_callback_msg_handle_set (Ecore_Evas *ee, void(*func_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size))
	Sets a callback for child Ecore_Evas message.
void	ecore_evas_move (Ecore_Evas *ee, int x, int y)
	Moves an Ecore_Evas.
void	ecore_evas_resize (Ecore_Evas *ee, int w, int h)
	Resizes an Ecore_Evas.
void	ecore_evas_move_resize (Ecore_Evas *ee, int x, int y, int w, int h)
	Moves and resizes an Ecore_Evas.
void	ecore_evas_rotation_set (Ecore_Evas *ee, int rot)
	Sets the rotation of an Ecore_Evas' window.
void	ecore_evas_rotation_with_resize_set (Ecore_Evas *ee, int rot)
	Sets the rotation of an Ecore_Evas' window.
int	ecore_evas_rotation_get (const Ecore_Evas *ee)
	Gets the rotation of an Ecore_Evas' window.
void	ecore_evas_raise (Ecore_Evas *ee)
	Raises an Ecore_Evas' window.
void	ecore_evas_lower (Ecore_Evas *ee)
	Lowers an Ecore_Evas' window.
void	ecore_evas_title_set (Ecore_Evas *ee, const char *t)
	Sets the title of an Ecore_Evas' window.
const char *	ecore_evas_title_get (const Ecore_Evas *ee)
	Gets the title of an Ecore_Evas' window.
void	ecore_evas_name_class_set (Ecore_Evas *ee, const char *n, const char *c)
	Sets the name and class of an Ecore_Evas' window.
void	ecore_evas_name_class_get (const Ecore_Evas *ee, const char **n, const char **c)
	Gets the name and class of an Ecore_Evas' window.
Ecore_Window	ecore_evas_window_get (const Ecore_Evas *ee)
	Returns a pointer to the underlying window.
Ecore_Evas *	ecore_evas_gl_tbm_new (int w, int h)
	Creates Ecore_Evas using gl_tbm backend.
Ecore_Evas *	ecore_evas_buffer_new (int w, int h)
	Creates a new Ecore_Evas canvas bound to the Evas. buffer engine.
Ecore_Evas *	ecore_evas_buffer_allocfunc_new (int w, int h, void *(*alloc_func)(void *data, int size), void(*free_func)(void *data, void *pix), const void *data)
	Creates a new Ecore_Evas canvas bound to the Evas. buffer engine, giving custom allocation and freeing functions for the canvas memory region.
const void *	ecore_evas_buffer_pixels_get (Ecore_Evas *ee)
	Grabs a pointer to the actual pixels array of a given Ecore_Evas buffer canvas/window.
Ecore_Evas *	ecore_evas_buffer_ecore_evas_parent_get (Ecore_Evas *ee)
	Returns a pointer to the Ecore_Evas parent of the given Ecore_Evas.
Ecore_Evas *	ecore_evas_ecore_evas_get (const Evas *e)
	Returns the Ecore_Evas for this Evas.
void	ecore_evas_free (Ecore_Evas *ee)
	Frees an Ecore_Evas.
void *	ecore_evas_data_get (const Ecore_Evas *ee, const char *key)
	Retrieves user data associated with an Ecore_Evas.
void	ecore_evas_data_set (Ecore_Evas *ee, const char *key, const void *data)
	Stores user data in an Ecore_Evas structure.
void	ecore_evas_callback_resize_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas resize events.
void	ecore_evas_callback_move_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas move events.
void	ecore_evas_callback_show_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas show events.
void	ecore_evas_callback_hide_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas hide events.
void	ecore_evas_callback_delete_request_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas delete request events.
void	ecore_evas_callback_destroy_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas destroy events.
void	ecore_evas_callback_focus_in_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas focus in events.
void	ecore_evas_callback_focus_out_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas focus out events.
void	ecore_evas_callback_sticky_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas sticky events.
void	ecore_evas_callback_unsticky_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas un-sticky events.
void	ecore_evas_callback_mouse_in_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas mouse in events.
void	ecore_evas_callback_mouse_out_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas mouse out events.
void	ecore_evas_callback_pre_render_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas pre render events.
void	ecore_evas_callback_post_render_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas mouse post render events.
void	ecore_evas_callback_pre_free_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas pre-free event.
void	ecore_evas_callback_state_change_set (Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
	Sets a callback for Ecore_Evas state changes.
Evas *	ecore_evas_get (const Ecore_Evas *ee)
	Gets an Ecore_Evas's Evas.
void	ecore_evas_managed_move (Ecore_Evas *ee, int x, int y)
	Provides Managed move co-ordinates for an Ecore_Evas.
void	ecore_evas_shaped_set (Ecore_Evas *ee, Eina_Bool shaped)
	Sets whether an Ecore_Evas is shaped or not.
Eina_Bool	ecore_evas_shaped_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas is shaped or not.
void	ecore_evas_show (Ecore_Evas *ee)
	Shows an Ecore_Evas' window.
void	ecore_evas_hide (Ecore_Evas *ee)
	Hides an Ecore_Evas' window.
void	ecore_evas_activate (Ecore_Evas *ee)
	Activates (set focus to, via the window manager) an Ecore_Evas' window.
void	ecore_evas_size_min_set (Ecore_Evas *ee, int w, int h)
	Sets the minimum size of a given Ecore_Evas window.
void	ecore_evas_size_min_get (const Ecore_Evas *ee, int *w, int *h)
	Gets the minimum size set for a given Ecore_Evas window.
void	ecore_evas_size_max_set (Ecore_Evas *ee, int w, int h)
	Sets the maximum size of a given Ecore_Evas window.
void	ecore_evas_size_max_get (const Ecore_Evas *ee, int *w, int *h)
	Gets the maximum size set for a given Ecore_Evas window.
void	ecore_evas_size_base_set (Ecore_Evas *ee, int w, int h)
	Sets the base size for a given Ecore_Evas window.
void	ecore_evas_size_base_get (const Ecore_Evas *ee, int *w, int *h)
	Gets the base size set for a given Ecore_Evas window.
void	ecore_evas_size_step_set (Ecore_Evas *ee, int w, int h)
	Sets the "size step" for a given Ecore_Evas window.
void	ecore_evas_size_step_get (const Ecore_Evas *ee, int *w, int *h)
	Gets the "size step" set for a given Ecore_Evas window.
void	ecore_evas_cursor_set (Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y)
	Sets the cursor of an Ecore_Evas.
void	ecore_evas_cursor_get (const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y)
	Gets information about an Ecore_Evas' cursor.
Evas_Object *	ecore_evas_cursor_unset (Ecore_Evas *ee)
	Unsets the Ecore_Evas cursor.
void	ecore_evas_override_set (Ecore_Evas *ee, Eina_Bool on)
	Tells the WM whether or not to ignore an Ecore_Evas' window.
Eina_Bool	ecore_evas_override_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas' window is overridden or not.
void	ecore_evas_avoid_damage_set (Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on)
	Sets whether or not an Ecore_Evas' window should avoid damage.
Ecore_Evas_Avoid_Damage_Type	ecore_evas_avoid_damage_get (const Ecore_Evas *ee)
	Queries whether an Ecore_Evas' window avoids damage or not.
void	ecore_evas_withdrawn_set (Ecore_Evas *ee, Eina_Bool withdrawn)
	Sets the withdrawn state of an Ecore_Evas' window.
Eina_Bool	ecore_evas_withdrawn_get (const Ecore_Evas *ee)
	Returns the withdrawn state of an Ecore_Evas' window.
void	ecore_evas_sticky_set (Ecore_Evas *ee, Eina_Bool sticky)
	Sets the sticky state of an Ecore_Evas window.
Eina_Bool	ecore_evas_sticky_get (const Ecore_Evas *ee)
	Returns the sticky state of an Ecore_Evas' window.
void	ecore_evas_manual_render_set (Ecore_Evas *ee, Eina_Bool manual_render)
	Enables/disables manual render.
Eina_Bool	ecore_evas_manual_render_get (const Ecore_Evas *ee)
	Gets enable/disable status of manual render.
void	ecore_evas_input_event_register (Ecore_Evas *ee)
	Registers an Ecore_Evas to receive events through ecore_input_evas.
void	ecore_evas_input_event_register_with_multi (Ecore_Evas *ee)
	Registers an Ecore_Evas to receive events through ecore_input_evas.
void	ecore_evas_input_event_unregister (Ecore_Evas *ee)
	Unregisters an Ecore_Evas receiving events through ecore_input_evas.
void	ecore_evas_manual_render (Ecore_Evas *ee)
	Forces immediate rendering on a given Ecore_Evas window.
void	ecore_evas_screen_geometry_get (const Ecore_Evas *ee, int *x, int *y, int *w, int *h)
	Gets geometry of screen associated with this Ecore_Evas.
void	ecore_evas_screen_dpi_get (const Ecore_Evas *ee, int *xdpi, int *ydpi)
	Gets the dpi of the screen the Ecore_Evas is primarily on.

---

Enumeration Type Documentation

enum _Ecore_Evas_Avoid_Damage_Type

This option causes updates of the Ecore_Evas to be done on a pixmap, and then copied to the window, or the pixmap used directly on the window, depending on the setting.

Since :

3.0

Enumerator:

ECORE_EVAS_AVOID_DAMAGE_NONE	every expose event triggers a new damage and consequently render of the affected area. The rendering of things happens directly on the window
ECORE_EVAS_AVOID_DAMAGE_EXPOSE	there's a pixmap where everything is rendered into, and then copied to the window. On expose events, there's no need to render things again, just to copy the exposed region to the window
ECORE_EVAS_AVOID_DAMAGE_BUILT_IN	there's the same pixmap as the previous one, but it is set as a "background pixmap" of the window. The rendered things appear directly on the window, with no need to copy anything, but would stay stored on the pixmap, so there's no need to render things again on expose events. This option can be faster than the previous one, but may lead to artifacts during resize of the window

---

Function Documentation

void ecore_evas_activate

(

Ecore_Evas *

ee

)

Activates (set focus to, via the window manager) an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas to activate.

This functions activates the Ecore_Evas.

Since :

3.0

Eina_Bool ecore_evas_alpha_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas has an alpha channel.

Parameters:

ee	The Ecore_Evas to query.

Returns:

EINA_TRUE if ee has an alpha channel, EINA_FALSE if it does not.

This function returns EINA_TRUE if ee has an alpha channel, and EINA_FALSE if it does not.

See also:

ecore_evas_alpha_set()

Since :

3.0

void ecore_evas_alpha_set	(	Ecore_Evas *	ee,
		Eina_Bool	alpha
	)

Sets whether an Ecore_Evas has an alpha channel or not.

Parameters:

ee	The Ecore_Evas to shape
alpha	EINA_TRUE to enable the alpha channel, EINA_FALSE to disable it

This function allows you to make an Ecore_Evas translucent using an alpha channel. See ecore_evas_shaped_set() for details. The difference between a shaped window and a window with an alpha channel is that an alpha channel supports multiple levels of transparency, as opposed to the 1 bit transparency of a shaped window (a pixel is either opaque, or it's transparent).

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

double ecore_evas_aspect_get

(

const Ecore_Evas *

ee

)

Gets the aspect ratio of a canvas window.

This returns the value set by ecore_evas_aspect_set().

Parameters:

ee	The Ecore_Evas to set

Returns:

The aspect ratio

See also:

ecore_evas_aspect_set()

Since (EFL) :

1.2

Since :

3.0

void ecore_evas_aspect_set	(	Ecore_Evas *	ee,
		double	aspect
	)

Sets the aspect ratio of a canvas window.

Parameters:

ee	The Ecore_Evas
aspect	The aspect ratio (width divided by height), or 0 to disable

This sets the desired aspect ratio of a canvas window

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.2

Since :

3.0

int ecore_evas_aux_hint_add	(	Ecore_Evas *	ee,
		const char *	hint,
		const char *	val
	)

Creates an auxiliary hint of the Ecore_Evas.

Parameters:

ee	The Ecore_Evas
hint	The auxiliary hint string.
val	The value string.

Returns:

The ID of created auxiliary hint, or -1 on failure.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.10.0

Since :

3.0

Eina_Bool ecore_evas_aux_hint_del	(	Ecore_Evas *	ee,
		const int	id
	)

Deletes an auxiliary hint of the Ecore_Evas.

Parameters:

ee	The Ecore_Evas
id	The ID of the auxiliary hint.

Returns:

EINA_TRUE if no error occurred, EINA_FALSE otherwise.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.10.0

Since :

3.0

int ecore_evas_aux_hint_id_get	(	const Ecore_Evas *	ee,
		const char *	hint
	)

Gets a ID of the auxiliary hint string.

Parameters:

ee	The Ecore_Evas
hint	The auxiliary hint string.

Returns:

The ID of the auxiliary hint string, or -1 if none exists

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.15

Since :

3.0

const char* ecore_evas_aux_hint_val_get	(	const Ecore_Evas *	ee,
		int	id
	)

Gets a value of the auxiliary hint.

Parameters:

ee	The Ecore_Evas
id	The auxiliary hint ID.

Returns:

The string value of the auxiliary hint ID, or NULL if none exists

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.15

Since :

3.0

Eina_Bool ecore_evas_aux_hint_val_set	(	Ecore_Evas *	ee,
		const int	id,
		const char *	val
	)

Changes a value of the auxiliary hint.

Parameters:

ee	The Ecore_Evas
id	The auxiliary hint ID.
val	The value string to be set.

Returns:

EINA_TRUE if no error occurred, EINA_FALSE otherwise.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.10.0

Since :

3.0

Eina_List* ecore_evas_aux_hints_allowed_get

(

const Ecore_Evas *

ee

)

Gets the list of allowed auxiliary hint ID.

Parameters:

ee	The Ecore_Evas

Returns:

List of allowed auxiliary hint ID.

Note:

This function is low level. Instead of using it directly, consider using the callback mechanism in Elementary such as "aux,hint,allowed".

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.10.0

Since :

3.0

const Eina_List* ecore_evas_aux_hints_supported_get

(

const Ecore_Evas *

ee

)

Gets the list of supported auxiliary hint strings.

Parameters:

ee	The Ecore_Evas

Returns:

List of supported auxiliary hint strings.

Note:

Do not change the returned list of its contents. Auxiliary hint strings are internal and should be considered constants, do not free or modify them.

Warning:

Support for this depends on the underlying windowing system.

The window auxiliary hint is the value which is used to decide which actions should be made available to the user by the window manager. If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints that are registered in the root window by the window manager. Once you've added an auxiliary hint, you can get a new ID which is used to change value and delete hint. The window manager sends the response message to the application on receiving auxiliary hint change event. A list of auxiliary hint within the Ecore_Evas has this format: ID:HINT:VALUE,ID:HINT:VALUE,...

Since (EFL) :

1.10.0

Since :

3.0

Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas' window avoids damage or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

The type of the damage management

Since :

3.0

void ecore_evas_avoid_damage_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Avoid_Damage_Type	on
	)

Sets whether or not an Ecore_Evas' window should avoid damage.

Parameters:

ee	The Ecore_Evas
on	The type of the damage management

This option causes updates of the Ecore_Evas to be done on a pixmap, and then copied to the window, or the pixmap used directly on the window, depending on the setting. Possible options are:

• ECORE_EVAS_AVOID_DAMAGE_NONE - every expose event triggers a new damage and consequently render of the affected area. The rendering of things happens directly on the window;

• ECORE_EVAS_AVOID_DAMAGE_EXPOSE - there's a pixmap where everything is rendered into, and then copied to the window. On expose events, there's no need to render things again, just to copy the exposed region to the window;

• ECORE_EVAS_AVOID_DAMAGE_BUILT_IN - there's the same pixmap as the previous one, but it is set as a "background pixmap" of the window. The rendered things appear directly on the window, with no need to copy anything, but would stay stored on the pixmap, so there's no need to render things again on expose events. This option can be faster than the previous one, but may lead to artifacts during resize of the window.

Since :

3.0

Eina_Bool ecore_evas_borderless_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas' window is borderless or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee is borderless, EINA_FALSE if not.

See also:

ecore_evas_borderless_set()

Since :

3.0

void ecore_evas_borderless_set	(	Ecore_Evas *	ee,
		Eina_Bool	on
	)

Sets whether an Ecore_Evas' window is borderless or not.

Parameters:

ee	The Ecore_Evas
on	EINA_TRUE for borderless, EINA_FALSE for bordered.

This function makes ee borderless if on is EINA_TRUE, or bordered if on is EINA_FALSE.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Ecore_Evas* ecore_evas_buffer_allocfunc_new	(	int	w,
		int	h,
		void *(*)(void *data, int size)	alloc_func,
		void(*)(void *data, void *pix)	free_func,
		const void *	data
	)

Creates a new Ecore_Evas canvas bound to the Evas. buffer engine, giving custom allocation and freeing functions for the canvas memory region.

Parameters:

w	The width of the canvas, in canvas units
h	The height of the canvas, in canvas units
alloc_func	Function to be called to allocate the memory needed for the new buffer canvas. data will be passed the same value as the data of this function, while size will be passed w times h times sizeof(int).
free_func	Function to be called to free the memory used by the new buffer canvas. data will be passed the same value as the data of this function, while pix will be passed the canvas memory pointer.
data	Custom data to be passed to the allocation and freeing functions

Returns:

A new Ecore_Evas instance or NULL, on failure

This creates a new buffer canvas wrapper, with image data array bound to the ARGB format, 8 bits per pixel.

This function is useful when one wants an Ecore_Evas buffer canvas with a custom allocation function, like one getting memory chunks from a memory pool, for example.

On any resizing of this Ecore_Evas buffer canvas, its image data will be freed, to be allocated again with the new size.

Note:

w and h sizes have to greater or equal to 1. Otherwise, they'll be interpreted as 1, exactly.

See also:

ecore_evas_buffer_new()

Since :

3.0

Ecore_Evas* ecore_evas_buffer_ecore_evas_parent_get

(

Ecore_Evas *

ee

)

Returns a pointer to the Ecore_Evas parent of the given Ecore_Evas.

Parameters:

ee	An Ecore_Evas handle

Returns:

A pointer to the Ecore_Evas parent.

A use case for the function is to determine if the buffer is used inside X11 or Wayland. Since the buffer engine doesn't give any indication on it, we need to retrieve information from the Ecore_Evas parents.

Since (EFL) :

1.13

Since :

3.0

Ecore_Evas* ecore_evas_buffer_new	(	int	w,
		int	h
	)

Creates a new Ecore_Evas canvas bound to the Evas. buffer engine.

Parameters:

w	The width of the canvas, in pixels
h	The height of the canvas, in pixels

Returns:

A new Ecore_Evas instance or NULL, on failure

This creates a new buffer canvas wrapper, with image data array bound to the ARGB format, 8 bits per pixel.

This function will allocate the needed pixels array with canonical malloc(). If you wish a custom function to allocate it, consider using ecore_evas_buffer_allocfunc_new(), instead.

Note:

This function actually is a wrapper on ecore_evas_buffer_allocfunc_new(), using the same w and h arguments and canonical malloc() and free() to the memory allocation and freeing functions. See that function's documentation for more details.

Since :

3.0

Examples:

ecore_evas_buffer_example_01.c.

const void* ecore_evas_buffer_pixels_get

(

Ecore_Evas *

ee

)

Grabs a pointer to the actual pixels array of a given Ecore_Evas buffer canvas/window.

Parameters:

ee	An Ecore_Evas handle

Returns:

A pointer to the internal pixels array of ee

Besides returning a pointer to the actual pixel array of the given canvas, this call will force a rendering update on ee, first.

A common use case for this call is to create an image object, from another canvas, to have as data ee's contents, thus snapshoting the canvas. For that case, one can also use the ecore_evas_object_image_new() helper function.

Since :

3.0

Examples:

ecore_evas_buffer_example_01.c.

void ecore_evas_callback_delete_request_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas delete request events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee gets a delete request.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_basics_example.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_window_sizes_example.c, edje-basic.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, and evas-box.c.

void ecore_evas_callback_destroy_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas destroy events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee is destroyed.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, evas-hints.c, evas-images.c, evas-images2.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

void ecore_evas_callback_focus_in_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas focus in events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee gets focus.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

void ecore_evas_callback_focus_out_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas focus out events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee loses focus.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

void ecore_evas_callback_hide_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas hide events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee is hidden.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

void ecore_evas_callback_mouse_in_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas mouse in events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever the mouse enters ee.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

void ecore_evas_callback_mouse_out_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas mouse out events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever the mouse leaves ee.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

void ecore_evas_callback_move_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas move events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee is moved.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

void ecore_evas_callback_msg_handle_set	(	Ecore_Evas *	ee,
		void(*)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size)	func_handle
	)

Sets a callback for child Ecore_Evas message.

Parameters:

ee	The Ecore_Evas to set callbacks on
func_handle	The handle to be called when message arive

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

See also:

ecore_evas_msg_parent_send()

ecore_evas_msg_send()

ecore_evas_callback_msg_parent_handle_set()

Since :

3.0

void ecore_evas_callback_msg_parent_handle_set	(	Ecore_Evas *	ee,
		void(*)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size)	func_parent_handle
	)

Sets a callback for parent Ecore_Evas message.

Parameters:

ee	The Ecore_Evas to set callbacks on
func_parent_handle	The handle to be called when message arive.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

See also:

ecore_evas_msg_parent_send()

ecore_evas_msg_send()

eecore_evas_callback_msg_handle_set()

Since :

3.0

void ecore_evas_callback_post_render_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas mouse post render events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called just after the evas in ee is rendered.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

void ecore_evas_callback_pre_free_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas pre-free event.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called just before the instance ee is freed.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

void ecore_evas_callback_pre_render_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas pre render events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called just before the evas in ee is rendered.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

void ecore_evas_callback_resize_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas resize events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee is resized.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c, ecore_evas_window_sizes_example.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-swallow.c, edje-table.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

void ecore_evas_callback_show_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas show events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee is shown.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_callbacks.c.

void ecore_evas_callback_state_change_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas state changes.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee changes state.

Since (EFL) :

1.2

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

void ecore_evas_callback_sticky_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas sticky events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee becomes sticky.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

void ecore_evas_callback_unsticky_set	(	Ecore_Evas *	ee,
		Ecore_Evas_Event_Cb	func
	)

Sets a callback for Ecore_Evas un-sticky events.

Parameters:

ee	The Ecore_Evas to set callbacks on
func	The function to call

A call to this function will set a callback on an Ecore_Evas, causing func to be called whenever ee becomes un-sticky.

Warning:

If and when this function is called depends on the underlying windowing system.

Since :

3.0

void ecore_evas_cursor_get	(	const Ecore_Evas *	ee,
		Evas_Object **	obj,
		int *	layer,
		int *	hot_x,
		int *	hot_y
	)

Gets information about an Ecore_Evas' cursor.

Parameters:

ee	The Ecore_Evas to get
obj	A pointer to an Evas_Object to place the cursor Evas_Object.
layer	A pointer to an int to place the cursor's layer in.
hot_x	A pointer to an int to place the cursor's hot_x coordinate in.
hot_y	A pointer to an int to place the cursor's hot_y coordinate in.

This function queries information about an Ecore_Evas' cursor.

See also:

ecore_evas_cursor_set()

ecore_evas_object_cursor_set()

ecore_evas_cursor_unset()

Since :

3.0

Examples:

ecore_evas_object_example.c.

void ecore_evas_cursor_set	(	Ecore_Evas *	ee,
		const char *	file,
		int	layer,
		int	hot_x,
		int	hot_y
	)

Sets the cursor of an Ecore_Evas.

Parameters:

ee	The Ecore_Evas
file	The path to an image file for the cursor.
layer	The layer in which the cursor will appear.
hot_x	The x coordinate of the cursor's hot spot.
hot_y	The y coordinate of the cursor's hot spot.

This function makes the mouse cursor over ee be the image specified by file. The actual point within the image that the mouse is at is specified by hot_x and hot_y, which are coordinates with respect to the top left corner of the cursor image. Cursor object will be delete with Ecore_Evas.

Note:

This function creates an object from the image and uses ecore_evas_object_cursor_set().

Warning:

Previos setted cursor will be delete.

See also:

ecore_evas_object_cursor_set()

ecore_evas_cursor_unset()

Since :

3.0

Evas_Object* ecore_evas_cursor_unset

(

Ecore_Evas *

ee

)

Unsets the Ecore_Evas cursor.

Parameters:

ee	The Ecore_Evas to unset the cursor.

Returns:

The cursor object.

This function unsets the cursor from the Ecore_Evas, and returns the cursor object. If the cursor was set from ecore_evas_cursor_set(), this function returns the image. In this case, the image should be deleted when it is no longer needed.

See also:

ecore_evas_cursor_set()

ecore_evas_object_cursor_set()

Since (EFL) :

1.11

Since :

3.0

Examples:

ecore_evas_object_example.c.

void* ecore_evas_data_get	(	const Ecore_Evas *	ee,
		const char *	key
	)

Retrieves user data associated with an Ecore_Evas.

Parameters:

ee	The Ecore_Evas to retrieve the user data from.
key	The key which the user data to be retrieved is associated with.

This function retrieves user specific data that has been stored within an Ecore_Evas structure with ecore_evas_data_set().

Returns:

NULL on error or no data found, A pointer to the user data on success.

See also:

ecore_evas_data_set()

Since :

3.0

Examples:

ecore_evas_basics_example.c, edje-box.c, edje-box2.c, edje-drag.c, edje-perspective.c, edje-swallow.c, and edje-table.c.

void ecore_evas_data_set	(	Ecore_Evas *	ee,
		const char *	key,
		const void *	data
	)

Stores user data in an Ecore_Evas structure.

Parameters:

ee	The Ecore_Evas to store the user data in.
key	A unique string to associate the user data against. Cannot be NULL.
data	A pointer to the user data to store.

This function associates the data with a key which is stored by the Ecore_Evas ee. Be aware that a call to ecore_evas_free() will not free any memory for the associated user data, this is the responsibility of the caller.

See also:

ecore_evas_callback_pre_free_set()

ecore_evas_free()

ecore_evas_data_get()

Since :

3.0

Examples:

ecore_evas_basics_example.c, edje-box.c, edje-box2.c, edje-drag.c, edje-perspective.c, edje-swallow.c, and edje-table.c.

Eina_Bool ecore_evas_demand_attention_get

(

const Ecore_Evas *

ee

)

Gets the "i demand attention" flag.

This returns the value set by ecore_evas_demand_attention_set().

Parameters:

ee	The Ecore_Evas to set

Returns:

The "i demand attention" flag

See also:

ecore_evas_demand_attention_set()

Since (EFL) :

1.2

Since :

3.0

void ecore_evas_demand_attention_set	(	Ecore_Evas *	ee,
		Eina_Bool	demand
	)

Sets the "i demand attention" flag on a canvas window.

Parameters:

ee	The Ecore_Evas
demand	The flag state to set

A window may demand attention now (eg you must enter a password before continuing), and so it may flag a window with this.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.2

Since :

3.0

Ecore_Evas* ecore_evas_ecore_evas_get

(

const Evas *

e

)

Returns the Ecore_Evas for this Evas.

Parameters:

e	The Evas to get the Ecore_Evas from

Returns:

The Ecore_Evas that holds this Evas, or NULL if not held by one.

Warning:

Only use on Evas' created with ecore evas!

Since :

3.0

Examples:

ecore_evas_basics_example.c.

Eina_Bool ecore_evas_focus_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas' window is focused or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee if focused, EINA_FALSE if not.

See also:

ecore_evas_focus_set()

Since :

3.0

void ecore_evas_focus_set	(	Ecore_Evas *	ee,
		Eina_Bool	on
	)

Sets the focus of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas
on	EINA_TRUE for focus, EINA_FALSE to defocus.

This function focuses ee if on is EINA_TRUE, or unfocuses ee if on is EINA_FALSE.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Eina_Bool ecore_evas_focus_skip_get

(

const Ecore_Evas *

ee

)

Gets the "focus skip" flag.

This returns the value set by ecore_evas_focus_skip_set().

Parameters:

ee	The Ecore_Evas to set

Returns:

The "focus skip" flag

See also:

ecore_evas_focus_skip_set()

Since (EFL) :

1.2

Since :

3.0

void ecore_evas_focus_skip_set	(	Ecore_Evas *	ee,
		Eina_Bool	skip
	)

Sets the "focus skip" flag.

Parameters:

ee	The Ecore_Evas
skip	The "focus skip" state to set.

A window may not want to accept focus, be in the taskbar, pager etc. sometimes (example for a small notification window that hovers around a taskbar or panel, or hovers around a window until some activity dismisses it).

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.2

Since :

3.0

void ecore_evas_free

(

Ecore_Evas *

ee

)

Frees an Ecore_Evas.

Parameters:

ee	The Ecore_Evas to free

This frees up any memory used by the Ecore_Evas.

Since :

3.0

Examples:

ecore_animator_example.c, ecore_evas_basics_example.c, ecore_evas_buffer_example_01.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, ecore_imf_example.c, edje-basic.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, eina_tiler_01.c, evas-aspect-hints.c, evas-events.c, evas-images.c, evas-images2.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-table.c, and evas-text.c.

Eina_Bool ecore_evas_fullscreen_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas' window is fullscreen or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee is fullscreen, EINA_FALSE if not.

See also:

ecore_evas_fullscreen_set()

Since :

3.0

void ecore_evas_fullscreen_set	(	Ecore_Evas *	ee,
		Eina_Bool	on
	)

Sets whether or not an Ecore_Evas' window is fullscreen.

Parameters:

ee	The Ecore_Evas
on	EINA_TRUE fullscreen, EINA_FALSE not.

This function causes ee to be fullscreen if on is EINA_TRUE, or not if on is EINA_FALSE.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

void ecore_evas_geometry_get	(	const Ecore_Evas *	ee,
		int *	x,
		int *	y,
		int *	w,
		int *	h
	)

Gets the geometry of an Ecore_Evas.

Parameters:

ee	The Ecore_Evas whose geometry y
x	A pointer to an int to place the x coordinate in
y	A pointer to an int to place the y coordinate in
w	A pointer to an int to place the w size in
h	A pointer to an int to place the h size in

This function takes four pointers to (already allocated) ints, and places the geometry of ee in them. If any of the parameters is not desired you may pass NULL on them.

 int x, y, w, h;
 ecore_evas_geometry_get(ee, &x, &y, &w, &h);

See also:

ecore_evas_new()

ecore_evas_resize()

ecore_evas_move()

ecore_evas_move_resize()

Since :

3.0

Examples:

ecore_evas_window_sizes_example.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-swallow.c, edje-table.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

Evas* ecore_evas_get

(

const Ecore_Evas *

ee

)

Gets an Ecore_Evas's Evas.

Parameters:

ee	The Ecore_Evas whose Evas you wish to get

Returns:

The Evas wrapped by ee

This function returns the Evas contained within ee.

Since :

3.0

Examples:

ecore_animator_example.c, ecore_evas_basics_example.c, ecore_evas_buffer_example_01.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, ecore_imf_example.c, edje-basic.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, eina_tiler_01.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-map-utils.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

Ecore_Evas* ecore_evas_gl_tbm_new	(	int	w,
		int	h
	)

Creates Ecore_Evas using gl_tbm backend.

Since (EFL) :

1.12

Parameters:

w	The width of the Ecore_Evas to be created.
h	The height of the Ecore_Evas to be created.

Returns:

The new Ecore_Evas.

void ecore_evas_hide

(

Ecore_Evas *

ee

)

Hides an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas to hide.

This function makes ee hidden(not visible).

Since :

3.0

Examples:

ecore_evas_basics_example.c.

Eina_Bool ecore_evas_iconified_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas' window is iconified or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee is iconified, EINA_FALSE if not.

Note:

Iconify and minimize are synonyms.

See also:

ecore_evas_iconified_set()

Since :

3.0

void ecore_evas_iconified_set	(	Ecore_Evas *	ee,
		Eina_Bool	on
	)

Iconifies or uniconifies an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas
on	EINA_TRUE to iconify, EINA_FALSE to uniconify.

This function iconifies ee if on is EINA_TRUE, or uniconifies ee if on is EINA_FALSE.

Note:

Iconify and minimize are synonyms.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Eina_Bool ecore_evas_ignore_events_get

(

const Ecore_Evas *

ee

)

Returns the ignore state of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas whose window's ignore events state is returned.

Returns:

The Ecore_Evas window's ignore state.

See also:

ecore_evas_ignore_events_set()

Since :

3.0

void ecore_evas_ignore_events_set	(	Ecore_Evas *	ee,
		Eina_Bool	ignore
	)

Sets if this evas should ignore all events.

Parameters:

ee	The Ecore_Evas whose window's to ignore events.
ignore	The Ecore_Evas new ignore state.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

int ecore_evas_init

(

void

)

Inits the Ecore_Evas system.

Returns:

How many times the lib has been initialized, 0 indicates failure.

Set up the Evas wrapper system. Init Evas and Ecore libraries.

See also:

ecore_evas_shutdown()

Since :

3.0

Examples:

ecore_animator_example.c, ecore_evas_basics_example.c, ecore_evas_buffer_example_01.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, ecore_imf_example.c, edje-basic.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, eina_tiler_01.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-map-utils.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

void ecore_evas_input_event_register

(

Ecore_Evas *

ee

)

Registers an Ecore_Evas to receive events through ecore_input_evas.

Parameters:

ee	The Ecore_Evas handle.

This function calls ecore_event_window_register() with the ee as its id argument, window argument, and uses its Evas too. It is useful when no window information is available on a given Ecore_Evas backend.

See also:

ecore_evas_input_event_unregister()

Since (EFL) :

1.1

Since :

3.0

void ecore_evas_input_event_register_with_multi

(

Ecore_Evas *

ee

)

Registers an Ecore_Evas to receive events through ecore_input_evas.

Parameters:

ee	The Ecore_Evas handle.

This function calls ecore_event_window_register_with_multi() with the ee as its id argument, window argument, and uses its Evas too. It is useful when no window information is available on a given Ecore_Evas backend.

See also:

ecore_evas_input_event_unregister()

Since (EFL) :

1.1

void ecore_evas_input_event_unregister

(

Ecore_Evas *

ee

)

Unregisters an Ecore_Evas receiving events through ecore_input_evas.

Parameters:

ee	The Ecore_Evas handle.

See also:

ecore_evas_input_event_register()

Since (EFL) :

1.1

Since :

3.0

void ecore_evas_input_rect_add	(	Ecore_Evas *	ee,
		Eina_Rectangle *	input_rect
	)

Sets an input rect of surface.

Parameters:

ee	The Ecore_Evas
input_rect	The rect of input to be added

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.16

void ecore_evas_input_rect_set	(	Ecore_Evas *	ee,
		Eina_Rectangle *	input_rect
	)

Sets an input rect of surface.

Parameters:

ee	The Ecore_Evas
input_rect	The rect of input to be set

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.16

void ecore_evas_input_rect_subtract	(	Ecore_Evas *	ee,
		Eina_Rectangle *	input_rect
	)

Sets an input rect of surface.

Parameters:

ee	The Ecore_Evas
input_rect	The rect of input to be subtracted

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.16

int ecore_evas_layer_get

(

const Ecore_Evas *

ee

)

Gets the layer of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas to set

Returns:

The layer ee's window is on

See also:

ecore_evas_layer_set()

ecore_evas_lower()

ecore_evas_raise()

Since :

3.0

void ecore_evas_layer_set	(	Ecore_Evas *	ee,
		int	layer
	)

Sets the layer of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas
layer	The layer to put ee on.

This function moves ee to the layer layer.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_lower()

ecore_evas_raise()

Since :

3.0

void ecore_evas_lower

(

Ecore_Evas *

ee

)

Lowers an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas to raise.

This functions lowers the Ecore_Evas to the back.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_raise()

ecore_evas_layer_set()

Since :

3.0

void ecore_evas_managed_move	(	Ecore_Evas *	ee,
		int	x,
		int	y
	)

Provides Managed move co-ordinates for an Ecore_Evas.

Parameters:

ee	The Ecore_Evas to move
x	The x coordinate to set as the managed location
y	The y coordinate to set as the managed location

This sets the managed geometry position of the ee to (x, y)

Since :

3.0

void ecore_evas_manual_render

(

Ecore_Evas *

ee

)

Forces immediate rendering on a given Ecore_Evas window.

Parameters:

ee	An Ecore_Evas handle

Use this call to forcefully flush the ee's canvas rendering pipeline, thus bring its window to an up to date state.

Since :

3.0

Examples:

ecore_evas_buffer_example_01.c.

Eina_Bool ecore_evas_manual_render_get

(

const Ecore_Evas *

ee

)

Gets enable/disable status of manual render.

Parameters:

ee	An Ecore_Evas handle

Returns:

EINA_TRUE if manual render is enabled, EINA_FALSE if manual render is disabled

See also:

ecore_evas_manual_render_set()

ecore_evas_manual_render()

Since :

3.0

void ecore_evas_manual_render_set	(	Ecore_Evas *	ee,
		Eina_Bool	manual_render
	)

Enables/disables manual render.

Parameters:

ee	An Ecore_Evas handle
manual_render	Enable/disable manual render. EINA_TRUE to enable manual render, EINA_FALSE to disable manual render. EINA_FALSE by default

If manual_render is true, default ecore_evas render routine would be disabled and rendering will be done only manually. If manual_render is false, rendering will be done by default ecore_evas rendering routine, but still manual rendering is available. Call ecore_evas_manual_render() to force immediate render.

See also:

ecore_evas_manual_render_get()

ecore_evas_manual_render()

Since :

3.0

Eina_Bool ecore_evas_maximized_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas' window is maximized or not.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee is maximized, EINA_FALSE if not.

See also:

ecore_evas_maximized_set()

Since :

3.0

void ecore_evas_maximized_set	(	Ecore_Evas *	ee,
		Eina_Bool	on
	)

Maximizes (or unmaximizes) an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas
on	EINA_TRUE to maximize, EINA_FALSE to unmaximize

This function maximizes ee if on is EINA_TRUE, or unmaximizes ee if on is EINA_FALSE.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Eina_Bool ecore_evas_modal_get

(

const Ecore_Evas *

ee

)

Gets The modal flag.

This returns the value set by ecore_evas_modal_set().

Parameters:

ee	The Ecore_Evas to set

Returns:

The modal flag

See also:

ecore_evas_modal_set()

Since (EFL) :

1.2

Since :

3.0

void ecore_evas_modal_set	(	Ecore_Evas *	ee,
		Eina_Bool	modal
	)

Sets the modal state flag on the canvas window.

Parameters:

ee	The Ecore_Evas
modal	The modal hint flag

This hints if the window should be modal (eg if it is also transient for another window, the other window will maybe be denied focus by the desktop window manager).

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.2

Since :

3.0

void ecore_evas_move	(	Ecore_Evas *	ee,
		int	x,
		int	y
	)

Moves an Ecore_Evas.

Parameters:

ee	The Ecore_Evas to move
x	The x coordinate to move to
y	The y coordinate to move to

This moves ee to the screen coordinates (x, y)

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_new()

ecore_evas_resize()

ecore_evas_move_resize()

Since :

3.0

void ecore_evas_move_resize	(	Ecore_Evas *	ee,
		int	x,
		int	y,
		int	w,
		int	h
	)

Moves and resizes an Ecore_Evas.

Parameters:

ee	The Ecore_Evas to move and resize
x	The x coordinate to move to
y	The y coordinate to move to
w	The w coordinate to resize to
h	The h coordinate to resize to

This moves ee to the screen coordinates (x, y) and resizes it to w x h.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_new()

ecore_evas_move()

ecore_evas_resize()

Since :

3.0

void ecore_evas_msg_parent_send	(	Ecore_Evas *	ee,
		int	msg_domain,
		int	msg_id,
		void *	data,
		int	size
	)

Sends message to parent ecore.

Parameters:

ee	The Ecore_Evas to set
msg_domain	The domain of message
msg_id	The id of message
data	The data of message
size	The size of message data

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

See also:

ecore_evas_msg_send()

ecore_evas_callback_msg_parent_handle_set()

eecore_evas_callback_msg_handle_set()

This is a list of examples of these functions:

• ecore_evas_extn_socket_example
• ecore_evas_extn_plug_example

Since :

3.0

void ecore_evas_msg_send	(	Ecore_Evas *	ee,
		int	msg_domain,
		int	msg_id,
		void *	data,
		int	size
	)

Sends message to child ecore.

Parameters:

ee	The Ecore_Evas to set
msg_domain	The domain of message
msg_id	The id of message
data	The data of message
size	The size of message data

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

See also:

ecore_evas_msg_parent_send()

ecore_evas_callback_msg_parent_handle_set()

eecore_evas_callback_msg_handle_set()

Since :

3.0

void ecore_evas_name_class_get	(	const Ecore_Evas *	ee,
		const char **	n,
		const char **	c
	)

Gets the name and class of an Ecore_Evas' window.

This function gets the name of ee into n, and its class into c.

Parameters:

ee	The Ecore_Evas to query.
n	A pointer to a string to place the name in.
c	A pointer to a string to place the class in.

See also:

ecore_evas_name_class_set()

Since :

3.0

void ecore_evas_name_class_set	(	Ecore_Evas *	ee,
		const char *	n,
		const char *	c
	)

Sets the name and class of an Ecore_Evas' window.

Parameters:

ee	the Ecore_Evas
n	The name
c	The class

This function sets the name of ee to n, and its class to c. The meaning of name and class depends on the underlying windowing system.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Eina_Bool ecore_evas_obscured_get

(

const Ecore_Evas *

ee

)

Queries if the ecore evas is obscured or unobscured.

Parameters:

ee	The Ecore_Evas

Returns:

EINA_TRUE if the ecore evas is obscured, EINA_FALSE unobscured.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.16

Eina_Bool ecore_evas_override_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas' window is overridden or not.

Parameters:

ee	The Ecore_Evas to set.

Returns:

EINA_TRUE if ee is overridden, EINA_FALSE if not.

Since :

3.0

void ecore_evas_override_set	(	Ecore_Evas *	ee,
		Eina_Bool	on
	)

Tells the WM whether or not to ignore an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas.
on	EINA_TRUE to ignore, EINA_FALSE to not.

This function causes the window manager to ignore ee if on is EINA_TRUE, or not ignore ee if on is EINA_FALSE.

Since :

3.0

void ecore_evas_raise

(

Ecore_Evas *

ee

)

Raises an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas to raise.

This functions raises the Ecore_Evas to the front.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_lower()

ecore_evas_layer_set()

Since :

3.0

void ecore_evas_request_geometry_get	(	const Ecore_Evas *	ee,
		int *	x,
		int *	y,
		int *	w,
		int *	h
	)

Gets the geometry which an Ecore_Evas was latest recently requested.

Parameters:

ee	The Ecore_Evas whose geometry y
x	A pointer to an int to place the x coordinate in
y	A pointer to an int to place the y coordinate in
w	A pointer to an int to place the w size in
h	A pointer to an int to place the h size in

This function takes four pointers to (already allocated) ints, and places the geometry which ee was latest recently requested . If any of the parameters is not desired you may pass NULL on them. This function can represent recently requested geometry. ecore_evas_geometry_get function returns the value is updated after engine finished request. By comparison, ecore_evas_request_geometry_get returns recently requested value.

 int x, y, w, h;
 ecore_evas_request_geometry_get(ee, &x, &y, &w, &h);

Since (EFL) :

1.1

Since :

3.0

void ecore_evas_resize	(	Ecore_Evas *	ee,
		int	w,
		int	h
	)

Resizes an Ecore_Evas.

Parameters:

ee	The Ecore_Evas to move
w	The w coordinate to resize to
h	The h coordinate to resize to

This resizes ee to w x h.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_new()

ecore_evas_move()

ecore_evas_move_resize()

Since :

3.0

Examples:

ecore_evas_buffer_example_02.c.

int ecore_evas_rotation_get

(

const Ecore_Evas *

ee

)

Gets the rotation of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas

Returns:

The angle (in degrees) of rotation

See also:

ecore_evas_rotation_set()

ecore_evas_rotation_with_resize_set()

Since :

3.0

void ecore_evas_rotation_set	(	Ecore_Evas *	ee,
		int	rot
	)

Sets the rotation of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas
rot	The angle (in degrees) of rotation

The allowed values of rot depend on the engine being used. Most only allow multiples of 90.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_rotation_with_resize_set()

Since :

3.0

void ecore_evas_rotation_with_resize_set	(	Ecore_Evas *	ee,
		int	rot
	)

Sets the rotation of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas
rot	The angle (in degrees) of rotation.

Like ecore_evas_rotation_set(), but it also resizes the window's contents so that they fit inside the current window geometry.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_rotation_set()

Since :

3.0

void ecore_evas_screen_dpi_get	(	const Ecore_Evas *	ee,
		int *	xdpi,
		int *	ydpi
	)

Gets the dpi of the screen the Ecore_Evas is primarily on.

Parameters:

ee	The Ecore_Evas whose window's to query.
xdpi	Pointer to integer to store horizontal DPI. May be NULL.
ydpi	Pointer to integer to store vertical DPI. May be NULL.

Since (EFL) :

1.7

Since :

3.0

void ecore_evas_screen_geometry_get	(	const Ecore_Evas *	ee,
		int *	x,
		int *	y,
		int *	w,
		int *	h
	)

Gets geometry of screen associated with this Ecore_Evas.

Parameters:

ee	The Ecore_Evas whose window's to query container screen geometry.
x	Where to return the horizontal offset value. May be NULL.
y	Where to return the vertical offset value. May be NULL.
w	Where to return the width value. May be NULL.
h	Where to return the height value. May be NULL.

Since (EFL) :

1.1

Since :

3.0

Examples:

ecore_evas_window_sizes_example.c.

Eina_Bool ecore_evas_shaped_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas is shaped or not.

Parameters:

ee	The Ecore_Evas to query.

Returns:

EINA_TRUE if shaped, EINA_FALSE if not.

This function returns EINA_TRUE if ee is shaped, and EINA_FALSE if not.

Since :

3.0

void ecore_evas_shaped_set	(	Ecore_Evas *	ee,
		Eina_Bool	shaped
	)

Sets whether an Ecore_Evas is shaped or not.

Parameters:

ee	The Ecore_Evas to shape.
shaped	EINA_TRUE to shape, EINA_FALSE to not.

This function allows one to make an Ecore_Evas shaped to the contents of the evas. If shaped is EINA_TRUE, ee will be transparent in parts of the evas that contain no objects. If shaped is EINA_FALSE, then ee will be rectangular, and parts with no data will show random framebuffer artifacting. For non-shaped Ecore_Evases, it is recommended to cover the entire evas with a background object.

Since :

3.0

void ecore_evas_show

(

Ecore_Evas *

ee

)

Shows an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas to show.

This function makes ee visible.

Since :

3.0

Examples:

ecore_animator_example.c, ecore_evas_basics_example.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, ecore_imf_example.c, edje-basic.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, eina_tiler_01.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

int ecore_evas_shutdown

(

void

)

Shuts down the Ecore_Evas system.

Returns:

0 if ecore evas is fully shut down, or > 0 if it still being used.

This closes the Evas wrapper system down. Shut down Evas and Ecore libraries.

See also:

ecore_evas_init()

Since :

3.0

Examples:

ecore_animator_example.c, ecore_evas_basics_example.c, ecore_evas_buffer_example_01.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, ecore_imf_example.c, edje-basic.c, edje-box.c, edje-box2.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, edje-text.c, eina_tiler_01.c, evas-aspect-hints.c, evas-box.c, evas-events.c, evas-hints.c, evas-images.c, evas-images2.c, evas-map-utils.c, evas-object-manipulation.c, evas-smart-interface.c, evas-smart-object.c, evas-stacking.c, evas-table.c, and evas-text.c.

void ecore_evas_size_base_get	(	const Ecore_Evas *	ee,
		int *	w,
		int *	h
	)

Gets the base size set for a given Ecore_Evas window.

Parameters:

ee	An Ecore_Evas window's handle
w	A pointer to an int to place the base width in.
h	A pointer to an int to place the base height in.

Note:

Use NULL pointers on the size components you're not interested in: they'll be ignored by the function.

See also:

ecore_evas_size_base_set() for more details

Since :

3.0

void ecore_evas_size_base_set	(	Ecore_Evas *	ee,
		int	w,
		int	h
	)

Sets the base size for a given Ecore_Evas window.

Parameters:

ee	An Ecore_Evas window's handle
w	The base width
h	The base height

This function sets the base size of ee to be w x h. When base sizes are set, they'll be used to calculate a window's minimum size, instead of those set by ecore_evas_size_min_get().

See also:

ecore_evas_size_base_get()

Since :

3.0

Examples:

ecore_evas_window_sizes_example.c.

void ecore_evas_size_max_get	(	const Ecore_Evas *	ee,
		int *	w,
		int *	h
	)

Gets the maximum size set for a given Ecore_Evas window.

Parameters:

ee	An Ecore_Evas window's handle
w	A pointer to an int to place the maximum width in.
h	A pointer to an int to place the maximum height in.

Note:

Use NULL pointers on the size components you're not interested in: they'll be ignored by the function.

See also:

ecore_evas_size_max_set() for more details

Since :

3.0

void ecore_evas_size_max_set	(	Ecore_Evas *	ee,
		int	w,
		int	h
	)

Sets the maximum size of a given Ecore_Evas window.

Parameters:

ee	An Ecore_Evas window's handle
w	The maximum width
h	The maximum height

This function sets the maximum size of ee to be w x h. One won't be able to resize that window to dimensions bigger than the ones set.

See also:

ecore_evas_size_max_get()

Since :

3.0

Examples:

ecore_evas_buffer_example_02.c, and ecore_evas_window_sizes_example.c.

void ecore_evas_size_min_get	(	const Ecore_Evas *	ee,
		int *	w,
		int *	h
	)

Gets the minimum size set for a given Ecore_Evas window.

Parameters:

ee	An Ecore_Evas window's handle
w	A pointer to an int to place the minimum width in.
h	A pointer to an int to place the minimum height in.

Note:

Use NULL pointers on the size components you're not interested in: they'll be ignored by the function.

See also:

ecore_evas_size_min_set() for more details

Since :

3.0

void ecore_evas_size_min_set	(	Ecore_Evas *	ee,
		int	w,
		int	h
	)

Sets the minimum size of a given Ecore_Evas window.

Parameters:

ee	An Ecore_Evas window's handle
w	The minimum width
h	The minimum height

This function sets the minimum size of ee to be w x h. One won't be able to resize that window to dimensions smaller than the ones set.

Note:

When base sizes are set, via ecore_evas_size_base_set(), they'll be used to calculate a window's minimum size, instead of those set by this function.

See also:

ecore_evas_size_min_get()

Since :

3.0

Examples:

ecore_evas_buffer_example_02.c, and ecore_evas_window_sizes_example.c.

void ecore_evas_size_step_get	(	const Ecore_Evas *	ee,
		int *	w,
		int *	h
	)

Gets the "size step" set for a given Ecore_Evas window.

Parameters:

ee	An Ecore_Evas window's handle
w	A pointer to an int to place the step width in.
h	A pointer to an int to place the step height in.

Note:

Use NULL pointers on the size components you're not interested in: they'll be ignored by the function.

See also:

ecore_evas_size_base_set() for more details

Since :

3.0

void ecore_evas_size_step_set	(	Ecore_Evas *	ee,
		int	w,
		int	h
	)

Sets the "size step" for a given Ecore_Evas window.

Parameters:

ee	An Ecore_Evas window's handle
w	The step width
h	The step height

This function sets the size steps of ee to be w x h. This limits the size of this Ecore_Evas window to be always an integer multiple of the step size, for each axis.

Since :

3.0

Examples:

ecore_evas_window_sizes_example.c.

Eina_Bool ecore_evas_sticky_get

(

const Ecore_Evas *

ee

)

Returns the sticky state of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas whose window's sticky state is returned.

Returns:

The Ecore_Evas window's sticky state.

Since :

3.0

void ecore_evas_sticky_set	(	Ecore_Evas *	ee,
		Eina_Bool	sticky
	)

Sets the sticky state of an Ecore_Evas window.

Parameters:

ee	The Ecore_Evas whose window's sticky state is set.
sticky	The Ecore_Evas window's new sticky state.

Since :

3.0

const char* ecore_evas_title_get

(

const Ecore_Evas *

ee

)

Gets the title of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas whose title you wish to get.

Returns:

The title of ee.

This function returns the title of ee.

See also:

ecore_evas_title_set()

Since :

3.0

void ecore_evas_title_set	(	Ecore_Evas *	ee,
		const char *	t
	)

Sets the title of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas whose title you wish to set.
t	The title

This function sets the title of ee to t.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

Examples:

ecore_evas_basics_example.c, ecore_evas_buffer_example_02.c, ecore_evas_callbacks.c, ecore_evas_object_example.c, ecore_evas_window_sizes_example.c, edje-basic.c, edje-box.c, edje-color-class.c, edje-drag.c, edje-perspective.c, edje-signals-messages.c, edje-swallow.c, edje-table.c, and edje-text.c.

Eina_Bool ecore_evas_transparent_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas is transparent.

Parameters:

ee	The Ecore_Evas to query.

Returns:

EINA_TRUE if ee is transparent, EINA_FALSE if it isn't.

See also:

ecore_evas_transparent_set()

Since :

3.0

void ecore_evas_transparent_set	(	Ecore_Evas *	ee,
		Eina_Bool	transparent
	)

Sets whether an Ecore_Evas has an transparent window or not.

Parameters:

ee	The Ecore_Evas to shape
transparent	EINA_TRUE to enable the transparent window, EINA_FALSE to disable it

This function sets some translucency options, for more complete support see ecore_evas_alpha_set().

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_alpha_set()

Since :

3.0

Eina_Bool ecore_evas_urgent_get

(

const Ecore_Evas *

ee

)

Gets the urgent state on the canvas window.

This returns the value set by ecore_evas_urgent_set()

Parameters:

ee	The Ecore_Evas to set

Returns:

The urgent state set

See also:

ecore_evas_urgent_set()

Since (EFL) :

1.2

Since :

3.0

void ecore_evas_urgent_set	(	Ecore_Evas *	ee,
		Eina_Bool	urgent
	)

Sets The urgent hint flag.

Parameters:

ee	The Ecore_Evas
urgent	The urgent state flag

This sets the "urgent" state hint on a window so the desktop environment can highlight it somehow.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.2

Since :

3.0

int ecore_evas_visibility_get

(

const Ecore_Evas *

ee

)

Queries whether an Ecore_Evas' window is visible or not.

Parameters:

ee	The Ecore_Evas to query.

Returns:

1 if visible, 0 if not.

This function queries ee and returns 1 if it is visible, and 0 if not.

See also:

ecore_evas_show()

ecore_evas_hide()

Since :

3.0

Eina_Bool ecore_evas_window_available_profiles_get	(	Ecore_Evas *	ee,
		char ***	profiles,
		unsigned int *	count
	)

Gets the array of available window profiles.

Parameters:

ee	The Ecore_Evas to get available window profiles from.
profiles	Where to return the string array of available window profiles
count	Where to return the number of members in profiles

Returns:

EINA_TRUE if available window profiles exist, EINA_FALSE otherwise

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

Since :

3.0

void ecore_evas_window_available_profiles_set	(	Ecore_Evas *	ee,
		const char **	profiles,
		const unsigned int	count
	)

Sets the array of available window profiles.

Parameters:

ee	The Ecore_Evas to set
profiles	The string array of available window profiles
count	The number of members in profiles

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

Since :

3.0

Ecore_Window ecore_evas_window_get

(

const Ecore_Evas *

ee

)

Returns a pointer to the underlying window.

Parameters:

ee	The Ecore_Evas whose window is desired.

Returns:

A pointer to the underlying window.

Warning:

Support for this depends on the underlying windowing system.

Since :

3.0

const Ecore_Evas* ecore_evas_window_group_get

(

const Ecore_Evas *

ee

)

Gets the canvas group set.

This returns the handle set by ecore_evas_window_group_set().

Parameters:

ee	The Ecore_Evas to set

Returns:

The Canvas group handle

See also:

ecore_evas_window_group_set()

Since (EFL) :

1.2

Since :

3.0

void ecore_evas_window_group_set	(	Ecore_Evas *	ee,
		const Ecore_Evas *	ee_group
	)

Sets another window that this window is a group member of.

Parameters:

ee	The Ecore_Evas
ee_group	The other group member

If ee_group is NULL, ee is removed from the group, otherwise it is added. Note that if you free the ee_group canvas before ee, then getting the group canvas with ecore_evas_window_group_get() will return an invalid handle.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.2

Since :

3.0

const char* ecore_evas_window_profile_get

(

const Ecore_Evas *

ee

)

Gets the window profile.

Parameters:

ee	The Ecore_Evas to get the window profile from.

Returns:

The string value of the window profile, or NULL if none exists

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

Since :

3.0

void ecore_evas_window_profile_set	(	Ecore_Evas *	ee,
		const char *	profile
	)

Sets the window profile.

Parameters:

ee	The Ecore_Evas to set
profile	The string value of the window profile

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

Since :

3.0

Eina_Bool ecore_evas_window_profile_supported_get

(

const Ecore_Evas *

ee

)

Queries if the underlying windowing system supports the window profile.

Parameters:

ee	The Ecore_Evas

Returns:

EINA_TRUE if the window profile is supported, EINA_FALSE otherwise.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.8.0

Since :

3.0

Eina_Bool ecore_evas_withdrawn_get

(

const Ecore_Evas *

ee

)

Returns the withdrawn state of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas whose window's withdrawn state is returned.

Returns:

The Ecore_Evas window's withdrawn state.

Since :

3.0

void ecore_evas_withdrawn_set	(	Ecore_Evas *	ee,
		Eina_Bool	withdrawn
	)

Sets the withdrawn state of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas whose window's withdrawn state is set.
withdrawn	The Ecore_Evas window's new withdrawn state.

Since :

3.0

Eina_Bool ecore_evas_wm_rotation_available_rotations_get	(	const Ecore_Evas *	ee,
		int **	rotations,
		unsigned int *	count
	)

Gets the array of available window rotations.

Parameters:

ee	The Ecore_Evas to get available window rotations from.
rotations	Where to return the integer array of available window rotations
count	Where to return the number of members in rotations

Returns:

EINA_TRUE if available window rotations exist, EINA_FALSE otherwise

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.9.0

Since :

3.0

void ecore_evas_wm_rotation_available_rotations_set	(	Ecore_Evas *	ee,
		const int *	rotations,
		unsigned int	count
	)

Sets the array of available window rotations.

Parameters:

ee	The Ecore_Evas to set
rotations	The integer array of available window rotations
count	The number of members in rotations

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.9.0

Since :

3.0

void ecore_evas_wm_rotation_manual_rotation_done

(

Ecore_Evas *

ee

)

Sets rotation finish manually.

Parameters:

ee	The Ecore_Evas

Since (EFL) :

1.9.0

Since :

3.0

Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get

(

const Ecore_Evas *

ee

)

Gets manual rotation done mode of Ecore_Evas's window.

Parameters:

ee	The Ecore_Evas

Returns:

If true, the manual rotation done mode is enabled

Since (EFL) :

1.9.0

Since :

3.0

void ecore_evas_wm_rotation_manual_rotation_done_set	(	Ecore_Evas *	ee,
		Eina_Bool	set
	)

Sets manual rotation done mode of Ecore_Evas's window.

Parameters:

ee	The Ecore_Evas
set	If true, the window manager will not rotate the Ecore_Evas's window until the rotation done event is received by ecore_evas_wm_rotation_manual_rotation_done. If false, the manual rotation mode is disabled.

Since (EFL) :

1.9.0

Since :

3.0

int ecore_evas_wm_rotation_preferred_rotation_get

(

const Ecore_Evas *

ee

)

Gets the preferred rotation hint.

Parameters:

ee	The Ecore_Evas to get the preferred rotation hint from.

Returns:

The preferred rotation hint, -1 on failure.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.9.0

Since :

3.0

void ecore_evas_wm_rotation_preferred_rotation_set	(	Ecore_Evas *	ee,
		int	rotation
	)

Sets the preferred rotation hint.

Parameters:

ee	The Ecore_Evas to set
rotation	Value to set the preferred rotation hint

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.9.0

Since :

3.0

Eina_Bool ecore_evas_wm_rotation_supported_get

(

const Ecore_Evas *

ee

)

Queries if the underlying windowing system supports the window manager rotation.

Parameters:

ee	The Ecore_Evas

Returns:

EINA_TRUE if the window manager rotation is supported, EINA_FALSE otherwise.

Warning:

Support for this depends on the underlying windowing system.

Since (EFL) :

1.9.0

Since :

3.0