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 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[]);
  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 uint32_t
  74 display_get_serial(struct display *display);
  75
  76 typedef void (*display_output_handler_t)(struct output *output, void *data);
  77
  78 /*
  79  * The output configure handler is called, when a new output is connected
  80  * and we know its current mode, or when the current mode changes.
  81  * Test and set the output user data in your handler to know, if the
  82  * output is new. Note: 'data' in the configure handler is the display
  83  * user data.
  84  */
  85 void
  86 display_set_output_configure_handler(struct display *display,
  87                                      display_output_handler_t handler);
  88
  89 struct wl_data_source *
  90 display_create_data_source(struct display *display);
  91
  92 #ifdef EGL_NO_DISPLAY
  93 EGLDisplay
  94 display_get_egl_display(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 struct wl_cursor_image *
 127 display_get_pointer_image(struct display *display, int pointer);
 128
 129 void
 130 display_defer(struct display *display, struct task *task);
 131
 132 void
 133 display_watch_fd(struct display *display,
 134                  int fd, uint32_t events, struct task *task);
 135
 136 void
 137 display_run(struct display *d);
 138
 139 void
 140 display_exit(struct display *d);
 141
 142 enum pointer_type {
 143         POINTER_BOTTOM_LEFT,
 144         POINTER_BOTTOM_RIGHT,
 145         POINTER_BOTTOM,
 146         POINTER_DRAGGING,
 147         POINTER_LEFT_PTR,
 148         POINTER_LEFT,
 149         POINTER_RIGHT,
 150         POINTER_TOP_LEFT,
 151         POINTER_TOP_RIGHT,
 152         POINTER_TOP,
 153         POINTER_IBEAM,
 154         POINTER_HAND1,
 155 };
 156
 157 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 158                                      uint32_t time, uint32_t key, uint32_t unicode,
 159                                      uint32_t state, void *data);
 160
 161 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 162                                                 struct input *device, void *data);
 163
 164 typedef void (*window_data_handler_t)(struct window *window,
 165                                       struct input *input,
 166                                       float x, float y,
 167                                       const char **types,
 168                                       void *data);
 169
 170 typedef void (*window_drop_handler_t)(struct window *window,
 171                                       struct input *input,
 172                                       int32_t x, int32_t y, void *data);
 173
 174 typedef void (*window_close_handler_t)(struct window *window, void *data);
 175
 176 typedef void (*widget_resize_handler_t)(struct widget *widget,
 177                                         int32_t width, int32_t height,
 178                                         void *data);
 179 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
 180
 181 typedef int (*widget_enter_handler_t)(struct widget *widget,
 182                                       struct input *input,
 183                                       float x, float y, void *data);
 184 typedef void (*widget_leave_handler_t)(struct widget *widget,
 185                                        struct input *input, void *data);
 186 typedef int (*widget_motion_handler_t)(struct widget *widget,
 187                                        struct input *input, uint32_t time,
 188                                        float x, float y, void *data);
 189 typedef void (*widget_button_handler_t)(struct widget *widget,
 190                                         struct input *input, uint32_t time,
 191                                         uint32_t button, uint32_t state,
 192                                         void *data);
 193
 194 struct window *
 195 window_create(struct display *display);
 196 struct window *
 197 window_create_transient(struct display *display, struct window *parent,
 198                         int32_t x, int32_t y, uint32_t flags);
 199
 200 typedef void (*menu_func_t)(struct window *window, int index, void *data);
 201
 202 void
 203 window_show_menu(struct display *display,
 204                  struct input *input, uint32_t time, struct window *parent,
 205                  int32_t x, int32_t y,
 206                  menu_func_t func, const char **entries, int count);
 207
 208 void
 209 window_show_frame_menu(struct window *window,
 210                        struct input *input, uint32_t time);
 211
 212 void
 213 window_destroy(struct window *window);
 214
 215 struct widget *
 216 window_add_widget(struct window *window, void *data);
 217
 218 typedef void (*data_func_t)(void *data, size_t len,
 219                             int32_t x, int32_t y, void *user_data);
 220
 221 struct display *
 222 window_get_display(struct window *window);
 223 void
 224 window_move(struct window *window, struct input *input, uint32_t time);
 225 void
 226 window_get_allocation(struct window *window, struct rectangle *allocation);
 227 void
 228 window_set_transparent(struct window *window, int transparent);
 229 void
 230 window_schedule_redraw(struct window *window);
 231 void
 232 window_schedule_resize(struct window *window, int width, int height);
 233
 234 void
 235 window_damage(struct window *window, int32_t x, int32_t y,
 236               int32_t width, int32_t height);
 237
 238 cairo_surface_t *
 239 window_get_surface(struct window *window);
 240
 241 struct wl_surface *
 242 window_get_wl_surface(struct window *window);
 243
 244 struct wl_shell_surface *
 245 window_get_wl_shell_surface(struct window *window);
 246
 247 void
 248 window_flush(struct window *window);
 249
 250 void
 251 window_set_surface(struct window *window, cairo_surface_t *surface);
 252
 253 void
 254 window_create_surface(struct window *window);
 255
 256 enum window_buffer_type {
 257         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 258         WINDOW_BUFFER_TYPE_SHM,
 259 };
 260
 261 void
 262 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 263                        int32_t x, int32_t y, int32_t width, int32_t height);
 264
 265 void
 266 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 267
 268 void
 269 window_set_fullscreen(struct window *window, int fullscreen);
 270
 271 void
 272 window_set_maximized(struct window *window, int maximized);
 273
 274 void
 275 window_set_custom(struct window *window);
 276
 277 void
 278 window_set_user_data(struct window *window, void *data);
 279
 280 void *
 281 window_get_user_data(struct window *window);
 282
 283 void
 284 window_set_key_handler(struct window *window,
 285                        window_key_handler_t handler);
 286
 287 void
 288 window_set_keyboard_focus_handler(struct window *window,
 289                                   window_keyboard_focus_handler_t handler);
 290
 291 void
 292 window_set_data_handler(struct window *window,
 293                         window_data_handler_t handler);
 294
 295 void
 296 window_set_drop_handler(struct window *window,
 297                         window_drop_handler_t handler);
 298
 299 void
 300 window_set_close_handler(struct window *window,
 301                          window_close_handler_t handler);
 302
 303 void
 304 window_set_title(struct window *window, const char *title);
 305
 306 const char *
 307 window_get_title(struct window *window);
 308
 309 int
 310 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
 311
 312 void
 313 widget_destroy_tooltip(struct widget *parent);
 314
 315 struct widget *
 316 widget_add_widget(struct widget *parent, void *data);
 317
 318 void
 319 widget_destroy(struct widget *widget);
 320 void
 321 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
 322
 323 void
 324 widget_set_allocation(struct widget *widget,
 325                       int32_t x, int32_t y, int32_t width, int32_t height);
 326 void
 327 widget_set_size(struct widget *widget, int32_t width, int32_t height);
 328 void
 329 widget_set_transparent(struct widget *widget, int transparent);
 330 void
 331 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
 332
 333 void *
 334 widget_get_user_data(struct widget *widget);
 335
 336 void
 337 widget_set_redraw_handler(struct widget *widget,
 338                           widget_redraw_handler_t handler);
 339 void
 340 widget_set_resize_handler(struct widget *widget,
 341                           widget_resize_handler_t handler);
 342 void
 343 widget_set_enter_handler(struct widget *widget,
 344                          widget_enter_handler_t handler);
 345 void
 346 widget_set_leave_handler(struct widget *widget,
 347                          widget_leave_handler_t handler);
 348 void
 349 widget_set_motion_handler(struct widget *widget,
 350                           widget_motion_handler_t handler);
 351 void
 352 widget_set_button_handler(struct widget *widget,
 353                           widget_button_handler_t handler);
 354
 355 void
 356 widget_schedule_redraw(struct widget *widget);
 357
 358 struct widget *
 359 frame_create(struct window *window, void *data);
 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 #define MOD_SHIFT_MASK          0x01
 368 #define MOD_ALT_MASK            0x02
 369 #define MOD_CONTROL_MASK        0x04
 370
 371 uint32_t
 372 input_get_modifiers(struct input *input);
 373
 374 void
 375 input_grab(struct input *input, struct widget *widget, uint32_t button);
 376
 377 void
 378 input_ungrab(struct input *input);
 379
 380 struct widget *
 381 input_get_focus_widget(struct input *input);
 382
 383 struct wl_seat *
 384 input_get_seat(struct input *input);
 385
 386 struct wl_data_device *
 387 input_get_data_device(struct input *input);
 388
 389 void
 390 input_set_selection(struct input *input,
 391                     struct wl_data_source *source, uint32_t time);
 392
 393 void
 394 input_accept(struct input *input, const char *type);
 395
 396
 397 void
 398 input_receive_drag_data(struct input *input, const char *mime_type,
 399                         data_func_t func, void *user_data);
 400
 401 int
 402 input_receive_selection_data(struct input *input, const char *mime_type,
 403                              data_func_t func, void *data);
 404 int
 405 input_receive_selection_data_to_fd(struct input *input,
 406                                    const char *mime_type, int fd);
 407
 408 void
 409 output_set_user_data(struct output *output, void *data);
 410
 411 void *
 412 output_get_user_data(struct output *output);
 413
 414 void
 415 output_set_destroy_handler(struct output *output,
 416                            display_output_handler_t handler);
 417
 418 void
 419 output_get_allocation(struct output *output, struct rectangle *allocation);
 420
 421 struct wl_output *
 422 output_get_wl_output(struct output *output);
 423
 424 #endif