Ecore_Evas (3) - Linux Manuals

Ecore_Evas: Evas wrapper functions.

NAME

Ecore_Evas.h - Evas wrapper functions.

SYNOPSIS

Functions

EAPI int ecore_evas_engine_type_supported_get (Ecore_Evas_Engine_Type engine)
Query if a particular renginering engine target has support.
EAPI int ecore_evas_init (void)
Init the Evas system.
EAPI int ecore_evas_shutdown (void)
Shut down the Evas system.
EAPI Evas_List * ecore_evas_engines_get (void)
Returns a list of supported engines names.
EAPI void ecore_evas_engines_free (Evas_List *engines)
Free list returned by ecore_evas_engines_get().
EAPI Ecore_Evas * ecore_evas_new (const char *engine_name, int x, int y, int w, int h, const char *extra_options)
Creates a new Ecore_Evas based on engine name and common parameters.
EAPI Ecore_Evas * ecore_evas_software_x11_new (const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h)
To be documented.
EAPI Ecore_X_Window ecore_evas_software_x11_window_get (Ecore_Evas *ee)
To be documented.
EAPI Ecore_X_Window ecore_evas_software_x11_subwindow_get (Ecore_Evas *ee)
To be documented.
EAPI void ecore_evas_software_x11_direct_resize_set (Ecore_Evas *ee, int on)
To be documented.
EAPI int ecore_evas_software_x11_direct_resize_get (Ecore_Evas *ee)
To be documented.
EAPI void ecore_evas_software_x11_extra_event_window_add (Ecore_Evas *ee, Ecore_X_Window win)
To be documented.
EAPI Ecore_Evas * ecore_evas_gl_x11_new (const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h)
To be documented.
EAPI Ecore_X_Window ecore_evas_gl_x11_window_get (Ecore_Evas *ee)
To be documented.
EAPI Ecore_X_Window ecore_evas_gl_x11_subwindow_get (Ecore_Evas *ee)
To be documented.
EAPI void ecore_evas_gl_x11_direct_resize_set (Ecore_Evas *ee, int on)
To be documented.
EAPI int ecore_evas_gl_x11_direct_resize_get (Ecore_Evas *ee)
To be documented.
EAPI void ecore_evas_gl_x11_extra_event_window_add (Ecore_Evas *ee, Ecore_X_Window win)
To be documented.
EAPI Ecore_Evas * ecore_evas_xrender_x11_new (const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h)
To be documented.
EAPI Ecore_X_Window ecore_evas_xrender_x11_window_get (Ecore_Evas *ee)
To be documented.
EAPI Ecore_X_Window ecore_evas_xrender_x11_subwindow_get (Ecore_Evas *ee)
To be documented.
EAPI void ecore_evas_xrender_x11_direct_resize_set (Ecore_Evas *ee, int on)
To be documented.
EAPI int ecore_evas_xrender_x11_direct_resize_get (Ecore_Evas *ee)
To be documented.
EAPI void ecore_evas_xrender_x11_extra_event_window_add (Ecore_Evas *ee, Ecore_X_Window win)
To be documented.
EAPI Ecore_Evas * ecore_evas_software_x11_16_new (const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h)
To be documented.
EAPI Ecore_X_Window ecore_evas_software_x11_16_window_get (Ecore_Evas *ee)
To be documented.
EAPI Ecore_X_Window ecore_evas_software_x11_16_subwindow_get (Ecore_Evas *ee)
To be documented.
EAPI void ecore_evas_software_x11_16_direct_resize_set (Ecore_Evas *ee, int on)
To be documented.
EAPI int ecore_evas_software_x11_16_direct_resize_get (Ecore_Evas *ee)
To be documented.
EAPI void ecore_evas_software_x11_16_extra_event_window_add (Ecore_Evas *ee, Ecore_X_Window win)
To be documented.
EAPI Ecore_Evas * ecore_evas_fb_new (char *disp_name, int rotation, int w, int h)
To be documented.
EAPI Ecore_Evas * ecore_evas_buffer_new (int w, int h)
To be documented.
EAPI Ecore_Evas * ecore_evas_ecore_evas_get (Evas *e)
Return the Ecore_Evas for this Evas.
EAPI void ecore_evas_free (Ecore_Evas *ee)
Free an Ecore_Evas.
EAPI void * ecore_evas_data_get (Ecore_Evas *ee, const char *key)
Retrieve user data associated with an Ecore_Evas.
EAPI void ecore_evas_data_set (Ecore_Evas *ee, const char *key, const void *data)
Store user data in an Ecore_Evas structure.
EAPI void ecore_evas_callback_resize_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas resize events.
EAPI void ecore_evas_callback_move_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas move events.
EAPI void ecore_evas_callback_show_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas show events.
EAPI void ecore_evas_callback_hide_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas hide events.
EAPI void ecore_evas_callback_delete_request_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas delete request events.
EAPI void ecore_evas_callback_destroy_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas destroy events.
EAPI void ecore_evas_callback_focus_in_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas focus in events.
EAPI void ecore_evas_callback_focus_out_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas focus out events.
EAPI void ecore_evas_callback_sticky_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas sticky events.
EAPI void ecore_evas_callback_unsticky_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas un-sticky events.
EAPI void ecore_evas_callback_mouse_in_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas mouse in events.
EAPI void ecore_evas_callback_mouse_out_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas mouse out events.
EAPI void ecore_evas_callback_pre_render_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas mouse pre render events.
EAPI void ecore_evas_callback_post_render_set (Ecore_Evas *ee, void(*func)(Ecore_Evas *ee))
Set a callback for Ecore_Evas mouse post render events.
EAPI Evas * ecore_evas_get (Ecore_Evas *ee)
Get an Ecore_Evas's Evas.
EAPI void ecore_evas_move (Ecore_Evas *ee, int x, int y)
Move an Ecore_Evas.
EAPI void ecore_evas_managed_move (Ecore_Evas *ee, int x, int y)
Provide Managed move co-ordinates for an Ecore_Evas.
EAPI void ecore_evas_resize (Ecore_Evas *ee, int w, int h)
Resize an Ecore_Evas.
EAPI void ecore_evas_move_resize (Ecore_Evas *ee, int x, int y, int w, int h)
Resize an Ecore_Evas.
EAPI void ecore_evas_geometry_get (Ecore_Evas *ee, int *x, int *y, int *w, int *h)
Get the geometry of an Ecore_Evas.
EAPI void ecore_evas_rotation_set (Ecore_Evas *ee, int rot)
Set the rotation of an Ecore_Evas' window.
EAPI int ecore_evas_rotation_get (Ecore_Evas *ee)
Set the rotation of an Ecore_Evas' window.
EAPI void ecore_evas_shaped_set (Ecore_Evas *ee, int shaped)
Set whether an Ecore_Evas is shaped or not.
EAPI int ecore_evas_shaped_get (Ecore_Evas *ee)
Query whether an Ecore_Evas is shaped or not.
EAPI void ecore_evas_alpha_set (Ecore_Evas *ee, int alpha)
Set whether an Ecore_Evas has an alpha channel or not.
EAPI int ecore_evas_alpha_get (Ecore_Evas *ee)
Query whether an Ecore_Evas has an alpha channel.
EAPI void ecore_evas_show (Ecore_Evas *ee)
Show an Ecore_Evas' window.
EAPI void ecore_evas_hide (Ecore_Evas *ee)
Hide an Ecore_Evas' window.
EAPI int ecore_evas_visibility_get (Ecore_Evas *ee)
Query whether an Ecore_Evas' window is visible or not.
EAPI void ecore_evas_raise (Ecore_Evas *ee)
Raise and Ecore_Evas' window.
EAPI void ecore_evas_lower (Ecore_Evas *ee)
Lower an Ecore_Evas' window.
EAPI void ecore_evas_activate (Ecore_Evas *ee)
Activate (set focus to, via the window manager) an Ecore_Evas' window.
EAPI void ecore_evas_title_set (Ecore_Evas *ee, const char *t)
Set the title of an Ecore_Evas' window.
EAPI const char * ecore_evas_title_get (Ecore_Evas *ee)
Get the title of an Ecore_Evas' window.
EAPI void ecore_evas_name_class_set (Ecore_Evas *ee, const char *n, const char *c)
Set the name and class of an Ecore_Evas' window.
EAPI void ecore_evas_name_class_get (Ecore_Evas *ee, const char **n, const char **c)
Get the name and class of an Ecore_Evas' window ee The Ecore_Evas to query n A pointer to a string to place the name in.
EAPI void ecore_evas_size_min_set (Ecore_Evas *ee, int w, int h)
Set the min size of an Ecore_Evas' window.
EAPI void ecore_evas_size_min_get (Ecore_Evas *ee, int *w, int *h)
Get the min size of an Ecore_Evas' window.
EAPI void ecore_evas_size_max_set (Ecore_Evas *ee, int w, int h)
Set the max size of an Ecore_Evas' window.
EAPI void ecore_evas_size_max_get (Ecore_Evas *ee, int *w, int *h)
Get the max size of an Ecore_Evas' window.
EAPI void ecore_evas_size_base_set (Ecore_Evas *ee, int w, int h)
Set the base size of an Ecore_Evas' window.
EAPI void ecore_evas_size_base_get (Ecore_Evas *ee, int *w, int *h)
Get the base size of an Ecore_Evas' window.
EAPI void ecore_evas_size_step_set (Ecore_Evas *ee, int w, int h)
Set the step size of an Ecore_Evas.
EAPI void ecore_evas_size_step_get (Ecore_Evas *ee, int *w, int *h)
Get the step size of an Ecore_Evas' window.
EAPI void ecore_evas_cursor_set (Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y)
Set the cursor of an Ecore_Evas.
EAPI void ecore_evas_object_cursor_set (Ecore_Evas *ee, Evas_Object *obj, int layer, int hot_x, int hot_y)
Set the cursor of an Ecore_Evas.
EAPI void ecore_evas_cursor_get (Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y)
Get information about an Ecore_Evas' cursor.
EAPI void ecore_evas_layer_set (Ecore_Evas *ee, int layer)
Set the layer of an Ecore_Evas' window.
EAPI int ecore_evas_layer_get (Ecore_Evas *ee)
Get the layer of an Ecore_Evas' window.
EAPI void ecore_evas_focus_set (Ecore_Evas *ee, int on)
Set the focus of an Ecore_Evas' window.
EAPI int ecore_evas_focus_get (Ecore_Evas *ee)
Query whether an Ecore_Evas' window is focused or not.
EAPI void ecore_evas_iconified_set (Ecore_Evas *ee, int on)
Iconify or uniconify an Ecore_Evas' window.
EAPI int ecore_evas_iconified_get (Ecore_Evas *ee)
Query whether an Ecore_Evas' window is iconified or not.
EAPI void ecore_evas_borderless_set (Ecore_Evas *ee, int on)
Set whether an Ecore_Evas' window is borderless or not.
EAPI int ecore_evas_borderless_get (Ecore_Evas *ee)
Query whether an Ecore_Evas' window is borderless or not.
EAPI void ecore_evas_override_set (Ecore_Evas *ee, int on)
Tell the WM whether or not to ignore an Ecore_Evas' window.
EAPI int ecore_evas_override_get (Ecore_Evas *ee)
Query whether an Ecore_Evas' window is overridden or not.
EAPI void ecore_evas_maximized_set (Ecore_Evas *ee, int on)
Maximize (or unmaximize) an Ecore_Evas' window.
EAPI int ecore_evas_maximized_get (Ecore_Evas *ee)
Query whether an Ecore_Evas' window is maximized or not.
EAPI void ecore_evas_fullscreen_set (Ecore_Evas *ee, int on)
Set whether or not an Ecore_Evas' window is fullscreen.
EAPI int ecore_evas_fullscreen_get (Ecore_Evas *ee)
Query whether an Ecore_Evas' window is fullscreen or not.
EAPI void ecore_evas_avoid_damage_set (Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on)
Set whether or not an Ecore_Evas' window should avoid damage.
EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get (Ecore_Evas *ee)
Query whether an Ecore_Evas' window avoids damage or not.
EAPI void ecore_evas_withdrawn_set (Ecore_Evas *ee, int withdrawn)
Set the withdrawn state of an Ecore_Evas' window.
EAPI int ecore_evas_withdrawn_get (Ecore_Evas *ee)
Returns the withdrawn state of an Ecore_Evas' window.
EAPI void ecore_evas_sticky_set (Ecore_Evas *ee, int sticky)
Set the sticky state of an Ecore_Evas window.
EAPI int ecore_evas_sticky_get (Ecore_Evas *ee)
Returns the sticky state of an Ecore_Evas' window.
EAPI void ecore_evas_ignore_events_set (Ecore_Evas *ee, int ignore)
Set if this evas should ignore events.
EAPI int ecore_evas_ignore_events_get (Ecore_Evas *ee)
Returns the ignore state of an Ecore_Evas' window.

