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.

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

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

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.

See also:

ecore_evas_alpha_set()

Since :

3.0

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

Get the compositing synchronization state.

Deprecated:

Deprecated since 6.0 DO NOT USE.

Returns:

True if app comp sync is enabled.

Since :

3.0

Sets application compositor synchronization on/off.

Deprecated:

Deprecated since 6.0 DO NOT USE.

Turns on client+server synchronized rendering in X11. App comp sync is disabled by default, but can be turned on optionally.

Parameters:

do_sync

True to enable comp syncing, False to disable

Since :

3.0

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

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

Since :

4.0

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

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

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

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

Gets the list of allowed auxiliary hint IDs.

Parameters:

ee	The Ecore_Evas

Returns:

List of allowed auxiliary hint IDs.

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

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 a specific hint on 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 hints within the Ecore_Evas has this format: ID:HINT:VALUE,ID:HINT:VALUE,...

Since (EFL) :

1.10.0

Since :

3.0

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

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

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

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 parent.

Since (EFL) :

1.13

Since :

3.0

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

Since (EFL) :

1.12

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.

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.

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.

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.

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.

Note:

This function only reports focus in events for the default seat!

See also:

ecore_evas_callback_focus_device_in_set()

Since :

3.0

Examples:

ecore_evas_callbacks.c.

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.

Note:

This function only reports focus in events for the default seat!

See also:

ecore_evas_callback_focus_device_out_set()

Since :

3.0

Examples:

ecore_evas_callbacks.c.

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.

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.

Note:

the func will only report events for the default mouse.

Warning:

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

See also:

ecore_evas_callback_device_mouse_in_set

Since :

3.0

Examples:

ecore_evas_callbacks.c.

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.

Note:

the func will only report events for the default mouse.

Warning:

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

See also:

ecore_evas_callback_device_mouse_out_set

Since :

3.0

Examples:

ecore_evas_callbacks.c.

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.

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 arrive

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

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 arrive.

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

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.

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.

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.

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.

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.

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.

Warning:

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

Since (EFL) :

1.2

Since :

3.0

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

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

Gets the comp sync state.

Deprecated:

Deprecated since 6.0 DO NOT USE.

Parameters:

ee	An Ecore_Evas handle

Returns:

True if composition synchronization is enabled, False otherwise

Since :

3.0

Sets comp syncing to enabled/disabled.

Deprecated:

Deprecated since 6.0 DO NOT USE.

Parameters:

ee	An Ecore_Evas handle
do_sync	True to enable comp syncing, False to disable

Turns on client+server synchronized rendering in X11. Comp sync is disabled by default, but can be turned on optionally. Can also be set via the ECORE_EVAS_COMP_NOSYNC / ECORE_EVAS_COMP_SYNC environmental variables.

Since :

3.0

Gets information about an Ecore_Evas' default pointer device.

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.

Sets the cursor for the default pointer device.

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 deleted with Ecore_Evas.

Note:

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

Warning:

Previously set cursor will be deleted.

See also:

ecore_evas_object_cursor_set()

ecore_evas_cursor_unset()

Since :

3.0

Unsets the cursor of the default pointer device.

Parameters:

ee	The Ecore_Evas to unset the cursor.

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.

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.

Returns:

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

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

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.

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.

Since :

3.0

Since :

3.0

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.

Queries whether the default seat has the Ecore_Evas focus.

Parameters:

ee	The Ecore_Evas to set

Returns:

EINA_TRUE if ee if focused, EINA_FALSE if not.

See also:

ecore_evas_focus_set()

ecore_evas_focus_device_get()

Since :

3.0

Sets the Ecore_Evas window focus for the default seat.

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.

See also:

ecore_evas_focus_device_set()

Since :

3.0

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

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

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.

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

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

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 are not desired you may pass NULL for 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.

Gets an Ecore_Evas's Evas.

Parameters:

ee	The Ecore_Evas whose Evas you wish to get

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.

Gets the window from Ecore_Evas using opengl x11.

Parameters:

ee	The Ecore_Evas from which to get the window.

Returns:

The window of type Ecore_X_Window of Ecore_Evas.

Note:

If ecore is not compiled with support for x11 or if ee was not created with ecore_evas_gl_x11_new() then nothing is done and 0 is returned.

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.

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

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

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

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

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.

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

Gets the name and class of an Ecore_Evas' window.

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.

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

See also:

ecore_evas_name_class_set()

Since :

3.0

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

Sets the coordinates of the mouse pointer.

Parameters:

ee	The Ecore_Evas containing the pointer
x	The horizontal coordinate to move the pointer to
y	The vertical coordinate to move the pointer to

Returns:

EINA_TRUE on success, EINA_FALSE on failure.

Since (EFL) :

1.8

Since :

3.0

Retrieves the coordinates of the default mouse pointer.

Parameters:

ee	The Ecore_Evas containing the pointer
x	Pointer to integer to store horizontal coordinate. May be NULL.
y	Pointer to integer to store vertical coordinate. May be NULL.

See also:

ecore_evas_pointer_device_xy_get

Since (EFL) :

1.8

Since :

3.0

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

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 are not desired you may pass NULL for 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

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.

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

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

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 content so that it fits inside the current window geometry.

Warning:

Support for this depends on the underlying windowing system.

See also:

ecore_evas_rotation_set()

Since :

3.0

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

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.

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.

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.

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

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.

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

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.

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

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.

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

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.

Gets the title of an Ecore_Evas' window.

Parameters:

ee	The Ecore_Evas whose title you wish to get.

Returns:

The title of ee.

See also:

ecore_evas_title_set()

Since :

3.0

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.

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

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

Queries whether an Ecore_Evas' window is visible or not.

Parameters:

ee	The Ecore_Evas to query.

Returns:

1 if ee is visible, 0 if not.

See also:

ecore_evas_show()

ecore_evas_hide()

Since :

3.0

Create an Ecore_Evas window using the wayland-shm engine.

Parameters:

disp_name	Name of the Wayland display to connect to.
parent	ID of the parent window this Ecore_Evas window belongs to, or 0 if this is a top-level window.
x	Horizontal position of the Ecore_Evas window.
y	Vertical position of the Ecore_Evas window.
w	Width of the Ecore_Evas window to be created.
h	Height of the Ecore_Evas window to be created.
frame	Deprecated. (Just pass EINA_FALSE.)

Returns:

Ecore_Evas instance or NULL if creation failed.

Wayland's Shared Memory (SHM) rendering model stores client-drawn data in system memory buffers for communication with the display server. The server then copies the buffer from system memory to the video output as appropriate. This routine constructs an Ecore_Evas window object that uses SHM buffers for communication using the Wayland protocol.

See also:

ecore_evas_new()

ecore_evas_wayland_egl_new()

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

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

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

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

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

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

Sets rotation finish manually.

Parameters:

ee	The Ecore_Evas

Since (EFL) :

1.9.0

Since :

3.0

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

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

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

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

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