Tizen Native API
5.5
|
Ecore evas is a set of functions that make 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:
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_app_comp_sync_set (Eina_Bool do_sync) |
Sets application compositor synchronization on/off. | |
Eina_Bool | ecore_evas_app_comp_sync_get (void) |
Get the compositing synchronization state. | |
Eina_List * | ecore_evas_engines_get (void) |
Returns a list of supported engine names. | |
void | ecore_evas_engines_free (Eina_List *engines) |
Free list returned by ecore_evas_engines_get() | |
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. | |
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 Ecore_Evas window focus for the default seat. | |
Eina_Bool | ecore_evas_focus_get (const Ecore_Evas *ee) |
Queries whether the default seat has the Ecore_Evas focus. | |
void | ecore_evas_focus_device_set (Ecore_Evas *ee, Eo *seat, Eina_Bool on) |
Sets the Ecore_Evas windows focus for a given seat. | |
Eina_Bool | ecore_evas_focus_device_get (const Ecore_Evas *ee, Eo *seat) |
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 IDs. | |
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_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_software_x11_new (const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h) |
Creates Ecore_Evas using software x11. | |
Ecore_X_Window | ecore_evas_software_x11_window_get (const Ecore_Evas *ee) |
Gets the window from Ecore_Evas using software x11. | |
void | ecore_evas_software_x11_direct_resize_set (Ecore_Evas *ee, Eina_Bool on) |
Sets the direct_resize of Ecore_Evas using software x11. | |
Eina_Bool | ecore_evas_software_x11_direct_resize_get (const Ecore_Evas *ee) |
Gets if the Ecore_Evas is being directly resized using software x11. | |
void | ecore_evas_software_x11_extra_event_window_add (Ecore_Evas *ee, Ecore_X_Window win) |
Adds an extra window on Ecore_Evas using software x11. | |
Ecore_Evas * | ecore_evas_software_x11_pixmap_new (const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h) |
Creates a new Ecore_Evas which does not contain an XWindow. It will only contain an XPixmap to render to. | |
Ecore_X_Pixmap | ecore_evas_software_x11_pixmap_get (const Ecore_Evas *ee) |
Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas. | |
Ecore_Evas * | ecore_evas_gl_x11_new (const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h) |
Creates Ecore_Evas using opengl x11. | |
Ecore_Evas * | ecore_evas_gl_x11_options_new (const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h, const int *opt) |
Create Ecore_Evas using OpenGL X11, with options. | |
Ecore_X_Window | ecore_evas_gl_x11_window_get (const Ecore_Evas *ee) |
Gets the window from Ecore_Evas using opengl x11. | |
void | ecore_evas_gl_x11_direct_resize_set (Ecore_Evas *ee, Eina_Bool on) |
Sets direct_resize for Ecore_Evas using opengl x11. | |
Eina_Bool | ecore_evas_gl_x11_direct_resize_get (const Ecore_Evas *ee) |
Gets if the Ecore_Evas is being directly resized using opengl x11. | |
void | ecore_evas_gl_x11_extra_event_window_add (Ecore_Evas *ee, Ecore_X_Window win) |
Adds extra window on Ecore_Evas using opengl x11. | |
void | ecore_evas_gl_x11_pre_post_swap_callback_set (const Ecore_Evas *ee, void *data, void(*pre_cb)(void *data, Evas *e), void(*post_cb)(void *data, Evas *e)) |
Sets the functions to be used before and after the swap callback. | |
Ecore_Evas * | ecore_evas_gl_x11_pixmap_new (const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h) |
Creates a new Ecore_Evas which does not contain an XWindow. It will only contain an XPixmap to render to. | |
Ecore_X_Pixmap | ecore_evas_gl_x11_pixmap_get (const Ecore_Evas *ee) |
Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas. | |
Ecore_Evas * | ecore_evas_fb_new (const char *disp_name, int rotation, int w, int h) |
Creates Ecore_Evas using fb backend. | |
Ecore_Evas * | ecore_evas_wayland_shm_new (const char *disp_name, unsigned int parent, int x, int y, int w, int h, Eina_Bool frame) |
Create an Ecore_Evas window using the wayland-shm engine. | |
Ecore_Evas * | ecore_evas_wayland_egl_new (const char *disp_name, unsigned int parent, int x, int y, int w, int h, Eina_Bool frame) |
Create an Ecore_Evas window using the wayland-egl engine. | |
void | ecore_evas_wayland_resize (Ecore_Evas *ee, int location) |
Begin resizing the Ecore_Evas window. | |
void | ecore_evas_wayland_move (Ecore_Evas *ee, int x, int y) |
Begin moving the Ecore_Evas window. | |
void | ecore_evas_wayland_pointer_set (Ecore_Evas *ee, int hot_x, int hot_y) |
Set the pointer for the Ecore_Evas window. | |
void | ecore_evas_wayland_type_set (Ecore_Evas *ee, int type) |
Set the type of the Ecore_Evas window. | |
Ecore_Wl_Window * | ecore_evas_wayland_window_get (const Ecore_Evas *ee) |
Gets the window from Ecore_Evas using the wayland backend. | |
Ecore_Wl2_Window * | ecore_evas_wayland2_window_get (const Ecore_Evas *ee) |
Gets the window from Ecore_Evas using the wayland2 backend. | |
Ecore_Cocoa_Window * | ecore_evas_cocoa_window_get (const Ecore_Evas *ee) |
Gets the window from Ecore_Evas using the opengl_cocoa backend. | |
Ecore_Evas * | ecore_evas_drm_new (const char *device, unsigned int parent, int x, int y, int w, int h) |
Create an Ecore_Evas window using the drm engine. | |
Ecore_Evas * | ecore_evas_gl_drm_new (const char *device, unsigned int parent, int x, int y, int w, int h) |
Create an Ecore_Evas window using the drm engine with GL support. | |
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_ews_new (int x, int y, int w, int h) |
Creates a new Ecore_Evas canvas bound to the Evas ews (Ecore + Evas Single Process Windowing System) engine. | |
Evas_Object * | ecore_evas_ews_backing_store_get (const Ecore_Evas *ee) |
Returns the backing store image object that represents the given window in EWS. | |
void | ecore_evas_ews_delete_request (Ecore_Evas *ee) |
Calls the window to be deleted (freed), but can let user decide to forbid it by using ecore_evas_callback_delete_request_set(). | |
Evas_Object * | ecore_evas_object_image_new (Ecore_Evas *ee_target) |
Creates an Evas image object with image data bound to an own, internal Ecore_Evas canvas wrapper | |
Ecore_Evas * | ecore_evas_object_ecore_evas_get (Evas_Object *obj) |
Retrieve the internal Ecore_Evas handle of an image object created via ecore_evas_object_image_new(). | |
Evas * | ecore_evas_object_evas_get (Evas_Object *obj) |
Retrieve the canvas bound to the internal Ecore_Evas handle of an image object created via ecore_evas_object_image_new() | |
Ecore_Evas * | ecore_evas_software_gdi_new (Ecore_Win32_Window *parent, int x, int y, int width, int height) |
Creates a new Ecore_Evas canvas bound to the Evas gdi (software) engine. | |
Ecore_Evas * | ecore_evas_software_ddraw_new (Ecore_Win32_Window *parent, int x, int y, int width, int height) |
Creates a new Ecore_Evas canvas bound to the Evas DirectDraw (software) engine. | |
Ecore_Evas * | ecore_evas_sdl_new (const char *name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha) |
Creates a new Ecore_Evas canvas bound to the Evas SDL engine. | |
Ecore_Evas * | ecore_evas_gl_sdl_new (const char *name, int w, int h, int fullscreen, int noframe) |
Creates a new Ecore_Evas canvas bound to the Evas SDL + gl engine. | |
Ecore_Evas * | ecore_evas_cocoa_new (Ecore_Cocoa_Window *parent, int x, int y, int w, int h) |
Creates a new Ecore_Evas canvas bound to the Evas Cocoa engine. | |
Ecore_Evas * | ecore_evas_psl1ght_new (const char *name, int w, int h) EINA_DEPRECATED |
Creates a new Ecore_Evas canvas bound to the Evas psl1ght engine. | |
const char * | ecore_evas_engine_name_get (const Ecore_Evas *ee) |
Gets the engine name used by this Ecore_Evas(window). | |
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_focus_device_in_set (Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func) |
Sets a callback for Ecore_Evas focus in events. | |
void | ecore_evas_callback_focus_device_out_set (Ecore_Evas *ee, Ecore_Evas_Focus_Device_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_device_mouse_in_set (Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func) |
Sets a callback for Ecore_Evas mouse in events. | |
void | ecore_evas_callback_device_mouse_out_set (Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func) |
Sets a callback for Ecore_Evas mouse out 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 for the default pointer device. | |
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' default pointer device. | |
void | ecore_evas_object_cursor_set (Ecore_Evas *ee, Evas_Object *obj, int layer, int hot_x, int hot_y) |
Sets the cursor for the default pointer device. | |
Evas_Object * | ecore_evas_cursor_unset (Ecore_Evas *ee) |
Unsets the cursor of the default pointer device. | |
Evas_Object * | ecore_evas_cursor_device_unset (Ecore_Evas *ee, Efl_Input_Device *pointer) |
Unsets the cursor of the specified pointer device. | |
void | ecore_evas_object_cursor_device_set (Ecore_Evas *ee, Efl_Input_Device *pointer, Evas_Object *obj, int layer, int hot_x, int hot_y) |
Sets the cursor of an Ecore_Evas specified pointer device. | |
Eina_Bool | ecore_evas_cursor_device_get (const Ecore_Evas *ee, Efl_Input_Device *pointer, Evas_Object **obj, int *layer, int *hot_x, int *hot_y) |
Gets information about an Ecore_Evas' specified pointer device. | |
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_register_with_multi2 (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_comp_sync_set (Ecore_Evas *ee, Eina_Bool do_sync) |
Sets comp syncing to enabled/disabled. | |
Eina_Bool | ecore_evas_comp_sync_get (const Ecore_Evas *ee) |
Gets the comp sync state. | |
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. | |
void | ecore_evas_draw_frame_set (Ecore_Evas *ee, Eina_Bool draw_frame) EINA_DEPRECATED |
Eina_Bool | ecore_evas_draw_frame_get (const Ecore_Evas *ee) EINA_DEPRECATED |
void | ecore_evas_shadow_geometry_set (Ecore_Evas *ee, int x, int y, int w, int h) |
Sets shadow geometry for client-side decorations. | |
void | ecore_evas_shadow_geometry_get (const Ecore_Evas *ee, int *x, int *y, int *w, int *h) |
Gets shadow geometry for client-side decorations. | |
Eina_Bool | ecore_evas_object_associate (Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags) |
Associates the given object to this ecore evas. | |
Eina_Bool | ecore_evas_object_dissociate (Ecore_Evas *ee, Evas_Object *obj) |
Cancels the association set with ecore_evas_object_associate(). | |
Evas_Object * | ecore_evas_object_associate_get (const Ecore_Evas *ee) |
Gets the object associated with ee . | |
Eina_List * | ecore_evas_ecore_evas_list_get (void) |
Gets a list of all the ecore_evases. | |
Eina_List * | ecore_evas_sub_ecore_evas_list_get (const Ecore_Evas *ee) |
Gets a list of all the sub ecore_evases. | |
void | ecore_evas_x11_leader_set (Ecore_Evas *ee, Ecore_X_Window win) |
Set the window's client leader. | |
Ecore_X_Window | ecore_evas_x11_leader_get (Ecore_Evas *ee) |
Get the client leader. | |
void | ecore_evas_x11_leader_default_set (Ecore_Evas *ee) |
Reset the client leader to default. | |
void | ecore_evas_x11_shape_input_rectangle_set (Ecore_Evas *ee, int x, int y, int w, int h) |
Set the rectangular region that can "contain" the pointer, replacing any previously set region. | |
void | ecore_evas_x11_shape_input_rectangle_add (Ecore_Evas *ee, int x, int y, int w, int h) |
Extends the pointer containment region to the union of the new and existing input rectangle. | |
void | ecore_evas_x11_shape_input_rectangle_subtract (Ecore_Evas *ee, int x, int y, int w, int h) |
Modifies the pointer containment region to subtract a rectangular region from it. | |
void | ecore_evas_x11_shape_input_empty (Ecore_Evas *ee) |
Disables input for the window. | |
void | ecore_evas_x11_shape_input_reset (Ecore_Evas *ee) |
Unsets the pointer containment for the window. | |
void | ecore_evas_x11_shape_input_apply (Ecore_Evas *ee) |
Applies the pointer containment region to the client window. | |
void | ecore_evas_callback_new_set (Evas *(*func)(int w, int h)) |
Sets a callback for building new Evas. |
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.
void ecore_evas_activate | ( | Ecore_Evas * | ee | ) |
Activates (set focus to, via the window manager) an Ecore_Evas' window.
ee | The Ecore_Evas to activate. |
This functions activates the Ecore_Evas.
Eina_Bool ecore_evas_alpha_get | ( | const Ecore_Evas * | ee | ) |
Queries whether an Ecore_Evas has an alpha channel.
ee | The Ecore_Evas to query. |
EINA_TRUE
if ee has an alpha channel, EINA_FALSE
if it does not.void ecore_evas_alpha_set | ( | Ecore_Evas * | ee, |
Eina_Bool | alpha | ||
) |
Sets whether an Ecore_Evas has an alpha channel or not.
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).
Eina_Bool ecore_evas_app_comp_sync_get | ( | void | ) |
Get the compositing synchronization state.
void ecore_evas_app_comp_sync_set | ( | Eina_Bool | do_sync | ) |
Sets application compositor synchronization on/off.
Turns on client+server synchronized rendering in X11. App comp sync is disabled by default, but can be turned on optionally.
do_sync | True to enable comp syncing, False to disable |
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().
ee | The Ecore_Evas to set |
void ecore_evas_aspect_set | ( | Ecore_Evas * | ee, |
double | aspect | ||
) |
Sets the aspect ratio of a canvas window.
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
int ecore_evas_aux_hint_add | ( | Ecore_Evas * | ee, |
const char * | hint, | ||
const char * | val | ||
) |
Creates an auxiliary hint of the Ecore_Evas.
ee | The Ecore_Evas |
hint | The auxiliary hint string. |
val | The value string. |
-1
on failure.Eina_Bool ecore_evas_aux_hint_del | ( | Ecore_Evas * | ee, |
const int | id | ||
) |
Deletes an auxiliary hint of the Ecore_Evas.
ee | The Ecore_Evas |
id | The ID of the auxiliary hint. |
EINA_TRUE
if no error occurred, EINA_FALSE
otherwise.int ecore_evas_aux_hint_id_get | ( | const Ecore_Evas * | ee, |
const char * | hint | ||
) |
Gets a ID of the auxiliary hint string.
ee | The Ecore_Evas |
hint | The auxiliary hint string. |
-1
if none existsconst char* ecore_evas_aux_hint_val_get | ( | const Ecore_Evas * | ee, |
int | id | ||
) |
Gets a value of the auxiliary hint.
ee | The Ecore_Evas |
id | The auxiliary hint ID. |
Eina_Bool ecore_evas_aux_hint_val_set | ( | Ecore_Evas * | ee, |
const int | id, | ||
const char * | val | ||
) |
Changes a value of the auxiliary hint.
ee | The Ecore_Evas |
id | The auxiliary hint ID. |
val | The value string to be set. |
EINA_TRUE
if no error occurred, EINA_FALSE
otherwise.Eina_List* ecore_evas_aux_hints_allowed_get | ( | const Ecore_Evas * | ee | ) |
Gets the list of allowed auxiliary hint IDs.
ee | The Ecore_Evas |
const Eina_List* ecore_evas_aux_hints_supported_get | ( | const Ecore_Evas * | ee | ) |
Gets the list of supported auxiliary hint strings.
ee | The Ecore_Evas |
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,...
Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get | ( | const Ecore_Evas * | ee | ) |
Queries whether an Ecore_Evas' window avoids damage or not.
ee | The Ecore_Evas to set |
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.
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:
Eina_Bool ecore_evas_borderless_get | ( | const Ecore_Evas * | ee | ) |
Queries whether an Ecore_Evas' window is borderless or not.
ee | The Ecore_Evas to set |
EINA_TRUE
if ee
is borderless, EINA_FALSE
if not.void ecore_evas_borderless_set | ( | Ecore_Evas * | ee, |
Eina_Bool | on | ||
) |
Sets whether an Ecore_Evas' window is borderless or not.
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
.
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.
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 |
Ecore_Evas
instance or NULL
, on failureThis 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.
w
and h
sizes have to greater or equal to 1. Otherwise, they'll be interpreted as 1, exactly.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.
ee | An Ecore_Evas handle |
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.
Ecore_Evas* ecore_evas_buffer_new | ( | int | w, |
int | h | ||
) |
Creates a new Ecore_Evas
canvas bound to the Evas buffer engine.
w | The width of the canvas, in pixels |
h | The height of the canvas, in pixels |
Ecore_Evas
instance or NULL
, on failureThis 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.
malloc()
and free()
to the memory allocation and freeing functions. See that function's documentation for more details. 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.
ee | An Ecore_Evas handle |
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.
void ecore_evas_callback_delete_request_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas delete request events.
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.
void ecore_evas_callback_destroy_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas destroy events.
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.
void ecore_evas_callback_device_mouse_in_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Mouse_IO_Cb | func | ||
) |
Sets a callback for Ecore_Evas mouse in events.
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
.
void ecore_evas_callback_device_mouse_out_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Mouse_IO_Cb | func | ||
) |
Sets a callback for Ecore_Evas mouse out events.
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
.
void ecore_evas_callback_focus_device_in_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Focus_Device_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas focus in events.
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.
void ecore_evas_callback_focus_device_out_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Focus_Device_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas focus out events.
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.
void ecore_evas_callback_focus_in_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas focus in events.
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.
void ecore_evas_callback_focus_out_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas focus out events.
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.
void ecore_evas_callback_hide_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas hide events.
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.
void ecore_evas_callback_mouse_in_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas mouse in events.
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
.
func
will only report events for the default mouse. void ecore_evas_callback_mouse_out_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas mouse out events.
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
.
func
will only report events for the default mouse. void ecore_evas_callback_move_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas move events.
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.
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.
ee | The Ecore_Evas to set callbacks on |
func_handle | The handle to be called when message arrive |
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.
ee | The Ecore_Evas to set callbacks on |
func_parent_handle | The handle to be called when message arrive. |
void ecore_evas_callback_new_set | ( | Evas *(*)(int w, int h) | func | ) |
Sets a callback for building new Evas.
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 a new Ecore_Evas is created.
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.
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.
void ecore_evas_callback_pre_free_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas pre-free event.
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.
void ecore_evas_callback_pre_render_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas pre-render events.
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.
void ecore_evas_callback_resize_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas resize events.
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.
void ecore_evas_callback_show_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas show events.
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.
void ecore_evas_callback_state_change_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas state changes.
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.
void ecore_evas_callback_sticky_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas sticky events.
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.
void ecore_evas_callback_unsticky_set | ( | Ecore_Evas * | ee, |
Ecore_Evas_Event_Cb | func | ||
) |
Sets a callback for Ecore_Evas un-sticky events.
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.
Ecore_Evas* ecore_evas_cocoa_new | ( | Ecore_Cocoa_Window * | parent, |
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Creates a new Ecore_Evas
canvas bound to the Evas Cocoa engine.
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 window, in pixels |
y | Vertical position of window, in pixels |
w | Width of the canvas, in pixels. |
h | Height of the canvas, in pixels. |
The cocoa backend is used for MacOS based systems.
Ecore_Cocoa_Window* ecore_evas_cocoa_window_get | ( | const Ecore_Evas * | ee | ) |
Gets the window from Ecore_Evas using the opengl_cocoa backend.
ee | The Ecore_Evas from which to get the window. |
ee
was not created with ecore_evas_cocoa_new() then nothing is done and NULL is returned.Eina_Bool ecore_evas_comp_sync_get | ( | const Ecore_Evas * | ee | ) |
Gets the comp sync state.
ee | An Ecore_Evas handle |
void ecore_evas_comp_sync_set | ( | Ecore_Evas * | ee, |
Eina_Bool | do_sync | ||
) |
Sets comp syncing to enabled/disabled.
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.
Eina_Bool ecore_evas_cursor_device_get | ( | const Ecore_Evas * | ee, |
Efl_Input_Device * | pointer, | ||
Evas_Object ** | obj, | ||
int * | layer, | ||
int * | hot_x, | ||
int * | hot_y | ||
) |
Gets information about an Ecore_Evas' specified pointer device.
ee | The Ecore_Evas |
pointer | A pointer device to set the cursor. Use NULL for the default. |
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.
Evas_Object* ecore_evas_cursor_device_unset | ( | Ecore_Evas * | ee, |
Efl_Input_Device * | pointer | ||
) |
Unsets the cursor of the specified pointer device.
ee | The Ecore_Evas to unset the cursor. |
pointer | A pointer device to set the cursor. Use NULL for the default. |
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.
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' default pointer device.
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.
void ecore_evas_cursor_set | ( | Ecore_Evas * | ee, |
const char * | file, | ||
int | layer, | ||
int | hot_x, | ||
int | hot_y | ||
) |
Sets the cursor for the default pointer device.
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.
Evas_Object* ecore_evas_cursor_unset | ( | Ecore_Evas * | ee | ) |
Unsets the cursor of the default pointer device.
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.
void* ecore_evas_data_get | ( | const Ecore_Evas * | ee, |
const char * | key | ||
) |
Retrieves user data associated with an Ecore_Evas.
ee | The Ecore_Evas to retrieve the user data from. |
key | The key which the user data to be retrieved is associated with. |
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().
void ecore_evas_data_set | ( | Ecore_Evas * | ee, |
const char * | key, | ||
const void * | data | ||
) |
Stores user data in an Ecore_Evas structure.
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.
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().
ee | The Ecore_Evas to set |
void ecore_evas_demand_attention_set | ( | Ecore_Evas * | ee, |
Eina_Bool | demand | ||
) |
Sets the "i demand attention" flag on a canvas window.
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.
Eina_Bool ecore_evas_draw_frame_get | ( | const Ecore_Evas * | ee | ) |
void ecore_evas_draw_frame_set | ( | Ecore_Evas * | ee, |
Eina_Bool | draw_frame | ||
) |
Ecore_Evas* ecore_evas_drm_new | ( | const char * | device, |
unsigned int | parent, | ||
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Create an Ecore_Evas window using the drm engine.
disp_name | Name of the Wayland display to connect to. |
parent | (Unused) |
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. |
NULL
if creation failed.Creates an Ecore_Evas window using the Direct Rendering Manager (DRM) backend. DRM is a kernel-level module providing direct graphic hardware access, bypassing the GL stack entirely.
Ecore_Evas* ecore_evas_ecore_evas_get | ( | const Evas * | e | ) |
Returns the Ecore_Evas for this Evas.
e | The Evas to get the Ecore_Evas from |
NULL
if not held by one.Eina_List* ecore_evas_ecore_evas_list_get | ( | void | ) |
Gets a list of all the ecore_evases.
The returned list of ecore evases is only valid until the canvases are destroyed (and should not be cached for instance). The list can be freed by just deleting the list.
const char* ecore_evas_engine_name_get | ( | const Ecore_Evas * | ee | ) |
Gets the engine name used by this Ecore_Evas(window).
ee | Ecore_Evas whose engine's name is desired |
void ecore_evas_engines_free | ( | Eina_List * | engines | ) |
Free list returned by ecore_evas_engines_get()
engines | List with engine names |
Eina_List* ecore_evas_engines_get | ( | void | ) |
Returns a list of supported engine names.
Evas_Object* ecore_evas_ews_backing_store_get | ( | const Ecore_Evas * | ee | ) |
Returns the backing store image object that represents the given window in EWS.
ee | The Ecore_Evas from which to get the backing store. |
void ecore_evas_ews_delete_request | ( | Ecore_Evas * | ee | ) |
Calls the window to be deleted (freed), but can let user decide to forbid it by using ecore_evas_callback_delete_request_set().
ee | The Ecore_Evas for which window will be deleted. |
Ecore_Evas* ecore_evas_ews_new | ( | int | x, |
int | y, | ||
int | w, | ||
int | h | ||
) |
Creates a new Ecore_Evas
canvas bound to the Evas ews (Ecore + Evas Single Process Windowing System) engine.
EWS is a simple single process windowing system. The backing store is also an Ecore_Evas
that can be setup with ecore_evas_ews_setup() and retrieved with ecore_evas_ews_ecore_evas_get(). It will allow window management using events prefixed with ECORE_EVAS_EVENT_EWS_
.
The EWS windows (returned by this function or ecore_evas_new("ews"...)) will all be software buffer windows automatic rendered to the backing store.
x | Horizontal position of window, in pixels |
y | Vertical position of window, in pixels |
w | The width of the canvas, in pixels |
h | The height of the canvas, in pixels |
Ecore_Evas
instance or NULL
, on failureEcore_Evas* ecore_evas_fb_new | ( | const char * | disp_name, |
int | rotation, | ||
int | w, | ||
int | h | ||
) |
Creates Ecore_Evas using fb backend.
disp_name | The name of the display to be used. |
rotation | The rotation to be used. |
w | The width of the Ecore_Evas to be created. |
h | The height of the Ecore_Evas to be created. |
Eina_Bool ecore_evas_focus_device_get | ( | const Ecore_Evas * | ee, |
Eo * | seat | ||
) |
Queries whether an Ecore_Evas' window is focused or not.
ee | The Ecore_Evas to set |
seat | An Efl_Input_Device that represents the seat or NULL for the default seat. |
EINA_TRUE
if ee
if focused, EINA_FALSE
if not.void ecore_evas_focus_device_set | ( | Ecore_Evas * | ee, |
Eo * | seat, | ||
Eina_Bool | on | ||
) |
Sets the Ecore_Evas windows focus for a given seat.
ee | The Ecore_Evas |
seat | An Efl_Input_Device that represents the seat or NULL for the default seat. |
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
.
Eina_Bool ecore_evas_focus_get | ( | const Ecore_Evas * | ee | ) |
Queries whether the default seat has the Ecore_Evas focus.
ee | The Ecore_Evas to set |
EINA_TRUE
if ee
if focused, EINA_FALSE
if not.void ecore_evas_focus_set | ( | Ecore_Evas * | ee, |
Eina_Bool | on | ||
) |
Sets the Ecore_Evas window focus for the default seat.
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
.
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().
ee | The Ecore_Evas to set |
void ecore_evas_focus_skip_set | ( | Ecore_Evas * | ee, |
Eina_Bool | skip | ||
) |
Sets the "focus skip" flag.
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).
void ecore_evas_free | ( | Ecore_Evas * | ee | ) |
Frees an Ecore_Evas.
ee | The Ecore_Evas to free |
This frees up any memory used by the Ecore_Evas.
Eina_Bool ecore_evas_fullscreen_get | ( | const Ecore_Evas * | ee | ) |
Queries whether an Ecore_Evas' window is fullscreen or not.
ee | The Ecore_Evas to set |
EINA_TRUE
if ee
is fullscreen, EINA_FALSE
if not.void ecore_evas_fullscreen_set | ( | Ecore_Evas * | ee, |
Eina_Bool | on | ||
) |
Sets whether or not an Ecore_Evas' window is fullscreen.
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
.
void ecore_evas_geometry_get | ( | const Ecore_Evas * | ee, |
int * | x, | ||
int * | y, | ||
int * | w, | ||
int * | h | ||
) |
Gets the geometry of an Ecore_Evas.
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);
Evas* ecore_evas_get | ( | const Ecore_Evas * | ee | ) |
Gets an Ecore_Evas's Evas.
ee | The Ecore_Evas whose Evas you wish to get |
ee
. Ecore_Evas* ecore_evas_gl_drm_new | ( | const char * | device, |
unsigned int | parent, | ||
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Create an Ecore_Evas window using the drm engine with GL support.
disp_name | Name of the Wayland display to connect to. |
parent | (Unused) |
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. |
NULL
if creation failed.This creates a drm backend backed Ecore_Evas window, that also includes gl support using libglapi.
Ecore_Evas* ecore_evas_gl_sdl_new | ( | const char * | name, |
int | w, | ||
int | h, | ||
int | fullscreen, | ||
int | noframe | ||
) |
Creates a new Ecore_Evas
canvas bound to the Evas SDL + gl engine.
name | Device target name, defaults to "EFL SDL" if NULL. |
w | Width of the canvas, in pixels. |
h | Height of the canvas, in pixels. |
fullscreen | Set the fullscreen property for the window. |
noframe | Set the noframe flag on the einfo. |
Ecore_Evas
instance or NULL
on failure Eina_Bool ecore_evas_gl_x11_direct_resize_get | ( | const Ecore_Evas * | ee | ) |
Gets if the Ecore_Evas is being directly resized using opengl x11.
ee | The Ecore_Evas from which to get direct resize. |
EINA_TRUE
if the resize was managed directly, otherwise return EINA_FALSE
. void ecore_evas_gl_x11_direct_resize_set | ( | Ecore_Evas * | ee, |
Eina_Bool | on | ||
) |
Sets direct_resize for Ecore_Evas using opengl x11.
ee | The Ecore_Evas in which to set direct resize. |
on | Enables the resize of Ecore_Evas if equals EINA_TRUE , disables if equals EINA_FALSE . |
void ecore_evas_gl_x11_extra_event_window_add | ( | Ecore_Evas * | ee, |
Ecore_X_Window | win | ||
) |
Adds extra window on Ecore_Evas using opengl x11.
ee | The Ecore_Evas for which to add the window. |
win | The window to be added to the Ecore_Evas. |
Ecore_Evas* ecore_evas_gl_x11_new | ( | const char * | disp_name, |
Ecore_X_Window | parent, | ||
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Creates Ecore_Evas using opengl x11.
disp_name | The name of the display of the Ecore_Evas to be created. |
parent | The parent of the Ecore_Evas to be created. |
x | The X coordinate to be used. |
y | The Y coordinate to be used. |
w | The width of the Ecore_Evas to be created. |
h | The height of the Ecore_Evas to be created. |
Ecore_Evas* ecore_evas_gl_x11_options_new | ( | const char * | disp_name, |
Ecore_X_Window | parent, | ||
int | x, | ||
int | y, | ||
int | w, | ||
int | h, | ||
const int * | opt | ||
) |
Create Ecore_Evas using OpenGL X11, with options.
disp_name | The name of the display of the Ecore_Evas to be created. |
parent | The parent of the Ecore_Evas to be created. |
x | The X coordinate to be used. |
y | The Y coordinate to be used. |
w | The width of the Ecore_Evas to be created. |
h | The height of the Ecore_Evas to be created. |
opt | The options array (see above) |
Allows creation of an Ecore_Evas, similar to ecore_evas_gl_x11_new, except it permits passing in opt
, a NULL-terminated C array of key/value pairs for various settings, as follows:
ECORE_EVAS_GL_X11_OPT_INDIRECT: Use indirect rendering [0,1] ECORE_EVAS_GL_X11_OPT_VSYNC: Use vsync [0,1] ECORE_EVAS_GL_X11_OPT_SWAP_MODE: Swap mode to assume (see Evas_Engine_Info_Gl_Swap_Mode) ECORE_EVAS_GL_X11_OPT_GL_DEPTH: depth_bits ECORE_EVAS_GL_X11_OPT_GL_STENCIL: stencil_bits ECORE_EVAS_GL_X11_OPT_GL_MSAA: msaa_bits
Ecore_X_Pixmap ecore_evas_gl_x11_pixmap_get | ( | const Ecore_Evas * | ee | ) |
Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas.
ee | The Ecore_Evas whose pixmap is desired. |
Ecore_Evas* ecore_evas_gl_x11_pixmap_new | ( | const char * | disp_name, |
Ecore_X_Window | parent, | ||
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Creates a new Ecore_Evas which does not contain an XWindow. It will only contain an XPixmap to render to.
void ecore_evas_gl_x11_pre_post_swap_callback_set | ( | const Ecore_Evas * | ee, |
void * | data, | ||
void(*)(void *data, Evas *e) | pre_cb, | ||
void(*)(void *data, Evas *e) | post_cb | ||
) |
Sets the functions to be used before and after the swap callback.
ee | The Ecore_Evas for which to set the swap callback. |
data | The data for which to set the swap callback. |
pre_cb | The function to be called before the callback. |
post_cb | The function to be called after the callback. |
Ecore_X_Window ecore_evas_gl_x11_window_get | ( | const Ecore_Evas * | ee | ) |
Gets the window from Ecore_Evas using opengl x11.
ee | The Ecore_Evas from which to get the window. |
ee
was not created with ecore_evas_gl_x11_new() then nothing is done and 0 is returned. void ecore_evas_hide | ( | Ecore_Evas * | ee | ) |
Hides an Ecore_Evas' window.
ee | The Ecore_Evas to hide. |
This function makes ee
hidden(not visible).
Eina_Bool ecore_evas_iconified_get | ( | const Ecore_Evas * | ee | ) |
Queries whether an Ecore_Evas' window is iconified or not.
ee | The Ecore_Evas to set |
EINA_TRUE
if ee
is iconified, EINA_FALSE
if not.void ecore_evas_iconified_set | ( | Ecore_Evas * | ee, |
Eina_Bool | on | ||
) |
Iconifies or uniconifies an Ecore_Evas' window.
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
.
Eina_Bool ecore_evas_ignore_events_get | ( | const Ecore_Evas * | ee | ) |
Returns the ignore state of an Ecore_Evas' window.
ee | The Ecore_Evas whose window's ignore events state is returned. |
void ecore_evas_ignore_events_set | ( | Ecore_Evas * | ee, |
Eina_Bool | ignore | ||
) |
Sets if this evas should ignore all events.
ee | The Ecore_Evas whose window's to ignore events. |
ignore | The Ecore_Evas new ignore state. |
int ecore_evas_init | ( | void | ) |
Inits the Ecore_Evas system.
0
indicates failure.Set up the Evas wrapper system. Init Evas and Ecore libraries.
void ecore_evas_input_event_register | ( | Ecore_Evas * | ee | ) |
Registers an Ecore_Evas
to receive events through ecore_input_evas.
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.
void ecore_evas_input_event_register_with_multi | ( | Ecore_Evas * | ee | ) |
Registers an Ecore_Evas
to receive events through ecore_input_evas.
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.
void ecore_evas_input_event_register_with_multi2 | ( | Ecore_Evas * | ee | ) |
Registers an Ecore_Evas
to receive events through ecore_input_evas.
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.
void ecore_evas_input_event_unregister | ( | Ecore_Evas * | ee | ) |
Unregisters an Ecore_Evas
receiving events through ecore_input_evas.
ee | The Ecore_Evas handle. |
int ecore_evas_layer_get | ( | const Ecore_Evas * | ee | ) |
Gets the layer of an Ecore_Evas' window.
ee | The Ecore_Evas to set |
ee's
window is onvoid ecore_evas_layer_set | ( | Ecore_Evas * | ee, |
int | layer | ||
) |
Sets the layer of an Ecore_Evas' window.
ee | The Ecore_Evas |
layer | The layer to put ee on. |
This function moves ee
to the layer layer
.
void ecore_evas_lower | ( | Ecore_Evas * | ee | ) |
Lowers an Ecore_Evas' window.
ee | The Ecore_Evas to raise. |
This functions lowers the Ecore_Evas to the back.
void ecore_evas_managed_move | ( | Ecore_Evas * | ee, |
int | x, | ||
int | y | ||
) |
Provides Managed move co-ordinates for an Ecore_Evas.
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
)
void ecore_evas_manual_render | ( | Ecore_Evas * | ee | ) |
Forces immediate rendering on a given Ecore_Evas
window.
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.
Eina_Bool ecore_evas_manual_render_get | ( | const Ecore_Evas * | ee | ) |
Gets enable/disable status of manual render.
ee | An Ecore_Evas handle |
EINA_TRUE
if manual render is enabled, EINA_FALSE
if manual render is disabledvoid ecore_evas_manual_render_set | ( | Ecore_Evas * | ee, |
Eina_Bool | manual_render | ||
) |
Enables/disables manual render.
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.
Eina_Bool ecore_evas_maximized_get | ( | const Ecore_Evas * | ee | ) |
Queries whether an Ecore_Evas' window is maximized or not.
ee | The Ecore_Evas to set |
EINA_TRUE
if ee
is maximized, EINA_FALSE
if not.void ecore_evas_maximized_set | ( | Ecore_Evas * | ee, |
Eina_Bool | on | ||
) |
Maximizes (or unmaximizes) an Ecore_Evas' window.
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
.
Eina_Bool ecore_evas_modal_get | ( | const Ecore_Evas * | ee | ) |
Gets The modal flag.
This returns the value set by ecore_evas_modal_set().
ee | The Ecore_Evas to set |
void ecore_evas_modal_set | ( | Ecore_Evas * | ee, |
Eina_Bool | modal | ||
) |
Sets the modal state flag on the canvas window.
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).
void ecore_evas_move | ( | Ecore_Evas * | ee, |
int | x, | ||
int | y | ||
) |
Moves an Ecore_Evas.
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
)
void ecore_evas_move_resize | ( | Ecore_Evas * | ee, |
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Moves and resizes an Ecore_Evas.
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
.
void ecore_evas_msg_parent_send | ( | Ecore_Evas * | ee, |
int | msg_domain, | ||
int | msg_id, | ||
void * | data, | ||
int | size | ||
) |
Sends message to parent ecore.
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 |
This is a list of examples of these functions:
void ecore_evas_msg_send | ( | Ecore_Evas * | ee, |
int | msg_domain, | ||
int | msg_id, | ||
void * | data, | ||
int | size | ||
) |
Sends message to child ecore.
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 |
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.
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
.
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.
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.
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.
engine_name | Engine name as returned by ecore_evas_engines_get() or NULL to use environment variable ECORE_EVAS_ENGINE, which 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 this from shell commands, most consider ';' as the command terminator, so you need to escape it or use quotes. |
NULL
if creation failed. Eina_Bool ecore_evas_object_associate | ( | Ecore_Evas * | ee, |
Evas_Object * | obj, | ||
Ecore_Evas_Object_Associate_Flags | flags | ||
) |
Associates the given object to this ecore evas.
ee | The Ecore_Evas to associate to obj |
obj | The object to associate to ee |
flags | The association flags. |
EINA_TRUE
on success, EINA_FALSE
otherwise.Association means that operations on one will affect the other, for example moving the object will move the window, resize the object will also affect the ecore evas window, hide and show applies as well.
This is meant to simplify development, since you often need to associate these events with your "base" objects, background or bottom-most object.
Be aware that some methods might not be what you would like, deleting either the window or the object will delete the other. If you want to change that behavior, let's say to hide window when it's closed, you must use ecore_evas_callback_delete_request_set() and set your own code, like ecore_evas_hide(). Just remember that if you override delete_request and still want to delete the window/object, you must do that yourself.
Since we now define delete_request, deleting windows will not quit main loop, if you wish to do so, you should listen for EVAS_CALLBACK_FREE on the object, that way you get notified and you can call ecore_main_loop_quit().
Flags can be OR'ed of:
Evas_Object* ecore_evas_object_associate_get | ( | const Ecore_Evas * | ee | ) |
Gets the object associated with ee
.
ee | The Ecore_Evas to get the object from. |
NULL
if there is no associated object. void ecore_evas_object_cursor_device_set | ( | Ecore_Evas * | ee, |
Efl_Input_Device * | pointer, | ||
Evas_Object * | obj, | ||
int | layer, | ||
int | hot_x, | ||
int | hot_y | ||
) |
Sets the cursor of an Ecore_Evas specified pointer device.
ee | The Ecore_Evas |
pointer | A pointer device to set the cursor. Use NULL for the default. |
obj | The Evas_Object which will be 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 object specified by obj
. The actual point within the object 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 object. Cursor object will be deleted with the Ecore_Evas.
void ecore_evas_object_cursor_set | ( | Ecore_Evas * | ee, |
Evas_Object * | obj, | ||
int | layer, | ||
int | hot_x, | ||
int | hot_y | ||
) |
Sets the cursor for the default pointer device.
ee | The Ecore_Evas |
obj | The Evas_Object which will be 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 object specified by obj
. The actual point within the object 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 object. Cursor object will be deleted with the Ecore_Evas.
Eina_Bool ecore_evas_object_dissociate | ( | Ecore_Evas * | ee, |
Evas_Object * | obj | ||
) |
Cancels the association set with ecore_evas_object_associate().
ee | The Ecore_Evas to dissociate from obj |
obj | The object to dissociate from ee |
EINA_TRUE
on success, EINA_FALSE
otherwise. Ecore_Evas* ecore_evas_object_ecore_evas_get | ( | Evas_Object * | obj | ) |
Retrieve the internal Ecore_Evas
handle of an image object created via ecore_evas_object_image_new().
obj | A handle to an image object created via ecore_evas_object_image_new() |
Ecore_Evas
handle in obj
Evas* ecore_evas_object_evas_get | ( | Evas_Object * | obj | ) |
Retrieve the canvas bound to the internal Ecore_Evas
handle of an image object created via ecore_evas_object_image_new()
obj | A handle to an image object created via ecore_evas_object_image_new() |
obj's
underlying Ecore_Evas's
canvas Evas_Object* ecore_evas_object_image_new | ( | Ecore_Evas * | ee_target | ) |
Creates an Evas image object with image data bound to an own, internal Ecore_Evas
canvas wrapper
ee_target | Ecore_Evas to have the canvas receiving the new image object |
This will create a special Evas image object. The image's pixel array will get bound to the same image data array of an internal buffer Ecore_Evas
canvas. The user of this function is, then, supposed to grab that Ecore_Evas
handle, with ecore_evas_object_ecore_evas_get(), and use its canvas to render whatever contents he/she wants, independently of the contents of the canvas owned by ee_target
. Those contents will reflect on the canvas of ee
, though, being exactly the image data of the object returned by this function.
This is a helper function for the scenario of one wanting to grab a buffer canvas' contents (with ecore_evas_buffer_pixels_get()) to be used on another canvas, for whatever reason. The most common goal of this setup is to save an image file with a whole canvas as contents, that cannot be achieved by using an image file within the target canvas.
Ecore_Evas
handle accordingly. They must be kept with same sizes for things to work as expected. Also, you must issue evas_object_image_size_set()
on the image with that same size. If the image is to be shown in a canvas bound to an engine different than the buffer one, then you must also set this image's fill properties accordingly.EVAS_COLORSPACE_ARGB8888
colorspace, always.Ecore_Evas
firstly, with ecore_evas_manual_render(). Eina_Bool ecore_evas_override_get | ( | const Ecore_Evas * | ee | ) |
Queries whether an Ecore_Evas' window is overridden or not.
ee | The Ecore_Evas to set. |
EINA_TRUE
if ee
is overridden, EINA_FALSE
if not. void ecore_evas_override_set | ( | Ecore_Evas * | ee, |
Eina_Bool | on | ||
) |
Tells the WM whether or not to ignore an Ecore_Evas' window.
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
.
Ecore_Evas* ecore_evas_psl1ght_new | ( | const char * | name, |
int | w, | ||
int | h | ||
) |
Creates a new Ecore_Evas
canvas bound to the Evas psl1ght engine.
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 window, in pixels |
y | Vertical position of window, in pixels |
w | Width of the canvas, in pixels. |
h | Height of the canvas, in pixels. |
The psl1ght backend is used for the PS3 GameOS.
void ecore_evas_raise | ( | Ecore_Evas * | ee | ) |
Raises an Ecore_Evas' window.
ee | The Ecore_Evas to raise. |
This functions raises the Ecore_Evas to the front.
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.
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);
void ecore_evas_resize | ( | Ecore_Evas * | ee, |
int | w, | ||
int | h | ||
) |
Resizes an Ecore_Evas.
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
.
int ecore_evas_rotation_get | ( | const Ecore_Evas * | ee | ) |
Gets the rotation of an Ecore_Evas' window.
ee | The Ecore_Evas |
void ecore_evas_rotation_set | ( | Ecore_Evas * | ee, |
int | rot | ||
) |
Sets the rotation of an Ecore_Evas' window.
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.
void ecore_evas_rotation_with_resize_set | ( | Ecore_Evas * | ee, |
int | rot | ||
) |
Sets the rotation of an Ecore_Evas' window.
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.
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.
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 . |
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.
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 . |
Ecore_Evas* ecore_evas_sdl_new | ( | const char * | name, |
int | w, | ||
int | h, | ||
int | fullscreen, | ||
int | hwsurface, | ||
int | noframe, | ||
int | alpha | ||
) |
Creates a new Ecore_Evas
canvas bound to the Evas SDL engine.
name | Device target name, defaults to "EFL SDL" if NULL. |
w | Width of the canvas, in pixels. |
h | Height of the canvas, in pixels. |
fullscreen | Set the fullscreen property for the window. |
hwsurface | Set the hardware surface property for the window. |
noframe | Set the noframe flag on the einfo. |
alpha | Set alpha for the Ecore_Evas window. |
Ecore_Evas
instance, or NULL
on failure. void ecore_evas_shadow_geometry_get | ( | const Ecore_Evas * | ee, |
int * | x, | ||
int * | y, | ||
int * | w, | ||
int * | h | ||
) |
Gets shadow geometry for client-side decorations.
Note that the framespace contains both a shadow or glow around the window, and the window borders (title bar, etc...).
void ecore_evas_shadow_geometry_set | ( | Ecore_Evas * | ee, |
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Sets shadow geometry for client-side decorations.
Note that the framespace contains both a shadow or glow around the window, and the window borders (title bar, etc...).
Eina_Bool ecore_evas_shaped_get | ( | const Ecore_Evas * | ee | ) |
Queries whether an Ecore_Evas is shaped or not.
ee | The Ecore_Evas to query. |
EINA_TRUE
if shaped, EINA_FALSE
if not. void ecore_evas_shaped_set | ( | Ecore_Evas * | ee, |
Eina_Bool | shaped | ||
) |
Sets whether an Ecore_Evas is shaped or not.
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.
void ecore_evas_show | ( | Ecore_Evas * | ee | ) |
Shows an Ecore_Evas' window.
ee | The Ecore_Evas to show. |
This function makes ee
visible.
int ecore_evas_shutdown | ( | void | ) |
Shuts down the Ecore_Evas system.
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.
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.
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. |
NULL
pointers on the size components you're not interested in: they'll be ignored by the function.void ecore_evas_size_base_set | ( | Ecore_Evas * | ee, |
int | w, | ||
int | h | ||
) |
Sets the base size for a given Ecore_Evas
window.
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().
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.
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. |
NULL
pointers on the size components you're not interested in: they'll be ignored by the function.void ecore_evas_size_max_set | ( | Ecore_Evas * | ee, |
int | w, | ||
int | h | ||
) |
Sets the maximum size of a given Ecore_Evas
window.
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.
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.
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. |
NULL
pointers on the size components you're not interested in: they'll be ignored by the function.void ecore_evas_size_min_set | ( | Ecore_Evas * | ee, |
int | w, | ||
int | h | ||
) |
Sets the minimum size of a given Ecore_Evas
window.
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.
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.
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. |
NULL
pointers on the size components you're not interested in: they'll be ignored by the function.void ecore_evas_size_step_set | ( | Ecore_Evas * | ee, |
int | w, | ||
int | h | ||
) |
Sets the "size step" for a given Ecore_Evas
window.
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.
Ecore_Evas* ecore_evas_software_ddraw_new | ( | Ecore_Win32_Window * | parent, |
int | x, | ||
int | y, | ||
int | width, | ||
int | height | ||
) |
Creates a new Ecore_Evas
canvas bound to the Evas DirectDraw (software) engine.
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 window, in pixels |
y | Vertical position of window, in pixels |
width | The width of the canvas, in pixels |
height | The height of the canvas, in pixels |
Ecore_Evas
instance or NULL
on failureDirectDraw is an old Microsoft Win32 API for graphics rendering. This API uses the unaccelerated software-based rendering.
Ecore_Evas* ecore_evas_software_gdi_new | ( | Ecore_Win32_Window * | parent, |
int | x, | ||
int | y, | ||
int | width, | ||
int | height | ||
) |
Creates a new Ecore_Evas
canvas bound to the Evas gdi (software) engine.
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 window, in pixels. |
y | Vertical position of window, in pixels. |
width | The width of the canvas, in pixels. |
height | The height of the canvas, in pixels. |
Ecore_Evas
instance, or NULL
on failure.The Graphics Device Interface (GDI) is a display API for Microsoft Win32 similar in concept to Xlib or Quartz, providing an abstraction layer for performing advanced drawing functionalities using software rendering.
Eina_Bool ecore_evas_software_x11_direct_resize_get | ( | const Ecore_Evas * | ee | ) |
Gets if the Ecore_Evas is being directly resized using software x11.
ee | The Ecore_Evas from which to get direct resize. |
EINA_TRUE
if the resize was managed directly, otherwise return EINA_FALSE
.void ecore_evas_software_x11_direct_resize_set | ( | Ecore_Evas * | ee, |
Eina_Bool | on | ||
) |
Sets the direct_resize of Ecore_Evas using software x11.
ee | The Ecore_Evas in which to set direct resize. |
on | Enables the resize of Ecore_Evas if equals EINA_TRUE , disables if equals EINA_FALSE . |
void ecore_evas_software_x11_extra_event_window_add | ( | Ecore_Evas * | ee, |
Ecore_X_Window | win | ||
) |
Adds an extra window on Ecore_Evas using software x11.
ee | The Ecore_Evas for which to add the window. |
win | The window to be added to the Ecore_Evas. |
Ecore_Evas* ecore_evas_software_x11_new | ( | const char * | disp_name, |
Ecore_X_Window | parent, | ||
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Creates Ecore_Evas using software x11.
disp_name | The name of the Ecore_Evas to be created. |
parent | The parent of the Ecore_Evas to be created. |
x | The X coordinate to be used. |
y | The Y coordinate to be used. |
w | The width of the Ecore_Evas to be created. |
h | The height of the Ecore_Evas to be created. |
Ecore_X_Pixmap ecore_evas_software_x11_pixmap_get | ( | const Ecore_Evas * | ee | ) |
Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas.
ee | The Ecore_Evas whose pixmap is desired. |
Ecore_Evas* ecore_evas_software_x11_pixmap_new | ( | const char * | disp_name, |
Ecore_X_Window | parent, | ||
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Creates a new Ecore_Evas which does not contain an XWindow. It will only contain an XPixmap to render to.
Ecore_X_Window ecore_evas_software_x11_window_get | ( | const Ecore_Evas * | ee | ) |
Gets the window from Ecore_Evas using software x11.
ee | The Ecore_Evas from which to get the window. |
ee
was not created with ecore_evas_software_x11_new() then nothing is done and 0 is returned. Eina_Bool ecore_evas_sticky_get | ( | const Ecore_Evas * | ee | ) |
Returns the sticky state of an Ecore_Evas' window.
ee | The Ecore_Evas whose window's sticky state is returned. |
void ecore_evas_sticky_set | ( | Ecore_Evas * | ee, |
Eina_Bool | sticky | ||
) |
Sets the sticky state of an Ecore_Evas window.
ee | The Ecore_Evas whose window's sticky state is set. |
sticky | The Ecore_Evas window's new sticky state. |
Eina_List* ecore_evas_sub_ecore_evas_list_get | ( | const Ecore_Evas * | ee | ) |
Gets a list of all the sub ecore_evases.
ee | Ecore_Evas to get the list from. |
NULL
if there is no sub ecore_evases. const char* ecore_evas_title_get | ( | const Ecore_Evas * | ee | ) |
Gets the title of an Ecore_Evas' window.
ee | The Ecore_Evas whose title you wish to get. |
ee
.void ecore_evas_title_set | ( | Ecore_Evas * | ee, |
const char * | t | ||
) |
Sets the title of an Ecore_Evas' window.
ee | The Ecore_Evas whose title you wish to set. |
t | The title |
This function sets the title of ee
to t
.
Eina_Bool ecore_evas_transparent_get | ( | const Ecore_Evas * | ee | ) |
Queries whether an Ecore_Evas is transparent.
ee | The Ecore_Evas to query. |
EINA_TRUE
if ee is transparent, EINA_FALSE
if it isn't.void ecore_evas_transparent_set | ( | Ecore_Evas * | ee, |
Eina_Bool | transparent | ||
) |
Sets whether an Ecore_Evas has an transparent window or not.
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().
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()
ee | The Ecore_Evas to set |
void ecore_evas_urgent_set | ( | Ecore_Evas * | ee, |
Eina_Bool | urgent | ||
) |
Sets The urgent hint flag.
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.
int ecore_evas_visibility_get | ( | const Ecore_Evas * | ee | ) |
Queries whether an Ecore_Evas' window is visible or not.
ee | The Ecore_Evas to query. |
1
if ee
is visible, 0
if not.Ecore_Wl2_Window* ecore_evas_wayland2_window_get | ( | const Ecore_Evas * | ee | ) |
Gets the window from Ecore_Evas using the wayland2 backend.
ee | The Ecore_Evas from which to get the window. |
ee
was not created with ecore_evas_wayland_shm_new() or ecore_evas_wayland_egl_new() then nothing is done and NULL is returned.Ecore_Evas* ecore_evas_wayland_egl_new | ( | const char * | disp_name, |
unsigned int | parent, | ||
int | x, | ||
int | y, | ||
int | w, | ||
int | h, | ||
Eina_Bool | frame | ||
) |
Create an Ecore_Evas window using the wayland-egl engine.
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.) |
NULL
if creation failed.Under Wayland, clients can also set up rendering directly to graphics hardware memory via various rendering APIs such as OpenGL, OpenGL ES, etc.) thus skipping the need for server-side copying of graphics data to the display device, thus providing higher performance than SHM. This routine constructs an Ecore_Evas window object using the Embedded-system Graphics Library (EGL) interface for handling the context management and rendering synchronization.
void ecore_evas_wayland_move | ( | Ecore_Evas * | ee, |
int | x, | ||
int | y | ||
) |
Begin moving the Ecore_Evas window.
ee | The Ecore_Evas. |
x | (unused) |
y | (unused) |
void ecore_evas_wayland_pointer_set | ( | Ecore_Evas * | ee, |
int | hot_x, | ||
int | hot_y | ||
) |
Set the pointer for the Ecore_Evas window.
ee | The Ecore_Evas. |
hot_x | X coordinate. |
hot_y | Y coordinate. |
void ecore_evas_wayland_resize | ( | Ecore_Evas * | ee, |
int | location | ||
) |
Begin resizing the Ecore_Evas window.
ee | The Ecore_Evas. |
location | The edge of the window from which the resize should start. |
The location edge is an enum as defined by the XDG Shell protocol. See the zxdg_toplevel_v6_resize_edge enum definition for edge numbering.
Ecore_Evas* ecore_evas_wayland_shm_new | ( | const char * | disp_name, |
unsigned int | parent, | ||
int | x, | ||
int | y, | ||
int | w, | ||
int | h, | ||
Eina_Bool | frame | ||
) |
Create an Ecore_Evas window using the wayland-shm engine.
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.) |
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.
void ecore_evas_wayland_type_set | ( | Ecore_Evas * | ee, |
int | type | ||
) |
Set the type of the Ecore_Evas window.
Enables setting the window as top level, menu, dnd, etc.
ee | The Ecore_Evas. |
type | The Ecore_Wl2_Window_Type to set on the window. |
Ecore_Wl_Window* ecore_evas_wayland_window_get | ( | const Ecore_Evas * | ee | ) |
Gets the window from Ecore_Evas using the wayland backend.
ee | The Ecore_Evas from which to get the window. |
ee
was not created with ecore_evas_wayland_shm_new() or ecore_evas_wayland_egl_new() then nothing is done and NULL is returned. Eina_Bool ecore_evas_window_available_profiles_get | ( | Ecore_Evas * | ee, |
char *** | profiles, | ||
unsigned int * | count | ||
) |
Gets the array of available window profiles.
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 |
EINA_TRUE
if available window profiles exist, EINA_FALSE
otherwisevoid ecore_evas_window_available_profiles_set | ( | Ecore_Evas * | ee, |
const char ** | profiles, | ||
const unsigned int | count | ||
) |
Sets the array of available window profiles.
ee | The Ecore_Evas to set |
profiles | The string array of available window profiles |
count | The number of members in profiles |
Ecore_Window ecore_evas_window_get | ( | const Ecore_Evas * | ee | ) |
Returns a pointer to the underlying window.
ee | The Ecore_Evas whose window is desired. |
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().
ee | The Ecore_Evas to set |
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.
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.
const char* ecore_evas_window_profile_get | ( | const Ecore_Evas * | ee | ) |
Gets the window profile.
ee | The Ecore_Evas to get the window profile from. |
void ecore_evas_window_profile_set | ( | Ecore_Evas * | ee, |
const char * | profile | ||
) |
Sets the window profile.
ee | The Ecore_Evas to set |
profile | The string value of the window profile |
Eina_Bool ecore_evas_window_profile_supported_get | ( | const Ecore_Evas * | ee | ) |
Queries if the underlying windowing system supports the window profile.
ee | The Ecore_Evas |
EINA_TRUE
if the window profile is supported, EINA_FALSE
otherwise.Eina_Bool ecore_evas_withdrawn_get | ( | const Ecore_Evas * | ee | ) |
Returns the withdrawn state of an Ecore_Evas' window.
ee | The Ecore_Evas whose window's withdrawn state is returned. |
void ecore_evas_withdrawn_set | ( | Ecore_Evas * | ee, |
Eina_Bool | withdrawn | ||
) |
Sets the withdrawn state of an Ecore_Evas' window.
ee | The Ecore_Evas whose window's withdrawn state is set. |
withdrawn | The Ecore_Evas window's new withdrawn state. |
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.
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 |
EINA_TRUE
if available window rotations exist, EINA_FALSE
otherwisevoid ecore_evas_wm_rotation_available_rotations_set | ( | Ecore_Evas * | ee, |
const int * | rotations, | ||
unsigned int | count | ||
) |
Sets the array of available window rotations.
ee | The Ecore_Evas to set |
rotations | The integer array of available window rotations |
count | The number of members in rotations |
void ecore_evas_wm_rotation_manual_rotation_done | ( | Ecore_Evas * | ee | ) |
Sets rotation finish manually.
ee | The Ecore_Evas |
Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get | ( | const Ecore_Evas * | ee | ) |
Gets manual rotation done mode of Ecore_Evas's window.
ee | The Ecore_Evas |
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.
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. |
int ecore_evas_wm_rotation_preferred_rotation_get | ( | const Ecore_Evas * | ee | ) |
Gets the preferred rotation hint.
ee | The Ecore_Evas to get the preferred rotation hint from. |
-1
on failure.void ecore_evas_wm_rotation_preferred_rotation_set | ( | Ecore_Evas * | ee, |
int | rotation | ||
) |
Sets the preferred rotation hint.
ee | The Ecore_Evas to set |
rotation | Value to set the preferred rotation hint |
Eina_Bool ecore_evas_wm_rotation_supported_get | ( | const Ecore_Evas * | ee | ) |
Queries if the underlying windowing system supports the window manager rotation.
ee | The Ecore_Evas |
EINA_TRUE
if the window manager rotation is supported, EINA_FALSE
otherwise.void ecore_evas_x11_leader_default_set | ( | Ecore_Evas * | ee | ) |
Reset the client leader to default.
ee | Ecore_Evas for the window. |
Ecore_X_Window ecore_evas_x11_leader_get | ( | Ecore_Evas * | ee | ) |
Get the client leader.
ee | Ecore_Evas for the window. |
void ecore_evas_x11_leader_set | ( | Ecore_Evas * | ee, |
Ecore_X_Window | win | ||
) |
Set the window's client leader.
ee | Ecore_Evas for the window. |
win | The window. |
Sets the client leader X atom property for the given window. All non-transient top-level windows created by an app other than the main window must have this property set to the app's main window.
void ecore_evas_x11_shape_input_apply | ( | Ecore_Evas * | ee | ) |
Applies the pointer containment region to the client window.
ee | The Ecore_Evas |
void ecore_evas_x11_shape_input_empty | ( | Ecore_Evas * | ee | ) |
Disables input for the window.
ee | The Ecore_Evas |
Sets the pointer containment region to a null rectangle, effectively disabling input for the window. Note that ecore_evas_x11_shape_input_apply() must be called to commit the changes to the window itself.
void ecore_evas_x11_shape_input_rectangle_add | ( | Ecore_Evas * | ee, |
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Extends the pointer containment region to the union of the new and existing input rectangle.
ee | The Ecore_Evas |
x | The X coordinate of the rectangular area to add. |
y | The Y coordinate of the rectangular area to add. |
w | The width of the rectangular area to add. |
h | The height of the rectangular area to add. |
Ecore_Evas may apply (orthogonal) rotations if needed, via an internal call to _ecore_evas_x11_convert_rectangle_with_angle(). Note that ecore_evas_x11_shape_input_apply() must be called to commit the changes to the window itself.
void ecore_evas_x11_shape_input_rectangle_set | ( | Ecore_Evas * | ee, |
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Set the rectangular region that can "contain" the pointer, replacing any previously set region.
ee | The Ecore_Evas |
x | The X coordinate for the origin of the input containment rectangle. |
y | The Y coordinate for the origin of the input containment rectangle. |
w | The width of the input containment rectangle. |
h | The height of the input containment rectangle. |
Ecore_Evas may apply (orthogonal) rotations if needed, via an internal call to _ecore_evas_x11_convert_rectangle_with_angle(). Note that ecore_evas_x11_shape_input_apply() must be called to commit the changes to the window itself.
void ecore_evas_x11_shape_input_rectangle_subtract | ( | Ecore_Evas * | ee, |
int | x, | ||
int | y, | ||
int | w, | ||
int | h | ||
) |
Modifies the pointer containment region to subtract a rectangular region from it.
ee | The Ecore_Evas |
x | The X coordinate of the subtraction rectangle. |
y | The Y coordinate of the subtraction rectangle. |
w | The width of the subtraction rectangle. |
h | The height of the subtraction rectangle. |
Ecore_Evas may apply (orthogonal) rotations if needed, via an internal call to _ecore_evas_x11_convert_rectangle_with_angle(). Note that ecore_evas_x11_shape_input_apply() must be called to commit the changes to the window itself.
void ecore_evas_x11_shape_input_reset | ( | Ecore_Evas * | ee | ) |
Unsets the pointer containment for the window.
ee | The Ecore_Evas |
Sets the pointer containment region to a maximally wide and high rectangle, effectively permitting all allowed input events to reach the window. Note that ecore_evas_x11_shape_input_apply() must be called to commit the changes to the window itself.