Detailed Description

Evas wrapper functions.

Function Documentation

EAPI void ecore_evas_activate (Ecore_Evas * ee)

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

Parameters:

ee The Ecore_Evas to activate.

This functions activates the Ecore_Evas.

EAPI int ecore_evas_alpha_get (Ecore_Evas * ee)

Query whether an Ecore_Evas has an alpha channel.

Parameters:

ee The Ecore_Evas to query.

Returns:

1 if ee has an alpha channel, 0 if it does not.

This function returns 1 if ee has an alpha channel, and 0 if it does not.

EAPI void ecore_evas_alpha_set (Ecore_Evas * ee, int alpha)

Set whether an Ecore_Evas has an alpha channel or not.

Parameters:

ee The Ecore_Evas to shape
alpha 1 to enable the alpha channel, 0 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 transpararency, as opposed to the 1 bit transparency of a shaped window (a pixel is either opaque, or it's transparent).

EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get (Ecore_Evas * ee)

Query whether an Ecore_Evas' window avoids damage or not.

Parameters:

ee The Ecore_Evas to set

Returns:

1 if ee avoids damage, 0 if not.

EAPI void ecore_evas_avoid_damage_set (Ecore_Evas * ee, Ecore_Evas_Avoid_Damage_Type on)

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

Parameters:

ee The Ecore_Evas
on 1 to avoid damage, 0 to not

This function causes ee to be drawn to a pixmap to avoid recalculations. On expose events it will copy from the pixmap to the window.

EAPI int ecore_evas_borderless_get (Ecore_Evas * ee)

Query whether an Ecore_Evas' window is borderless or not.

Parameters:

ee The Ecore_Evas to set

Returns:

1 if ee is borderless, 0 if not.

EAPI void ecore_evas_borderless_set (Ecore_Evas * ee, int on)

Set whether an Ecore_Evas' window is borderless or not.

Parameters:

ee The Ecore_Evas
on 1 for borderless, 0 for bordered.

This function makes ee borderless if on is 1, or bordered if on is 0.

EAPI Ecore_Evas* ecore_evas_buffer_new (int w, int h)

To be documented.

FIXME: To be fixed.

References ecore_evas_buffer_new().

Referenced by ecore_evas_buffer_new().

EAPI void ecore_evas_callback_delete_request_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_destroy_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_focus_in_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_focus_out_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_hide_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_mouse_in_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_mouse_out_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_move_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_post_render_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_pre_render_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

Set a callback for Ecore_Evas mouse 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.

EAPI void ecore_evas_callback_resize_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_show_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_sticky_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

EAPI void ecore_evas_callback_unsticky_set (Ecore_Evas * ee, void(*)(Ecore_Evas *ee) func)

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

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

Get information about an Ecore_Evas' cursor.

Parameters:

ee The Ecore_Evas to set
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.

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

Set the cursor of an Ecore_Evas.

Parameters:

ee The Ecore_Evas
file The path to an image file for the cursor
layer
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.

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

Retrieve 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

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

Store user data in an Ecore_Evas structure.

Parameters:

eeThe Ecore_Evas to store the user data in.
keyA unique string to associate the user data against. Cannot be NULL.
dataA 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_free

EAPI Ecore_Evas* ecore_evas_ecore_evas_get (Evas * e)

Return the Ecore_Evas for this Evas.

Parameters:

e The Evas to get the Ecore_Evas from

Returns:

The Ecore_Evas that holds this Evas

EAPI int ecore_evas_engine_type_supported_get (Ecore_Evas_Engine_Type engine)

Query if a particular renginering engine target has support.

Parameters:

engine The engine to check support for

Returns:

1 if the particualr engine is supported, 0 if it is not

Query if engine

Parameters:

engine is supported by ecore_evas. 1 is returned if it is, and 0 is returned if it is not supported.

EAPI Evas_List* ecore_evas_engines_get (void)

Returns a list of supported engines names.

Returns:

newly allocated list with engines names. Engines names strings are internal and should be considered constants, do not free them, to avoid problems use ecore_evas_engines_free()

EAPI Ecore_Evas* ecore_evas_fb_new (char * disp_name, int rotation, int w, int h)

To be documented.

FIXME: To be fixed.

References ecore_evas_fb_new(), ecore_fb_callback_gain_set(), ecore_fb_callback_lose_set(), ecore_fb_init(), and ecore_time_get().

Referenced by ecore_evas_fb_new().

EAPI int ecore_evas_focus_get (Ecore_Evas * ee)

Query whether an Ecore_Evas' window is focused or not.

Parameters:

ee The Ecore_Evas to set

Returns:

1 if ee if focused, 0 if not.

EAPI void ecore_evas_focus_set (Ecore_Evas * ee, int on)

Set the focus of an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas
on 1 for focus, 0 to defocus.

This function focuses ee if on is 1, or defocuses ee if on is 0.

EAPI void ecore_evas_free (Ecore_Evas * ee)

Free an Ecore_Evas.

Parameters:

ee The Ecore_Evas to free

This frees up any memory used by the Ecore_Evas.

EAPI int ecore_evas_fullscreen_get (Ecore_Evas * ee)

Query whether an Ecore_Evas' window is fullscreen or not.

Parameters:

ee The Ecore_Evas to set

Returns:

1 if ee is fullscreen, 0 if not.

EAPI void ecore_evas_fullscreen_set (Ecore_Evas * ee, int on)

Set whether or not an Ecore_Evas' window is fullscreen.

Parameters:

ee The Ecore_Evas
on 1 fullscreen, 0 not.

This function causes ee to be fullscreen if on is 1, or not if on is 0.

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

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

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

 

EAPI Evas* ecore_evas_get (Ecore_Evas * ee)

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

EAPI int ecore_evas_gl_x11_direct_resize_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_gl_x11_direct_resize_get().

Referenced by ecore_evas_gl_x11_direct_resize_get().

EAPI void ecore_evas_gl_x11_direct_resize_set (Ecore_Evas * ee, int on)

To be documented.

FIXME: To be fixed.

References ecore_evas_gl_x11_direct_resize_set().

Referenced by ecore_evas_gl_x11_direct_resize_set().

EAPI void ecore_evas_gl_x11_extra_event_window_add (Ecore_Evas * ee, Ecore_X_Window win)

To be documented.

FIXME: To be fixed.

References ecore_evas_gl_x11_extra_event_window_add(), and ecore_evas_software_x11_extra_event_window_add().

Referenced by ecore_evas_gl_x11_extra_event_window_add().

EAPI Ecore_Evas* ecore_evas_gl_x11_new (const char * disp_name, Ecore_X_Window parent, int x, int y, int w, int h)

To be documented.

FIXME: To be fixed.

References ecore_evas_gl_x11_new(), ecore_x_display_get(), ecore_x_init(), and ecore_x_netwm_startup_id_set().

Referenced by ecore_evas_gl_x11_new().

EAPI Ecore_X_Window ecore_evas_gl_x11_subwindow_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_gl_x11_subwindow_get().

Referenced by ecore_evas_gl_x11_subwindow_get().

EAPI Ecore_X_Window ecore_evas_gl_x11_window_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_gl_x11_window_get().

Referenced by ecore_evas_gl_x11_window_get().

EAPI void ecore_evas_hide (Ecore_Evas * ee)

Hide an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to show.

This function makes ee hidden.

EAPI int ecore_evas_iconified_get (Ecore_Evas * ee)

Query whether an Ecore_Evas' window is iconified or not.

Parameters:

ee The Ecore_Evas to set

Returns:

1 if ee is iconified, 0 if not.

EAPI void ecore_evas_iconified_set (Ecore_Evas * ee, int on)

Iconify or uniconify an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas
on 1 to iconify, 0 to uniconify.

This function iconifies ee if on is 1, or uniconifies ee if on is 0.

EAPI int ecore_evas_ignore_events_get (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.

EAPI void ecore_evas_ignore_events_set (Ecore_Evas * ee, int ignore)

Set if this evas should ignore events.

Parameters:

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

EAPI int ecore_evas_init (void)

Init the Evas system.

Returns:

greater than 0 on success, 0 on failure

Set up the Evas wrapper system.

References ECORE_FD_READ, and ecore_main_fd_handler_add().

EAPI int ecore_evas_layer_get (Ecore_Evas * ee)

Get the layer of an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to set

Returns:

the layer ee's window is on.

EAPI void ecore_evas_layer_set (Ecore_Evas * ee, int layer)

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

EAPI void ecore_evas_lower (Ecore_Evas * ee)

Lower an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to raise.

This functions lowers the Ecore_Evas to the back.

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

Provide 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)

EAPI int ecore_evas_maximized_get (Ecore_Evas * ee)

Query whether an Ecore_Evas' window is maximized or not.

Parameters:

ee The Ecore_Evas to set

Returns:

1 if ee is maximized, 0 if not.

EAPI void ecore_evas_maximized_set (Ecore_Evas * ee, int on)

Maximize (or unmaximize) an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas
on 1 to maximize, 0 to unmaximize.

This function maximizes ee if on is 1, or unmaximizes ee if on is 0.

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

Move 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)

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

