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 <xkbcommon/xkbcommon.h>
  27 #include <wayland-client.h>
  28 #include <cairo.h>
  29 #include "../shared/config-parser.h"
  30
  31 #define ARRAY_LENGTH(a) (sizeof (a) / sizeof (a)[0])
  32
  33 struct window;
  34 struct widget;
  35 struct display;
  36 struct input;
  37 struct output;
  38
  39 struct task {
  40         void (*run)(struct task *task, uint32_t events);
  41         struct wl_list link;
  42 };
  43
  44 struct rectangle {
  45         int32_t x;
  46         int32_t y;
  47         int32_t width;
  48         int32_t height;
  49 };
  50
  51 struct display *
  52 display_create(int argc, char *argv[]);
  53
  54 void
  55 display_destroy(struct display *display);
  56
  57 void
  58 display_set_user_data(struct display *display, void *data);
  59
  60 void *
  61 display_get_user_data(struct display *display);
  62
  63 struct wl_display *
  64 display_get_display(struct display *display);
  65
  66 struct wl_compositor *
  67 display_get_compositor(struct display *display);
  68
  69 struct wl_shell *
  70 display_get_shell(struct display *display);
  71
  72 struct output *
  73 display_get_output(struct display *display);
  74
  75 uint32_t
  76 display_get_serial(struct display *display);
  77
  78 typedef void (*display_global_handler_t)(struct display *display,
  79                                          uint32_t name,
  80                                          const char *interface,
  81                                          uint32_t version, void *data);
  82
  83 void
  84 display_set_global_handler(struct display *display,
  85                            display_global_handler_t handler);
  86 void *
  87 display_bind(struct display *display, uint32_t name,
  88              const struct wl_interface *interface, uint32_t version);
  89
  90 typedef void (*display_output_handler_t)(struct output *output, void *data);
  91
  92 /*
  93  * The output configure handler is called, when a new output is connected
  94  * and we know its current mode, or when the current mode changes.
  95  * Test and set the output user data in your handler to know, if the
  96  * output is new. Note: 'data' in the configure handler is the display
  97  * user data.
  98  */
  99 void
 100 display_set_output_configure_handler(struct display *display,
 101                                      display_output_handler_t handler);
 102
 103 struct wl_data_source *
 104 display_create_data_source(struct display *display);
 105
 106 #ifdef EGL_NO_DISPLAY
 107 EGLDisplay
 108 display_get_egl_display(struct display *d);
 109
 110 EGLConfig
 111 display_get_argb_egl_config(struct display *d);
 112
 113 int
 114 display_acquire_window_surface(struct display *display,
 115                                struct window *window,
 116                                EGLContext ctx);
 117 void
 118 display_release_window_surface(struct display *display,
 119                                struct window *window);
 120 #endif
 121
 122 #define SURFACE_OPAQUE 0x01
 123 #define SURFACE_SHM    0x02
 124
 125 cairo_surface_t *
 126 display_create_surface(struct display *display,
 127                        struct wl_surface *surface,
 128                        struct rectangle *rectangle,
 129                        uint32_t flags);
 130
 131 struct wl_buffer *
 132 display_get_buffer_for_surface(struct display *display,
 133                                cairo_surface_t *surface);
 134
 135 struct wl_cursor_image *
 136 display_get_pointer_image(struct display *display, int pointer);
 137
 138 void
 139 display_defer(struct display *display, struct task *task);
 140
 141 void
 142 display_watch_fd(struct display *display,
 143                  int fd, uint32_t events, struct task *task);
 144
 145 void
 146 display_run(struct display *d);
 147
 148 void
 149 display_exit(struct display *d);
 150
 151 enum cursor_type {
 152         CURSOR_BOTTOM_LEFT,
 153         CURSOR_BOTTOM_RIGHT,
 154         CURSOR_BOTTOM,
 155         CURSOR_DRAGGING,
 156         CURSOR_LEFT_PTR,
 157         CURSOR_LEFT,
 158         CURSOR_RIGHT,
 159         CURSOR_TOP_LEFT,
 160         CURSOR_TOP_RIGHT,
 161         CURSOR_TOP,
 162         CURSOR_IBEAM,
 163         CURSOR_HAND1,
 164         CURSOR_WATCH,
 165
 166         CURSOR_BLANK
 167 };
 168
 169 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 170                                      uint32_t time, uint32_t key, uint32_t unicode,
 171                                      enum wl_keyboard_key_state state, void *data);
 172
 173 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 174                                                 struct input *device, void *data);
 175
 176 typedef void (*window_data_handler_t)(struct window *window,
 177                                       struct input *input,
 178                                       float x, float y,
 179                                       const char **types,
 180                                       void *data);
 181
 182 typedef void (*window_drop_handler_t)(struct window *window,
 183                                       struct input *input,
 184                                       int32_t x, int32_t y, void *data);
 185
 186 typedef void (*window_close_handler_t)(struct window *window, void *data);
 187 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
 188
 189 typedef void (*widget_resize_handler_t)(struct widget *widget,
 190                                         int32_t width, int32_t height,
 191                                         void *data);
 192 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
 193
 194 typedef int (*widget_enter_handler_t)(struct widget *widget,
 195                                       struct input *input,
 196                                       float x, float y, void *data);
 197 typedef void (*widget_leave_handler_t)(struct widget *widget,
 198                                        struct input *input, void *data);
 199 typedef int (*widget_motion_handler_t)(struct widget *widget,
 200                                        struct input *input, uint32_t time,
 201                                        float x, float y, void *data);
 202 typedef void (*widget_button_handler_t)(struct widget *widget,
 203                                         struct input *input, uint32_t time,
 204                                         uint32_t button,
 205                                         enum wl_pointer_button_state state,
 206                                         void *data);
 207 typedef void (*widget_axis_handler_t)(struct widget *widget,
 208                                       struct input *input, uint32_t time,
 209                                       uint32_t axis,
 210                                       wl_fixed_t value,
 211                                       void *data);
 212
 213 struct window *
 214 window_create(struct display *display);
 215 struct window *
 216 window_create_transient(struct display *display, struct window *parent,
 217                         int32_t x, int32_t y, uint32_t flags);
 218 struct window *
 219 window_create_custom(struct display *display);
 220
 221 int
 222 window_has_focus(struct window *window);
 223
 224 typedef void (*menu_func_t)(struct window *window, int index, void *data);
 225
 226 void
 227 window_show_menu(struct display *display,
 228                  struct input *input, uint32_t time, struct window *parent,
 229                  int32_t x, int32_t y,
 230                  menu_func_t func, const char **entries, int count);
 231
 232 void
 233 window_show_frame_menu(struct window *window,
 234                        struct input *input, uint32_t time);
 235
 236 void
 237 window_destroy(struct window *window);
 238
 239 struct widget *
 240 window_add_widget(struct window *window, void *data);
 241
 242 typedef void (*data_func_t)(void *data, size_t len,
 243                             int32_t x, int32_t y, void *user_data);
 244
 245 struct display *
 246 window_get_display(struct window *window);
 247 void
 248 window_move(struct window *window, struct input *input, uint32_t time);
 249 void
 250 window_get_allocation(struct window *window, struct rectangle *allocation);
 251 void
 252 window_set_transparent(struct window *window, int transparent);
 253 void
 254 window_schedule_redraw(struct window *window);
 255 void
 256 window_schedule_resize(struct window *window, int width, int height);
 257
 258 void
 259 window_damage(struct window *window, int32_t x, int32_t y,
 260               int32_t width, int32_t height);
 261
 262 cairo_surface_t *
 263 window_get_surface(struct window *window);
 264
 265 struct wl_surface *
 266 window_get_wl_surface(struct window *window);
 267
 268 struct wl_shell_surface *
 269 window_get_wl_shell_surface(struct window *window);
 270
 271 void
 272 window_flush(struct window *window);
 273
 274 void
 275 window_set_surface(struct window *window, cairo_surface_t *surface);
 276
 277 void
 278 window_create_surface(struct window *window);
 279
 280 enum window_buffer_type {
 281         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 282         WINDOW_BUFFER_TYPE_SHM,
 283 };
 284
 285 void
 286 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 287                        int32_t x, int32_t y, int32_t width, int32_t height);
 288
 289 void
 290 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 291
 292 int
 293 window_is_fullscreen(struct window *window);
 294
 295 void
 296 window_set_fullscreen(struct window *window, int fullscreen);
 297
 298 int
 299 window_is_maximized(struct window *window);
 300
 301 void
 302 window_set_maximized(struct window *window, int maximized);
 303
 304 void
 305 window_set_user_data(struct window *window, void *data);
 306
 307 void *
 308 window_get_user_data(struct window *window);
 309
 310 void
 311 window_set_key_handler(struct window *window,
 312                        window_key_handler_t handler);
 313
 314 void
 315 window_set_keyboard_focus_handler(struct window *window,
 316                                   window_keyboard_focus_handler_t handler);
 317
 318 void
 319 window_set_data_handler(struct window *window,
 320                         window_data_handler_t handler);
 321
 322 void
 323 window_set_drop_handler(struct window *window,
 324                         window_drop_handler_t handler);
 325
 326 void
 327 window_set_close_handler(struct window *window,
 328                          window_close_handler_t handler);
 329 void
 330 window_set_fullscreen_handler(struct window *window,
 331                               window_fullscreen_handler_t handler);
 332
 333 void
 334 window_set_title(struct window *window, const char *title);
 335
 336 const char *
 337 window_get_title(struct window *window);
 338
 339 void
 340 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
 341
 342 int
 343 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
 344
 345 void
 346 widget_destroy_tooltip(struct widget *parent);
 347
 348 struct widget *
 349 widget_add_widget(struct widget *parent, void *data);
 350
 351 void
 352 widget_destroy(struct widget *widget);
 353 void
 354 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
 355
 356 void
 357 widget_set_allocation(struct widget *widget,
 358                       int32_t x, int32_t y, int32_t width, int32_t height);
 359 void
 360 widget_set_size(struct widget *widget, int32_t width, int32_t height);
 361 void
 362 widget_set_transparent(struct widget *widget, int transparent);
 363 void
 364 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
 365
 366 void *
 367 widget_get_user_data(struct widget *widget);
 368
 369 void
 370 widget_set_redraw_handler(struct widget *widget,
 371                           widget_redraw_handler_t handler);
 372 void
 373 widget_set_resize_handler(struct widget *widget,
 374                           widget_resize_handler_t handler);
 375 void
 376 widget_set_enter_handler(struct widget *widget,
 377                          widget_enter_handler_t handler);
 378 void
 379 widget_set_leave_handler(struct widget *widget,
 380                          widget_leave_handler_t handler);
 381 void
 382 widget_set_motion_handler(struct widget *widget,
 383                           widget_motion_handler_t handler);
 384 void
 385 widget_set_button_handler(struct widget *widget,
 386                           widget_button_handler_t handler);
 387 void
 388 widget_set_axis_handler(struct widget *widget,
 389                         widget_axis_handler_t handler);
 390
 391 void
 392 widget_schedule_redraw(struct widget *widget);
 393
 394 struct widget *
 395 frame_create(struct window *window, void *data);
 396 void
 397 frame_set_child_size(struct widget *widget, int child_width, int child_height);
 398
 399 void
 400 input_set_pointer_image(struct input *input, int pointer);
 401
 402 void
 403 input_get_position(struct input *input, int32_t *x, int32_t *y);
 404
 405 #define MOD_SHIFT_MASK          0x01
 406 #define MOD_ALT_MASK            0x02
 407 #define MOD_CONTROL_MASK        0x04
 408
 409 uint32_t
 410 input_get_modifiers(struct input *input);
 411
 412 void
 413 input_grab(struct input *input, struct widget *widget, uint32_t button);
 414
 415 void
 416 input_ungrab(struct input *input);
 417
 418 struct widget *
 419 input_get_focus_widget(struct input *input);
 420
 421 struct display *
 422 input_get_display(struct input *input);
 423
 424 struct wl_seat *
 425 input_get_seat(struct input *input);
 426
 427 struct wl_data_device *
 428 input_get_data_device(struct input *input);
 429
 430 void
 431 input_set_selection(struct input *input,
 432                     struct wl_data_source *source, uint32_t time);
 433
 434 void
 435 input_accept(struct input *input, const char *type);
 436
 437
 438 void
 439 input_receive_drag_data(struct input *input, const char *mime_type,
 440                         data_func_t func, void *user_data);
 441
 442 int
 443 input_receive_selection_data(struct input *input, const char *mime_type,
 444                              data_func_t func, void *data);
 445 int
 446 input_receive_selection_data_to_fd(struct input *input,
 447                                    const char *mime_type, int fd);
 448
 449 void
 450 output_set_user_data(struct output *output, void *data);
 451
 452 void *
 453 output_get_user_data(struct output *output);
 454
 455 void
 456 output_set_destroy_handler(struct output *output,
 457                            display_output_handler_t handler);
 458
 459 void
 460 output_get_allocation(struct output *output, struct rectangle *allocation);
 461
 462 struct wl_output *
 463 output_get_wl_output(struct output *output);
 464
 465 #endif