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_egl_image_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
 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
 113 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 114                                                 struct input *device, void *data);
 115
 116 typedef void (*window_button_handler_t)(struct window *window,
 117                                         struct input *input, uint32_t time,
 118                                         int button, int state, void *data);
 119
 120 typedef int (*window_motion_handler_t)(struct window *window,
 121                                        struct input *input, uint32_t time,
 122                                        int32_t x, int32_t y,
 123                                        int32_t sx, int32_t sy, void *data);
 124
 125 typedef void (*display_global_handler_t)(struct display *display,
 126                                          const char *interface,
 127                                          uint32_t id,
 128                                          uint32_t version);
 129
 130 struct window *
 131 window_create(struct display *display, int32_t width, int32_t height);
 132 struct window *
 133 window_create_transient(struct display *display, struct window *parent,
 134                         int32_t x, int32_t y, int32_t width, int32_t height);
 135
 136 void
 137 window_destroy(struct window *window);
 138
 139 void
 140 window_move(struct window *window, struct input *input, uint32_t time);
 141
 142 void
 143 window_draw(struct window *window);
 144 void
 145 window_get_child_allocation(struct window *window,
 146                             struct rectangle *allocation);
 147
 148 void
 149 window_set_child_size(struct window *window, int32_t width, int32_t height);
 150 void
 151 window_schedule_redraw(struct window *window);
 152
 153 void
 154 window_damage(struct window *window, int32_t x, int32_t y,
 155               int32_t width, int32_t height);
 156
 157 cairo_surface_t *
 158 window_get_surface(struct window *window);
 159
 160 struct wl_surface *
 161 window_get_wl_surface(struct window *window);
 162
 163 void
 164 window_flush(struct window *window);
 165
 166 void
 167 window_set_surface(struct window *window, cairo_surface_t *surface);
 168
 169 void
 170 window_create_surface(struct window *window);
 171
 172 enum window_buffer_type {
 173         WINDOW_BUFFER_TYPE_EGL_IMAGE,
 174         WINDOW_BUFFER_TYPE_SHM,
 175 };
 176
 177 void
 178 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 179
 180 void
 181 window_set_fullscreen(struct window *window, int fullscreen);
 182
 183 void
 184 window_set_user_data(struct window *window, void *data);
 185
 186 void *
 187 window_get_user_data(struct window *window);
 188
 189 void
 190 window_set_redraw_handler(struct window *window,
 191                           window_redraw_handler_t handler);
 192
 193 void
 194 window_set_decoration(struct window *window, int decoration);
 195
 196 void
 197 window_set_resize_handler(struct window *window,
 198                           window_resize_handler_t handler);
 199
 200 void
 201 window_set_key_handler(struct window *window,
 202                        window_key_handler_t handler);
 203
 204 void
 205 window_set_button_handler(struct window *window,
 206                           window_button_handler_t handler);
 207
 208 void
 209 window_set_motion_handler(struct window *window,
 210                           window_motion_handler_t handler);
 211
 212 void
 213 window_set_keyboard_focus_handler(struct window *window,
 214                                   window_keyboard_focus_handler_t handler);
 215
 216 void
 217 window_set_title(struct window *window, const char *title);
 218
 219 const char *
 220 window_get_title(struct window *window);
 221
 222 void
 223 display_set_global_handler(struct display *display,
 224                            display_global_handler_t handler);
 225
 226 struct wl_drag *
 227 window_create_drag(struct window *window);
 228
 229 void
 230 window_activate_drag(struct wl_drag *drag, struct window *window,
 231                      struct input *input, uint32_t time);
 232
 233 void
 234 input_get_position(struct input *input, int32_t *x, int32_t *y);
 235
 236 uint32_t
 237 input_get_modifiers(struct input *input);
 238
 239 struct wl_input_device *
 240 input_get_input_device(struct input *input);
 241
 242 int
 243 input_offers_mime_type(struct input *input, const char *type);
 244 void
 245 input_receive_mime_type(struct input *input, const char *type, int fd);
 246
 247
 248 #endif