Resize an Ecore_Evas.

Parameters:

ee The Ecore_Evas to move
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.

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

Get the name and class of an Ecore_Evas' window 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 puts the name of ee into n, and its class into c.

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

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

EAPI Ecore_Evas* ecore_evas_new (const char * engine_name, int x, int y, int w, int h, const char * extra_options)

Creates a new Ecore_Evas based on engine name and common parameters.

Parameters:

engine_name engine name as returned by ecore_evas_engines_get() or NULL to use environment variable ECORE_EVAS_ENGINE, that can be undefined and in this case this call will try to find the first working engine.
x horizontal position of window (not supported in all engines)
y vertical position of window (not supported in all engines)
w width of window
h height of window
extra_options string with extra parameter, dependent on engines or NULL. String is usually in the form: 'key1=value1;key2=value2'. Pay attention that when getting that from shell commands, most consider ';' as the command terminator, so you need to escape it or use quotes.
Ecore_Evas instance or NULL if creation failed.

EAPI void ecore_evas_object_cursor_set (Ecore_Evas * ee, Evas_Object * obj, int layer, int hot_x, int hot_y)

Set the cursor of an Ecore_Evas.

Parameters:

ee The Ecore_Evas
obj The Evas_Object for the cursor
layer
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.

EAPI int ecore_evas_override_get (Ecore_Evas * ee)

