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_defer(struct display *display, struct task *task);
 105
 106 void
 107 display_watch_fd(struct display *display,
 108                  int fd, uint32_t events, struct task *task);
 109
 110 void
 111 display_run(struct display *d);
 112
 113 enum pointer_type {
 114         POINTER_BOTTOM_LEFT,
 115         POINTER_BOTTOM_RIGHT,
 116         POINTER_BOTTOM,
 117         POINTER_DRAGGING,
 118         POINTER_LEFT_PTR,
 119         POINTER_LEFT,
 120         POINTER_RIGHT,
 121         POINTER_TOP_LEFT,
 122         POINTER_TOP_RIGHT,
 123         POINTER_TOP,
 124         POINTER_IBEAM,
 125         POINTER_HAND1,
 126 };
 127
 128 typedef void (*window_resize_handler_t)(struct window *window,
 129                                         int32_t width, int32_t height,
 130                                         void *data);
 131 typedef void (*window_redraw_handler_t)(struct window *window, void *data);
 132
 133 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 134                                      uint32_t time, uint32_t key, uint32_t unicode,
 135                                      uint32_t state, void *data);
 136
 137 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 138                                                 struct input *device, void *data);
 139
 140 typedef void (*window_button_handler_t)(struct window *window,
 141                                         struct input *input, uint32_t time,
 142                                         int button, int state, void *data);
 143
 144 typedef int (*window_enter_handler_t)(struct window *window,
 145                                       struct input *input, uint32_t time,
 146                                       int32_t x, int32_t y, void *data);
 147 typedef void (*window_leave_handler_t)(struct window *window,
 148                                        struct input *input, uint32_t time,
 149                                        void *data);
 150
 151 typedef int (*window_motion_handler_t)(struct window *window,
 152                                        struct input *input, uint32_t time,
 153                                        int32_t x, int32_t y,
 154                                        int32_t sx, int32_t sy, void *data);
 155
 156 typedef void (*window_item_focus_handler_t)(struct window *window,
 157                                             struct item *focus, void *data);
 158
 159 struct window *
 160 window_create(struct display *display, int32_t width, int32_t height);
 161 struct window *
 162 window_create_transient(struct display *display, struct window *parent,
 163                         int32_t x, int32_t y, int32_t width, int32_t height);
 164
 165 void
 166 window_destroy(struct window *window);
 167
 168 struct item *
 169 window_add_item(struct window *window, void *data);
 170
 171 typedef void (*item_func_t)(struct item *item, void *data);
 172
 173 void
 174 window_for_each_item(struct window *window, item_func_t func, void *data);
 175
 176 struct item *
 177 window_get_focus_item(struct window *window);
 178
 179 void
 180 window_move(struct window *window, struct input *input, uint32_t time);
 181
 182 void
 183 window_draw(struct window *window);
 184
 185 void
 186 window_get_allocation(struct window *window,
 187                       struct rectangle *allocation);
 188
 189 void
 190 window_get_child_allocation(struct window *window,
 191                             struct rectangle *allocation);
 192
 193 void
 194 window_set_transparent(struct window *window, int transparent);
 195 void
 196 window_set_child_size(struct window *window, int32_t width, int32_t height);
 197 void
 198 window_schedule_redraw(struct window *window);
 199
 200 void
 201 window_damage(struct window *window, int32_t x, int32_t y,
 202               int32_t width, int32_t height);
 203
 204 cairo_surface_t *
 205 window_get_surface(struct window *window);
 206
 207 struct wl_surface *
 208 window_get_wl_surface(struct window *window);
 209
 210 void
 211 window_flush(struct window *window);
 212
 213 void
 214 window_set_surface(struct window *window, cairo_surface_t *surface);
 215
 216 void
 217 window_create_surface(struct window *window);
 218
 219 enum window_buffer_type {
 220         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 221         WINDOW_BUFFER_TYPE_EGL_IMAGE,
 222         WINDOW_BUFFER_TYPE_SHM,
 223 };
 224
 225 void
 226 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 227                        int32_t x, int32_t y, int32_t width, int32_t height);
 228
 229 void
 230 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 231
 232 void
 233 window_set_fullscreen(struct window *window, int fullscreen);
 234
 235 void
 236 window_set_custom(struct window *window);
 237
 238 void
 239 window_set_user_data(struct window *window, void *data);
 240
 241 void *
 242 window_get_user_data(struct window *window);
 243
 244 void
 245 window_set_redraw_handler(struct window *window,
 246                           window_redraw_handler_t handler);
 247
 248 void
 249 window_set_decoration(struct window *window, int decoration);
 250
 251 void
 252 window_set_resize_handler(struct window *window,
 253                           window_resize_handler_t handler);
 254
 255 void
 256 window_set_key_handler(struct window *window,
 257                        window_key_handler_t handler);
 258
 259 void
 260 window_set_button_handler(struct window *window,
 261                           window_button_handler_t handler);
 262
 263 void
 264 window_set_motion_handler(struct window *window,
 265                           window_motion_handler_t handler);
 266
 267 void
 268 window_set_enter_handler(struct window *window,
 269                          window_enter_handler_t handler);
 270 void
 271 window_set_leave_handler(struct window *window,
 272                          window_leave_handler_t handler);
 273
 274 void
 275 window_set_keyboard_focus_handler(struct window *window,
 276                                   window_keyboard_focus_handler_t handler);
 277
 278 void
 279 window_set_item_focus_handler(struct window *window,
 280                               window_item_focus_handler_t handler);
 281
 282 void
 283 window_set_title(struct window *window, const char *title);
 284
 285 const char *
 286 window_get_title(struct window *window);
 287
 288 struct wl_drag *
 289 window_create_drag(struct window *window);
 290
 291 void
 292 window_activate_drag(struct wl_drag *drag, struct window *window,
 293                      struct input *input, uint32_t time);
 294
 295 void
 296 item_get_allocation(struct item *item, struct rectangle *allocation);
 297
 298 void
 299 item_set_allocation(struct item *item,
 300                     int32_t x, int32_t y, int32_t width, int32_t height);
 301
 302 void *
 303 item_get_user_data(struct item *item);
 304
 305 void
 306 input_get_position(struct input *input, int32_t *x, int32_t *y);
 307
 308 uint32_t
 309 input_get_modifiers(struct input *input);
 310
 311 struct wl_input_device *
 312 input_get_input_device(struct input *input);
 313
 314 int
 315 input_offers_mime_type(struct input *input, const char *type);
 316 void
 317 input_receive_mime_type(struct input *input, const char *type, int fd);
 318
 319
 320 #endif