[ecore] merged svn latest code (svn54830)
[profile/ivi/ecore.git] / src / lib / ecore_evas / Ecore_Evas.h
1 #ifndef _ECORE_EVAS_H
2 #define _ECORE_EVAS_H
3
4 #include <Evas.h>
5 #include <Ecore_Getopt.h>
6 #include <Ecore_Input.h>
7
8 #ifdef EAPI
9 # undef EAPI
10 #endif
11
12 #ifdef _WIN32
13 # ifdef EFL_ECORE_EVAS_BUILD
14 #  ifdef DLL_EXPORT
15 #   define EAPI __declspec(dllexport)
16 #  else
17 #   define EAPI
18 #  endif /* ! DLL_EXPORT */
19 # else
20 #  define EAPI __declspec(dllimport)
21 # endif /* ! EFL_ECORE_EVAS_BUILD */
22 #else
23 # ifdef __GNUC__
24 #  if __GNUC__ >= 4
25 #   define EAPI __attribute__ ((visibility("default")))
26 #  else
27 #   define EAPI
28 #  endif
29 # else
30 #  define EAPI
31 # endif
32 #endif /* ! _WIN32 */
33
34 /**
35  * @file Ecore_Evas.h
36  * @brief Evas wrapper functions
37  */
38
39 /* FIXME:
40  * to do soon:
41  * - iconfication api needs to work
42  * - maximization api needs to work
43  * - document all calls
44  *
45  * later:
46  * - buffer back-end that renders to an evas_image_object ???
47  * - qt back-end ???
48  * - dfb back-end ??? (dfb's threads make this REALLY HARD)
49  */
50
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54
55 /* these are dummy and just tell u what API levels ecore_evas supports - not if
56  * the actual support is compiled in. you need to query for that separately.
57  */
58 #define HAVE_ECORE_EVAS_X 1
59 #define HAVE_ECORE_EVAS_FB 1
60 #define HAVE_ECORE_EVAS_X11_GL 1
61 #define HAVE_ECORE_EVAS_X11_16 1
62 #define HAVE_ECORE_EVAS_DIRECTFB 1
63 #define HAVE_ECORE_EVAS_WIN32 1
64 #define HAVE_ECORE_EVAS_COCOA 1
65 #define HAVE_ECORE_EVAS_SDL 1
66 #define HAVE_ECORE_EVAS_WINCE 1
67
68 typedef enum _Ecore_Evas_Engine_Type
69 {
70    ECORE_EVAS_ENGINE_SOFTWARE_BUFFER,
71    ECORE_EVAS_ENGINE_SOFTWARE_XLIB,
72    ECORE_EVAS_ENGINE_XRENDER_X11,
73    ECORE_EVAS_ENGINE_OPENGL_X11,
74    ECORE_EVAS_ENGINE_SOFTWARE_XCB,
75    ECORE_EVAS_ENGINE_XRENDER_XCB,
76    ECORE_EVAS_ENGINE_SOFTWARE_GDI,
77    ECORE_EVAS_ENGINE_SOFTWARE_DDRAW,
78    ECORE_EVAS_ENGINE_DIRECT3D,
79    ECORE_EVAS_ENGINE_OPENGL_GLEW,
80    ECORE_EVAS_ENGINE_COCOA,
81    ECORE_EVAS_ENGINE_SOFTWARE_SDL,
82    ECORE_EVAS_ENGINE_DIRECTFB,
83    ECORE_EVAS_ENGINE_SOFTWARE_FB,
84    ECORE_EVAS_ENGINE_SOFTWARE_8_X11,
85    ECORE_EVAS_ENGINE_SOFTWARE_16_X11,
86    ECORE_EVAS_ENGINE_SOFTWARE_16_DDRAW,
87    ECORE_EVAS_ENGINE_SOFTWARE_16_WINCE,
88    ECORE_EVAS_ENGINE_OPENGL_SDL
89 } Ecore_Evas_Engine_Type;
90
91 typedef enum _Ecore_Evas_Avoid_Damage_Type
92 {
93    ECORE_EVAS_AVOID_DAMAGE_NONE = 0,
94    ECORE_EVAS_AVOID_DAMAGE_EXPOSE = 1,
95    ECORE_EVAS_AVOID_DAMAGE_BUILT_IN = 2
96 } Ecore_Evas_Avoid_Damage_Type;
97
98 typedef enum _Ecore_Evas_Object_Associate_Flags
99 {
100   ECORE_EVAS_OBJECT_ASSOCIATE_BASE  = 0,
101   ECORE_EVAS_OBJECT_ASSOCIATE_STACK = 1 << 0,
102   ECORE_EVAS_OBJECT_ASSOCIATE_LAYER = 1 << 1,
103   ECORE_EVAS_OBJECT_ASSOCIATE_DEL = 1 << 2
104 } Ecore_Evas_Object_Associate_Flags;
105
106 #ifndef _ECORE_X_H
107 #define _ECORE_X_WINDOW_PREDEF
108 typedef unsigned int Ecore_X_Window;
109 #endif
110
111 #ifndef _ECORE_DIRECTFB_H
112 #define _ECORE_DIRECTFB_WINDOW_PREDEF
113 typedef struct _Ecore_DirectFB_Window Ecore_DirectFB_Window;
114 #endif
115
116 #ifndef __ECORE_WIN32_H__
117 typedef struct _Ecore_Win32_Window Ecore_Win32_Window;
118 #endif
119
120 #ifndef __ECORE_WINCE_H__
121 typedef void Ecore_WinCE_Window;
122 #endif
123
124 #ifndef _ECORE_EVAS_PRIVATE_H
125 /* basic data types */
126 typedef struct _Ecore_Evas Ecore_Evas;
127 #endif
128
129 /* module setup/shutdown calls */
130
131 EAPI int         ecore_evas_engine_type_supported_get(Ecore_Evas_Engine_Type engine);
132
133 EAPI int         ecore_evas_init(void);
134 EAPI int         ecore_evas_shutdown(void);
135
136 EAPI void        ecore_evas_app_comp_sync_set(Eina_Bool do_sync);
137 EAPI Eina_Bool   ecore_evas_app_comp_sync_get(void);
138
139 EAPI Eina_List  *ecore_evas_engines_get(void);
140 EAPI void        ecore_evas_engines_free(Eina_List *engines);
141 EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options);
142
143
144 /* engine/target specific init calls */
145 EAPI Ecore_Evas     *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
146 EAPI Ecore_X_Window  ecore_evas_software_x11_window_get(const Ecore_Evas *ee);
147 EAPI void            ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
148 EAPI Eina_Bool       ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee);
149 EAPI void            ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
150
151 #define ECORE_EVAS_GL_X11_OPT_NONE     0
152 #define ECORE_EVAS_GL_X11_OPT_INDIRECT 1
153 #define ECORE_EVAS_GL_X11_OPT_LAST     2
154
155 EAPI Ecore_Evas     *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
156 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);
157 EAPI Ecore_X_Window  ecore_evas_gl_x11_window_get(const Ecore_Evas *ee);
158 EAPI void            ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
159 EAPI Eina_Bool       ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee);
160 EAPI void            ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
161 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));
162
163 EAPI Ecore_Evas     *ecore_evas_xrender_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
164 EAPI Ecore_X_Window  ecore_evas_xrender_x11_window_get(const Ecore_Evas *ee);
165 EAPI void            ecore_evas_xrender_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
166 EAPI Eina_Bool       ecore_evas_xrender_x11_direct_resize_get(const Ecore_Evas *ee);
167 EAPI void            ecore_evas_xrender_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
168
169 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);
170 EAPI Ecore_X_Window  ecore_evas_software_x11_8_window_get(const Ecore_Evas *ee);
171 EAPI Ecore_X_Window  ecore_evas_software_x11_8_subwindow_get(const Ecore_Evas *ee);
172 EAPI void            ecore_evas_software_x11_8_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
173 EAPI Eina_Bool       ecore_evas_software_x11_8_direct_resize_get(const Ecore_Evas *ee);
174 EAPI void            ecore_evas_software_x11_8_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
175
176 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);
177 EAPI Ecore_X_Window  ecore_evas_software_x11_16_window_get(const Ecore_Evas *ee);
178 EAPI void            ecore_evas_software_x11_16_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
179 EAPI Eina_Bool       ecore_evas_software_x11_16_direct_resize_get(const Ecore_Evas *ee);
180 EAPI void            ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
181
182 EAPI Ecore_Evas     *ecore_evas_fb_new(const char *disp_name, int rotation, int w, int h);
183
184 EAPI Ecore_Evas     *ecore_evas_directfb_new(const char *disp_name, int windowed, int x, int y, int w, int h);
185 EAPI Ecore_DirectFB_Window *ecore_evas_directfb_window_get(const Ecore_Evas *ee);
186
187 EAPI Ecore_Evas     *ecore_evas_buffer_new(int w, int h);
188 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);
189 EAPI const void     *ecore_evas_buffer_pixels_get(Ecore_Evas *ee);
190
191 EAPI Evas_Object    *ecore_evas_object_image_new(Ecore_Evas *ee_target);
192
193 EAPI Ecore_Evas     *ecore_evas_software_gdi_new(Ecore_Win32_Window *parent,
194                                                  int                 x,
195                                                  int                 y,
196                                                  int                 width,
197                                                  int                 height);
198
199 EAPI Ecore_Evas     *ecore_evas_software_ddraw_new(Ecore_Win32_Window *parent,
200                                                    int                 x,
201                                                    int                 y,
202                                                    int                 width,
203                                                    int                 height);
204
205 EAPI Ecore_Evas     *ecore_evas_software_16_ddraw_new(Ecore_Win32_Window *parent,
206                                                       int                 x,
207                                                       int                 y,
208                                                       int                 width,
209                                                       int                 height);
210
211 EAPI Ecore_Evas     *ecore_evas_direct3d_new(Ecore_Win32_Window *parent,
212                                              int                 x,
213                                              int                 y,
214                                              int                 width,
215                                              int                 height);
216
217 EAPI Ecore_Evas *ecore_evas_gl_glew_new(Ecore_Win32_Window *parent,
218                                         int                 x,
219                                         int                 y,
220                                         int                 width,
221                                         int                 height);
222
223 EAPI Ecore_Win32_Window *ecore_evas_win32_window_get(const Ecore_Evas *ee);
224
225 EAPI Ecore_Evas     *ecore_evas_sdl_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
226 EAPI Ecore_Evas     *ecore_evas_sdl16_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
227 EAPI Ecore_Evas     *ecore_evas_gl_sdl_new(const char* name, int w, int h, int fullscreen, int noframe);
228
229 EAPI Ecore_Evas     *ecore_evas_software_wince_new(Ecore_WinCE_Window *parent,
230                                                    int                 x,
231                                                    int                 y,
232                                                    int                 width,
233                                                    int                 height);
234
235 EAPI Ecore_Evas     *ecore_evas_software_wince_fb_new(Ecore_WinCE_Window *parent,
236                                                       int                 x,
237                                                       int                 y,
238                                                       int                 width,
239                                                       int                 height);
240
241 EAPI Ecore_Evas     *ecore_evas_software_wince_gapi_new(Ecore_WinCE_Window *parent,
242                                                         int                 x,
243                                                         int                 y,
244                                                         int                 width,
245                                                         int                 height);
246
247 EAPI Ecore_Evas     *ecore_evas_software_wince_ddraw_new(Ecore_WinCE_Window *parent,
248                                                          int                 x,
249                                                          int                 y,
250                                                          int                 width,
251                                                          int                 height);
252
253 EAPI Ecore_Evas     *ecore_evas_software_wince_gdi_new(Ecore_WinCE_Window *parent,
254                                                        int                 x,
255                                                        int                 y,
256                                                        int                 width,
257                                                        int                 height);
258
259 EAPI Ecore_WinCE_Window *ecore_evas_software_wince_window_get(const Ecore_Evas *ee);
260
261 EAPI Ecore_Evas *ecore_evas_cocoa_new(const char* name, int w, int h);
262
263 /* generic manipulation calls */
264 EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee);
265 EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e);
266 EAPI void        ecore_evas_free(Ecore_Evas *ee);
267 EAPI void       *ecore_evas_data_get(const Ecore_Evas *ee, const char *key);
268 EAPI void        ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data);
269 EAPI void        ecore_evas_callback_resize_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
270 EAPI void        ecore_evas_callback_move_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
271 EAPI void        ecore_evas_callback_show_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
272 EAPI void        ecore_evas_callback_hide_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
273 EAPI void        ecore_evas_callback_delete_request_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
274 EAPI void        ecore_evas_callback_destroy_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
275 EAPI void        ecore_evas_callback_focus_in_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
276 EAPI void        ecore_evas_callback_focus_out_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
277 EAPI void        ecore_evas_callback_sticky_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
278 EAPI void        ecore_evas_callback_unsticky_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
279 EAPI void        ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
280 EAPI void        ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
281 EAPI void        ecore_evas_callback_pre_render_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
282 EAPI void        ecore_evas_callback_post_render_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
283 EAPI void        ecore_evas_callback_pre_free_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
284 EAPI Evas       *ecore_evas_get(const Ecore_Evas *ee);
285 EAPI void        ecore_evas_move(Ecore_Evas *ee, int x, int y);
286 EAPI void        ecore_evas_managed_move(Ecore_Evas *ee, int x, int y);
287 EAPI void        ecore_evas_resize(Ecore_Evas *ee, int w, int h);
288 EAPI void        ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h);
289 EAPI void        ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
290 EAPI void        ecore_evas_rotation_set(Ecore_Evas *ee, int rot);
291 EAPI void        ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot);
292 EAPI int         ecore_evas_rotation_get(const Ecore_Evas *ee);
293 EAPI void        ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped);
294 EAPI Eina_Bool   ecore_evas_shaped_get(const Ecore_Evas *ee);
295 EAPI void        ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha);
296 EAPI Eina_Bool   ecore_evas_alpha_get(const Ecore_Evas *ee);
297 EAPI void        ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparent);
298 EAPI Eina_Bool   ecore_evas_transparent_get(const Ecore_Evas *ee);
299 EAPI void        ecore_evas_show(Ecore_Evas *ee);
300 EAPI void        ecore_evas_hide(Ecore_Evas *ee);
301 EAPI int         ecore_evas_visibility_get(const Ecore_Evas *ee);
302 EAPI void        ecore_evas_raise(Ecore_Evas *ee);
303 EAPI void        ecore_evas_lower(Ecore_Evas *ee);
304 EAPI void        ecore_evas_activate(Ecore_Evas *ee);
305 EAPI void        ecore_evas_title_set(Ecore_Evas *ee, const char *t);
306 EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee);
307 EAPI void        ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c);
308 EAPI void        ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c);
309 EAPI void        ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h);
310 EAPI void        ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h);
311 EAPI void        ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h);
312 EAPI void        ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h);
313 EAPI void        ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h);
314 EAPI void        ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h);
315 EAPI void        ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h);
316 EAPI void        ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h);
317 EAPI void        ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y);
318 EAPI void        ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj, int layer, int hot_x, int hot_y);
319 EAPI void        ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y);
320 EAPI void        ecore_evas_layer_set(Ecore_Evas *ee, int layer);
321 EAPI int         ecore_evas_layer_get(const Ecore_Evas *ee);
322 EAPI void        ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on);
323 EAPI Eina_Bool   ecore_evas_focus_get(const Ecore_Evas *ee);
324 EAPI void        ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on);
325 EAPI Eina_Bool   ecore_evas_iconified_get(const Ecore_Evas *ee);
326 EAPI void        ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on);
327 EAPI Eina_Bool   ecore_evas_borderless_get(const Ecore_Evas *ee);
328 EAPI void        ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on);
329 EAPI Eina_Bool   ecore_evas_override_get(const Ecore_Evas *ee);
330 EAPI void        ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on);
331 EAPI Eina_Bool   ecore_evas_maximized_get(const Ecore_Evas *ee);
332 EAPI void        ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on);
333 EAPI Eina_Bool   ecore_evas_fullscreen_get(const Ecore_Evas *ee);
334 EAPI void        ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on);
335 EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee);
336 EAPI void        ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn);
337 EAPI Eina_Bool   ecore_evas_withdrawn_get(const Ecore_Evas *ee);
338 EAPI void        ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky);
339 EAPI Eina_Bool   ecore_evas_sticky_get(const Ecore_Evas *ee);
340 EAPI void        ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore);
341 EAPI Eina_Bool   ecore_evas_ignore_events_get(const Ecore_Evas *ee);
342 EAPI void        ecore_evas_manual_render_set(Ecore_Evas *ee, Eina_Bool manual_render);
343 EAPI Eina_Bool   ecore_evas_manual_render_get(const Ecore_Evas *ee);
344 EAPI void        ecore_evas_manual_render(Ecore_Evas *ee);
345 EAPI void        ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync);
346 EAPI Eina_Bool   ecore_evas_comp_sync_get(const Ecore_Evas *ee);
347        
348 EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee);
349
350 EAPI Eina_Bool    ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags);
351 EAPI Eina_Bool    ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj);
352 EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee);
353
354 /* helper function to be used with ECORE_GETOPT_CALLBACK_*() */
355 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);
356
357 EAPI Eina_List   *ecore_evas_ecore_evas_list_get(void);
358
359 /* specific calls to an x11 environment ecore_evas */
360 EAPI void           ecore_evas_x11_leader_set(Ecore_Evas *ee, Ecore_X_Window win);
361 EAPI Ecore_X_Window ecore_evas_x11_leader_get(Ecore_Evas *ee);
362 EAPI void           ecore_evas_x11_leader_default_set(Ecore_Evas *ee);
363          
364 #ifdef __cplusplus
365 }
366 #endif
367
368 #endif