Query whether an Ecore_Evas' window is overridden or not.

Parameters:

ee The Ecore_Evas to set

Returns:

1 if ee is overridden, 0 if not.

EAPI void ecore_evas_override_set (Ecore_Evas * ee, int on)

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

Parameters:

ee The Ecore_Evas
on 1 to ignore, 0 to not.

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

EAPI void ecore_evas_raise (Ecore_Evas * ee)

Raise and Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to raise.

This functions raises the Ecore_Evas to the front.

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

Resize 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

EAPI int ecore_evas_rotation_get (Ecore_Evas * ee)

Set the rotation of an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas

Returns:

the angle (in degrees) of rotation.

EAPI void ecore_evas_rotation_set (Ecore_Evas * ee, int rot)

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

EAPI int ecore_evas_shaped_get (Ecore_Evas * ee)

Query whether an Ecore_Evas is shaped or not.

Parameters:

ee The Ecore_Evas to query.

Returns:

1 if shaped, 0 if not.

This function returns 1 if ee is shaped, and 0 if not.

EAPI void ecore_evas_shaped_set (Ecore_Evas * ee, int shaped)

Set whether an Ecore_Evas is shaped or not.

Parameters:

ee The Ecore_Evas to shape
shaped 1 to shape, 0 to not

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

EAPI void ecore_evas_show (Ecore_Evas * ee)

