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 struct output;
  36
  37 struct task {
  38         void (*run)(struct task *task, uint32_t events);
  39         struct wl_list link;
  40 };
  41
  42 struct rectangle {
  43         int32_t x;
  44         int32_t y;
  45         int32_t width;
  46         int32_t height;
  47 };
  48
  49 struct display *
  50 display_create(int *argc, char **argv[], const GOptionEntry *option_entries);
  51
  52 void
  53 display_set_user_data(struct display *display, void *data);
  54
  55 void *
  56 display_get_user_data(struct display *display);
  57
  58 struct wl_display *
  59 display_get_display(struct display *display);
  60
  61 struct wl_compositor *
  62 display_get_compositor(struct display *display);
  63
  64 struct wl_shell *
  65 display_get_shell(struct display *display);
  66
  67 struct output *
  68 display_get_output(struct display *display);
  69
  70 typedef void (*display_output_handler_t)(struct output *output, void *data);
  71
  72 /*
  73  * The output configure handler is called, when a new output is connected
  74  * and we know its current mode, or when the current mode changes.
  75  * Test and set the output user data in your handler to know, if the
  76  * output is new. Note: 'data' in the configure handler is the display
  77  * user data.
  78  */
  79 void
  80 display_set_output_configure_handler(struct display *display,
  81                                      display_output_handler_t handler);
  82
  83 struct wl_data_source *
  84 display_create_data_source(struct display *display);
  85
  86 #ifdef EGL_NO_DISPLAY
  87 EGLDisplay
  88 display_get_egl_display(struct display *d);
  89
  90 EGLConfig
  91 display_get_rgb_egl_config(struct display *d);
  92
  93 EGLConfig
  94 display_get_argb_egl_config(struct display *d);
  95
  96 int
  97 display_acquire_window_surface(struct display *display,
  98                                struct window *window,
  99                                EGLContext ctx);
 100 void
 101 display_release_window_surface(struct display *display,
 102                                struct window *window);
 103
 104 #ifdef HAVE_CAIRO_EGL
 105 EGLImageKHR
 106 display_get_image_for_egl_image_surface(struct display *display,
 107                                         cairo_surface_t *surface);
 108 #endif
 109 #endif
 110
 111 #define SURFACE_OPAQUE 0x01
 112
 113 cairo_surface_t *
 114 display_create_surface(struct display *display,
 115                        struct wl_surface *surface,
 116                        struct rectangle *rectangle,
 117                        uint32_t flags);
 118
 119 struct wl_buffer *
 120 display_get_buffer_for_surface(struct display *display,
 121                                cairo_surface_t *surface);
 122
 123 cairo_surface_t *
 124 display_get_pointer_surface(struct display *display, int pointer,
 125                             int *width, int *height,
 126                             int *hotspot_x, int *hotspot_y);
 127
 128 void
 129 display_defer(struct display *display, struct task *task);
 130
 131 void
 132 display_watch_fd(struct display *display,
 133                  int fd, uint32_t events, struct task *task);
 134
 135 void
 136 display_run(struct display *d);
 137
 138 void
 139 display_exit(struct display *d);
 140
 141 enum pointer_type {
 142         POINTER_BOTTOM_LEFT,
 143         POINTER_BOTTOM_RIGHT,
 144         POINTER_BOTTOM,
 145         POINTER_DRAGGING,
 146         POINTER_LEFT_PTR,
 147         POINTER_LEFT,
 148         POINTER_RIGHT,
 149         POINTER_TOP_LEFT,
 150         POINTER_TOP_RIGHT,
 151         POINTER_TOP,
 152         POINTER_IBEAM,
 153         POINTER_HAND1,
 154 };
 155
 156 typedef void (*window_resize_handler_t)(struct window *window,
 157                                         int32_t width, int32_t height,
 158                                         void *data);
 159 typedef void (*window_redraw_handler_t)(struct window *window, void *data);
 160
 161 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 162                                      uint32_t time, uint32_t key, uint32_t unicode,
 163                                      uint32_t state, void *data);
 164
 165 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 166                                                 struct input *device, void *data);
 167
 168 typedef void (*window_button_handler_t)(struct window *window,
 169                                         struct input *input, uint32_t time,
 170                                         int button, int state, void *data);
 171
 172 typedef int (*window_enter_handler_t)(struct window *window,
 173                                       struct input *input, uint32_t time,
 174                                       int32_t x, int32_t y, void *data);
 175 typedef void (*window_leave_handler_t)(struct window *window,
 176                                        struct input *input, uint32_t time,
 177                                        void *data);
 178
 179 typedef int (*window_motion_handler_t)(struct window *window,
 180                                        struct input *input, uint32_t time,
 181                                        int32_t x, int32_t y,
 182                                        int32_t sx, int32_t sy, void *data);
 183
 184 typedef void (*window_data_handler_t)(struct window *window,
 185                                       struct input *input, uint32_t time,
 186                                       int32_t x, int32_t y,
 187                                       const char **types,
 188                                       void *data);
 189
 190 typedef void (*window_drop_handler_t)(struct window *window,
 191                                       struct input *input,
 192                                       int32_t x, int32_t y, void *data);
 193
 194 typedef void (*window_item_focus_handler_t)(struct window *window,
 195                                             struct item *focus, void *data);
 196
 197 struct window *
 198 window_create(struct display *display, int32_t width, int32_t height);
 199 struct window *
 200 window_create_transient(struct display *display, struct window *parent,
 201                         int32_t x, int32_t y, int32_t width, int32_t height);
 202 struct window *
 203 window_create_menu(struct display *display, struct window *parent,
 204                    int32_t x, int32_t y, const char **entries, int count);
 205
 206 void
 207 window_destroy(struct window *window);
 208
 209 struct item *
 210 window_add_item(struct window *window, void *data);
 211
 212 typedef void (*item_func_t)(struct item *item, void *data);
 213
 214 typedef void (*data_func_t)(void *data, size_t len,
 215                             int32_t x, int32_t y, void *user_data);
 216
 217 void
 218 window_for_each_item(struct window *window, item_func_t func, void *data);
 219
 220 struct item *
 221 window_get_focus_item(struct window *window);
 222 struct display *
 223 window_get_display(struct window *window);
 224
 225 void
 226 window_move(struct window *window, struct input *input, uint32_t time);
 227
 228 void
 229 window_draw(struct window *window);
 230
 231 void
 232 window_get_allocation(struct window *window,
 233                       struct rectangle *allocation);
 234
 235 void
 236 window_get_child_allocation(struct window *window,
 237                             struct rectangle *allocation);
 238
 239 void
 240 window_set_transparent(struct window *window, int transparent);
 241 void
 242 window_set_child_size(struct window *window, int32_t width, int32_t height);
 243 void
 244 window_schedule_redraw(struct window *window);
 245
 246 void
 247 window_damage(struct window *window, int32_t x, int32_t y,
 248               int32_t width, int32_t height);
 249
 250 cairo_surface_t *
 251 window_get_surface(struct window *window);
 252
 253 struct wl_surface *
 254 window_get_wl_surface(struct window *window);
 255
 256 struct wl_shell_surface *
 257 window_get_wl_shell_surface(struct window *window);
 258
 259 void
 260 window_flush(struct window *window);
 261
 262 void
 263 window_set_surface(struct window *window, cairo_surface_t *surface);
 264
 265 void
 266 window_create_surface(struct window *window);
 267
 268 enum window_buffer_type {
 269         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 270         WINDOW_BUFFER_TYPE_EGL_IMAGE,
 271         WINDOW_BUFFER_TYPE_SHM,
 272 };
 273
 274 void
 275 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 276                        int32_t x, int32_t y, int32_t width, int32_t height);
 277
 278 void
 279 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 280
 281 void
 282 window_set_fullscreen(struct window *window, int fullscreen);
 283
 284 void
 285 window_set_custom(struct window *window);
 286
 287 void
 288 window_set_user_data(struct window *window, void *data);
 289
 290 void *
 291 window_get_user_data(struct window *window);
 292
 293 void
 294 window_set_redraw_handler(struct window *window,
 295                           window_redraw_handler_t handler);
 296
 297 void
 298 window_set_decoration(struct window *window, int decoration);
 299
 300 void
 301 window_set_resize_handler(struct window *window,
 302                           window_resize_handler_t handler);
 303
 304 void
 305 window_set_key_handler(struct window *window,
 306                        window_key_handler_t handler);
 307
 308 void
 309 window_set_button_handler(struct window *window,
 310                           window_button_handler_t handler);
 311
 312 void
 313 window_set_motion_handler(struct window *window,
 314                           window_motion_handler_t handler);
 315
 316 void
 317 window_set_enter_handler(struct window *window,
 318                          window_enter_handler_t handler);
 319 void
 320 window_set_leave_handler(struct window *window,
 321                          window_leave_handler_t handler);
 322
 323 void
 324 window_set_keyboard_focus_handler(struct window *window,
 325                                   window_keyboard_focus_handler_t handler);
 326
 327 void
 328 window_set_item_focus_handler(struct window *window,
 329                               window_item_focus_handler_t handler);
 330
 331 void
 332 window_set_data_handler(struct window *window,
 333                         window_data_handler_t handler);
 334
 335 void
 336 window_set_drop_handler(struct window *window,
 337                         window_drop_handler_t handler);
 338
 339 void
 340 window_set_title(struct window *window, const char *title);
 341
 342 const char *
 343 window_get_title(struct window *window);
 344
 345 void
 346 item_get_allocation(struct item *item, struct rectangle *allocation);
 347
 348 void
 349 item_set_allocation(struct item *item,
 350                     int32_t x, int32_t y, int32_t width, int32_t height);
 351
 352 void *
 353 item_get_user_data(struct item *item);
 354
 355 void
 356 input_set_pointer_image(struct input *input, uint32_t time, int pointer);
 357
 358 void
 359 input_get_position(struct input *input, int32_t *x, int32_t *y);
 360
 361 uint32_t
 362 input_get_modifiers(struct input *input);
 363
 364 struct wl_input_device *
 365 input_get_input_device(struct input *input);
 366
 367 struct wl_data_device *
 368 input_get_data_device(struct input *input);
 369
 370 void
 371 input_set_selection(struct input *input,
 372                     struct wl_data_source *source, uint32_t time);
 373
 374 void
 375 input_accept(struct input *input, uint32_t time, const char *type);
 376
 377
 378 void
 379 input_receive_drag_data(struct input *input, const char *mime_type,
 380                         data_func_t func, void *user_data);
 381
 382 int
 383 input_receive_selection_data(struct input *input, const char *mime_type,
 384                              data_func_t func, void *data);
 385
 386 void
 387 output_set_user_data(struct output *output, void *data);
 388
 389 void *
 390 output_get_user_data(struct output *output);
 391
 392 void
 393 output_set_destroy_handler(struct output *output,
 394                            display_output_handler_t handler);
 395
 396 void
 397 output_get_allocation(struct output *output, struct rectangle *allocation);
 398
 399 struct wl_output *
 400 output_get_wl_output(struct output *output);
 401
 402 #endif