src/lib/ecore_evas/Ecore_Evas.h

   1 /*
   2  * vim:ts=8:sw=3:sts=8:noexpandtab:cino=>5n-3f0^-2{2
   3  */
   4
   5 #ifndef _ECORE_EVAS_H
   6 #define _ECORE_EVAS_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 #include <Evas.h>
  52
  53 #ifdef __cplusplus
  54 extern "C" {
  55 #endif
  56
  57 /* these are dummy and just tell u what API levels ecore_evas supports - not if
  58  * the actual support is compiled in. you need to query for that separately.
  59  */
  60 #define HAVE_ECORE_EVAS_X 1
  61 #define HAVE_ECORE_EVAS_FB 1
  62 #define HAVE_ECORE_EVAS_X11_GL 1
  63 #define HAVE_ECORE_EVAS_X11_16 1
  64 #define HAVE_ECORE_EVAS_DIRECTFB 1
  65 #define HAVE_ECORE_EVAS_WIN32 1
  66 #define HAVE_ECORE_EVAS_SDL 1
  67 #define HAVE_ECORE_EVAS_WINCE 1
  68
  69 typedef enum _Ecore_Evas_Engine_Type
  70 {
  71    ECORE_EVAS_ENGINE_SOFTWARE_BUFFER,
  72    ECORE_EVAS_ENGINE_SOFTWARE_X11,
  73    ECORE_EVAS_ENGINE_XRENDER_X11,
  74    ECORE_EVAS_ENGINE_OPENGL_X11,
  75    ECORE_EVAS_ENGINE_SOFTWARE_XCB,
  76    ECORE_EVAS_ENGINE_XRENDER_XCB,
  77    ECORE_EVAS_ENGINE_SOFTWARE_DDRAW,
  78    ECORE_EVAS_ENGINE_DIRECT3D,
  79    ECORE_EVAS_ENGINE_OPENGL_GLEW,
  80    ECORE_EVAS_ENGINE_SDL,
  81    ECORE_EVAS_ENGINE_DIRECTFB,
  82    ECORE_EVAS_ENGINE_SOFTWARE_FB,
  83    ECORE_EVAS_ENGINE_SOFTWARE_16_X11,
  84    ECORE_EVAS_ENGINE_SOFTWARE_16_DDRAW,
  85    ECORE_EVAS_ENGINE_SOFTWARE_16_WINCE
  86 } Ecore_Evas_Engine_Type;
  87
  88 typedef enum _Ecore_Evas_Avoid_Damage_Type
  89 {
  90    ECORE_EVAS_AVOID_DAMAGE_NONE = 0,
  91    ECORE_EVAS_AVOID_DAMAGE_EXPOSE = 1,
  92    ECORE_EVAS_AVOID_DAMAGE_BUILT_IN = 2
  93 } Ecore_Evas_Avoid_Damage_Type;
  94
  95 typedef enum _Ecore_Evas_Object_Associate_Flags
  96 {
  97   ECORE_EVAS_OBJECT_ASSOCIATE_BASE  = 0,
  98   ECORE_EVAS_OBJECT_ASSOCIATE_STACK = 1 << 0,
  99   ECORE_EVAS_OBJECT_ASSOCIATE_LAYER = 1 << 1
 100 } Ecore_Evas_Object_Associate_Flags;
 101
 102 #ifndef _ECORE_X_H
 103 #define _ECORE_X_WINDOW_PREDEF
 104 typedef unsigned int Ecore_X_Window;
 105 #endif
 106
 107 #ifndef _ECORE_DIRECTFB_H
 108 #define _ECORE_DIRECTFB_WINDOW_PREDEF
 109 typedef struct _Ecore_DirectFB_Window Ecore_DirectFB_Window;
 110 #endif
 111
 112 #ifndef __ECORE_WIN32_H__
 113 typedef void Ecore_Win32_Window;
 114 #endif
 115
 116 #ifndef __ECORE_WINCE_H__
 117 typedef void Ecore_WinCE_Window;
 118 #endif
 119
 120 #ifndef _ECORE_EVAS_PRIVATE_H
 121 /* basic data types */
 122 typedef struct _Ecore_Evas Ecore_Evas;
 123 #endif
 124
 125 /* module setup/shutdown calls */
 126
 127 EAPI int         ecore_evas_engine_type_supported_get(Ecore_Evas_Engine_Type engine);
 128
 129 EAPI int         ecore_evas_init(void);
 130 EAPI int         ecore_evas_shutdown(void);
 131
 132 EAPI Eina_List  *ecore_evas_engines_get(void);
 133 EAPI void        ecore_evas_engines_free(Eina_List *engines);
 134 EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options);
 135
 136
 137 /* engine/target specific init calls */
 138 EAPI Ecore_Evas     *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
 139 EAPI Ecore_X_Window  ecore_evas_software_x11_window_get(const Ecore_Evas *ee);
 140 EAPI Ecore_X_Window  ecore_evas_software_x11_subwindow_get(const Ecore_Evas *ee);
 141 EAPI void            ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, int on);
 142 EAPI int             ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee);
 143 EAPI void            ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
 144
 145 EAPI Ecore_Evas     *ecore_evas_gl_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_gl_x11_window_get(const Ecore_Evas *ee);
 147 EAPI Ecore_X_Window  ecore_evas_gl_x11_subwindow_get(const Ecore_Evas *ee);
 148 EAPI void            ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, int on);
 149 EAPI int             ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee);
 150 EAPI void            ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
 151
 152 EAPI Ecore_Evas     *ecore_evas_xrender_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
 153 EAPI Ecore_X_Window  ecore_evas_xrender_x11_window_get(const Ecore_Evas *ee);
 154 EAPI Ecore_X_Window  ecore_evas_xrender_x11_subwindow_get(const Ecore_Evas *ee);
 155 EAPI void            ecore_evas_xrender_x11_direct_resize_set(Ecore_Evas *ee, int on);
 156 EAPI int             ecore_evas_xrender_x11_direct_resize_get(const Ecore_Evas *ee);
 157 EAPI void            ecore_evas_xrender_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
 158
 159 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);
 160 EAPI Ecore_X_Window  ecore_evas_software_x11_16_window_get(const Ecore_Evas *ee);
 161 EAPI Ecore_X_Window  ecore_evas_software_x11_16_subwindow_get(const Ecore_Evas *ee);
 162 EAPI void            ecore_evas_software_x11_16_direct_resize_set(Ecore_Evas *ee, int on);
 163 EAPI int             ecore_evas_software_x11_16_direct_resize_get(const Ecore_Evas *ee);
 164 EAPI void            ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
 165
 166 EAPI Ecore_Evas     *ecore_evas_fb_new(const char *disp_name, int rotation, int w, int h);
 167
 168 EAPI Ecore_Evas     *ecore_evas_directfb_new(const char *disp_name, int windowed, int x, int y, int w, int h);
 169 EAPI Ecore_DirectFB_Window *ecore_evas_directfb_window_get(const Ecore_Evas *ee);
 170
 171 EAPI Ecore_Evas     *ecore_evas_buffer_new(int w, int h);
 172 EAPI const void     *ecore_evas_buffer_pixels_get(Ecore_Evas *ee);
 173
 174 EAPI Evas_Object    *ecore_evas_object_image_new(Ecore_Evas *ee_target);
 175
 176 EAPI Ecore_Evas     *ecore_evas_software_ddraw_new(Ecore_Win32_Window *parent,
 177                                                    int                 x,
 178                                                    int                 y,
 179                                                    int                 width,
 180                                                    int                 height);
 181
 182 EAPI Ecore_Evas     *ecore_evas_software_ddraw_16_new(Ecore_Win32_Window *parent,
 183                                                       int                 x,
 184                                                       int                 y,
 185                                                       int                 width,
 186                                                       int                 height);
 187
 188 EAPI Ecore_Evas     *ecore_evas_direct3d_new(Ecore_Win32_Window *parent,
 189                                              int                 x,
 190                                              int                 y,
 191                                              int                 width,
 192                                              int                 height);
 193
 194 EAPI Ecore_Evas *ecore_evas_gl_glew_new(Ecore_Win32_Window *parent,
 195                                         int                 x,
 196                                         int                 y,
 197                                         int                 width,
 198                                         int                 height);
 199
 200 EAPI Ecore_Win32_Window *ecore_evas_win32_window_get(const Ecore_Evas *ee);
 201
 202 EAPI Ecore_Evas     *ecore_evas_sdl_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
 203 EAPI Ecore_Evas     *ecore_evas_sdl16_new(const char* name, int w, int h, int fullscreen, int hwsurface, int noframe, int alpha);
 204
 205 EAPI Ecore_Evas     *ecore_evas_software_wince_new(Ecore_WinCE_Window *parent,
 206                                                    int                 x,
 207                                                    int                 y,
 208                                                    int                 width,
 209                                                    int                 height);
 210
 211 EAPI Ecore_Evas     *ecore_evas_software_wince_fb_new(Ecore_WinCE_Window *parent,
 212                                                       int                 x,
 213                                                       int                 y,
 214                                                       int                 width,
 215                                                       int                 height);
 216
 217 EAPI Ecore_Evas     *ecore_evas_software_wince_gapi_new(Ecore_WinCE_Window *parent,
 218                                                         int                 x,
 219                                                         int                 y,
 220                                                         int                 width,
 221                                                         int                 height);
 222
 223 EAPI Ecore_Evas     *ecore_evas_software_wince_ddraw_new(Ecore_WinCE_Window *parent,
 224                                                          int                 x,
 225                                                          int                 y,
 226                                                          int                 width,
 227                                                          int                 height);
 228
 229 EAPI Ecore_WinCE_Window *ecore_evas_software_wince_window_get(const Ecore_Evas *ee);
 230
 231 /* generic manipulation calls */
 232 EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee);
 233 EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e);
 234 EAPI void        ecore_evas_free(Ecore_Evas *ee);
 235 EAPI void       *ecore_evas_data_get(const Ecore_Evas *ee, const char *key);
 236 EAPI void        ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data);
 237 EAPI void        ecore_evas_callback_resize_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 238 EAPI void        ecore_evas_callback_move_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 239 EAPI void        ecore_evas_callback_show_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 240 EAPI void        ecore_evas_callback_hide_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 241 EAPI void        ecore_evas_callback_delete_request_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 242 EAPI void        ecore_evas_callback_destroy_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 243 EAPI void        ecore_evas_callback_focus_in_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 244 EAPI void        ecore_evas_callback_focus_out_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 245 EAPI void        ecore_evas_callback_sticky_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 246 EAPI void        ecore_evas_callback_unsticky_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 247 EAPI void        ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 248 EAPI void        ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 249 EAPI void        ecore_evas_callback_pre_render_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 250 EAPI void        ecore_evas_callback_post_render_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 251 EAPI void        ecore_evas_callback_pre_free_set(Ecore_Evas *ee, void (*func) (Ecore_Evas *ee));
 252 EAPI Evas       *ecore_evas_get(const Ecore_Evas *ee);
 253 EAPI void        ecore_evas_move(Ecore_Evas *ee, int x, int y);
 254 EAPI void        ecore_evas_managed_move(Ecore_Evas *ee, int x, int y);
 255 EAPI void        ecore_evas_resize(Ecore_Evas *ee, int w, int h);
 256 EAPI void        ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h);
 257 EAPI void        ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
 258 EAPI void        ecore_evas_rotation_set(Ecore_Evas *ee, int rot);
 259 EAPI int         ecore_evas_rotation_get(const Ecore_Evas *ee);
 260 EAPI void        ecore_evas_shaped_set(Ecore_Evas *ee, int shaped);
 261 EAPI int         ecore_evas_shaped_get(const Ecore_Evas *ee);
 262 EAPI void        ecore_evas_alpha_set(Ecore_Evas *ee, int alpha);
 263 EAPI int         ecore_evas_alpha_get(const Ecore_Evas *ee);
 264 EAPI void        ecore_evas_show(Ecore_Evas *ee);
 265 EAPI void        ecore_evas_hide(Ecore_Evas *ee);
 266 EAPI int         ecore_evas_visibility_get(const Ecore_Evas *ee);
 267 EAPI void        ecore_evas_raise(Ecore_Evas *ee);
 268 EAPI void        ecore_evas_lower(Ecore_Evas *ee);
 269 EAPI void        ecore_evas_activate(Ecore_Evas *ee);
 270 EAPI void        ecore_evas_title_set(Ecore_Evas *ee, const char *t);
 271 EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee);
 272 EAPI void        ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c);
 273 EAPI void        ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c);
 274 EAPI void        ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h);
 275 EAPI void        ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h);
 276 EAPI void        ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h);
 277 EAPI void        ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h);
 278 EAPI void        ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h);
 279 EAPI void        ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h);
 280 EAPI void        ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h);
 281 EAPI void        ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h);
 282 EAPI void        ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y);
 283 EAPI void        ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj, int layer, int hot_x, int hot_y);
 284 EAPI void        ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y);
 285 EAPI void        ecore_evas_layer_set(Ecore_Evas *ee, int layer);
 286 EAPI int         ecore_evas_layer_get(const Ecore_Evas *ee);
 287 EAPI void        ecore_evas_focus_set(Ecore_Evas *ee, int on);
 288 EAPI int         ecore_evas_focus_get(const Ecore_Evas *ee);
 289 EAPI void        ecore_evas_iconified_set(Ecore_Evas *ee, int on);
 290 EAPI int         ecore_evas_iconified_get(const Ecore_Evas *ee);
 291 EAPI void        ecore_evas_borderless_set(Ecore_Evas *ee, int on);
 292 EAPI int         ecore_evas_borderless_get(const Ecore_Evas *ee);
 293 EAPI void        ecore_evas_override_set(Ecore_Evas *ee, int on);
 294 EAPI int         ecore_evas_override_get(const Ecore_Evas *ee);
 295 EAPI void        ecore_evas_maximized_set(Ecore_Evas *ee, int on);
 296 EAPI int         ecore_evas_maximized_get(const Ecore_Evas *ee);
 297 EAPI void        ecore_evas_fullscreen_set(Ecore_Evas *ee, int on);
 298 EAPI int         ecore_evas_fullscreen_get(const Ecore_Evas *ee);
 299 EAPI void        ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on);
 300 EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee);
 301 EAPI void        ecore_evas_withdrawn_set(Ecore_Evas *ee, int withdrawn);
 302 EAPI int         ecore_evas_withdrawn_get(const Ecore_Evas *ee);
 303 EAPI void        ecore_evas_sticky_set(Ecore_Evas *ee, int sticky);
 304 EAPI int         ecore_evas_sticky_get(const Ecore_Evas *ee);
 305 EAPI void        ecore_evas_ignore_events_set(Ecore_Evas *ee, int ignore);
 306 EAPI int         ecore_evas_ignore_events_get(const Ecore_Evas *ee);
 307 EAPI void       *ecore_evas_window_get(const Ecore_Evas *ee);
 308
 309
 310 EAPI int          ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags);
 311 EAPI int          ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj);
 312 EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee);
 313
 314 #ifdef __cplusplus
 315 }
 316 #endif
 317
 318 #endif