Show an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to show.

This function makes ee visible.

EAPI int ecore_evas_shutdown (void)

Shut down the Evas system.

Returns:

0 if ecore evas is fully shut down, or > 0 if it still needs to be shut down

This closes the Evas system down.

References ecore_main_fd_handler_del().

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

Get the base size of an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to set
w A pointer to an int to place the base width in.
h A pointer to an int to place the base height in.

This function puts the base size of ee into w and h.

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

Set the base size of an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to set
w The base width
h The base height

This function sets the base size of ee to w x h.

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

Get the max size of an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to set
w A pointer to an int to place the max width in.
h A pointer to an int to place the max height in.

This function puts the maximum size of ee into w and h.

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

Set the max size of an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to set
w The maximum width
h The maximum height

This function sets the maximum size of ee to w x h.

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

Get the min size of an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to set
w A pointer to an int to place the min width in.
h A pointer to an int to place the min height in.

This function puts the minimum size of ee into w and h.

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

Set the min size of an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to set
w The minimum width
h The minimum height

This function sets the minimum size of ee to w x h.

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

Get the step size of an Ecore_Evas' window.

Parameters:

ee The Ecore_Evas to set
w A pointer to an int to place the step width in.
h A pointer to an int to place the step height in.

This function puts the step size of ee into w and h.

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

