clients/window.h

   1 /*
   2  * Copyright © 2008 Kristian Høgsberg
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that copyright
   7  * notice and this permission notice appear in supporting documentation, and
   8  * that the name of the copyright holders not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  The copyright holders make no representations
  11  * about the suitability of this software for any purpose.  It is provided "as
  12  * is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20  * OF THIS SOFTWARE.
  21  */
  22
  23 #ifndef _WINDOW_H_
  24 #define _WINDOW_H_
  25
  26 #include <X11/extensions/XKBcommon.h>
  27 #include <glib.h>
  28 #include <wayland-client.h>
  29 #include <cairo.h>
  30
  31 struct window;
  32
  33 struct rectangle {
  34         int32_t x;
  35         int32_t y;
  36         int32_t width;
  37         int32_t height;
  38 };
  39
  40 struct display;
  41 struct input;
  42
  43 struct display *
  44 display_create(int *argc, char **argv[], const GOptionEntry *option_entries);
  45
  46 struct wl_display *
  47 display_get_display(struct display *display);
  48
  49 struct wl_compositor *
  50 display_get_compositor(struct display *display);
  51
  52 struct wl_shell *
  53 display_get_shell(struct display *display);
  54
  55 #ifdef EGL_NO_DISPLAY
  56 EGLDisplay
  57 display_get_egl_display(struct display *d);
  58
  59 EGLConfig
  60 display_get_egl_config(struct display *d);
  61
  62 void
  63 display_acquire_window_surface(struct display *display,
  64                                struct window *window,
  65                                EGLContext ctx);
  66 void
  67 display_release(struct display *display);
  68
  69 #ifdef HAVE_CAIRO_EGL
  70 EGLImageKHR
  71 display_get_image_for_egl_image_surface(struct display *display,
  72                                         cairo_surface_t *surface);
  73 #endif
  74 #endif
  75
  76 #define SURFACE_OPAQUE 0x01
  77
  78 cairo_surface_t *
  79 display_create_surface(struct display *display,
  80                        struct wl_surface *surface,
  81                        struct rectangle *rectangle,
  82                        uint32_t flags);
  83
  84 struct wl_buffer *
  85 display_get_buffer_for_surface(struct display *display,
  86                                cairo_surface_t *surface);
  87
  88 cairo_surface_t *
  89 display_get_pointer_surface(struct display *display, int pointer,
  90                             int *width, int *height,
  91                             int *hotspot_x, int *hotspot_y);
  92
  93 void
  94 display_add_drag_listener(struct display *display,
  95                           const struct wl_drag_listener *drag_listener,
  96                           void *data);
  97
  98 void
  99 display_flush_cairo_device(struct display *display);
 100
 101 void
 102 display_run(struct display *d);
 103
 104 enum pointer_type {
 105         POINTER_BOTTOM_LEFT,
 106         POINTER_BOTTOM_RIGHT,
 107         POINTER_BOTTOM,
 108         POINTER_DRAGGING,
 109         POINTER_LEFT_PTR,
 110         POINTER_LEFT,
 111         POINTER_RIGHT,
 112         POINTER_TOP_LEFT,
 113         POINTER_TOP_RIGHT,
 114         POINTER_TOP,
 115         POINTER_IBEAM,
 116         POINTER_HAND1,
 117 };
 118
 119 typedef void (*window_resize_handler_t)(struct window *window,
 120                                         int32_t width, int32_t height,
 121                                         void *data);
 122 typedef void (*window_redraw_handler_t)(struct window *window, void *data);
 123
 124 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 125                                      uint32_t time, uint32_t key, uint32_t unicode,
 126                                      uint32_t state, void *data);
 127
 128 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 129                                                 struct input *device, void *data);
 130
 131 typedef void (*window_button_handler_t)(struct window *window,
 132                                         struct input *input, uint32_t time,
 133                                         int button, int state, void *data);
 134
 135 typedef int (*window_enter_handler_t)(struct window *window,
 136                                       struct input *input, uint32_t time,
 137                                       int32_t x, int32_t y, void *data);
 138 typedef int (*window_leave_handler_t)(struct window *window,
 139                                       struct input *input, uint32_t time,
 140                                       void *data);
 141
 142 typedef int (*window_motion_handler_t)(struct window *window,
 143                                        struct input *input, uint32_t time,
 144                                        int32_t x, int32_t y,
 145                                        int32_t sx, int32_t sy, void *data);
 146
 147 struct window *
 148 window_create(struct display *display, int32_t width, int32_t height);
 149 struct window *
 150 window_create_transient(struct display *display, struct window *parent,
 151                         int32_t x, int32_t y, int32_t width, int32_t height);
 152
 153 void
 154 window_destroy(struct window *window);
 155
 156 void
 157 window_move(struct window *window, struct input *input, uint32_t time);
 158
 159 void
 160 window_draw(struct window *window);
 161
 162 void
 163 window_get_allocation(struct window *window,
 164                       struct rectangle *allocation);
 165
 166 void
 167 window_get_child_allocation(struct window *window,
 168                             struct rectangle *allocation);
 169
 170 void
 171 window_set_transparent(struct window *window, int transparent);
 172 void
 173 window_set_child_size(struct window *window, int32_t width, int32_t height);
 174 void
 175 window_schedule_redraw(struct window *window);
 176
 177 void
 178 window_damage(struct window *window, int32_t x, int32_t y,
 179               int32_t width, int32_t height);
 180
 181 cairo_surface_t *
 182 window_get_surface(struct window *window);
 183
 184 struct wl_surface *
 185 window_get_wl_surface(struct window *window);
 186
 187 void
 188 window_flush(struct window *window);
 189
 190 void
 191 window_set_surface(struct window *window, cairo_surface_t *surface);
 192
 193 void
 194 window_create_surface(struct window *window);
 195
 196 enum window_buffer_type {
 197         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 198         WINDOW_BUFFER_TYPE_EGL_IMAGE,
 199         WINDOW_BUFFER_TYPE_SHM,
 200 };
 201
 202 void
 203 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 204                        int32_t x, int32_t y, int32_t width, int32_t height);
 205
 206 void
 207 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 208
 209 void
 210 window_set_fullscreen(struct window *window, int fullscreen);
 211
 212 void
 213 window_set_user_data(struct window *window, void *data);
 214
 215 void *
 216 window_get_user_data(struct window *window);
 217
 218 void
 219 window_set_redraw_handler(struct window *window,
 220                           window_redraw_handler_t handler);
 221
 222 void
 223 window_set_decoration(struct window *window, int decoration);
 224
 225 void
 226 window_set_resize_handler(struct window *window,
 227                           window_resize_handler_t handler);
 228
 229 void
 230 window_set_key_handler(struct window *window,
 231                        window_key_handler_t handler);
 232
 233 void
 234 window_set_button_handler(struct window *window,
 235                           window_button_handler_t handler);
 236
 237 void
 238 window_set_motion_handler(struct window *window,
 239                           window_motion_handler_t handler);
 240
 241 void
 242 window_set_enter_handler(struct window *window,
 243                          window_enter_handler_t handler);
 244 void
 245 window_set_leave_handler(struct window *window,
 246                          window_leave_handler_t handler);
 247
 248 void
 249 window_set_keyboard_focus_handler(struct window *window,
 250                                   window_keyboard_focus_handler_t handler);
 251
 252 void
 253 window_set_title(struct window *window, const char *title);
 254
 255 const char *
 256 window_get_title(struct window *window);
 257
 258 struct wl_drag *
 259 window_create_drag(struct window *window);
 260
 261 void
 262 window_activate_drag(struct wl_drag *drag, struct window *window,
 263                      struct input *input, uint32_t time);
 264
 265 void
 266 input_get_position(struct input *input, int32_t *x, int32_t *y);
 267
 268 uint32_t
 269 input_get_modifiers(struct input *input);
 270
 271 struct wl_input_device *
 272 input_get_input_device(struct input *input);
 273
 274 int
 275 input_offers_mime_type(struct input *input, const char *type);
 276 void
 277 input_receive_mime_type(struct input *input, const char *type, int fd);
 278
 279
 280 #endif