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