Set the step size of an Ecore_Evas.

Parameters:

ee The Ecore_Evas to set
w The step width
h The step height

This function sets the step size of ee to w x h. This limits the size of an Ecore_Evas to always being an integer multiple of the step size.

EAPI int ecore_evas_software_x11_16_direct_resize_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_16_direct_resize_get().

Referenced by ecore_evas_software_x11_16_direct_resize_get().

EAPI void ecore_evas_software_x11_16_direct_resize_set (Ecore_Evas * ee, int on)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_16_direct_resize_set().

Referenced by ecore_evas_software_x11_16_direct_resize_set().

EAPI void ecore_evas_software_x11_16_extra_event_window_add (Ecore_Evas * ee, Ecore_X_Window win)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_16_extra_event_window_add().

Referenced by ecore_evas_software_x11_16_extra_event_window_add().

EAPI Ecore_Evas* ecore_evas_software_x11_16_new (const char * disp_name, Ecore_X_Window parent, int x, int y, int w, int h)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_16_new(), ecore_x_display_get(), ecore_x_init(), ecore_x_netwm_startup_id_set(), ecore_x_window_argb_new(), ecore_x_window_new(), and ecore_x_window_root_list().

Referenced by ecore_evas_software_x11_16_new().

EAPI Ecore_X_Window ecore_evas_software_x11_16_subwindow_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_16_subwindow_get().

