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 * @param engines list with engines names
222 EAPI void ecore_evas_engines_free(Eina_List *engines);
224 * @brief Creates a new Ecore_Evas based on engine name and common parameters.
226 * @param engine_name engine name as returned by
227 * ecore_evas_engines_get() or @c NULL to use environment variable
228 * ECORE_EVAS_ENGINE, that can be undefined and in this case
229 * this call will try to find the first working engine.
230 * @param x horizontal position of window (not supported in all engines)
231 * @param y vertical position of window (not supported in all engines)
232 * @param w width of window
233 * @param h height of window
234 * @param extra_options string with extra parameter, dependent on engines
235 * or @ NULL. String is usually in the form: 'key1=value1;key2=value2'.
236 * Pay attention that when getting that from shell commands, most
237 * consider ';' as the command terminator, so you need to escape
240 * @return Ecore_Evas instance or @c NULL if creation failed.
242 EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options);
244 * @brief Set whether an Ecore_Evas has an alpha channel or not.
246 * @param ee The Ecore_Evas to shape
247 * @param alpha @c EINA_TRUE to enable the alpha channel, @c EINA_FALSE to
250 * This function allows you to make an Ecore_Evas translucent using an
251 * alpha channel. See ecore_evas_shaped_set() for details. The difference
252 * between a shaped window and a window with an alpha channel is that an
253 * alpha channel supports multiple levels of transparency, as opposed to
254 * the 1 bit transparency of a shaped window (a pixel is either opaque, or
257 * @warning Support for this depends on the underlying windowing system.
259 EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha);
261 * @brief Query whether an Ecore_Evas has an alpha channel.
262 * @param ee The Ecore_Evas to query.
263 * @return @c EINA_TRUE if ee has an alpha channel, @c EINA_FALSE if it does
266 * This function returns @c EINA_TRUE if @p ee has an alpha channel, and
267 * @c EINA_FALSE if it does not.
269 * @see ecore_evas_alpha_set()
271 EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee);
273 * @brief Set whether an Ecore_Evas has an transparent window or not.
275 * @param ee The Ecore_Evas to shape
276 * @param transparent @c EINA_TRUE to enable the transparent window,
277 * @c EINA_FALSE to disable it
279 * This function sets some translucency options, for more complete support see
280 * ecore_evas_alpha_set().
282 * @warning Support for this depends on the underlying windowing system.
284 * @see ecore_evas_alpha_set()
286 EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparent);
288 * @brief Query whether an Ecore_Evas is transparent.
290 * @param ee The Ecore_Evas to query.
291 * @return @c EINA_TRUE if ee is transparent, @c EINA_FALSE if it isn't.
293 * @see ecore_evas_transparent_set()
295 EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee);
297 * @brief Get the geometry of an Ecore_Evas.
299 * @param ee The Ecore_Evas whose geometry y
300 * @param x A pointer to an int to place the x coordinate in
301 * @param y A pointer to an int to place the y coordinate in
302 * @param w A pointer to an int to place the w size in
303 * @param h A pointer to an int to place the h size in
305 * This function takes four pointers to (already allocated) ints, and places
306 * the geometry of @p ee in them. If any of the parameters is not desired you
307 * may pass @c NULL on them.
311 * ecore_evas_geometry_get(ee, &x, &y, &w, &h);
314 * @see ecore_evas_new()
315 * @see ecore_evas_resize()
316 * @see ecore_evas_move()
317 * @see ecore_evas_move_resize()
319 EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
321 * @brief Get the geometry which an Ecore_Evas was latest recently requested.
323 * @param ee The Ecore_Evas whose geometry y
324 * @param x A pointer to an int to place the x coordinate in
325 * @param y A pointer to an int to place the y coordinate in
326 * @param w A pointer to an int to place the w size in
327 * @param h A pointer to an int to place the h size in
329 * This function takes four pointers to (already allocated) ints, and places
330 * the geometry which @p ee was latest recently requested . If any of the
331 * parameters is not desired you may pass @c NULL on them.
332 * This function can represent recently requested geometry.
333 * ecore_evas_geometry_get function returns the value is updated after engine
334 * finished request. By comparison, ecore_evas_request_geometry_get returns
335 * recently requested value.
339 * ecore_evas_request_geometry_get(ee, &x, &y, &w, &h);
344 EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
346 * @brief Set the focus of an Ecore_Evas' window.
348 * @param ee The Ecore_Evas
349 * @param on @c EINA_TRUE for focus, @c EINA_FALSE to defocus.
351 * This function focuses @p ee if @p on is @c EINA_TRUE, or unfocuses @p ee if
352 * @p on is @c EINA_FALSE.
354 * @warning Support for this depends on the underlying windowing system.
356 EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on);
358 * @brief Query whether an Ecore_Evas' window is focused or not.
360 * @param ee The Ecore_Evas to set
361 * @return @c EINA_TRUE if @p ee if focused, @c EINA_FALSE if not.
363 * @see ecore_evas_focus_set()
365 EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee);
367 * @brief Iconify or uniconify an Ecore_Evas' window.
369 * @param ee The Ecore_Evas
370 * @param on @c EINA_TRUE to iconify, @c EINA_FALSE to uniconify.
372 * This function iconifies @p ee if @p on is @c EINA_TRUE, or uniconifies @p ee
373 * if @p on is @c EINA_FALSE.
375 * @note Iconify and minimize are synonyms.
377 * @warning Support for this depends on the underlying windowing system.
379 EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on);
381 * @brief Query whether an Ecore_Evas' window is iconified or not.
383 * @param ee The Ecore_Evas to set
384 * @return @c EINA_TRUE if @p ee is iconified, @c EINA_FALSE if not.
386 * @note Iconify and minimize are synonyms.
388 * @see ecore_evas_iconified_set()
390 EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee);
392 * @brief Set whether an Ecore_Evas' window is borderless or not.
394 * @param ee The Ecore_Evas
395 * @param on @c EINA_TRUE for borderless, @c EINA_FALSE for bordered.
397 * This function makes @p ee borderless if @p on is @c EINA_TRUE, or bordered
398 * if @p on is @c EINA_FALSE.
400 * @warning Support for this depends on the underlying windowing system.
402 EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on);
404 * @brief Query whether an Ecore_Evas' window is borderless or not.
406 * @param ee The Ecore_Evas to set
407 * @return @c EINA_TRUE if @p ee is borderless, @c EINA_FALSE if not.
409 * @see ecore_evas_borderless_set()
411 EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee);
413 * @brief Set whether or not an Ecore_Evas' window is fullscreen.
415 * @param ee The Ecore_Evas
416 * @param on @c EINA_TRUE fullscreen, @c EINA_FALSE not.
418 * This function causes @p ee to be fullscreen if @p on is @c EINA_TRUE, or
419 * not if @p on is @c EINA_FALSE.
421 * @warning Support for this depends on the underlying windowing system.
423 EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on);
425 * @brief Query whether an Ecore_Evas' window is fullscreen or not.
427 * @param ee The Ecore_Evas to set
428 * @return @c EINA_TRUE if @p ee is fullscreen, @c EINA_FALSE if not.
430 * @see ecore_evas_fullscreen_set()
432 EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee);
434 * @brief Set another window that this window is a group member of
436 * @param ee The Ecore_Evas
437 * @param ee_group The other group member
439 * If @p ee_group is @c NULL, @p ee is removed from the group, otherwise it is
440 * added. Note that if you free the @p ee_group canvas before @p ee, then
441 * getting the group canvas with ecore_evas_window_group_get() will return
444 * @warning Support for this depends on the underlying windowing system.
447 EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *ee_group);
449 * @brief Get the canvas group set.
451 * This returns the handle set by ecore_evas_window_group_set().
453 * @param ee The Ecore_Evas to set
454 * @return The Canvas group handle
456 * @see ecore_evas_window_group_set()
459 EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee);
461 * @brief Set the aspect ratio of a canvas window
463 * @param ee The Ecore_Evas
464 * @param aspect The aspect ratio (width divided by height), or 0 to disable
466 * This sets the desired aspect ratio of a canvas window
468 * @warning Support for this depends on the underlying windowing system.
471 EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect);
473 * @brief Get the aspect ratio of a canvas window
475 * This returns the value set by ecore_evas_aspect_set().
477 * @param ee The Ecore_Evas to set
478 * @return The aspect ratio
480 * @see ecore_evas_aspect_set()
483 EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee);
485 * @brief Set The urgent hint flag
487 * @param ee The Ecore_Evas
488 * @param urgent The urgent state flag
490 * This sets the "urgent" state hint on a window so the desktop environment
491 * can highlight it somehow.
493 * @warning Support for this depends on the underlying windowing system.
496 EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent);
498 * @brief Get the urgent state on the cavas window
500 * This returns the value set by ecore_evas_urgent_set()
502 * @param ee The Ecore_Evas to set
503 * @return The urgent state set
505 * @see ecore_evas_urgent_set()
508 EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee);
510 * @brief Set the modal state flag on the canvas window
512 * @param ee The Ecore_Evas
513 * @param modal The modal hint flag
515 * This hints if the window should be modal (eg if it is also transient
516 * for another window, the other window will maybe be denied focus by
517 * the desktop window manager).
519 * @warning Support for this depends on the underlying windowing system.
522 EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal);
524 * @brief Get The modal flag
526 * This returns the value set by ecore_evas_modal_set().
528 * @param ee The Ecore_Evas to set
529 * @return The modal flag
531 * @see ecore_evas_modal_set()
534 EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee);
536 * @brief Set the "i demand attention" flag on a canvas window
538 * @param ee The Ecore_Evas
539 * @param demand The flag state to set
541 * A window may demand attention now (eg you must enter a password before
542 * continuing), and so it may flag a window with this.
544 * @warning Support for this depends on the underlying windowing system.
547 EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand);
549 * @brief Get the "i demand attention" flag
551 * This returns the value set by ecore_evas_demand_attention_set().
553 * @param ee The Ecore_Evas to set
554 * @return The "i demand attention" flag.
556 * @see ecore_evas_demand_attention_set()
559 EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee);
561 * @brief Set the "focus skip" flag
563 * @param ee The Ecore_Evas
564 * @param skip The "focus skip" state to set.
566 * A window may not want to accept focus, be in the taskbar, pager etc.
567 * sometimes (example for a small notification window that hovers around
568 * a taskbar or panel, or hovers around a window until some activity
571 * @warning Support for this depends on the underlying windowing system.
574 EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip);
576 * @brief Get the "focus skip" flag
578 * This returns the value set by ecore_evas_focus_skip_set().
580 * @param ee The Ecore_Evas to set
581 * @return The "focus skip" flag.
583 * @see ecore_evas_focus_skip_set()
586 EAPI Eina_Bool ecore_evas_focus_skip_get(const Ecore_Evas *ee);
589 * @brief Set if this evas should ignore @b all events.
591 * @param ee The Ecore_Evas whose window's to ignore events.
592 * @param ignore The Ecore_Evas new ignore state.
594 * @warning Support for this depends on the underlying windowing system.
596 EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore);
598 * @brief Returns the ignore state of an Ecore_Evas' window.
600 * @param ee The Ecore_Evas whose window's ignore events state is returned.
601 * @return The Ecore_Evas window's ignore state.
603 * @see ecore_evas_ignore_events_set()
605 EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee);
607 * @brief Query whether an Ecore_Evas' window is visible or not.
609 * @param ee The Ecore_Evas to query.
610 * @return 1 if visible, 0 if not.
612 * This function queries @p ee and returns 1 if it is visible, and 0 if not.
614 * @see ecore_evas_show()
615 * @see ecore_evas_hide()
617 EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee);
619 * @brief Set the layer of an Ecore_Evas' window.
621 * @param ee The Ecore_Evas
622 * @param layer The layer to put @p ee on.
624 * This function moves @p ee to the layer @p layer.
626 * @warning Support for this depends on the underlying windowing system.
628 * @see ecore_evas_lower()
629 * @see ecore_evas_raise()
631 EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer);
633 * @brief Get the layer of an Ecore_Evas' window.
635 * @param ee The Ecore_Evas to set
636 * @return the layer @p ee's window is on.
638 * @see ecore_evas_layer_set()
639 * @see ecore_evas_lower()
640 * @see ecore_evas_raise()
642 EAPI int ecore_evas_layer_get(const Ecore_Evas *ee);
644 * @brief Maximize (or unmaximize) an Ecore_Evas' window.
646 * @param ee The Ecore_Evas
647 * @param on @c EINA_TRUE to maximize, @c EINA_FALSE to unmaximize.
649 * This function maximizes @p ee if @p on is @c EINA_TRUE, or unmaximizes @p ee
650 * if @p on is @c EINA_FALSE.
652 * @warning Support for this depends on the underlying windowing system.
654 EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on);
656 * @brief Query whether an Ecore_Evas' window is maximized or not.
658 * @param ee The Ecore_Evas to set
659 * @return @c EINA_TRUE if @p ee is maximized, @c EINA_FALSE if not.
661 * @see ecore_evas_maximized_set()
663 EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee);
665 * @brief Set Ecore_Evas's window profile list.
667 * @param ee The Ecore_Evas
668 * @param profiles The profile name list
669 * @param num_profiles The number of profile names
671 * @warning Support for this depends on the underlying windowing system.
674 EAPI void ecore_evas_profiles_set(Ecore_Evas *ee, const char **profiles, unsigned int num_profiles);
676 * @brief Get Ecore_Evas's window profile name.
678 * @param ee The Ecore_Evas
679 * @return The profile name
683 EAPI const char *ecore_evas_profile_get(const Ecore_Evas *ee);
685 * @brief Move an Ecore_Evas.
687 * @param ee The Ecore_Evas to move
688 * @param x The x coordinate to move to
689 * @param y The y coordinate to move to
691 * This moves @p ee to the screen coordinates (@p x, @p y)
693 * @warning Support for this depends on the underlying windowing system.
695 * @see ecore_evas_new()
696 * @see ecore_evas_resize()
697 * @see ecore_evas_move_resize()
699 EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y);
701 * @brief Resize an Ecore_Evas.
703 * @param ee The Ecore_Evas to move
704 * @param w The w coordinate to resize to
705 * @param h The h coordinate to resize to
707 * This resizes @p ee to @p w x @p h.
709 * @warning Support for this depends on the underlying windowing system.
711 * @see ecore_evas_new()
712 * @see ecore_evas_move()
713 * @see ecore_evas_move_resize()
715 EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h);
717 * @brief Move and resize an Ecore_Evas
719 * @param ee The Ecore_Evas to move and resize
720 * @param x The x coordinate to move to
721 * @param y The y coordinate to move to
722 * @param w The w coordinate to resize to
723 * @param h The h coordinate to resize to
725 * This moves @p ee to the screen coordinates (@p x, @p y) and resizes
728 * @warning Support for this depends on the underlying windowing system.
730 * @see ecore_evas_new()
731 * @see ecore_evas_move()
732 * @see ecore_evas_resize()
734 EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h);
736 * @brief Set the rotation of an Ecore_Evas' window.
738 * @param ee The Ecore_Evas
739 * @param rot the angle (in degrees) of rotation.
741 * The allowed values of @p rot depend on the engine being used. Most only
742 * allow multiples of 90.
744 * @warning Support for this depends on the underlying windowing system.
746 * @see ecore_evas_rotation_with_resize_set()
748 EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot);
750 * @brief Set the rotation of an Ecore_Evas' window
752 * @param ee The Ecore_Evas
753 * @param rot the angle (in degrees) of rotation.
755 * Like ecore_evas_rotation_set(), but it also resizes the window's contents so
756 * that they fit inside the current window geometry.
758 * @warning Support for this depends on the underlying windowing system.
760 * @see ecore_evas_rotation_set()
762 EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot);
764 * @brief Get the rotation of an Ecore_Evas' window
766 * @param ee The Ecore_Evas
767 * @return the angle (in degrees) of rotation.
769 * @see ecore_evas_rotation_set()
770 * @see ecore_evas_rotation_with_resize_set()
772 EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee);
774 * @brief Raise an Ecore_Evas' window.
776 * @param ee The Ecore_Evas to raise.
778 * This functions raises the Ecore_Evas to the front.
780 * @warning Support for this depends on the underlying windowing system.
782 * @see ecore_evas_lower()
783 * @see ecore_evas_layer_set()
785 EAPI void ecore_evas_raise(Ecore_Evas *ee);
787 * @brief Lower an Ecore_Evas' window.
789 * @param ee The Ecore_Evas to raise.
791 * This functions lowers the Ecore_Evas to the back.
793 * @warning Support for this depends on the underlying windowing system.
795 * @see ecore_evas_raise()
796 * @see ecore_evas_layer_set()
798 EAPI void ecore_evas_lower(Ecore_Evas *ee);
800 * @brief Set the title of an Ecore_Evas' window.
802 * @param ee The Ecore_Evas whose title you wish to set.
805 * This function sets the title of @p ee to @p t.
807 * @warning Support for this depends on the underlying windowing system.
809 EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t);
811 * @brief Get the title of an Ecore_Evas' window.
813 * @param ee The Ecore_Evas whose title you wish to get.
814 * @return The title of @p ee.
816 * This function returns the title of @p ee.
818 * @see ecore_evas_title_set()
820 EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee);
822 * @brief Set the name and class of an Ecore_Evas' window.
824 * @param ee the Ecore_Evas
828 * This function sets the name of @p ee to @p n, and its class to @p c. The
829 * meaning of @p name and @p class depends on the underlying windowing system.
831 * @warning Support for this depends on the underlying windowing system.
833 EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c);
835 * @brief Get the name and class of an Ecore_Evas' window
837 * This function gets the name of @p ee into @p n, and its class into
840 * @param ee The Ecore_Evas to query.
841 * @param n A pointer to a string to place the name in.
842 * @param c A pointer to a string to place the class in.
843 * @see ecore_evas_name_class_set()
845 EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c);
847 * @brief Returns a pointer to the underlying window.
849 * @param ee The Ecore_Evas whose window is desired.
850 * @return A pointer to the underlying window.
852 * @warning Support for this depends on the underlying windowing system.
854 EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee);
857 /* engine/target specific init calls */
858 EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
859 EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee);
860 EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
861 EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee);
862 EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
864 #define ECORE_EVAS_GL_X11_OPT_NONE 0
865 #define ECORE_EVAS_GL_X11_OPT_INDIRECT 1
866 #define ECORE_EVAS_GL_X11_OPT_VSYNC 2
867 #define ECORE_EVAS_GL_X11_OPT_LAST 3
869 EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
870 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);
871 EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee);
872 EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
873 EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee);
874 EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
875 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));
877 EAPI Ecore_Evas *ecore_evas_xrender_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
878 EAPI Ecore_X_Window ecore_evas_xrender_x11_window_get(const Ecore_Evas *ee);
879 EAPI void ecore_evas_xrender_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
880 EAPI Eina_Bool ecore_evas_xrender_x11_direct_resize_get(const Ecore_Evas *ee);
881 EAPI void ecore_evas_xrender_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
883 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);
884 EAPI Ecore_X_Window ecore_evas_software_x11_8_window_get(const Ecore_Evas *ee);
885 EAPI Ecore_X_Window ecore_evas_software_x11_8_subwindow_get(const Ecore_Evas *ee);
886 EAPI void ecore_evas_software_x11_8_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
887 EAPI Eina_Bool ecore_evas_software_x11_8_direct_resize_get(const Ecore_Evas *ee);
888 EAPI void ecore_evas_software_x11_8_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
890 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);
891 EAPI Ecore_X_Window ecore_evas_software_x11_16_window_get(const Ecore_Evas *ee);
892 EAPI void ecore_evas_software_x11_16_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
893 EAPI Eina_Bool ecore_evas_software_x11_16_direct_resize_get(const Ecore_Evas *ee);
894 EAPI void ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
896 EAPI Ecore_Evas *ecore_evas_fb_new(const char *disp_name, int rotation, int w, int h);
898 EAPI Ecore_Evas *ecore_evas_directfb_new(const char *disp_name, int windowed, int x, int y, int w, int h);
899 EAPI Ecore_DirectFB_Window *ecore_evas_directfb_window_get(const Ecore_Evas *ee);
902 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);
903 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);
904 EAPI void ecore_evas_wayland_resize(Ecore_Evas *ee, int location);
905 EAPI void ecore_evas_wayland_move(Ecore_Evas *ee, int x, int y);
907 /* EAPI void ecore_evas_wayland_drag_start(Ecore_Evas *ee, Ecore_Evas *drag_ee, void *source); */
908 EAPI void ecore_evas_wayland_pointer_set(Ecore_Evas *ee, int hot_x, int hot_y);
909 EAPI void ecore_evas_wayland_type_set(Ecore_Evas *ee, int type);
910 EAPI Ecore_Wl_Window *ecore_evas_wayland_window_get(const Ecore_Evas *ee);
913 * @brief Create a new @c Ecore_Evas canvas bound to the Evas
916 * @param w The width of the canvas, in pixels
917 * @param h The height of the canvas, in pixels
918 * @return A new @c Ecore_Evas instance or @c NULL, on failure
920 * This creates a new buffer canvas wrapper, with image data array
921 * @b bound to the ARGB format, 8 bits per pixel.
923 * This function will allocate the needed pixels array with canonical
924 * @c malloc(). If you wish a custom function to allocate it, consider
925 * using ecore_evas_buffer_allocfunc_new(), instead.
927 * @note This function actually is a wrapper on
928 * ecore_evas_buffer_allocfunc_new(), using the same @a w and @a h
929 * arguments and canonical @c malloc() and @c free() to the memory
930 * allocation and freeing functions. See that function's documentation
933 EAPI Ecore_Evas *ecore_evas_buffer_new(int w, int h);
936 * @brief Create a new @c Ecore_Evas canvas bound to the Evas
937 * @b buffer engine, giving custom allocation and freeing functions for
938 * the canvas memory region
940 * @param w The width of the canvas, in canvas units
941 * @param h The height of the canvas, in canvas units
942 * @param alloc_func Function to be called to allocate the memory
943 * needed for the new buffer canvas. @a data will be passed the same
944 * value as the @p data of this function, while @a size will be passed
945 * @p w times @p h times @c sizeof(int).
946 * @param free_func Function to be called to free the memory used by
947 * the new buffer canvas. @a data will be passed the same value as the
948 * @p data of this function, while @a pix will be passed the canvas
950 * @param data Custom data to be passed to the allocation and freeing
952 * @return A new @c Ecore_Evas instance or @c NULL, on failure
954 * This creates a new buffer canvas wrapper, with image data array
955 * @b bound to the ARGB format, 8 bits per pixel.
957 * This function is useful when one wants an @c Ecore_Evas buffer
958 * canvas with a custom allocation function, like one getting memory
959 * chunks from a memory pool, for example.
961 * On any resizing of this @c Ecore_Evas buffer canvas, its image data
962 * will be @b freed, to be allocated again with the new size.
964 * @note @p w and @p h sizes have to greater or equal to 1. Otherwise,
965 * they'll be interpreted as 1, exactly.
967 * @see ecore_evas_buffer_new()
969 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);
972 * @brief Grab a pointer to the actual pixels array of a given
973 * @c Ecore_Evas @b buffer canvas/window.
975 * @param ee An @c Ecore_Evas handle
976 * @return A pointer to the internal pixels array of @p ee
978 * Besides returning a pointer to the actual pixel array of the given
979 * canvas, this call will force a <b>rendering update on @p ee</b>,
982 * A common use case for this call is to create an image object, from
983 * @b another canvas, to have as data @p ee's contents, thus
984 * snapshoting the canvas. For that case, one can also use the
985 * ecore_evas_object_image_new() helper function.
987 EAPI const void *ecore_evas_buffer_pixels_get(Ecore_Evas *ee);
990 * @brief Create a new @c Ecore_Evas canvas bound to the Evas
991 * @b ews (Ecore + Evas Single Process Windowing System) engine
993 * EWS is a simple single process windowing system. The backing store
994 * is also an @c Ecore_Evas that can be setup with
995 * ecore_evas_ews_setup() and retrieved with
996 * ecore_evas_ews_ecore_evas_get(). It will allow window management
997 * using events prefixed with @c ECORE_EVAS_EVENT_EWS_.
999 * The EWS windows (returned by this function or
1000 * ecore_evas_new("ews"...)) will all be software buffer windows
1001 * automatic rendered to the backing store.
1003 * @param x horizontal position of window, in pixels
1004 * @param y vertical position of window, in pixels
1005 * @param w The width of the canvas, in pixels
1006 * @param h The height of the canvas, in pixels
1007 * @return A new @c Ecore_Evas instance or @c NULL, on failure
1009 * @see ecore_evas_ews_setup()
1010 * @see ecore_evas_ews_ecore_evas_get()
1014 EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h);
1018 * Returns the backing store image object that represents the given
1020 * @return The evas object of EWS backing store.
1022 * @note This should not be modified anyhow, but may be helpful to
1023 * determine stacking and geometry of it for window managers
1024 * that decorate windows.
1026 * @param ee The Ecore_Evas from which to get the backing store.
1027 * @see ecore_evas_ews_manager_set()
1028 * @see ecore_evas_ews_evas_get()
1031 EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee);
1034 * Calls the window to be deleted (freed), but can let user decide to
1035 * forbid it by using ecore_evas_callback_delete_request_set()
1037 * @param ee The Ecore_Evas for which window will be deleted.
1040 EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee);
1043 * @brief Create an Evas image object with image data <b>bound to an
1044 * own, internal @c Ecore_Evas canvas wrapper</b>
1046 * @param ee_target @c Ecore_Evas to have the canvas receiving the new
1048 * @return A handle to the new image object
1050 * This will create a @b special Evas image object. The image's pixel
1051 * array will get bound to the same image data array of an @b internal
1052 * @b buffer @c Ecore_Evas canvas. The user of this function is, then,
1053 * supposed to grab that @c Ecore_Evas handle, with
1054 * ecore_evas_object_ecore_evas_get(), and use its canvas to render
1055 * whichever contents he/she wants, @b independently of the contents
1056 * of the canvas owned by @p ee_target. Those contents will reflect on
1057 * the canvas of @p ee, though, being exactly the image data of the
1058 * object returned by this function.
1060 * This is a helper function for the scenario of one wanting to grab a
1061 * buffer canvas' contents (with ecore_evas_buffer_pixels_get()) to be
1062 * used on another canvas, for whichever reason. The most common goal
1063 * of this setup is to @b save an image file with a whole canvas as
1064 * contents, which could not be achieved by using an image file within
1065 * the target canvas.
1067 * @warning Always resize the returned image and its underlying
1068 * @c Ecore_Evas handle accordingly. They must be kept with same sizes
1069 * for things to work as expected. Also, you @b must issue
1070 * @c evas_object_image_size_set() on the image with that same size. If
1071 * the image is to be shown in a canvas bound to an engine different
1072 * than the buffer one, then you must also set this image's @b fill
1073 * properties accordingly.
1075 * @note The image returned will always be bound to the
1076 * @c EVAS_COLORSPACE_ARGB8888 colorspace, always.
1078 * @note Use ecore_evas_object_evas_get() to grab the image's internal
1079 * own canvas directly.
1081 * @note If snapshoting this image's internal canvas, remember to
1082 * flush its internal @c Ecore_Evas firstly, with
1083 * ecore_evas_manual_render().
1085 EAPI Evas_Object *ecore_evas_object_image_new(Ecore_Evas *ee_target);
1088 * @brief Retrieve the internal @c Ecore_Evas handle of an image
1089 * object created via ecore_evas_object_image_new()
1091 * @param obj A handle to an image object created via
1092 * ecore_evas_object_image_new()
1093 * @return The underlying @c Ecore_Evas handle in @p obj
1095 EAPI Ecore_Evas *ecore_evas_object_ecore_evas_get(Evas_Object *obj);
1098 * @brief Retrieve the canvas bound to the internal @c Ecore_Evas
1099 * handle of an image object created via ecore_evas_object_image_new()
1101 * @param obj A handle to an image object created via
1102 * ecore_evas_object_image_new()
1103 * @return A handle to @p obj's underlying @c Ecore_Evas's canvas
1105 EAPI Evas *ecore_evas_object_evas_get(Evas_Object *obj);
1107 EAPI Ecore_Evas *ecore_evas_software_gdi_new(Ecore_Win32_Window *parent,
1113 EAPI Ecore_Evas *ecore_evas_software_ddraw_new(Ecore_Win32_Window *parent,
1119 EAPI Ecore_Evas *ecore_evas_software_16_ddraw_new(Ecore_Win32_Window *parent,
1125 EAPI Ecore_Evas *ecore_evas_direct3d_new(Ecore_Win32_Window *parent,
1131 EAPI Ecore_Evas *ecore_evas_gl_glew_new(Ecore_Win32_Window *parent,
1137 EAPI Ecore_Win32_Window *ecore_evas_win32_window_get(const Ecore_Evas *ee);
1139 EAPI Ecore_Evas *ecore_evas_sdl_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
1140 EAPI Ecore_Evas *ecore_evas_sdl16_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
1141 EAPI Ecore_Evas *ecore_evas_gl_sdl_new(const char* name, int w, int h, int fullscreen, int noframe);
1143 EAPI Ecore_Evas *ecore_evas_software_wince_new(Ecore_WinCE_Window *parent,
1149 EAPI Ecore_Evas *ecore_evas_software_wince_fb_new(Ecore_WinCE_Window *parent,
1155 EAPI Ecore_Evas *ecore_evas_software_wince_gapi_new(Ecore_WinCE_Window *parent,
1161 EAPI Ecore_Evas *ecore_evas_software_wince_ddraw_new(Ecore_WinCE_Window *parent,
1167 EAPI Ecore_Evas *ecore_evas_software_wince_gdi_new(Ecore_WinCE_Window *parent,
1173 EAPI Ecore_WinCE_Window *ecore_evas_software_wince_window_get(const Ecore_Evas *ee);
1175 EAPI Ecore_Evas *ecore_evas_cocoa_new(Ecore_Cocoa_Window *parent,
1181 EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h);
1184 /* generic manipulation calls */
1186 * @brief Get the engine name used by this Ecore_Evas(window).
1188 * @param ee Ecore_Evas whose engine's name is desired.
1189 * @return A string that can(usually) be used in ecore_evas_new()
1191 * @see ecore_evas_free()
1193 EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee);
1195 * @brief Return the Ecore_Evas for this Evas
1197 * @param e The Evas to get the Ecore_Evas from
1198 * @return The Ecore_Evas that holds this Evas, or @c NULL if not held by one.
1200 * @warning Only use on Evas' created with ecore evas!
1202 EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e);
1204 * @brief Free an Ecore_Evas
1206 * @param ee The Ecore_Evas to free
1208 * This frees up any memory used by the Ecore_Evas.
1210 EAPI void ecore_evas_free(Ecore_Evas *ee);
1212 * @brief Retrieve user data associated with an Ecore_Evas.
1214 * @param ee The Ecore_Evas to retrieve the user data from.
1215 * @param key The key which the user data to be retrieved is associated with.
1217 * This function retrieves user specific data that has been stored within an
1218 * Ecore_Evas structure with ecore_evas_data_set().
1220 * @returns @c NULL on error or no data found, A pointer to the user data on
1223 * @see ecore_evas_data_set()
1225 EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key);
1227 * @brief Store user data in an Ecore_Evas structure.
1229 * @param ee The Ecore_Evas to store the user data in.
1230 * @param key A unique string to associate the user data against. Cannot
1232 * @param data A pointer to the user data to store.
1234 * This function associates the @p data with a @p key which is stored by
1235 * the Ecore_Evas @p ee. Be aware that a call to ecore_evas_free() will
1236 * not free any memory for the associated user data, this is the responsibility
1239 * @see ecore_evas_callback_pre_free_set()
1240 * @see ecore_evas_free()
1241 * @see ecore_evas_data_get()
1243 EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data);
1245 * Set a callback for Ecore_Evas resize events.
1246 * @param ee The Ecore_Evas to set callbacks on
1247 * @param func The function to call
1249 * A call to this function will set a callback on an Ecore_Evas, causing
1250 * @p func to be called whenever @p ee is resized.
1252 * @warning If and when this function is called depends on the underlying
1255 EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1257 * Set a callback for Ecore_Evas move events.
1258 * @param ee The Ecore_Evas to set callbacks on
1259 * @param func The function to call
1261 * A call to this function will set a callback on an Ecore_Evas, causing
1262 * @p func to be called whenever @p ee is moved.
1264 * @warning If and when this function is called depends on the underlying
1267 EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1269 * Set a callback for Ecore_Evas show events.
1270 * @param ee The Ecore_Evas to set callbacks on
1271 * @param func The function to call
1273 * A call to this function will set a callback on an Ecore_Evas, causing
1274 * @p func to be called whenever @p ee is shown.
1276 * @warning If and when this function is called depends on the underlying
1279 EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1281 * Set a callback for Ecore_Evas hide events.
1282 * @param ee The Ecore_Evas to set callbacks on
1283 * @param func The function to call
1285 * A call to this function will set a callback on an Ecore_Evas, causing
1286 * @p func to be called whenever @p ee is hidden.
1288 * @warning If and when this function is called depends on the underlying
1291 EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1293 * Set a callback for Ecore_Evas delete request events.
1294 * @param ee The Ecore_Evas to set callbacks on
1295 * @param func The function to call
1297 * A call to this function will set a callback on an Ecore_Evas, causing
1298 * @p func to be called whenever @p ee gets a delete request.
1300 * @warning If and when this function is called depends on the underlying
1303 EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1305 * Set a callback for Ecore_Evas destroy events.
1306 * @param ee The Ecore_Evas to set callbacks on
1307 * @param func The function to call
1309 * A call to this function will set a callback on an Ecore_Evas, causing
1310 * @p func to be called whenever @p ee is destroyed.
1312 * @warning If and when this function is called depends on the underlying
1315 EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1317 * Set a callback for Ecore_Evas focus in events.
1318 * @param ee The Ecore_Evas to set callbacks on
1319 * @param func The function to call
1321 * A call to this function will set a callback on an Ecore_Evas, causing
1322 * @p func to be called whenever @p ee gets focus.
1324 * @warning If and when this function is called depends on the underlying
1327 EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1329 * Set a callback for Ecore_Evas focus out events.
1330 * @param ee The Ecore_Evas to set callbacks on
1331 * @param func The function to call
1333 * A call to this function will set a callback on an Ecore_Evas, causing
1334 * @p func to be called whenever @p ee loses focus.
1336 * @warning If and when this function is called depends on the underlying
1339 EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1341 * Set a callback for Ecore_Evas sticky events.
1342 * @param ee The Ecore_Evas to set callbacks on
1343 * @param func The function to call
1345 * A call to this function will set a callback on an Ecore_Evas, causing
1346 * @p func to be called whenever @p ee becomes sticky.
1348 * @warning If and when this function is called depends on the underlying
1351 EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1353 * Set a callback for Ecore_Evas un-sticky events.
1354 * @param ee The Ecore_Evas to set callbacks on
1355 * @param func The function to call
1357 * A call to this function will set a callback on an Ecore_Evas, causing
1358 * @p func to be called whenever @p ee becomes un-sticky.
1360 * @warning If and when this function is called depends on the underlying
1363 EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1365 * Set a callback for Ecore_Evas mouse in events.
1366 * @param ee The Ecore_Evas to set callbacks on
1367 * @param func The function to call
1369 * A call to this function will set a callback on an Ecore_Evas, causing
1370 * @p func to be called whenever the mouse enters @p ee.
1372 * @warning If and when this function is called depends on the underlying
1375 EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1377 * Set a callback for Ecore_Evas mouse out events.
1378 * @param ee The Ecore_Evas to set callbacks on
1379 * @param func The function to call
1381 * A call to this function will set a callback on an Ecore_Evas, causing
1382 * @p func to be called whenever the mouse leaves @p ee.
1384 * @warning If and when this function is called depends on the underlying
1387 EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1389 * Set a callback for Ecore_Evas pre render events.
1390 * @param ee The Ecore_Evas to set callbacks on
1391 * @param func The function to call
1393 * A call to this function will set a callback on an Ecore_Evas, causing
1394 * @p func to be called just before the evas in @p ee is rendered.
1396 * @warning If and when this function is called depends on the underlying
1399 EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1401 * Set a callback for Ecore_Evas mouse post render events.
1402 * @param ee The Ecore_Evas to set callbacks on
1403 * @param func The function to call
1405 * A call to this function will set a callback on an Ecore_Evas, causing
1406 * @p func to be called just after the evas in @p ee is rendered.
1408 * @warning If and when this function is called depends on the underlying
1411 EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1413 * Set a callback for Ecore_Evas pre-free event.
1414 * @param ee The Ecore_Evas to set callbacks on
1415 * @param func The function to call
1417 * A call to this function will set a callback on an Ecore_Evas, causing
1418 * @p func to be called just before the instance @p ee is freed.
1420 * @warning If and when this function is called depends on the underlying
1423 EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1425 * Set a callback for Ecore_Evas state changes.
1426 * @param ee The Ecore_Evas to set callbacks on
1427 * @param func The function to call
1429 * A call to this function will set a callback on an Ecore_Evas, causing
1430 * @p func to be called whenever @p ee changes state.
1433 * @warning If and when this function is called depends on the underlying
1436 EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1439 * Get an Ecore_Evas's Evas
1440 * @param ee The Ecore_Evas whose Evas you wish to get
1441 * @return The Evas wrapped by @p ee
1443 * This function returns the Evas contained within @p ee.
1445 EAPI Evas *ecore_evas_get(const Ecore_Evas *ee);
1448 * Provide Managed move co-ordinates for an Ecore_Evas
1449 * @param ee The Ecore_Evas to move
1450 * @param x The x coordinate to set as the managed location
1451 * @param y The y coordinate to set as the managed location
1453 * This sets the managed geometry position of the @p ee to (@p x, @p y)
1455 EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y);
1458 * Set whether an Ecore_Evas is shaped or not.
1460 * @param ee The Ecore_Evas to shape.
1461 * @param shaped @c EINA_TRUE to shape, @c EINA_FALSE to not.
1463 * This function allows one to make an Ecore_Evas shaped to the contents of the
1464 * evas. If @p shaped is @c EINA_TRUE, @p ee will be transparent in parts of
1465 * the evas that contain no objects. If @p shaped is @c EINA_FALSE, then @p ee
1466 * will be rectangular, and parts with no data will show random framebuffer
1467 * artifacting. For non-shaped Ecore_Evases, it is recommended to cover the
1468 * entire evas with a background object.
1470 EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped);
1473 * Query whether an Ecore_Evas is shaped or not.
1475 * @param ee The Ecore_Evas to query.
1476 * @return @c EINA_TRUE if shaped, @c EINA_FALSE if not.
1478 * This function returns @c EINA_TRUE if @p ee is shaped, and @c EINA_FALSE if not.
1480 EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee);
1482 * @brief Show an Ecore_Evas' window
1484 * @param ee The Ecore_Evas to show.
1486 * This function makes @p ee visible.
1488 EAPI void ecore_evas_show(Ecore_Evas *ee);
1490 * @brief Hide an Ecore_Evas' window
1492 * @param ee The Ecore_Evas to hide.
1494 * This function makes @p ee hidden(not visible).
1496 EAPI void ecore_evas_hide(Ecore_Evas *ee);
1499 * Activate (set focus to, via the window manager) an Ecore_Evas' window.
1500 * @param ee The Ecore_Evas to activate.
1502 * This functions activates the Ecore_Evas.
1504 EAPI void ecore_evas_activate(Ecore_Evas *ee);
1508 * Set the minimum size of a given @c Ecore_Evas window
1510 * @param ee An @c Ecore_Evas window's handle
1511 * @param w The minimum width
1512 * @param h The minimum height
1514 * This function sets the minimum size of @p ee to be @p w x @p h.
1515 * One won't be able to resize that window to dimensions smaller than
1518 * @note When base sizes are set, via ecore_evas_size_base_set(),
1519 * they'll be used to calculate a window's minimum size, instead of
1520 * those set by this function.
1522 * @see ecore_evas_size_min_get()
1524 EAPI void ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h);
1527 * Get the minimum size set for a given @c Ecore_Evas window
1529 * @param ee An @c Ecore_Evas window's handle
1530 * @param w A pointer to an int to place the minimum width in.
1531 * @param h A pointer to an int to place the minimum height in.
1533 * @note Use @c NULL pointers on the size components you're not
1534 * interested in: they'll be ignored by the function.
1536 * @see ecore_evas_size_min_set() for more details
1538 EAPI void ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h);
1541 * Set the maximum size of a given @c Ecore_Evas window
1543 * @param ee An @c Ecore_Evas window's handle
1544 * @param w The maximum width
1545 * @param h The maximum height
1547 * This function sets the maximum size of @p ee to be @p w x @p h.
1548 * One won't be able to resize that window to dimensions bigger than
1551 * @see ecore_evas_size_max_get()
1553 EAPI void ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h);
1556 * Get the maximum size set for a given @c Ecore_Evas window
1558 * @param ee An @c Ecore_Evas window's handle
1559 * @param w A pointer to an int to place the maximum width in.
1560 * @param h A pointer to an int to place the maximum height in.
1562 * @note Use @c NULL pointers on the size components you're not
1563 * interested in: they'll be ignored by the function.
1565 * @see ecore_evas_size_max_set() for more details
1567 EAPI void ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h);
1570 * Set the base size for a given @c Ecore_Evas window
1572 * @param ee An @c Ecore_Evas window's handle
1573 * @param w The base width
1574 * @param h The base height
1576 * This function sets the @b base size of @p ee to be @p w x @p h.
1577 * When base sizes are set, they'll be used to calculate a window's
1578 * @b minimum size, instead of those set by ecore_evas_size_min_get().
1580 * @see ecore_evas_size_base_get()
1582 EAPI void ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h);
1585 * Get the base size set for a given @c Ecore_Evas window
1587 * @param ee An @c Ecore_Evas window's handle
1588 * @param w A pointer to an int to place the base width in.
1589 * @param h A pointer to an int to place the base height in.
1591 * @note Use @c NULL pointers on the size components you're not
1592 * interested in: they'll be ignored by the function.
1594 * @see ecore_evas_size_base_set() for more details
1596 EAPI void ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h);
1599 * Set the "size step" for a given @c Ecore_Evas window
1601 * @param ee An @c Ecore_Evas window's handle
1602 * @param w The step width
1603 * @param h The step height
1605 * This function sets the size steps of @p ee to be @p w x @p h. This
1606 * limits the size of this @c Ecore_Evas window to be @b always an
1607 * integer multiple of the step size, for each axis.
1609 EAPI void ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h);
1612 * Get the "size step" set for a given @c Ecore_Evas window
1614 * @param ee An @c Ecore_Evas window's handle
1615 * @param w A pointer to an int to place the step width in.
1616 * @param h A pointer to an int to place the step height in.
1618 * @note Use @c NULL pointers on the size components you're not
1619 * interested in: they'll be ignored by the function.
1621 * @see ecore_evas_size_base_set() for more details
1623 EAPI void ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h);
1626 * @brief Set the cursor of an Ecore_Evas.
1628 * @param ee The Ecore_Evas
1629 * @param file The path to an image file for the cursor.
1630 * @param layer The layer in which the cursor will appear.
1631 * @param hot_x The x coordinate of the cursor's hot spot.
1632 * @param hot_y The y coordinate of the cursor's hot spot.
1634 * This function makes the mouse cursor over @p ee be the image specified by
1635 * @p file. The actual point within the image that the mouse is at is specified
1636 * by @p hot_x and @p hot_y, which are coordinates with respect to the top left
1637 * corner of the cursor image.
1639 * @note This function creates an object from the image and uses
1640 * ecore_evas_object_cursor_set().
1642 * @see ecore_evas_object_cursor_set()
1644 EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y);
1646 * @brief Get information about an Ecore_Evas' cursor
1648 * @param ee The Ecore_Evas to set
1649 * @param obj A pointer to an Evas_Object to place the cursor Evas_Object.
1650 * @param layer A pointer to an int to place the cursor's layer in.
1651 * @param hot_x A pointer to an int to place the cursor's hot_x coordinate in.
1652 * @param hot_y A pointer to an int to place the cursor's hot_y coordinate in.
1654 * This function queries information about an Ecore_Evas' cursor.
1656 * @see ecore_evas_cursor_set()
1657 * @see ecore_evas_object_cursor_set()
1659 EAPI void ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y);
1661 * @brief Set the cursor of an Ecore_Evas
1663 * @param ee The Ecore_Evas
1665 * @param obj The Evas_Object which will be the cursor.
1666 * @param layer The layer in which the cursor will appear.
1667 * @param hot_x The x coordinate of the cursor's hot spot.
1668 * @param hot_y The y coordinate of the cursor's hot spot.
1670 * This function makes the mouse cursor over @p ee be the object specified by
1671 * @p obj. The actual point within the object that the mouse is at is specified
1672 * by @p hot_x and @p hot_y, which are coordinates with respect to the top left
1673 * corner of the cursor object.
1675 * @see ecore_evas_cursor_set()
1677 EAPI void ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj, int layer, int hot_x, int hot_y);
1680 * Tell the WM whether or not to ignore an Ecore_Evas' window
1682 * @param ee The Ecore_Evas.
1683 * @param on @c EINA_TRUE to ignore, @c EINA_FALSE to not.
1685 * This function causes the window manager to ignore @p ee if @p on is
1686 * @c EINA_TRUE, or not ignore @p ee if @p on is @c EINA_FALSE.
1688 EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on);
1691 * Query whether an Ecore_Evas' window is overridden or not
1693 * @param ee The Ecore_Evas to set.
1694 * @return @c EINA_TRUE if @p ee is overridden, @c EINA_FALSE if not.
1696 EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee);
1699 * Set whether or not an Ecore_Evas' window should avoid damage
1701 * @param ee The Ecore_Evas
1702 * @param on The type of the damage management
1704 * This function causes @p ee to be drawn to a pixmap to avoid recalculations.
1705 * On expose events it will copy from the pixmap to the window.
1707 EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on);
1710 * Query whether an Ecore_Evas' window avoids damage or not
1711 * @param ee The Ecore_Evas to set
1712 * @return The type of the damage management
1715 EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee);
1718 * Set the withdrawn state of an Ecore_Evas' window.
1719 * @param ee The Ecore_Evas whose window's withdrawn state is set.
1720 * @param withdrawn The Ecore_Evas window's new withdrawn state.
1723 EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn);
1726 * Returns the withdrawn state of an Ecore_Evas' window.
1727 * @param ee The Ecore_Evas whose window's withdrawn state is returned.
1728 * @return The Ecore_Evas window's withdrawn state.
1731 EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee);
1734 * Set the sticky state of an Ecore_Evas window.
1736 * @param ee The Ecore_Evas whose window's sticky state is set.
1737 * @param sticky The Ecore_Evas window's new sticky state.
1740 EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky);
1743 * Returns the sticky state of an Ecore_Evas' window.
1745 * @param ee The Ecore_Evas whose window's sticky state is returned.
1746 * @return The Ecore_Evas window's sticky state.
1749 EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee);
1750 EAPI void ecore_evas_manual_render_set(Ecore_Evas *ee, Eina_Bool manual_render);
1751 EAPI Eina_Bool ecore_evas_manual_render_get(const Ecore_Evas *ee);
1754 * @brief Registers an @c Ecore_Evas to receive events through ecore_input_evas.
1756 * @param ee The @c Ecore_Evas handle.
1758 * This function calls ecore_event_window_register() with the @p ee as its @c
1759 * id argument, @c window argument, and uses its @c Evas too. It is useful when
1760 * no @c window information is available on a given @c Ecore_Evas backend.
1762 * @see ecore_evas_input_event_unregister()
1765 EAPI void ecore_evas_input_event_register(Ecore_Evas *ee);
1767 * @brief Unregisters an @c Ecore_Evas receiving events through ecore_input_evas.
1769 * @param ee The @c Ecore_Evas handle.
1771 * @see ecore_evas_input_event_register()
1774 EAPI void ecore_evas_input_event_unregister(Ecore_Evas *ee);
1777 * @brief Force immediate rendering on a given @c Ecore_Evas window
1779 * @param ee An @c Ecore_Evas handle
1781 * Use this call to forcefully flush the @p ee's canvas rendering
1782 * pipeline, thus bring its window to an up to date state.
1784 EAPI void ecore_evas_manual_render(Ecore_Evas *ee);
1785 EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync);
1786 EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee);
1788 * @brief Get geometry of screen associated with this Ecore_Evas.
1790 * @param ee The Ecore_Evas whose window's to query container screen geometry.
1791 * @param x where to return the horizontal offset value. May be @c NULL.
1792 * @param y where to return the vertical offset value. May be @c NULL.
1793 * @param w where to return the width value. May be @c NULL.
1794 * @param h where to return the height value. May be @c NULL.
1798 EAPI void ecore_evas_screen_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
1800 EAPI void ecore_evas_draw_frame_set(Ecore_Evas *ee, Eina_Bool draw_frame);
1801 EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee);
1804 * @brief Associate the given object to this ecore evas.
1806 * @param ee The Ecore_Evas to associate to @a obj
1807 * @param obj The object to associate to @a ee
1808 * @param flags The association flags.
1809 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1811 * Association means that operations on one will affect the other, for
1812 * example moving the object will move the window, resize the object will
1813 * also affect the ecore evas window, hide and show applies as well.
1815 * This is meant to simplify development, since you often need to associate
1816 * these events with your "base" objects, background or bottom-most object.
1818 * Be aware that some methods might not be what you would like, deleting
1819 * either the window or the object will delete the other. If you want to
1820 * change that behavior, let's say to hide window when it's closed, you
1821 * must use ecore_evas_callback_delete_request_set() and set your own code,
1822 * like ecore_evas_hide(). Just remember that if you override delete_request
1823 * and still want to delete the window/object, you must do that yourself.
1825 * Since we now define delete_request, deleting windows will not quit
1826 * main loop, if you wish to do so, you should listen for EVAS_CALLBACK_FREE
1827 * on the object, that way you get notified and you can call
1828 * ecore_main_loop_quit().
1830 * Flags can be OR'ed of:
1831 * @li ECORE_EVAS_OBJECT_ASSOCIATE_BASE (or 0): to listen to basic events
1832 * like delete, resize and move, but no stacking or layer are used.
1833 * @li ECORE_EVAS_OBJECT_ASSOCIATE_STACK: stacking operations will act
1834 * on the Ecore_Evas, not the object. So evas_object_raise() will
1835 * call ecore_evas_raise(). Relative operations (stack_above, stack_below)
1836 * are still not implemented.
1837 * @li ECORE_EVAS_OBJECT_ASSOCIATE_LAYER: stacking operations will act
1838 * on the Ecore_Evas, not the object. So evas_object_layer_set() will
1839 * call ecore_evas_layer_set().
1840 * @li ECORE_EVAS_OBJECT_ASSOCIATE_DEL: the object delete will delete the
1841 * ecore_evas as well as delete_requests on the ecore_evas will delete
1844 EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags);
1846 * @brief Cancel the association set with ecore_evas_object_associate().
1848 * @param ee The Ecore_Evas to dissociate from @a obj
1849 * @param obj The object to dissociate from @a ee
1850 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1852 EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj);
1854 * @brief Get the object associated with @p ee
1856 * @param ee The Ecore_Evas to get the object from.
1857 * @return The associated object, or @c NULL if there is no associated object.
1859 EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee);
1861 /* helper function to be used with ECORE_GETOPT_CALLBACK_*() */
1862 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);
1865 * @brief Get a list of all the ecore_evases.
1867 * @return A list of ecore_evases.
1869 * The returned list of ecore evases is only valid until the canvases are
1870 * destroyed (and should not be cached for instance). The list can be freed by
1871 * just deleting the list.
1873 EAPI Eina_List *ecore_evas_ecore_evas_list_get(void);
1875 /* specific calls to an x11 environment ecore_evas */
1876 EAPI void ecore_evas_x11_leader_set(Ecore_Evas *ee, Ecore_X_Window win);
1877 EAPI Ecore_X_Window ecore_evas_x11_leader_get(Ecore_Evas *ee);
1878 EAPI void ecore_evas_x11_leader_default_set(Ecore_Evas *ee);
1879 EAPI void ecore_evas_x11_shape_input_rectangle_set(Ecore_Evas *ee, int x, int y, int w, int h);
1880 EAPI void ecore_evas_x11_shape_input_rectangle_add(Ecore_Evas *ee, int x, int y, int w, int h);
1881 EAPI void ecore_evas_x11_shape_input_rectangle_subtract(Ecore_Evas *ee, int x, int y, int w, int h);
1882 EAPI void ecore_evas_x11_shape_input_empty(Ecore_Evas *ee);
1883 EAPI void ecore_evas_x11_shape_input_reset(Ecore_Evas *ee);
1884 EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee);
1887 * @defgroup Ecore_Evas_Ews Ecore_Evas Single Process Windowing System.
1889 * These are global scope functions to manage the EWS to be used by
1890 * ecore_evas_ews_new().
1897 * Sets the engine to be used by the backing store engine.
1899 * @param engine The engine to be set.
1900 * @param options The options of the engine to be set.
1901 * @return @c EINA_TRUE on success, @c EINA_FALSE if ews is already in use.
1904 EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options);
1907 * Reconfigure the backing store used.
1909 * @param x The X coordinate to be used.
1910 * @param y The Y coordinate to be used.
1911 * @param w The width of the Ecore_Evas to setup.
1912 * @param h The height of the Ecore_Evas to setup.
1913 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise.
1916 EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h);
1919 * Return the internal backing store in use.
1921 * @return The internal backing store in use.
1922 * @note this will forced it to be created, making future calls to
1923 * ecore_evas_ews_engine_set() void.
1925 * @see ecore_evas_ews_evas_get()
1928 EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void);
1931 * Return the internal backing store in use.
1933 * @return The internal backing store in use.
1934 * @note this will forced it to be created, making future calls to
1935 * ecore_evas_ews_engine_set() void.
1937 * @see ecore_evas_ews_ecore_evas_get()
1940 EAPI Evas *ecore_evas_ews_evas_get(void);
1943 * Get the current background.
1945 EAPI Evas_Object *ecore_evas_ews_background_get(void);
1948 * Set the current background, must be created at evas ecore_evas_ews_evas_get()
1950 * It will be kept at lowest layer (EVAS_LAYER_MIN) and below
1951 * everything else. You can set any object, default is a black
1954 * @note previous object will be deleted!
1955 * @param o The Evas_Object for which to set the background.
1957 EAPI void ecore_evas_ews_background_set(Evas_Object *o);
1960 * Return all Ecore_Evas* created by EWS.
1962 * @return An eina list of Ecore_evases.
1963 e @note Do not change the returned list or its contents.
1966 EAPI const Eina_List *ecore_evas_ews_children_get(void);
1969 * Set the identifier of the manager taking care of internal windows.
1971 * The ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE event is issued. Consider
1972 * handling it to know if you should stop handling events yourself
1973 * (ie: another manager took over)
1975 * @param manager any unique identifier address.
1977 * @see ecore_evas_ews_manager_get()
1980 EAPI void ecore_evas_ews_manager_set(const void *manager);
1983 * Get the identifier of the manager taking care of internal windows.
1985 * @return the value set by ecore_evas_ews_manager_set()
1988 EAPI const void *ecore_evas_ews_manager_get(void);
1990 EAPI extern int ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE; /**< manager was changed @since 1.1 */
1991 EAPI extern int ECORE_EVAS_EWS_EVENT_ADD; /**< window was created @since 1.1 */
1992 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 */
1993 EAPI extern int ECORE_EVAS_EWS_EVENT_RESIZE; /**< window was resized @since 1.1 */
1994 EAPI extern int ECORE_EVAS_EWS_EVENT_MOVE; /**< window was moved @since 1.1 */
1995 EAPI extern int ECORE_EVAS_EWS_EVENT_SHOW; /**< window become visible @since 1.1 */
1996 EAPI extern int ECORE_EVAS_EWS_EVENT_HIDE; /**< window become hidden @since 1.1 */
1997 EAPI extern int ECORE_EVAS_EWS_EVENT_FOCUS; /**< window was focused @since 1.1 */
1998 EAPI extern int ECORE_EVAS_EWS_EVENT_UNFOCUS; /**< window lost focus @since 1.1 */
1999 EAPI extern int ECORE_EVAS_EWS_EVENT_RAISE; /**< window was raised @since 1.1 */
2000 EAPI extern int ECORE_EVAS_EWS_EVENT_LOWER; /**< window was lowered @since 1.1 */
2001 EAPI extern int ECORE_EVAS_EWS_EVENT_ACTIVATE; /**< window was activated @since 1.1 */
2003 EAPI extern int ECORE_EVAS_EWS_EVENT_ICONIFIED_CHANGE; /**< window minimized/iconified changed @since 1.1 */
2004 EAPI extern int ECORE_EVAS_EWS_EVENT_MAXIMIZED_CHANGE; /**< window maximized changed @since 1.1 */
2005 EAPI extern int ECORE_EVAS_EWS_EVENT_LAYER_CHANGE; /**< window layer changed @since 1.1 */
2006 EAPI extern int ECORE_EVAS_EWS_EVENT_FULLSCREEN_CHANGE; /**< window fullscreen changed @since 1.1 */
2007 EAPI extern int ECORE_EVAS_EWS_EVENT_CONFIG_CHANGE; /**< some other window property changed (title, name, class, alpha, transparent, shaped...) @since 1.1 */
2014 * @defgroup Ecore_Evas_Extn External plug/socket infrastructure to remote canvases
2016 * These functions allow 1 process to create a "socket" was pluged into which another
2017 * process can create a "plug" remotely to plug into.
2018 * Socket can provides content for several plugs.
2019 * This is best for small sized objects (about the size range
2020 * of a small icon up to a few large icons). Sine the plug is actually an
2021 * image object, you can fetch the pixel data
2027 EAPI extern int ECORE_EVAS_EXTN_CLIENT_ADD; /**< this event is received when a plug has connected to an extn socket @since 1.2 */
2028 EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a plug has disconnected from an extn socket @since 1.2 */
2031 * @brief Create a new Ecore_Evas canvas for the new external ecore evas socket
2033 * @param w The width of the canvas, in pixels
2034 * @param h The height of the canvas, in pixels
2035 * @return A new @c Ecore_Evas instance or @c NULL, on failure
2037 * This creates a new extn_socket canvas wrapper, with image data array
2038 * @b bound to the ARGB format, 8 bits per pixel.
2040 * If creation is successful, an Ecore_Evas handle is returned or @c NULL if
2041 * creation fails. Also focus, show, hide etc. callbacks will also be called
2042 * if the plug object is shown, or already visible on connect, or if it is
2043 * hidden later, focused or unfocused.
2045 * This function has to be flowed by ecore_evas_extn_socket_listen(),
2046 * for starting ecore ipc service.
2049 * Eina_Bool res = EINA_FALSE;
2050 * Ecore_Evas *ee = ecore_evas_extn_socket_new(1, 1);
2052 * res = ecore_evas_extn_socket_listen("svcname", 1, EINA_FALSE);
2054 * ecore_evas_resize(ee, 240, 400);
2060 * Eina_Bool res = EINA_FALSE;
2061 * Ecore_Evas *ee = ecore_evas_extn_socket_new(240, 400);
2063 * res = ecore_evas_extn_socket_listen("svcname", 1, EINA_FALSE);
2067 * When a client(plug) connects, you will get the ECORE_EVAS_EXTN_CLIENT_ADD event
2068 * in the ecore event queue, with event_info being the image object pointer
2069 * passed as a void pointer. When a client disconnects you will get the
2070 * ECORE_EVAS_EXTN_CLIENT_DEL event.
2072 * You can set up event handles for these events as follows:
2075 * static void client_add_cb(void *data, int event, void *event_info)
2077 * Evas_Object *obj = event_info;
2078 * printf("client added to image object %p\n", obj);
2079 * evas_object_show(obj);
2082 * static void client_del_cb(void *data, int event, void *event_info)
2084 * Evas_Object *obj = event_info;
2085 * printf("client deleted from image object %p\n", obj);
2086 * evas_object_hide(obj);
2091 * ecore_event_handler_add(ECORE_EVAS_EXTN_CLIENT_ADD,
2092 * client_add_cb, NULL);
2093 * ecore_event_handler_add(ECORE_EVAS_EXTN_CLIENT_DEL,
2094 * client_del_cb, NULL);
2098 * Note that events come in later after the event happened. You may want to be
2099 * careful as data structures you had associated with the image object
2100 * may have been freed after deleting, but the object may still be around
2101 * awating cleanup and thus still be valid.You can change the size with something like:
2103 * @see ecore_evas_extn_socket_listen()
2104 * @see ecore_evas_extn_plug_new()
2105 * @see ecore_evas_extn_plug_object_data_lock()
2106 * @see ecore_evas_extn_plug_object_data_unlock()
2110 EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h);
2113 * @brief Create a socket to provide the service for external ecore evas
2116 * @param ee The Ecore_Evas.
2117 * @param svcname The name of the service to be advertised. ensure that it is
2118 * unique (when combined with @p svcnum) otherwise creation may fail.
2119 * @param svcnum A number (any value, @c 0 being the common default) to
2120 * differentiate multiple instances of services with the same name.
2121 * @param svcsys A boolean that if true, specifies to create a system-wide
2122 * service all users can connect to, otherwise the service is private to the
2123 * user ide that created the service.
2124 * @return @c EINA_TRUE if creation is successful, @c EINA_FALSE if it does
2127 * This creates socket specified by @p svcname, @p svcnum and @p svcsys. If
2128 * creation is successful, @c EINA_TRUE is returned or @c EINA_FALSE if
2131 * @see ecore_evas_extn_socket_new()
2132 * @see ecore_evas_extn_plug_new()
2133 * @see ecore_evas_extn_plug_object_data_lock()
2134 * @see ecore_evas_extn_plug_object_data_unlock()
2138 EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname, int svcnum, Eina_Bool svcsys);
2141 * @brief Lock the pixel data so the socket cannot change it
2143 * @param obj The image object returned by ecore_evas_extn_plug_new() to lock
2145 * You may need to get the image pixel data with evas_object_image_data_get()
2146 * from the image object, but need to ensure that it does not change while
2147 * you are using the data. This function lets you set an advisory lock on the
2148 * image data so the external plug process will not render to it or alter it.
2150 * You should only hold the lock for just as long as you need to read out the
2151 * image data or otherwise deal with it, and then unlock it with
2152 * ecore_evas_extn_plug_object_data_unlock(). Keeping a lock over more than
2153 * 1 iteration of the main ecore loop will be problematic, so avoid it. Also
2154 * forgetting to unlock may cause the socket process to freeze and thus create
2157 * @see ecore_evas_extn_plug_new()
2158 * @see ecore_evas_extn_plug_object_data_unlock()
2162 EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj);
2165 * @brief Unlock the pixel data so the socket can change it again.
2167 * @param obj The image object returned by ecore_evas_extn_plug_new() to unlock
2169 * This unlocks after an advisor lock has been taken by
2170 * ecore_evas_extn_plug_object_data_lock().
2172 * @see ecore_evas_extn_plug_new()
2173 * @see ecore_evas_extn_plug_object_data_lock()
2177 EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj);
2180 * @brief Create a new external ecore evas plug
2182 * @param ee_target The Ecore_Evas containing the canvas in which the new image object will live.
2183 * @return An evas image object that will contain the image output of a socket.
2185 * This creates an image object that will contain the output of another
2186 * processes socket canvas when it connects. All input will be sent back to
2187 * this process as well, effectively swallowing or placing the socket process
2188 * in the canvas of the plug process in place of the image object. The image
2189 * object by default is created to be filled (equivalent of
2190 * evas_object_image_filled_add() on creation) so image content will scale
2191 * to fill the image unless otherwise reconfigured. The Ecore_Evas size
2192 * of the plug is the master size and determines size in pixels of the
2193 * plug canvas. You can change the size with something like:
2196 * Eina_Bool res = EINA_FALSE;
2197 * Evas_Object *obj = ecore_evas_extn_plug_new(ee);
2199 * res = ecore_evas_extn_plug_connect("svcname", 1, EINA_FALSE);
2201 * ecore_evas_resize(ee, 240, 400);
2204 * @see ecore_evas_extn_socket_new()
2205 * @see ecore_evas_extn_plug_connect()
2208 EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target);
2211 * @brief Connect an external ecore evas plug to service provided by external
2212 * ecore evas socket.
2214 * @param obj The Ecore_Evas containing the canvas in which the new image
2216 * @param svcname The service name to connect to set up by the socket.
2217 * @param svcnum The service number to connect to (set up by socket).
2218 * @param svcsys Boolean to set if the service is a system one or not (set up
2220 * @return @c EINA_TRUE if creation is successful, @c EINA_FALSE if it does
2223 * @see ecore_evas_extn_plug_new()
2227 EAPI Eina_Bool ecore_evas_extn_plug_connect(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);