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 cairo_surface_t *
  77 display_create_surface(struct display *display,
  78                        struct wl_surface *surface,
  79                        struct rectangle *rectangle);
  80
  81 struct wl_buffer *
  82 display_get_buffer_for_surface(struct display *display,
  83                                cairo_surface_t *surface);
  84
  85 cairo_surface_t *
  86 display_get_pointer_surface(struct display *display, int pointer,
  87                             int *width, int *height,
  88                             int *hotspot_x, int *hotspot_y);
  89
  90 void
  91 display_add_drag_listener(struct display *display,
  92                           const struct wl_drag_listener *drag_listener,
  93                           void *data);
  94
  95 void
  96 display_flush_cairo_device(struct display *display);
  97
  98 void
  99 display_run(struct display *d);
 100
 101 enum pointer_type {
 102         POINTER_BOTTOM_LEFT,
 103         POINTER_BOTTOM_RIGHT,
 104         POINTER_BOTTOM,
 105         POINTER_DRAGGING,
 106         POINTER_LEFT_PTR,
 107         POINTER_LEFT,
 108         POINTER_RIGHT,
 109         POINTER_TOP_LEFT,
 110         POINTER_TOP_RIGHT,
 111         POINTER_TOP,
 112         POINTER_IBEAM,
 113         POINTER_HAND1,
 114 };
 115
 116 typedef void (*window_resize_handler_t)(struct window *window,
 117                                         int32_t width, int32_t height,
 118                                         void *data);
 119 typedef void (*window_redraw_handler_t)(struct window *window, void *data);
 120
 121 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 122                                      uint32_t time, uint32_t key, uint32_t unicode,
 123                                      uint32_t state, void *data);
 124
 125 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 126                                                 struct input *device, void *data);
 127
 128 typedef void (*window_button_handler_t)(struct window *window,
 129                                         struct input *input, uint32_t time,
 130                                         int button, int state, void *data);
 131
 132 typedef int (*window_motion_handler_t)(struct window *window,
 133                                        struct input *input, uint32_t time,
 134                                        int32_t x, int32_t y,
 135                                        int32_t sx, int32_t sy, void *data);
 136
 137 typedef void (*display_global_handler_t)(struct display *display,
 138                                          const char *interface,
 139                                          uint32_t id,
 140                                          uint32_t version);
 141
 142 struct window *
 143 window_create(struct display *display, int32_t width, int32_t height);
 144 struct window *
 145 window_create_transient(struct display *display, struct window *parent,
 146                         int32_t x, int32_t y, int32_t width, int32_t height);
 147
 148 void
 149 window_destroy(struct window *window);
 150
 151 void
 152 window_move(struct window *window, struct input *input, uint32_t time);
 153
 154 void
 155 window_draw(struct window *window);
 156
 157 void
 158 window_get_allocation(struct window *window,
 159                       struct rectangle *allocation);
 160
 161 void
 162 window_get_child_allocation(struct window *window,
 163                             struct rectangle *allocation);
 164
 165 void
 166 window_set_child_size(struct window *window, int32_t width, int32_t height);
 167 void
 168 window_schedule_redraw(struct window *window);
 169
 170 void
 171 window_damage(struct window *window, int32_t x, int32_t y,
 172               int32_t width, int32_t height);
 173
 174 cairo_surface_t *
 175 window_get_surface(struct window *window);
 176
 177 void
 178 window_flush(struct window *window);
 179
 180 void
 181 window_set_surface(struct window *window, cairo_surface_t *surface);
 182
 183 void
 184 window_create_surface(struct window *window);
 185
 186 enum window_buffer_type {
 187         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 188         WINDOW_BUFFER_TYPE_EGL_IMAGE,
 189         WINDOW_BUFFER_TYPE_SHM,
 190 };
 191
 192 void
 193 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 194
 195 void
 196 window_set_fullscreen(struct window *window, int fullscreen);
 197
 198 void
 199 window_set_user_data(struct window *window, void *data);
 200
 201 void *
 202 window_get_user_data(struct window *window);
 203
 204 void
 205 window_set_redraw_handler(struct window *window,
 206                           window_redraw_handler_t handler);
 207
 208 void
 209 window_set_decoration(struct window *window, int decoration);
 210
 211 void
 212 window_set_resize_handler(struct window *window,
 213                           window_resize_handler_t handler);
 214
 215 void
 216 window_set_key_handler(struct window *window,
 217                        window_key_handler_t handler);
 218
 219 void
 220 window_set_button_handler(struct window *window,
 221                           window_button_handler_t handler);
 222
 223 void
 224 window_set_motion_handler(struct window *window,
 225                           window_motion_handler_t handler);
 226
 227 void
 228 window_set_keyboard_focus_handler(struct window *window,
 229                                   window_keyboard_focus_handler_t handler);
 230
 231 void
 232 window_set_title(struct window *window, const char *title);
 233
 234 const char *
 235 window_get_title(struct window *window);
 236
 237 void
 238 display_set_global_handler(struct display *display,
 239                            display_global_handler_t handler);
 240
 241 struct wl_drag *
 242 window_create_drag(struct window *window);
 243
 244 void
 245 window_activate_drag(struct wl_drag *drag, struct window *window,
 246                      struct input *input, uint32_t time);
 247
 248 void
 249 input_get_position(struct input *input, int32_t *x, int32_t *y);
 250
 251 uint32_t
 252 input_get_modifiers(struct input *input);
 253
 254 struct wl_input_device *
 255 input_get_input_device(struct input *input);
 256
 257 int
 258 input_offers_mime_type(struct input *input, const char *type);
 259 void
 260 input_receive_mime_type(struct input *input, const char *type, int fd);
 261
 262
 263 #endif