Referenced by ecore_evas_software_x11_16_subwindow_get().

EAPI Ecore_X_Window ecore_evas_software_x11_16_window_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_16_window_get().

Referenced by ecore_evas_software_x11_16_window_get().

EAPI int ecore_evas_software_x11_direct_resize_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_direct_resize_get().

Referenced by ecore_evas_software_x11_direct_resize_get().

EAPI void ecore_evas_software_x11_direct_resize_set (Ecore_Evas * ee, int on)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_direct_resize_set().

Referenced by ecore_evas_software_x11_direct_resize_set().

EAPI void ecore_evas_software_x11_extra_event_window_add (Ecore_Evas * ee, Ecore_X_Window win)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_extra_event_window_add().

Referenced by ecore_evas_gl_x11_extra_event_window_add(), ecore_evas_software_x11_extra_event_window_add(), and ecore_evas_xrender_x11_extra_event_window_add().

EAPI Ecore_Evas* ecore_evas_software_x11_new (const char * disp_name, Ecore_X_Window parent, int x, int y, int w, int h)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_new(), ecore_x_connection_get(), ecore_x_default_screen_get(), ecore_x_display_get(), ecore_x_init(), ecore_x_netwm_startup_id_set(), ecore_x_window_argb_new(), ecore_x_window_new(), and ecore_x_window_root_list().

