5 #include <Ecore_Getopt.h>
6 #include <Ecore_Input.h>
13 # ifdef EFL_ECORE_EVAS_BUILD
15 # define EAPI __declspec(dllexport)
18 # endif /* ! DLL_EXPORT */
20 # define EAPI __declspec(dllimport)
21 # endif /* ! EFL_ECORE_EVAS_BUILD */
25 # define EAPI __attribute__ ((visibility("default")))
36 * @brief Evas wrapper functions
38 * The following is a list of example that partially exemplify Ecore_Evas's API:
39 * @li @ref ecore_evas_callbacks_example_c
40 * @li @ref ecore_evas_object_example_c
41 * @li @ref ecore_evas_basics_example_c
42 * @li @ref Ecore_Evas_Window_Sizes_Example_c
43 * @li @ref Ecore_Evas_Buffer_Example_01_c
44 * @li @ref Ecore_Evas_Buffer_Example_02_c
49 * - iconfication api needs to work
50 * - maximization api needs to work
51 * - document all calls
54 * - buffer back-end that renders to an evas_image_object ???
56 * - dfb back-end ??? (dfb's threads make this REALLY HARD)
64 * @defgroup Ecore_Evas_Group Ecore_Evas wrapper/helper set of functions
66 * Ecore evas is a set of functions that makes it easy to tie together ecore's
67 * main loop and input handling to evas. As such it's a natural base for EFL
68 * applications. While this combination makes it easy to create the basic
69 * aspects all applications need, for normal applications(ones with buttons,
70 * checkboxes and layouts) one should consider using Elementary.
72 * Ecore evas is extremely well suited for applications that are not based on
73 * widgets. It has a main loop that delivers events, does basic window handling
74 * and leaves all of the drawing up to the user. This works very well if used
75 * in conjunction with Edje or if doing custom drawing as, for example, is done
78 * This is a list of examples of these functions:
79 * @li @ref ecore_evas_basics_example_c
80 * @li @ref ecore_evas_object_example_c
81 * @li @ref ecore_evas_callbacks_example_c
82 * @li @ref Ecore_Evas_Window_Sizes_Example_c
83 * @li @ref Ecore_Evas_Buffer_Example_01_c
84 * @li @ref Ecore_Evas_Buffer_Example_02_c
89 /* these are dummy and just tell u what API levels ecore_evas supports - not if
90 * the actual support is compiled in. you need to query for that separately.
92 #define HAVE_ECORE_EVAS_X 1
93 #define HAVE_ECORE_EVAS_FB 1
94 #define HAVE_ECORE_EVAS_X11_GL 1
95 #define HAVE_ECORE_EVAS_X11_16 1
96 #define HAVE_ECORE_EVAS_DIRECTFB 1
97 #define HAVE_ECORE_EVAS_WIN32 1
98 #define HAVE_ECORE_EVAS_COCOA 1
99 #define HAVE_ECORE_EVAS_SDL 1
100 #define HAVE_ECORE_EVAS_WINCE 1
101 #define HAVE_ECORE_EVAS_EWS 1
102 #define HAVE_ECORE_EVAS_PSL1GHT 1
103 #define HAVE_ECORE_EVAS_WAYLAND_SHM 1
104 #define HAVE_ECORE_EVAS_WAYLAND_EGL 1
106 typedef enum _Ecore_Evas_Engine_Type
108 ECORE_EVAS_ENGINE_SOFTWARE_BUFFER,
109 ECORE_EVAS_ENGINE_SOFTWARE_XLIB,
110 ECORE_EVAS_ENGINE_XRENDER_X11,
111 ECORE_EVAS_ENGINE_OPENGL_X11,
112 ECORE_EVAS_ENGINE_SOFTWARE_XCB,
113 ECORE_EVAS_ENGINE_XRENDER_XCB,
114 ECORE_EVAS_ENGINE_SOFTWARE_GDI,
115 ECORE_EVAS_ENGINE_SOFTWARE_DDRAW,
116 ECORE_EVAS_ENGINE_DIRECT3D,
117 ECORE_EVAS_ENGINE_OPENGL_GLEW,
118 ECORE_EVAS_ENGINE_OPENGL_COCOA,
119 ECORE_EVAS_ENGINE_SOFTWARE_SDL,
120 ECORE_EVAS_ENGINE_DIRECTFB,
121 ECORE_EVAS_ENGINE_SOFTWARE_FB,
122 ECORE_EVAS_ENGINE_SOFTWARE_8_X11,
123 ECORE_EVAS_ENGINE_SOFTWARE_16_X11,
124 ECORE_EVAS_ENGINE_SOFTWARE_16_DDRAW,
125 ECORE_EVAS_ENGINE_SOFTWARE_16_WINCE,
126 ECORE_EVAS_ENGINE_OPENGL_SDL,
127 ECORE_EVAS_ENGINE_EWS,
128 ECORE_EVAS_ENGINE_PSL1GHT,
129 ECORE_EVAS_ENGINE_WAYLAND_SHM,
130 ECORE_EVAS_ENGINE_WAYLAND_EGL
131 } Ecore_Evas_Engine_Type;
133 typedef enum _Ecore_Evas_Avoid_Damage_Type
135 ECORE_EVAS_AVOID_DAMAGE_NONE = 0,
136 ECORE_EVAS_AVOID_DAMAGE_EXPOSE = 1,
137 ECORE_EVAS_AVOID_DAMAGE_BUILT_IN = 2
138 } Ecore_Evas_Avoid_Damage_Type;
140 typedef enum _Ecore_Evas_Object_Associate_Flags
142 ECORE_EVAS_OBJECT_ASSOCIATE_BASE = 0,
143 ECORE_EVAS_OBJECT_ASSOCIATE_STACK = 1 << 0,
144 ECORE_EVAS_OBJECT_ASSOCIATE_LAYER = 1 << 1,
145 ECORE_EVAS_OBJECT_ASSOCIATE_DEL = 1 << 2
146 } Ecore_Evas_Object_Associate_Flags;
149 #define _ECORE_X_WINDOW_PREDEF
150 typedef unsigned int Ecore_X_Window;
153 #ifndef _ECORE_DIRECTFB_H
154 #define _ECORE_DIRECTFB_WINDOW_PREDEF
155 typedef struct _Ecore_DirectFB_Window Ecore_DirectFB_Window;
158 #ifndef __ECORE_WIN32_H__
159 typedef struct _Ecore_Win32_Window Ecore_Win32_Window;
162 #ifndef __ECORE_WINCE_H__
163 typedef struct _Ecore_WinCE_Window Ecore_WinCE_Window;
166 #ifndef __ECORE_COCOA_H__
167 typedef struct _Ecore_Cocoa_Window Ecore_Cocoa_Window;
170 #ifndef _ECORE_EVAS_PRIVATE_H
171 /* basic data types */
172 typedef struct _Ecore_Evas Ecore_Evas;
173 typedef void (*Ecore_Evas_Event_Cb) (Ecore_Evas *ee); /**< Callback used for several ecore evas events @since 1.2 */
176 #ifndef _ECORE_WAYLAND_H_
177 #define _ECORE_WAYLAND_WINDOW_PREDEF
178 typedef struct _Ecore_Wl_Window Ecore_Wl_Window;
181 /* module setup/shutdown calls */
183 EAPI int ecore_evas_engine_type_supported_get(Ecore_Evas_Engine_Type engine);
186 * @brief Init the Ecore_Evas system.
188 * @return How many times the lib has been initialized, 0 indicates failure.
190 * Set up the Evas wrapper system. Init Evas and Ecore libraries.
192 * @see ecore_evas_shutdown()
194 EAPI int ecore_evas_init(void);
196 * @brief Shut down the Ecore_Evas system.
198 * @return 0 if ecore evas is fully shut down, or > 0 if it still being used.
200 * This closes the Evas wrapper system down. Shut down Evas and Ecore libraries.
202 * @see ecore_evas_init()
204 EAPI int ecore_evas_shutdown(void);
206 EAPI void ecore_evas_app_comp_sync_set(Eina_Bool do_sync);
207 EAPI Eina_Bool ecore_evas_app_comp_sync_get(void);
210 * @brief Returns a list of supported engines names.
212 * @return Newly allocated list with engines names. Engines names
213 * strings are internal and should be considered constants, do not
214 * free or modify them, to free the list use ecore_evas_engines_free().
216 EAPI Eina_List *ecore_evas_engines_get(void);
218 * @brief Free list returned by ecore_evas_engines_get()
220 EAPI void ecore_evas_engines_free(Eina_List *engines);
222 * @brief Creates a new Ecore_Evas based on engine name and common parameters.
224 * @param engine_name engine name as returned by
225 * ecore_evas_engines_get() or @c NULL to use environment variable
226 * ECORE_EVAS_ENGINE, that can be undefined and in this case
227 * this call will try to find the first working engine.
228 * @param x horizontal position of window (not supported in all engines)
229 * @param y vertical position of window (not supported in all engines)
230 * @param w width of window
231 * @param h height of window
232 * @param extra_options string with extra parameter, dependent on engines
233 * or @ NULL. String is usually in the form: 'key1=value1;key2=value2'.
234 * Pay attention that when getting that from shell commands, most
235 * consider ';' as the command terminator, so you need to escape
238 * @return Ecore_Evas instance or @c NULL if creation failed.
240 EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options);
242 * @brief Set whether an Ecore_Evas has an alpha channel or not.
244 * @param ee The Ecore_Evas to shape
245 * @param alpha @c EINA_TRUE to enable the alpha channel, @c EINA_FALSE to
248 * This function allows you to make an Ecore_Evas translucent using an
249 * alpha channel. See ecore_evas_shaped_set() for details. The difference
250 * between a shaped window and a window with an alpha channel is that an
251 * alpha channel supports multiple levels of transparency, as opposed to
252 * the 1 bit transparency of a shaped window (a pixel is either opaque, or
255 * @warning Support for this depends on the underlying windowing system.
257 EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha);
259 * @brief Query whether an Ecore_Evas has an alpha channel.
260 * @param ee The Ecore_Evas to query.
261 * @return @c EINA_TRUE if ee has an alpha channel, @c EINA_FALSE if it does
264 * This function returns @c EINA_TRUE if @p ee has an alpha channel, and
265 * @c EINA_FALSE if it does not.
267 * @see ecore_evas_alpha_set()
269 EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee);
271 * @brief Set whether an Ecore_Evas has an transparent window or not.
273 * @param ee The Ecore_Evas to shape
274 * @param transparent @c EINA_TRUE to enable the transparent window,
275 * @c EINA_FALSE to disable it
277 * This function sets some translucency options, for more complete support see
278 * ecore_evas_alpha_set().
280 * @warning Support for this depends on the underlying windowing system.
282 * @see ecore_evas_alpha_set()
284 EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparent);
286 * @brief Query whether an Ecore_Evas is transparent.
288 * @param ee The Ecore_Evas to query.
289 * @return @c EINA_TRUE if ee is transparent, @c EINA_FALSE if it isn't.
291 * @see ecore_evas_transparent_set()
293 EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee);
295 * @brief Get the geometry of an Ecore_Evas.
297 * @param ee The Ecore_Evas whose geometry y
298 * @param x A pointer to an int to place the x coordinate in
299 * @param y A pointer to an int to place the y coordinate in
300 * @param w A pointer to an int to place the w size in
301 * @param h A pointer to an int to place the h size in
303 * This function takes four pointers to (already allocated) ints, and places
304 * the geometry of @p ee in them. If any of the parameters is not desired you
305 * may pass @c NULL on them.
309 * ecore_evas_geometry_get(ee, &x, &y, &w, &h);
312 * @see ecore_evas_new()
313 * @see ecore_evas_resize()
314 * @see ecore_evas_move()
315 * @see ecore_evas_move_resize()
317 EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
319 * @brief Get the geometry which an Ecore_Evas was latest recently requested.
321 * @param ee The Ecore_Evas whose geometry y
322 * @param x A pointer to an int to place the x coordinate in
323 * @param y A pointer to an int to place the y coordinate in
324 * @param w A pointer to an int to place the w size in
325 * @param h A pointer to an int to place the h size in
327 * This function takes four pointers to (already allocated) ints, and places
328 * the geometry which @p ee was latest recently requested . If any of the
329 * parameters is not desired you may pass @c NULL on them.
330 * This function can represent recently requested geometry.
331 * ecore_evas_geometry_get function returns the value is updated after engine
332 * finished request. By comparison, ecore_evas_request_geometry_get returns
333 * recently requested value.
337 * ecore_evas_request_geometry_get(ee, &x, &y, &w, &h);
342 EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
344 * @brief Set the focus of an Ecore_Evas' window.
346 * @param ee The Ecore_Evas
347 * @param on @c EINA_TRUE for focus, @c EINA_FALSE to defocus.
349 * This function focuses @p ee if @p on is @c EINA_TRUE, or unfocuses @p ee if
350 * @p on is @c EINA_FALSE.
352 * @warning Support for this depends on the underlying windowing system.
354 EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on);
356 * @brief Query whether an Ecore_Evas' window is focused or not.
358 * @param ee The Ecore_Evas to set
359 * @return @c EINA_TRUE if @p ee if focused, @c EINA_FALSE if not.
361 * @see ecore_evas_focus_set()
363 EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee);
365 * @brief Iconify or uniconify an Ecore_Evas' window.
367 * @param ee The Ecore_Evas
368 * @param on @c EINA_TRUE to iconify, @c EINA_FALSE to uniconify.
370 * This function iconifies @p ee if @p on is @c EINA_TRUE, or uniconifies @p ee
371 * if @p on is @c EINA_FALSE.
373 * @note Iconify and minimize are synonyms.
375 * @warning Support for this depends on the underlying windowing system.
377 EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on);
379 * @brief Query whether an Ecore_Evas' window is iconified or not.
381 * @param ee The Ecore_Evas to set
382 * @return @c EINA_TRUE if @p ee is iconified, @c EINA_FALSE if not.
384 * @note Iconify and minimize are synonyms.
386 * @see ecore_evas_iconified_set()
388 EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee);
390 * @brief Set whether an Ecore_Evas' window is borderless or not.
392 * @param ee The Ecore_Evas
393 * @param on @c EINA_TRUE for borderless, @c EINA_FALSE for bordered.
395 * This function makes @p ee borderless if @p on is @c EINA_TRUE, or bordered
396 * if @p on is @c EINA_FALSE.
398 * @warning Support for this depends on the underlying windowing system.
400 EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on);
402 * @brief Query whether an Ecore_Evas' window is borderless or not.
404 * @param ee The Ecore_Evas to set
405 * @return @c EINA_TRUE if @p ee is borderless, @c EINA_FALSE if not.
407 * @see ecore_evas_borderless_set()
409 EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee);
411 * @brief Set whether or not an Ecore_Evas' window is fullscreen.
413 * @param ee The Ecore_Evas
414 * @param on @c EINA_TRUE fullscreen, @c EINA_FALSE not.
416 * This function causes @p ee to be fullscreen if @p on is @c EINA_TRUE, or
417 * not if @p on is @c EINA_FALSE.
419 * @warning Support for this depends on the underlying windowing system.
421 EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on);
423 * @brief Query whether an Ecore_Evas' window is fullscreen or not.
425 * @param ee The Ecore_Evas to set
426 * @return @c EINA_TRUE if @p ee is fullscreen, @c EINA_FALSE if not.
428 * @see ecore_evas_fullscreen_set()
430 EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee);
432 * @brief Set another window that this window is a group member of
434 * @param ee The Ecore_Evas
435 * @param ee_group The other group member
437 * If @p ee_group is @c NULL, @p ee is removed from the group, otherwise it is
438 * added. Note that if you free the @p ee_group canvas before @p ee, then
439 * getting the group canvas with ecore_evas_window_group_get() will return
442 * @warning Support for this depends on the underlying windowing system.
445 EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *ee_group);
447 * @brief Get the canvas group set.
449 * This returns the handle set by ecore_evas_window_group_set().
451 * @param ee The Ecore_Evas to set
452 * @return The Canvas group handle
454 * @see ecore_evas_window_group_set()
457 EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee);
459 * @brief Set the aspect ratio of a canvas window
461 * @param ee The Ecore_Evas
462 * @param aspect The aspect ratio (width divided by height), or 0 to disable
464 * This sets the desired aspect ratio of a canvas window
466 * @warning Support for this depends on the underlying windowing system.
469 EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect);
471 * @brief Get the aspect ratio of a canvas window
473 * This returns the value set by ecore_evas_aspect_set().
475 * @param ee The Ecore_Evas to set
476 * @return The aspect ratio
478 * @see ecore_evas_aspect_set()
481 EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee);
483 * @brief Set The urgent hint flag
485 * @param ee The Ecore_Evas
486 * @param urgent The urgent state flag
488 * This sets the "urgent" state hint on a window so the desktop environment
489 * can highlight it somehow.
491 * @warning Support for this depends on the underlying windowing system.
494 EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent);
496 * @brief Get the urgent state on the cavas window
498 * This returns the value set by ecore_evas_urgent_set()
500 * @param ee The Ecore_Evas to set
501 * @return The urgent state set
503 * @see ecore_evas_urgent_set()
506 EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee);
508 * @brief Set the modal state flag on the canvas window
510 * @param ee The Ecore_Evas
511 * @param modal The modal hint flag
513 * This hints if the window should be modal (eg if it is also transient
514 * for another window, the other window will maybe be denied focus by
515 * the desktop window manager).
517 * @warning Support for this depends on the underlying windowing system.
520 EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal);
522 * @brief Get The modal flag
524 * This returns the value set by ecore_evas_modal_set().
526 * @param ee The Ecore_Evas to set
527 * @return The modal flag
529 * @see ecore_evas_modal_set()
532 EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee);
534 * @brief Set the "i demand attention" flag on a canvas window
536 * @param ee The Ecore_Evas
537 * @param demand The flag state to set
539 * A window may demand attention now (eg you must enter a password before
540 * continuing), and so it may flag a window with this.
542 * @warning Support for this depends on the underlying windowing system.
545 EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand);
547 * @brief Get the "i demand attention" flag
549 * This returns the value set by ecore_evas_demand_attention_set().
551 * @param ee The Ecore_Evas to set
552 * @return The "i demand attention" flag.
554 * @see ecore_evas_demand_attention_set()
557 EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee);
559 * @brief Set the "focus skip" flag
561 * @param ee The Ecore_Evas
562 * @param skip The "focus skip" state to set.
564 * A window may not want to accept focus, be in the taskbar, pager etc.
565 * sometimes (example for a small notification window that hovers around
566 * a taskbar or panel, or hovers around a window until some activity
569 * @warning Support for this depends on the underlying windowing system.
572 EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip);
574 * @brief Get the "focus skip" flag
576 * This returns the value set by ecore_evas_focus_skip_set().
578 * @param ee The Ecore_Evas to set
579 * @return The "focus skip" flag.
581 * @see ecore_evas_focus_skip_set()
584 EAPI Eina_Bool ecore_evas_focus_skip_get(const Ecore_Evas *ee);
587 * @brief Set if this evas should ignore @b all events.
589 * @param ee The Ecore_Evas whose window's to ignore events.
590 * @param ignore The Ecore_Evas new ignore state.
592 * @warning Support for this depends on the underlying windowing system.
594 EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore);
596 * @brief Returns the ignore state of an Ecore_Evas' window.
598 * @param ee The Ecore_Evas whose window's ignore events state is returned.
599 * @return The Ecore_Evas window's ignore state.
601 * @see ecore_evas_ignore_events_set()
603 EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee);
605 * @brief Query whether an Ecore_Evas' window is visible or not.
607 * @param ee The Ecore_Evas to query.
608 * @return 1 if visible, 0 if not.
610 * This function queries @p ee and returns 1 if it is visible, and 0 if not.
612 * @see ecore_evas_show()
613 * @see ecore_evas_hide()
615 EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee);
617 * @brief Set the layer of an Ecore_Evas' window.
619 * @param ee The Ecore_Evas
620 * @param layer The layer to put @p ee on.
622 * This function moves @p ee to the layer @p layer.
624 * @warning Support for this depends on the underlying windowing system.
626 * @see ecore_evas_lower()
627 * @see ecore_evas_raise()
629 EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer);
631 * @brief Get the layer of an Ecore_Evas' window.
633 * @param ee The Ecore_Evas to set
634 * @return the layer @p ee's window is on.
636 * @see ecore_evas_layer_set()
637 * @see ecore_evas_lower()
638 * @see ecore_evas_raise()
640 EAPI int ecore_evas_layer_get(const Ecore_Evas *ee);
642 * @brief Maximize (or unmaximize) an Ecore_Evas' window.
644 * @param ee The Ecore_Evas
645 * @param on @c EINA_TRUE to maximize, @c EINA_FALSE to unmaximize.
647 * This function maximizes @p ee if @p on is @c EINA_TRUE, or unmaximizes @p ee
648 * if @p on is @c EINA_FALSE.
650 * @warning Support for this depends on the underlying windowing system.
652 EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on);
654 * @brief Query whether an Ecore_Evas' window is maximized or not.
656 * @param ee The Ecore_Evas to set
657 * @return @c EINA_TRUE if @p ee is maximized, @c EINA_FALSE if not.
659 * @see ecore_evas_maximized_set()
661 EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee);
663 * @brief Set Ecore_Evas's window profile list.
665 * @param ee The Ecore_Evas
666 * @param profiles The profile name list
667 * @param num_profiles The number of profile names
669 * @warning Support for this depends on the underlying windowing system.
672 EAPI void ecore_evas_profiles_set(Ecore_Evas *ee, const char **profiles, unsigned int num_profiles);
674 * @brief Get Ecore_Evas's window profile name.
676 * @param ee The Ecore_Evas
677 * @return The profile name
681 EAPI const char *ecore_evas_profile_get(const Ecore_Evas *ee);
683 * @brief Move an Ecore_Evas.
685 * @param ee The Ecore_Evas to move
686 * @param x The x coordinate to move to
687 * @param y The y coordinate to move to
689 * This moves @p ee to the screen coordinates (@p x, @p y)
691 * @warning Support for this depends on the underlying windowing system.
693 * @see ecore_evas_new()
694 * @see ecore_evas_resize()
695 * @see ecore_evas_move_resize()
697 EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y);
699 * @brief Resize an Ecore_Evas.
701 * @param ee The Ecore_Evas to move
702 * @param w The w coordinate to resize to
703 * @param h The h coordinate to resize to
705 * This resizes @p ee to @p w x @p h.
707 * @warning Support for this depends on the underlying windowing system.
709 * @see ecore_evas_new()
710 * @see ecore_evas_move()
711 * @see ecore_evas_move_resize()
713 EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h);
715 * @brief Move and resize an Ecore_Evas
717 * @param ee The Ecore_Evas to move and resize
718 * @param x The x coordinate to move to
719 * @param y The y coordinate to move to
720 * @param w The w coordinate to resize to
721 * @param h The h coordinate to resize to
723 * This moves @p ee to the screen coordinates (@p x, @p y) and resizes
726 * @warning Support for this depends on the underlying windowing system.
728 * @see ecore_evas_new()
729 * @see ecore_evas_move()
730 * @see ecore_evas_resize()
732 EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h);
734 * @brief Set the rotation of an Ecore_Evas' window.
736 * @param ee The Ecore_Evas
737 * @param rot the angle (in degrees) of rotation.
739 * The allowed values of @p rot depend on the engine being used. Most only
740 * allow multiples of 90.
742 * @warning Support for this depends on the underlying windowing system.
744 * @see ecore_evas_rotation_with_resize_set()
746 EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot);
748 * @brief Set the rotation of an Ecore_Evas' window
750 * @param ee The Ecore_Evas
751 * @param rot the angle (in degrees) of rotation.
753 * Like ecore_evas_rotation_set(), but it also resizes the window's contents so
754 * that they fit inside the current window geometry.
756 * @warning Support for this depends on the underlying windowing system.
758 * @see ecore_evas_rotation_set()
760 EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot);
762 * @brief Get the rotation of an Ecore_Evas' window
764 * @param ee The Ecore_Evas
765 * @return the angle (in degrees) of rotation.
767 * @see ecore_evas_rotation_set()
768 * @see ecore_evas_rotation_with_resize_set()
770 EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee);
772 * @brief Raise an Ecore_Evas' window.
774 * @param ee The Ecore_Evas to raise.
776 * This functions raises the Ecore_Evas to the front.
778 * @warning Support for this depends on the underlying windowing system.
780 * @see ecore_evas_lower()
781 * @see ecore_evas_layer_set()
783 EAPI void ecore_evas_raise(Ecore_Evas *ee);
785 * @brief Lower an Ecore_Evas' window.
787 * @param ee The Ecore_Evas to raise.
789 * This functions lowers the Ecore_Evas to the back.
791 * @warning Support for this depends on the underlying windowing system.
793 * @see ecore_evas_raise()
794 * @see ecore_evas_layer_set()
796 EAPI void ecore_evas_lower(Ecore_Evas *ee);
798 * @brief Set the title of an Ecore_Evas' window.
800 * @param ee The Ecore_Evas whose title you wish to set.
803 * This function sets the title of @p ee to @p t.
805 * @warning Support for this depends on the underlying windowing system.
807 EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t);
809 * @brief Get the title of an Ecore_Evas' window.
811 * @param ee The Ecore_Evas whose title you wish to get.
812 * @return The title of @p ee.
814 * This function returns the title of @p ee.
816 * @see ecore_evas_title_set()
818 EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee);
820 * @brief Set the name and class of an Ecore_Evas' window.
822 * @param ee the Ecore_Evas
826 * This function sets the name of @p ee to @p n, and its class to @p c. The
827 * meaning of @p name and @p class depends on the underlying windowing system.
829 * @warning Support for this depends on the underlying windowing system.
831 EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c);
833 * @brief Get the name and class of an Ecore_Evas' window
835 * This function gets the name of @p ee into @p n, and its class into
838 * @param ee The Ecore_Evas to query.
839 * @param n A pointer to a string to place the name in.
840 * @param c A pointer to a string to place the class in.
841 * @see ecore_evas_name_class_set()
843 EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c);
845 * @brief Returns a pointer to the underlying window.
847 * @param ee The Ecore_Evas whose window is desired.
848 * @return A pointer to the underlying window.
850 * @warning Support for this depends on the underlying windowing system.
852 EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee);
855 /* engine/target specific init calls */
856 EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
857 EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee);
858 EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
859 EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee);
860 EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
862 #define ECORE_EVAS_GL_X11_OPT_NONE 0
863 #define ECORE_EVAS_GL_X11_OPT_INDIRECT 1
864 #define ECORE_EVAS_GL_X11_OPT_VSYNC 2
865 #define ECORE_EVAS_GL_X11_OPT_LAST 3
867 EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
868 EAPI 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);
869 EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee);
870 EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
871 EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee);
872 EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
873 EAPI 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));
875 EAPI Ecore_Evas *ecore_evas_xrender_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
876 EAPI Ecore_X_Window ecore_evas_xrender_x11_window_get(const Ecore_Evas *ee);
877 EAPI void ecore_evas_xrender_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
878 EAPI Eina_Bool ecore_evas_xrender_x11_direct_resize_get(const Ecore_Evas *ee);
879 EAPI void ecore_evas_xrender_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
881 EAPI Ecore_Evas *ecore_evas_software_x11_8_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
882 EAPI Ecore_X_Window ecore_evas_software_x11_8_window_get(const Ecore_Evas *ee);
883 EAPI Ecore_X_Window ecore_evas_software_x11_8_subwindow_get(const Ecore_Evas *ee);
884 EAPI void ecore_evas_software_x11_8_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
885 EAPI Eina_Bool ecore_evas_software_x11_8_direct_resize_get(const Ecore_Evas *ee);
886 EAPI void ecore_evas_software_x11_8_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
888 EAPI Ecore_Evas *ecore_evas_software_x11_16_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
889 EAPI Ecore_X_Window ecore_evas_software_x11_16_window_get(const Ecore_Evas *ee);
890 EAPI void ecore_evas_software_x11_16_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
891 EAPI Eina_Bool ecore_evas_software_x11_16_direct_resize_get(const Ecore_Evas *ee);
892 EAPI void ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
894 EAPI Ecore_Evas *ecore_evas_fb_new(const char *disp_name, int rotation, int w, int h);
896 EAPI Ecore_Evas *ecore_evas_directfb_new(const char *disp_name, int windowed, int x, int y, int w, int h);
897 EAPI Ecore_DirectFB_Window *ecore_evas_directfb_window_get(const Ecore_Evas *ee);
900 EAPI 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);
901 EAPI 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);
902 EAPI void ecore_evas_wayland_resize(Ecore_Evas *ee, int location);
903 EAPI void ecore_evas_wayland_move(Ecore_Evas *ee, int x, int y);
905 /* EAPI void ecore_evas_wayland_drag_start(Ecore_Evas *ee, Ecore_Evas *drag_ee, void *source); */
906 EAPI void ecore_evas_wayland_pointer_set(Ecore_Evas *ee, int hot_x, int hot_y);
907 EAPI void ecore_evas_wayland_type_set(Ecore_Evas *ee, int type);
908 EAPI Ecore_Wl_Window *ecore_evas_wayland_window_get(const Ecore_Evas *ee);
911 * @brief Create a new @c Ecore_Evas canvas bound to the Evas
914 * @param w The width of the canvas, in pixels
915 * @param h The height of the canvas, in pixels
916 * @return A new @c Ecore_Evas instance or @c NULL, on failure
918 * This creates a new buffer canvas wrapper, with image data array
919 * @b bound to the ARGB format, 8 bits per pixel.
921 * This function will allocate the needed pixels array with canonical
922 * @c malloc(). If you wish a custom function to allocate it, consider
923 * using ecore_evas_buffer_allocfunc_new(), instead.
925 * @note This function actually is a wrapper on
926 * ecore_evas_buffer_allocfunc_new(), using the same @a w and @a h
927 * arguments and canonical @c malloc() and @c free() to the memory
928 * allocation and freeing functions. See that function's documentation
931 EAPI Ecore_Evas *ecore_evas_buffer_new(int w, int h);
934 * @brief Create a new @c Ecore_Evas canvas bound to the Evas
935 * @b buffer engine, giving custom allocation and freeing functions for
936 * the canvas memory region
938 * @param w The width of the canvas, in canvas units
939 * @param h The height of the canvas, in canvas units
940 * @param alloc_func Function to be called to allocate the memory
941 * needed for the new buffer canvas. @a data will be passed the same
942 * value as the @p data of this function, while @a size will be passed
943 * @p w times @p h times @c sizeof(int).
944 * @param free_func Function to be called to free the memory used by
945 * the new buffer canvas. @a data will be passed the same value as the
946 * @p data of this function, while @a pix will be passed the canvas
948 * @param data Custom data to be passed to the allocation and freeing
950 * @return A new @c Ecore_Evas instance or @c NULL, on failure
952 * This creates a new buffer canvas wrapper, with image data array
953 * @b bound to the ARGB format, 8 bits per pixel.
955 * This function is useful when one wants an @c Ecore_Evas buffer
956 * canvas with a custom allocation function, like one getting memory
957 * chunks from a memory pool, for example.
959 * On any resizing of this @c Ecore_Evas buffer canvas, its image data
960 * will be @b freed, to be allocated again with the new size.
962 * @note @p w and @p h sizes have to greater or equal to 1. Otherwise,
963 * they'll be interpreted as 1, exactly.
965 * @see ecore_evas_buffer_new()
967 EAPI 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);
970 * @brief Grab a pointer to the actual pixels array of a given
971 * @c Ecore_Evas @b buffer canvas/window.
973 * @param ee An @c Ecore_Evas handle
974 * @return A pointer to the internal pixels array of @p ee
976 * Besides returning a pointer to the actual pixel array of the given
977 * canvas, this call will force a <b>rendering update on @p ee</b>,
980 * A common use case for this call is to create an image object, from
981 * @b another canvas, to have as data @p ee's contents, thus
982 * snapshoting the canvas. For that case, one can also use the
983 * ecore_evas_object_image_new() helper function.
985 EAPI const void *ecore_evas_buffer_pixels_get(Ecore_Evas *ee);
988 * @brief Create a new @c Ecore_Evas canvas bound to the Evas
989 * @b ews (Ecore + Evas Single Process Windowing System) engine
991 * EWS is a simple single process windowing system. The backing store
992 * is also an @c Ecore_Evas that can be setup with
993 * ecore_evas_ews_setup() and retrieved with
994 * ecore_evas_ews_ecore_evas_get(). It will allow window management
995 * using events prefixed with @c ECORE_EVAS_EVENT_EWS_.
997 * The EWS windows (returned by this function or
998 * ecore_evas_new("ews"...)) will all be software buffer windows
999 * automatic rendered to the backing store.
1001 * @param x horizontal position of window, in pixels
1002 * @param y vertical position of window, in pixels
1003 * @param w The width of the canvas, in pixels
1004 * @param h The height of the canvas, in pixels
1005 * @return A new @c Ecore_Evas instance or @c NULL, on failure
1007 * @see ecore_evas_ews_setup()
1008 * @see ecore_evas_ews_ecore_evas_get()
1012 EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h);
1016 * Returns the backing store image object that represents the given
1018 * @return The evas object of EWS backing store.
1020 * @note This should not be modified anyhow, but may be helpful to
1021 * determine stacking and geometry of it for window managers
1022 * that decorate windows.
1024 * @param ee The Ecore_Evas from which to get the backing store.
1025 * @see ecore_evas_ews_manager_set()
1026 * @see ecore_evas_ews_evas_get()
1029 EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee);
1032 * Calls the window to be deleted (freed), but can let user decide to
1033 * forbid it by using ecore_evas_callback_delete_request_set()
1035 * @param ee The Ecore_Evas for which window will be deleted.
1038 EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee);
1041 * @brief Create an Evas image object with image data <b>bound to an
1042 * own, internal @c Ecore_Evas canvas wrapper</b>
1044 * @param ee_target @c Ecore_Evas to have the canvas receiving the new
1046 * @return A handle to the new image object
1048 * This will create a @b special Evas image object. The image's pixel
1049 * array will get bound to the same image data array of an @b internal
1050 * @b buffer @c Ecore_Evas canvas. The user of this function is, then,
1051 * supposed to grab that @c Ecore_Evas handle, with
1052 * ecore_evas_object_ecore_evas_get(), and use its canvas to render
1053 * whichever contents he/she wants, @b independently of the contents
1054 * of the canvas owned by @p ee_target. Those contents will reflect on
1055 * the canvas of @p ee, though, being exactly the image data of the
1056 * object returned by this function.
1058 * This is a helper function for the scenario of one wanting to grab a
1059 * buffer canvas' contents (with ecore_evas_buffer_pixels_get()) to be
1060 * used on another canvas, for whichever reason. The most common goal
1061 * of this setup is to @b save an image file with a whole canvas as
1062 * contents, which could not be achieved by using an image file within
1063 * the target canvas.
1065 * @warning Always resize the returned image and its underlying
1066 * @c Ecore_Evas handle accordingly. They must be kept with same sizes
1067 * for things to work as expected. Also, you @b must issue
1068 * @c evas_object_image_size_set() on the image with that same size. If
1069 * the image is to be shown in a canvas bound to an engine different
1070 * than the buffer one, then you must also set this image's @b fill
1071 * properties accordingly.
1073 * @note The image returned will always be bound to the
1074 * @c EVAS_COLORSPACE_ARGB8888 colorspace, always.
1076 * @note Use ecore_evas_object_evas_get() to grab the image's internal
1077 * own canvas directly.
1079 * @note If snapshoting this image's internal canvas, remember to
1080 * flush its internal @c Ecore_Evas firstly, with
1081 * ecore_evas_manual_render().
1083 EAPI Evas_Object *ecore_evas_object_image_new(Ecore_Evas *ee_target);
1086 * @brief Retrieve the internal @c Ecore_Evas handle of an image
1087 * object created via ecore_evas_object_image_new()
1089 * @param obj A handle to an image object created via
1090 * ecore_evas_object_image_new()
1091 * @return The underlying @c Ecore_Evas handle in @p obj
1093 EAPI Ecore_Evas *ecore_evas_object_ecore_evas_get(Evas_Object *obj);
1096 * @brief Retrieve the canvas bound to the internal @c Ecore_Evas
1097 * handle of an image object created via ecore_evas_object_image_new()
1099 * @param obj A handle to an image object created via
1100 * ecore_evas_object_image_new()
1101 * @return A handle to @p obj's underlying @c Ecore_Evas's canvas
1103 EAPI Evas *ecore_evas_object_evas_get(Evas_Object *obj);
1105 EAPI Ecore_Evas *ecore_evas_software_gdi_new(Ecore_Win32_Window *parent,
1111 EAPI Ecore_Evas *ecore_evas_software_ddraw_new(Ecore_Win32_Window *parent,
1117 EAPI Ecore_Evas *ecore_evas_software_16_ddraw_new(Ecore_Win32_Window *parent,
1123 EAPI Ecore_Evas *ecore_evas_direct3d_new(Ecore_Win32_Window *parent,
1129 EAPI Ecore_Evas *ecore_evas_gl_glew_new(Ecore_Win32_Window *parent,
1135 EAPI Ecore_Win32_Window *ecore_evas_win32_window_get(const Ecore_Evas *ee);
1137 EAPI Ecore_Evas *ecore_evas_sdl_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
1138 EAPI Ecore_Evas *ecore_evas_sdl16_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
1139 EAPI Ecore_Evas *ecore_evas_gl_sdl_new(const char* name, int w, int h, int fullscreen, int noframe);
1141 EAPI Ecore_Evas *ecore_evas_software_wince_new(Ecore_WinCE_Window *parent,
1147 EAPI Ecore_Evas *ecore_evas_software_wince_fb_new(Ecore_WinCE_Window *parent,
1153 EAPI Ecore_Evas *ecore_evas_software_wince_gapi_new(Ecore_WinCE_Window *parent,
1159 EAPI Ecore_Evas *ecore_evas_software_wince_ddraw_new(Ecore_WinCE_Window *parent,
1165 EAPI Ecore_Evas *ecore_evas_software_wince_gdi_new(Ecore_WinCE_Window *parent,
1171 EAPI Ecore_WinCE_Window *ecore_evas_software_wince_window_get(const Ecore_Evas *ee);
1173 EAPI Ecore_Evas *ecore_evas_cocoa_new(Ecore_Cocoa_Window *parent,
1179 EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h);
1182 /* generic manipulation calls */
1184 * @brief Get the engine name used by this Ecore_Evas(window).
1186 * @param ee Ecore_Evas whose engine's name is desired.
1187 * @return A string that can(usually) be used in ecore_evas_new()
1189 * @see ecore_evas_free()
1191 EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee);
1193 * @brief Return the Ecore_Evas for this Evas
1195 * @param e The Evas to get the Ecore_Evas from
1196 * @return The Ecore_Evas that holds this Evas, or @c NULL if not held by one.
1198 * @warning Only use on Evas' created with ecore evas!
1200 EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e);
1202 * @brief Free an Ecore_Evas
1204 * @param ee The Ecore_Evas to free
1206 * This frees up any memory used by the Ecore_Evas.
1208 EAPI void ecore_evas_free(Ecore_Evas *ee);
1210 * @brief Retrieve user data associated with an Ecore_Evas.
1212 * @param ee The Ecore_Evas to retrieve the user data from.
1213 * @param key The key which the user data to be retrieved is associated with.
1215 * This function retrieves user specific data that has been stored within an
1216 * Ecore_Evas structure with ecore_evas_data_set().
1218 * @returns @c NULL on error or no data found, A pointer to the user data on
1221 * @see ecore_evas_data_set()
1223 EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key);
1225 * @brief Store user data in an Ecore_Evas structure.
1227 * @param ee The Ecore_Evas to store the user data in.
1228 * @param key A unique string to associate the user data against. Cannot
1230 * @param data A pointer to the user data to store.
1232 * This function associates the @p data with a @p key which is stored by
1233 * the Ecore_Evas @p ee. Be aware that a call to ecore_evas_free() will
1234 * not free any memory for the associated user data, this is the responsibility
1237 * @see ecore_evas_callback_pre_free_set()
1238 * @see ecore_evas_free()
1239 * @see ecore_evas_data_get()
1241 EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data);
1243 * Set a callback for Ecore_Evas resize events.
1244 * @param ee The Ecore_Evas to set callbacks on
1245 * @param func The function to call
1247 * A call to this function will set a callback on an Ecore_Evas, causing
1248 * @p func to be called whenever @p ee is resized.
1250 * @warning If and when this function is called depends on the underlying
1253 EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1255 * Set a callback for Ecore_Evas move events.
1256 * @param ee The Ecore_Evas to set callbacks on
1257 * @param func The function to call
1259 * A call to this function will set a callback on an Ecore_Evas, causing
1260 * @p func to be called whenever @p ee is moved.
1262 * @warning If and when this function is called depends on the underlying
1265 EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1267 * Set a callback for Ecore_Evas show events.
1268 * @param ee The Ecore_Evas to set callbacks on
1269 * @param func The function to call
1271 * A call to this function will set a callback on an Ecore_Evas, causing
1272 * @p func to be called whenever @p ee is shown.
1274 * @warning If and when this function is called depends on the underlying
1277 EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1279 * Set a callback for Ecore_Evas hide events.
1280 * @param ee The Ecore_Evas to set callbacks on
1281 * @param func The function to call
1283 * A call to this function will set a callback on an Ecore_Evas, causing
1284 * @p func to be called whenever @p ee is hidden.
1286 * @warning If and when this function is called depends on the underlying
1289 EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1291 * Set a callback for Ecore_Evas delete request events.
1292 * @param ee The Ecore_Evas to set callbacks on
1293 * @param func The function to call
1295 * A call to this function will set a callback on an Ecore_Evas, causing
1296 * @p func to be called whenever @p ee gets a delete request.
1298 * @warning If and when this function is called depends on the underlying
1301 EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1303 * Set a callback for Ecore_Evas destroy events.
1304 * @param ee The Ecore_Evas to set callbacks on
1305 * @param func The function to call
1307 * A call to this function will set a callback on an Ecore_Evas, causing
1308 * @p func to be called whenever @p ee is destroyed.
1310 * @warning If and when this function is called depends on the underlying
1313 EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1315 * Set a callback for Ecore_Evas focus in events.
1316 * @param ee The Ecore_Evas to set callbacks on
1317 * @param func The function to call
1319 * A call to this function will set a callback on an Ecore_Evas, causing
1320 * @p func to be called whenever @p ee gets focus.
1322 * @warning If and when this function is called depends on the underlying
1325 EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1327 * Set a callback for Ecore_Evas focus out events.
1328 * @param ee The Ecore_Evas to set callbacks on
1329 * @param func The function to call
1331 * A call to this function will set a callback on an Ecore_Evas, causing
1332 * @p func to be called whenever @p ee loses focus.
1334 * @warning If and when this function is called depends on the underlying
1337 EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1339 * Set a callback for Ecore_Evas sticky events.
1340 * @param ee The Ecore_Evas to set callbacks on
1341 * @param func The function to call
1343 * A call to this function will set a callback on an Ecore_Evas, causing
1344 * @p func to be called whenever @p ee becomes sticky.
1346 * @warning If and when this function is called depends on the underlying
1349 EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1351 * Set a callback for Ecore_Evas un-sticky events.
1352 * @param ee The Ecore_Evas to set callbacks on
1353 * @param func The function to call
1355 * A call to this function will set a callback on an Ecore_Evas, causing
1356 * @p func to be called whenever @p ee becomes un-sticky.
1358 * @warning If and when this function is called depends on the underlying
1361 EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1363 * Set a callback for Ecore_Evas mouse in events.
1364 * @param ee The Ecore_Evas to set callbacks on
1365 * @param func The function to call
1367 * A call to this function will set a callback on an Ecore_Evas, causing
1368 * @p func to be called whenever the mouse enters @p ee.
1370 * @warning If and when this function is called depends on the underlying
1373 EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1375 * Set a callback for Ecore_Evas mouse out events.
1376 * @param ee The Ecore_Evas to set callbacks on
1377 * @param func The function to call
1379 * A call to this function will set a callback on an Ecore_Evas, causing
1380 * @p func to be called whenever the mouse leaves @p ee.
1382 * @warning If and when this function is called depends on the underlying
1385 EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1387 * Set a callback for Ecore_Evas pre render events.
1388 * @param ee The Ecore_Evas to set callbacks on
1389 * @param func The function to call
1391 * A call to this function will set a callback on an Ecore_Evas, causing
1392 * @p func to be called just before the evas in @p ee is rendered.
1394 * @warning If and when this function is called depends on the underlying
1397 EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1399 * Set a callback for Ecore_Evas mouse post render events.
1400 * @param ee The Ecore_Evas to set callbacks on
1401 * @param func The function to call
1403 * A call to this function will set a callback on an Ecore_Evas, causing
1404 * @p func to be called just after the evas in @p ee is rendered.
1406 * @warning If and when this function is called depends on the underlying
1409 EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1411 * Set a callback for Ecore_Evas pre-free event.
1412 * @param ee The Ecore_Evas to set callbacks on
1413 * @param func The function to call
1415 * A call to this function will set a callback on an Ecore_Evas, causing
1416 * @p func to be called just before the instance @p ee is freed.
1418 * @warning If and when this function is called depends on the underlying
1421 EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1423 * Set a callback for Ecore_Evas state changes.
1424 * @param ee The Ecore_Evas to set callbacks on
1425 * @param func The function to call
1427 * A call to this function will set a callback on an Ecore_Evas, causing
1428 * @p func to be called whenever @p ee changes state.
1431 * @warning If and when this function is called depends on the underlying
1434 EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1437 * Get an Ecore_Evas's Evas
1438 * @param ee The Ecore_Evas whose Evas you wish to get
1439 * @return The Evas wrapped by @p ee
1441 * This function returns the Evas contained within @p ee.
1443 EAPI Evas *ecore_evas_get(const Ecore_Evas *ee);
1446 * Provide Managed move co-ordinates for an Ecore_Evas
1447 * @param ee The Ecore_Evas to move
1448 * @param x The x coordinate to set as the managed location
1449 * @param y The y coordinate to set as the managed location
1451 * This sets the managed geometry position of the @p ee to (@p x, @p y)
1453 EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y);
1456 * Set whether an Ecore_Evas is shaped or not.
1458 * @param ee The Ecore_Evas to shape.
1459 * @param shaped @c EINA_TRUE to shape, @c EINA_FALSE to not.
1461 * This function allows one to make an Ecore_Evas shaped to the contents of the
1462 * evas. If @p shaped is @c EINA_TRUE, @p ee will be transparent in parts of
1463 * the evas that contain no objects. If @p shaped is @c EINA_FALSE, then @p ee
1464 * will be rectangular, and parts with no data will show random framebuffer
1465 * artifacting. For non-shaped Ecore_Evases, it is recommended to cover the
1466 * entire evas with a background object.
1468 EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped);
1471 * Query whether an Ecore_Evas is shaped or not.
1473 * @param ee The Ecore_Evas to query.
1474 * @return @c EINA_TRUE if shaped, @c EINA_FALSE if not.
1476 * This function returns @c EINA_TRUE if @p ee is shaped, and @c EINA_FALSE if not.
1478 EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee);
1480 * @brief Show an Ecore_Evas' window
1482 * @param ee The Ecore_Evas to show.
1484 * This function makes @p ee visible.
1486 EAPI void ecore_evas_show(Ecore_Evas *ee);
1488 * @brief Hide an Ecore_Evas' window
1490 * @param ee The Ecore_Evas to hide.
1492 * This function makes @p ee hidden(not visible).
1494 EAPI void ecore_evas_hide(Ecore_Evas *ee);
1497 * Activate (set focus to, via the window manager) an Ecore_Evas' window.
1498 * @param ee The Ecore_Evas to activate.
1500 * This functions activates the Ecore_Evas.
1502 EAPI void ecore_evas_activate(Ecore_Evas *ee);
1506 * Set the minimum size of a given @c Ecore_Evas window
1508 * @param ee An @c Ecore_Evas window's handle
1509 * @param w The minimum width
1510 * @param h The minimum height
1512 * This function sets the minimum size of @p ee to be @p w x @p h.
1513 * One won't be able to resize that window to dimensions smaller than
1516 * @note When base sizes are set, via ecore_evas_size_base_set(),
1517 * they'll be used to calculate a window's minimum size, instead of
1518 * those set by this function.
1520 * @see ecore_evas_size_min_get()
1522 EAPI void ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h);
1525 * Get the minimum size set for a given @c Ecore_Evas window
1527 * @param ee An @c Ecore_Evas window's handle
1528 * @param w A pointer to an int to place the minimum width in.
1529 * @param h A pointer to an int to place the minimum height in.
1531 * @note Use @c NULL pointers on the size components you're not
1532 * interested in: they'll be ignored by the function.
1534 * @see ecore_evas_size_min_set() for more details
1536 EAPI void ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h);
1539 * Set the maximum size of a given @c Ecore_Evas window
1541 * @param ee An @c Ecore_Evas window's handle
1542 * @param w The maximum width
1543 * @param h The maximum height
1545 * This function sets the maximum size of @p ee to be @p w x @p h.
1546 * One won't be able to resize that window to dimensions bigger than
1549 * @see ecore_evas_size_max_get()
1551 EAPI void ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h);
1554 * Get the maximum size set for a given @c Ecore_Evas window
1556 * @param ee An @c Ecore_Evas window's handle
1557 * @param w A pointer to an int to place the maximum width in.
1558 * @param h A pointer to an int to place the maximum height in.
1560 * @note Use @c NULL pointers on the size components you're not
1561 * interested in: they'll be ignored by the function.
1563 * @see ecore_evas_size_max_set() for more details
1565 EAPI void ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h);
1568 * Set the base size for a given @c Ecore_Evas window
1570 * @param ee An @c Ecore_Evas window's handle
1571 * @param w The base width
1572 * @param h The base height
1574 * This function sets the @b base size of @p ee to be @p w x @p h.
1575 * When base sizes are set, they'll be used to calculate a window's
1576 * @b minimum size, instead of those set by ecore_evas_size_min_get().
1578 * @see ecore_evas_size_base_get()
1580 EAPI void ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h);
1583 * Get the base size set for a given @c Ecore_Evas window
1585 * @param ee An @c Ecore_Evas window's handle
1586 * @param w A pointer to an int to place the base width in.
1587 * @param h A pointer to an int to place the base height in.
1589 * @note Use @c NULL pointers on the size components you're not
1590 * interested in: they'll be ignored by the function.
1592 * @see ecore_evas_size_base_set() for more details
1594 EAPI void ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h);
1597 * Set the "size step" for a given @c Ecore_Evas window
1599 * @param ee An @c Ecore_Evas window's handle
1600 * @param w The step width
1601 * @param h The step height
1603 * This function sets the size steps of @p ee to be @p w x @p h. This
1604 * limits the size of this @c Ecore_Evas window to be @b always an
1605 * integer multiple of the step size, for each axis.
1607 EAPI void ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h);
1610 * Get the "size step" set for a given @c Ecore_Evas window
1612 * @param ee An @c Ecore_Evas window's handle
1613 * @param w A pointer to an int to place the step width in.
1614 * @param h A pointer to an int to place the step height in.
1616 * @note Use @c NULL pointers on the size components you're not
1617 * interested in: they'll be ignored by the function.
1619 * @see ecore_evas_size_base_set() for more details
1621 EAPI void ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h);
1624 * @brief Set the cursor of an Ecore_Evas.
1626 * @param ee The Ecore_Evas
1627 * @param file The path to an image file for the cursor.
1628 * @param layer The layer in which the cursor will appear.
1629 * @param hot_x The x coordinate of the cursor's hot spot.
1630 * @param hot_y The y coordinate of the cursor's hot spot.
1632 * This function makes the mouse cursor over @p ee be the image specified by
1633 * @p file. The actual point within the image that the mouse is at is specified
1634 * by @p hot_x and @p hot_y, which are coordinates with respect to the top left
1635 * corner of the cursor image.
1637 * @note This function creates an object from the image and uses
1638 * ecore_evas_object_cursor_set().
1640 * @see ecore_evas_object_cursor_set()
1642 EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y);
1644 * @brief Get information about an Ecore_Evas' cursor
1646 * @param ee The Ecore_Evas to set
1647 * @param obj A pointer to an Evas_Object to place the cursor Evas_Object.
1648 * @param layer A pointer to an int to place the cursor's layer in.
1649 * @param hot_x A pointer to an int to place the cursor's hot_x coordinate in.
1650 * @param hot_y A pointer to an int to place the cursor's hot_y coordinate in.
1652 * This function queries information about an Ecore_Evas' cursor.
1654 * @see ecore_evas_cursor_set()
1655 * @see ecore_evas_object_cursor_set()
1657 EAPI void ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y);
1659 * @brief Set the cursor of an Ecore_Evas
1661 * @param ee The Ecore_Evas
1663 * @param obj The Evas_Object which will be the cursor.
1664 * @param layer The layer in which the cursor will appear.
1665 * @param hot_x The x coordinate of the cursor's hot spot.
1666 * @param hot_y The y coordinate of the cursor's hot spot.
1668 * This function makes the mouse cursor over @p ee be the object specified by
1669 * @p obj. The actual point within the object that the mouse is at is specified
1670 * by @p hot_x and @p hot_y, which are coordinates with respect to the top left
1671 * corner of the cursor object.
1673 * @see ecore_evas_cursor_set()
1675 EAPI void ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj, int layer, int hot_x, int hot_y);
1678 * Tell the WM whether or not to ignore an Ecore_Evas' window
1680 * @param ee The Ecore_Evas.
1681 * @param on @c EINA_TRUE to ignore, @c EINA_FALSE to not.
1683 * This function causes the window manager to ignore @p ee if @p on is
1684 * @c EINA_TRUE, or not ignore @p ee if @p on is @c EINA_FALSE.
1686 EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on);
1689 * Query whether an Ecore_Evas' window is overridden or not
1691 * @param ee The Ecore_Evas to set.
1692 * @return @c EINA_TRUE if @p ee is overridden, @c EINA_FALSE if not.
1694 EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee);
1697 * Set whether or not an Ecore_Evas' window should avoid damage
1699 * @param ee The Ecore_Evas
1700 * @param on The type of the damage management
1702 * This function causes @p ee to be drawn to a pixmap to avoid recalculations.
1703 * On expose events it will copy from the pixmap to the window.
1705 EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on);
1708 * Query whether an Ecore_Evas' window avoids damage or not
1709 * @param ee The Ecore_Evas to set
1710 * @return The type of the damage management
1713 EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee);
1716 * Set the withdrawn state of an Ecore_Evas' window.
1717 * @param ee The Ecore_Evas whose window's withdrawn state is set.
1718 * @param withdrawn The Ecore_Evas window's new withdrawn state.
1721 EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn);
1724 * Returns the withdrawn state of an Ecore_Evas' window.
1725 * @param ee The Ecore_Evas whose window's withdrawn state is returned.
1726 * @return The Ecore_Evas window's withdrawn state.
1729 EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee);
1732 * Set the sticky state of an Ecore_Evas window.
1734 * @param ee The Ecore_Evas whose window's sticky state is set.
1735 * @param sticky The Ecore_Evas window's new sticky state.
1738 EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky);
1741 * Returns the sticky state of an Ecore_Evas' window.
1743 * @param ee The Ecore_Evas whose window's sticky state is returned.
1744 * @return The Ecore_Evas window's sticky state.
1747 EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee);
1748 EAPI void ecore_evas_manual_render_set(Ecore_Evas *ee, Eina_Bool manual_render);
1749 EAPI Eina_Bool ecore_evas_manual_render_get(const Ecore_Evas *ee);
1752 * @brief Registers an @c Ecore_Evas to receive events through ecore_input_evas.
1754 * @param ee The @c Ecore_Evas handle.
1756 * This function calls ecore_event_window_register() with the @p ee as its @c
1757 * id argument, @c window argument, and uses its @c Evas too. It is useful when
1758 * no @c window information is available on a given @c Ecore_Evas backend.
1760 * @see ecore_evas_input_event_unregister()
1763 EAPI void ecore_evas_input_event_register(Ecore_Evas *ee);
1765 * @brief Unregisters an @c Ecore_Evas receiving events through ecore_input_evas.
1767 * @param ee The @c Ecore_Evas handle.
1769 * @see ecore_evas_input_event_register()
1772 EAPI void ecore_evas_input_event_unregister(Ecore_Evas *ee);
1775 * @brief Force immediate rendering on a given @c Ecore_Evas window
1777 * @param ee An @c Ecore_Evas handle
1779 * Use this call to forcefully flush the @p ee's canvas rendering
1780 * pipeline, thus bring its window to an up to date state.
1782 EAPI void ecore_evas_manual_render(Ecore_Evas *ee);
1783 EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync);
1784 EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee);
1786 * @brief Get geometry of screen associated with this Ecore_Evas.
1788 * @param ee The Ecore_Evas whose window's to query container screen geometry.
1789 * @param x where to return the horizontal offset value. May be @c NULL.
1790 * @param y where to return the vertical offset value. May be @c NULL.
1791 * @param w where to return the width value. May be @c NULL.
1792 * @param h where to return the height value. May be @c NULL.
1796 EAPI void ecore_evas_screen_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
1798 EAPI void ecore_evas_draw_frame_set(Ecore_Evas *ee, Eina_Bool draw_frame);
1799 EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee);
1802 * @brief Associate the given object to this ecore evas.
1804 * @param ee The Ecore_Evas to associate to @a obj
1805 * @param obj The object to associate to @a ee
1806 * @param flags The association flags.
1807 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1809 * Association means that operations on one will affect the other, for
1810 * example moving the object will move the window, resize the object will
1811 * also affect the ecore evas window, hide and show applies as well.
1813 * This is meant to simplify development, since you often need to associate
1814 * these events with your "base" objects, background or bottom-most object.
1816 * Be aware that some methods might not be what you would like, deleting
1817 * either the window or the object will delete the other. If you want to
1818 * change that behavior, let's say to hide window when it's closed, you
1819 * must use ecore_evas_callback_delete_request_set() and set your own code,
1820 * like ecore_evas_hide(). Just remember that if you override delete_request
1821 * and still want to delete the window/object, you must do that yourself.
1823 * Since we now define delete_request, deleting windows will not quit
1824 * main loop, if you wish to do so, you should listen for EVAS_CALLBACK_FREE
1825 * on the object, that way you get notified and you can call
1826 * ecore_main_loop_quit().
1828 * Flags can be OR'ed of:
1829 * @li ECORE_EVAS_OBJECT_ASSOCIATE_BASE (or 0): to listen to basic events
1830 * like delete, resize and move, but no stacking or layer are used.
1831 * @li ECORE_EVAS_OBJECT_ASSOCIATE_STACK: stacking operations will act
1832 * on the Ecore_Evas, not the object. So evas_object_raise() will
1833 * call ecore_evas_raise(). Relative operations (stack_above, stack_below)
1834 * are still not implemented.
1835 * @li ECORE_EVAS_OBJECT_ASSOCIATE_LAYER: stacking operations will act
1836 * on the Ecore_Evas, not the object. So evas_object_layer_set() will
1837 * call ecore_evas_layer_set().
1838 * @li ECORE_EVAS_OBJECT_ASSOCIATE_DEL: the object delete will delete the
1839 * ecore_evas as well as delete_requests on the ecore_evas will delete
1842 EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags);
1844 * @brief Cancel the association set with ecore_evas_object_associate().
1846 * @param ee The Ecore_Evas to dissociate from @a obj
1847 * @param obj The object to dissociate from @a ee
1848 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1850 EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj);
1852 * @brief Get the object associated with @p ee
1854 * @param ee The Ecore_Evas to get the object from.
1855 * @return The associated object, or @c NULL if there is no associated object.
1857 EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee);
1859 /* helper function to be used with ECORE_GETOPT_CALLBACK_*() */
1860 EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage);
1863 * @brief Get a list of all the ecore_evases.
1865 * @return A list of ecore_evases.
1867 * The returned list of ecore evases is only valid until the canvases are
1868 * destroyed (and should not be cached for instance). The list can be freed by
1869 * just deleting the list.
1871 EAPI Eina_List *ecore_evas_ecore_evas_list_get(void);
1873 /* specific calls to an x11 environment ecore_evas */
1874 EAPI void ecore_evas_x11_leader_set(Ecore_Evas *ee, Ecore_X_Window win);
1875 EAPI Ecore_X_Window ecore_evas_x11_leader_get(Ecore_Evas *ee);
1876 EAPI void ecore_evas_x11_leader_default_set(Ecore_Evas *ee);
1877 EAPI void ecore_evas_x11_shape_input_rectangle_set(Ecore_Evas *ee, int x, int y, int w, int h);
1878 EAPI void ecore_evas_x11_shape_input_rectangle_add(Ecore_Evas *ee, int x, int y, int w, int h);
1879 EAPI void ecore_evas_x11_shape_input_rectangle_subtract(Ecore_Evas *ee, int x, int y, int w, int h);
1880 EAPI void ecore_evas_x11_shape_input_empty(Ecore_Evas *ee);
1881 EAPI void ecore_evas_x11_shape_input_reset(Ecore_Evas *ee);
1882 EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee);
1885 * @defgroup Ecore_Evas_Ews Ecore_Evas Single Process Windowing System.
1887 * These are global scope functions to manage the EWS to be used by
1888 * ecore_evas_ews_new().
1895 * Sets the engine to be used by the backing store engine.
1897 * @param engine The engine to be set.
1898 * @param options The options of the engine to be set.
1899 * @return @c EINA_TRUE on success, @c EINA_FALSE if ews is already in use.
1902 EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options);
1905 * Reconfigure the backing store used.
1907 * @param x The X coordinate to be used.
1908 * @param y The Y coordinate to be used.
1909 * @param w The width of the Ecore_Evas to setup.
1910 * @param h The height of the Ecore_Evas to setup.
1911 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1914 EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h);
1917 * Return the internal backing store in use.
1919 * @return The internal backing store in use.
1920 * @note this will forced it to be created, making future calls to
1921 * ecore_evas_ews_engine_set() void.
1923 * @see ecore_evas_ews_evas_get()
1926 EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void);
1929 * Return the internal backing store in use.
1931 * @return The internal backing store in use.
1932 * @note this will forced it to be created, making future calls to
1933 * ecore_evas_ews_engine_set() void.
1935 * @see ecore_evas_ews_ecore_evas_get()
1938 EAPI Evas *ecore_evas_ews_evas_get(void);
1941 * Get the current background.
1943 EAPI Evas_Object *ecore_evas_ews_background_get(void);
1946 * Set the current background, must be created at evas ecore_evas_ews_evas_get()
1948 * It will be kept at lowest layer (EVAS_LAYER_MIN) and below
1949 * everything else. You can set any object, default is a black
1952 * @note previous object will be deleted!
1953 * @param o The Evas_Object for which to set the background.
1955 EAPI void ecore_evas_ews_background_set(Evas_Object *o);
1958 * Return all Ecore_Evas* created by EWS.
1960 * @return An eina list of Ecore_evases.
1961 e @note Do not change the returned list or its contents.
1964 EAPI const Eina_List *ecore_evas_ews_children_get(void);
1967 * Set the identifier of the manager taking care of internal windows.
1969 * The ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE event is issued. Consider
1970 * handling it to know if you should stop handling events yourself
1971 * (ie: another manager took over)
1973 * @param manager any unique identifier address.
1975 * @see ecore_evas_ews_manager_get()
1978 EAPI void ecore_evas_ews_manager_set(const void *manager);
1981 * Get the identifier of the manager taking care of internal windows.
1983 * @return the value set by ecore_evas_ews_manager_set()
1986 EAPI const void *ecore_evas_ews_manager_get(void);
1988 EAPI extern int ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE; /**< manager was changed @since 1.1 */
1989 EAPI extern int ECORE_EVAS_EWS_EVENT_ADD; /**< window was created @since 1.1 */
1990 EAPI extern int ECORE_EVAS_EWS_EVENT_DEL; /**< window was deleted, pointer is already invalid but may be used as reference for further cleanup work. @since 1.1 */
1991 EAPI extern int ECORE_EVAS_EWS_EVENT_RESIZE; /**< window was resized @since 1.1 */
1992 EAPI extern int ECORE_EVAS_EWS_EVENT_MOVE; /**< window was moved @since 1.1 */
1993 EAPI extern int ECORE_EVAS_EWS_EVENT_SHOW; /**< window become visible @since 1.1 */
1994 EAPI extern int ECORE_EVAS_EWS_EVENT_HIDE; /**< window become hidden @since 1.1 */
1995 EAPI extern int ECORE_EVAS_EWS_EVENT_FOCUS; /**< window was focused @since 1.1 */
1996 EAPI extern int ECORE_EVAS_EWS_EVENT_UNFOCUS; /**< window lost focus @since 1.1 */
1997 EAPI extern int ECORE_EVAS_EWS_EVENT_RAISE; /**< window was raised @since 1.1 */
1998 EAPI extern int ECORE_EVAS_EWS_EVENT_LOWER; /**< window was lowered @since 1.1 */
1999 EAPI extern int ECORE_EVAS_EWS_EVENT_ACTIVATE; /**< window was activated @since 1.1 */
2001 EAPI extern int ECORE_EVAS_EWS_EVENT_ICONIFIED_CHANGE; /**< window minimized/iconified changed @since 1.1 */
2002 EAPI extern int ECORE_EVAS_EWS_EVENT_MAXIMIZED_CHANGE; /**< window maximized changed @since 1.1 */
2003 EAPI extern int ECORE_EVAS_EWS_EVENT_LAYER_CHANGE; /**< window layer changed @since 1.1 */
2004 EAPI extern int ECORE_EVAS_EWS_EVENT_FULLSCREEN_CHANGE; /**< window fullscreen changed @since 1.1 */
2005 EAPI extern int ECORE_EVAS_EWS_EVENT_CONFIG_CHANGE; /**< some other window property changed (title, name, class, alpha, transparent, shaped...) @since 1.1 */
2012 * @defgroup Ecore_Evas_Extn External plug/socket infrastructure to remote canvases
2014 * These functions allow 1 process to create a "socket" was pluged into which another
2015 * process can create a "plug" remotely to plug into.
2016 * Socket can provides content for several plugs.
2017 * This is best for small sized objects (about the size range
2018 * of a small icon up to a few large icons). Sine the plug is actually an
2019 * image object, you can fetch the pixel data
2025 EAPI extern int ECORE_EVAS_EXTN_CLIENT_ADD; /**< this event is received when a plug has connected to an extn socket @since 1.2 */
2026 EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a plug has disconnected from an extn socket @since 1.2 */
2029 * @brief Create a new Ecore_Evas canvas for the new external ecore evas socket
2031 * @param w The width of the canvas, in pixels
2032 * @param h The height of the canvas, in pixels
2033 * @return A new @c Ecore_Evas instance or @c NULL, on failure
2035 * This creates a new extn_socket canvas wrapper, with image data array
2036 * @b bound to the ARGB format, 8 bits per pixel.
2038 * If creation is successful, an Ecore_Evas handle is returned or @c NULL if
2039 * creation fails. Also focus, show, hide etc. callbacks will also be called
2040 * if the plug object is shown, or already visible on connect, or if it is
2041 * hidden later, focused or unfocused.
2043 * This function has to be flowed by ecore_evas_extn_socket_listen(),
2044 * for starting ecore ipc service.
2047 * Eina_Bool res = EINA_FALSE;
2048 * Ecore_Evas *ee = ecore_evas_extn_socket_new(1, 1);
2050 * res = ecore_evas_extn_socket_listen("svcname", 1, EINA_FALSE);
2052 * ecore_evas_resize(ee, 240, 400);
2058 * Eina_Bool res = EINA_FALSE;
2059 * Ecore_Evas *ee = ecore_evas_extn_socket_new(240, 400);
2061 * res = ecore_evas_extn_socket_listen("svcname", 1, EINA_FALSE);
2065 * When a client(plug) connects, you will get the ECORE_EVAS_EXTN_CLIENT_ADD event
2066 * in the ecore event queue, with event_info being the image object pointer
2067 * passed as a void pointer. When a client disconnects you will get the
2068 * ECORE_EVAS_EXTN_CLIENT_DEL event.
2070 * You can set up event handles for these events as follows:
2073 * static void client_add_cb(void *data, int event, void *event_info)
2075 * Evas_Object *obj = event_info;
2076 * printf("client added to image object %p\n", obj);
2077 * evas_object_show(obj);
2080 * static void client_del_cb(void *data, int event, void *event_info)
2082 * Evas_Object *obj = event_info;
2083 * printf("client deleted from image object %p\n", obj);
2084 * evas_object_hide(obj);
2089 * ecore_event_handler_add(ECORE_EVAS_EXTN_CLIENT_ADD,
2090 * client_add_cb, NULL);
2091 * ecore_event_handler_add(ECORE_EVAS_EXTN_CLIENT_DEL,
2092 * client_del_cb, NULL);
2096 * Note that events come in later after the event happened. You may want to be
2097 * careful as data structures you had associated with the image object
2098 * may have been freed after deleting, but the object may still be around
2099 * awating cleanup and thus still be valid.You can change the size with something like:
2101 * @see ecore_evas_extn_socket_listen()
2102 * @see ecore_evas_extn_plug_new()
2103 * @see ecore_evas_extn_plug_object_data_lock()
2104 * @see ecore_evas_extn_plug_object_data_unlock()
2108 EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h);
2111 * @brief Create a socket to provide the service for external ecore evas
2114 * @param ee The Ecore_Evas.
2115 * @param svcname The name of the service to be advertised. ensure that it is
2116 * unique (when combined with @p svcnum) otherwise creation may fail.
2117 * @param svcnum A number (any value, @c 0 being the common default) to
2118 * differentiate multiple instances of services with the same name.
2119 * @param svcsys A boolean that if true, specifies to create a system-wide
2120 * service all users can connect to, otherwise the service is private to the
2121 * user ide that created the service.
2122 * @return @c EINA_TRUE if creation is successful, @c EINA_FALSE if it does
2125 * This creates socket specified by @p svcname, @p svcnum and @p svcsys. If
2126 * creation is successful, @c EINA_TRUE is returned or @c EINA_FALSE if
2129 * @see ecore_evas_extn_socket_new()
2130 * @see ecore_evas_extn_plug_new()
2131 * @see ecore_evas_extn_plug_object_data_lock()
2132 * @see ecore_evas_extn_plug_object_data_unlock()
2136 EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname, int svcnum, Eina_Bool svcsys);
2139 * @brief Lock the pixel data so the socket cannot change it
2141 * @param obj The image object returned by ecore_evas_extn_plug_new() to lock
2143 * You may need to get the image pixel data with evas_object_image_data_get()
2144 * from the image object, but need to ensure that it does not change while
2145 * you are using the data. This function lets you set an advisory lock on the
2146 * image data so the external plug process will not render to it or alter it.
2148 * You should only hold the lock for just as long as you need to read out the
2149 * image data or otherwise deal with it, and then unlock it with
2150 * ecore_evas_extn_plug_object_data_unlock(). Keeping a lock over more than
2151 * 1 iteration of the main ecore loop will be problematic, so avoid it. Also
2152 * forgetting to unlock may cause the socket process to freeze and thus create
2155 * @see ecore_evas_extn_plug_new()
2156 * @see ecore_evas_extn_plug_object_data_unlock()
2160 EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj);
2163 * @brief Unlock the pixel data so the socket can change it again.
2165 * @param obj The image object returned by ecore_evas_extn_plug_new() to unlock
2167 * This unlocks after an advisor lock has been taken by
2168 * ecore_evas_extn_plug_object_data_lock().
2170 * @see ecore_evas_extn_plug_new()
2171 * @see ecore_evas_extn_plug_object_data_lock()
2175 EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj);
2178 * @brief Create a new external ecore evas plug
2180 * @param ee_target The Ecore_Evas containing the canvas in which the new image object will live.
2181 * @return An evas image object that will contain the image output of a socket.
2183 * This creates an image object that will contain the output of another
2184 * processes socket canvas when it connects. All input will be sent back to
2185 * this process as well, effectively swallowing or placing the socket process
2186 * in the canvas of the plug process in place of the image object. The image
2187 * object by default is created to be filled (equivalent of
2188 * evas_object_image_filled_add() on creation) so image content will scale
2189 * to fill the image unless otherwise reconfigured. The Ecore_Evas size
2190 * of the plug is the master size and determines size in pixels of the
2191 * plug canvas. You can change the size with something like:
2194 * Eina_Bool res = EINA_FALSE;
2195 * Evas_Object *obj = ecore_evas_extn_plug_new(ee);
2197 * res = ecore_evas_extn_plug_connect("svcname", 1, EINA_FALSE);
2199 * ecore_evas_resize(ee, 240, 400);
2202 * @see ecore_evas_extn_socket_new()
2203 * @see ecore_evas_extn_plug_connect()
2206 EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target);
2209 * @brief Connect an external ecore evas plug to service provided by external
2210 * ecore evas socket.
2212 * @param obj The Ecore_Evas containing the canvas in which the new image
2214 * @param svcname The service name to connect to set up by the socket.
2215 * @param svcnum The service number to connect to (set up by socket).
2216 * @param svcsys Boolean to set if the service is a system one or not (set up
2218 * @return @c EINA_TRUE if creation is successful, @c EINA_FALSE if it does
2221 * @see ecore_evas_extn_plug_new()
2225 EAPI Eina_Bool ecore_evas_extn_plug_connect(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);