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