Referenced by ecore_evas_software_x11_new().

EAPI Ecore_X_Window ecore_evas_software_x11_subwindow_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_subwindow_get().

Referenced by ecore_evas_software_x11_subwindow_get().

EAPI Ecore_X_Window ecore_evas_software_x11_window_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_window_get().

Referenced by ecore_evas_software_x11_window_get().

EAPI int ecore_evas_sticky_get (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.

EAPI void ecore_evas_sticky_set (Ecore_Evas * ee, int sticky)

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

EAPI const char* ecore_evas_title_get (Ecore_Evas * ee)

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

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

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

EAPI int ecore_evas_visibility_get (Ecore_Evas * ee)

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

EAPI int ecore_evas_withdrawn_get (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.

EAPI void ecore_evas_withdrawn_set (Ecore_Evas * ee, int withdrawn)

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

EAPI int ecore_evas_xrender_x11_direct_resize_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_xrender_x11_direct_resize_get().

Referenced by ecore_evas_xrender_x11_direct_resize_get().

EAPI void ecore_evas_xrender_x11_direct_resize_set (Ecore_Evas * ee, int on)

To be documented.

FIXME: To be fixed.

References ecore_evas_xrender_x11_direct_resize_set().

Referenced by ecore_evas_xrender_x11_direct_resize_set().

EAPI void ecore_evas_xrender_x11_extra_event_window_add (Ecore_Evas * ee, Ecore_X_Window win)

To be documented.

FIXME: To be fixed.

References ecore_evas_software_x11_extra_event_window_add(), and ecore_evas_xrender_x11_extra_event_window_add().

Referenced by ecore_evas_xrender_x11_extra_event_window_add().

EAPI Ecore_Evas* ecore_evas_xrender_x11_new (const char * disp_name, Ecore_X_Window parent, int x, int y, int w, int h)

To be documented.

FIXME: To be fixed.

References ecore_evas_xrender_x11_new(), ecore_x_connection_get(), ecore_x_default_screen_get(), ecore_x_display_get(), ecore_x_init(), ecore_x_netwm_startup_id_set(), ecore_x_window_new(), and ecore_x_window_root_list().

Referenced by ecore_evas_xrender_x11_new().

EAPI Ecore_X_Window ecore_evas_xrender_x11_subwindow_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_xrender_x11_subwindow_get().

Referenced by ecore_evas_xrender_x11_subwindow_get().

EAPI Ecore_X_Window ecore_evas_xrender_x11_window_get (Ecore_Evas * ee)

To be documented.

FIXME: To be fixed.

References ecore_evas_xrender_x11_window_get().

Referenced by ecore_evas_xrender_x11_window_get().

Author

Generated automatically by Doxygen for Ecore from the source code.