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