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