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 #define SURFACE_SHM    0x02
 116
 117 cairo_surface_t *
 118 display_create_surface(struct display *display,
 119                        struct wl_surface *surface,
 120                        struct rectangle *rectangle,
 121                        uint32_t flags);
 122
 123 struct wl_buffer *
 124 display_get_buffer_for_surface(struct display *display,
 125                                cairo_surface_t *surface);
 126
 127 struct wl_cursor_image *
 128 display_get_pointer_image(struct display *display, int pointer);
 129
 130 void
 131 display_defer(struct display *display, struct task *task);
 132
 133 void
 134 display_watch_fd(struct display *display,
 135                  int fd, uint32_t events, struct task *task);
 136
 137 void
 138 display_run(struct display *d);
 139
 140 void
 141 display_exit(struct display *d);
 142
 143 enum cursor_type {
 144         CURSOR_BOTTOM_LEFT,
 145         CURSOR_BOTTOM_RIGHT,
 146         CURSOR_BOTTOM,
 147         CURSOR_DRAGGING,
 148         CURSOR_LEFT_PTR,
 149         CURSOR_LEFT,
 150         CURSOR_RIGHT,
 151         CURSOR_TOP_LEFT,
 152         CURSOR_TOP_RIGHT,
 153         CURSOR_TOP,
 154         CURSOR_IBEAM,
 155         CURSOR_HAND1,
 156         CURSOR_WATCH,
 157
 158         CURSOR_BLANK
 159 };
 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                                      enum wl_keyboard_key_state 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_data_handler_t)(struct window *window,
 169                                       struct input *input,
 170                                       float x, float y,
 171                                       const char **types,
 172                                       void *data);
 173
 174 typedef void (*window_drop_handler_t)(struct window *window,
 175                                       struct input *input,
 176                                       int32_t x, int32_t y, void *data);
 177
 178 typedef void (*window_close_handler_t)(struct window *window, void *data);
 179 typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
 180
 181 typedef void (*widget_resize_handler_t)(struct widget *widget,
 182                                         int32_t width, int32_t height,
 183                                         void *data);
 184 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
 185
 186 typedef int (*widget_enter_handler_t)(struct widget *widget,
 187                                       struct input *input,
 188                                       float x, float y, void *data);
 189 typedef void (*widget_leave_handler_t)(struct widget *widget,
 190                                        struct input *input, void *data);
 191 typedef int (*widget_motion_handler_t)(struct widget *widget,
 192                                        struct input *input, uint32_t time,
 193                                        float x, float y, void *data);
 194 typedef void (*widget_button_handler_t)(struct widget *widget,
 195                                         struct input *input, uint32_t time,
 196                                         uint32_t button,
 197                                         enum wl_pointer_button_state state,
 198                                         void *data);
 199 typedef void (*widget_axis_handler_t)(struct widget *widget,
 200                                       struct input *input, uint32_t time,
 201                                       uint32_t axis,
 202                                       wl_fixed_t value,
 203                                       void *data);
 204
 205 struct window *
 206 window_create(struct display *display);
 207 struct window *
 208 window_create_transient(struct display *display, struct window *parent,
 209                         int32_t x, int32_t y, uint32_t flags);
 210 struct window *
 211 window_create_custom(struct display *display);
 212
 213 int
 214 window_has_focus(struct window *window);
 215
 216 typedef void (*menu_func_t)(struct window *window, int index, void *data);
 217
 218 void
 219 window_show_menu(struct display *display,
 220                  struct input *input, uint32_t time, struct window *parent,
 221                  int32_t x, int32_t y,
 222                  menu_func_t func, const char **entries, int count);
 223
 224 void
 225 window_show_frame_menu(struct window *window,
 226                        struct input *input, uint32_t time);
 227
 228 void
 229 window_destroy(struct window *window);
 230
 231 struct widget *
 232 window_add_widget(struct window *window, void *data);
 233
 234 typedef void (*data_func_t)(void *data, size_t len,
 235                             int32_t x, int32_t y, void *user_data);
 236
 237 struct display *
 238 window_get_display(struct window *window);
 239 void
 240 window_move(struct window *window, struct input *input, uint32_t time);
 241 void
 242 window_get_allocation(struct window *window, struct rectangle *allocation);
 243 void
 244 window_set_transparent(struct window *window, int transparent);
 245 void
 246 window_schedule_redraw(struct window *window);
 247 void
 248 window_schedule_resize(struct window *window, int width, int height);
 249
 250 void
 251 window_damage(struct window *window, int32_t x, int32_t y,
 252               int32_t width, int32_t height);
 253
 254 cairo_surface_t *
 255 window_get_surface(struct window *window);
 256
 257 struct wl_surface *
 258 window_get_wl_surface(struct window *window);
 259
 260 struct wl_shell_surface *
 261 window_get_wl_shell_surface(struct window *window);
 262
 263 void
 264 window_flush(struct window *window);
 265
 266 void
 267 window_set_surface(struct window *window, cairo_surface_t *surface);
 268
 269 void
 270 window_create_surface(struct window *window);
 271
 272 enum window_buffer_type {
 273         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 274         WINDOW_BUFFER_TYPE_SHM,
 275 };
 276
 277 void
 278 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 279                        int32_t x, int32_t y, int32_t width, int32_t height);
 280
 281 void
 282 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 283
 284 void
 285 window_set_fullscreen(struct window *window, int fullscreen);
 286
 287 void
 288 window_set_maximized(struct window *window, int maximized);
 289
 290 void
 291 window_set_user_data(struct window *window, void *data);
 292
 293 void *
 294 window_get_user_data(struct window *window);
 295
 296 void
 297 window_set_key_handler(struct window *window,
 298                        window_key_handler_t handler);
 299
 300 void
 301 window_set_keyboard_focus_handler(struct window *window,
 302                                   window_keyboard_focus_handler_t handler);
 303
 304 void
 305 window_set_data_handler(struct window *window,
 306                         window_data_handler_t handler);
 307
 308 void
 309 window_set_drop_handler(struct window *window,
 310                         window_drop_handler_t handler);
 311
 312 void
 313 window_set_close_handler(struct window *window,
 314                          window_close_handler_t handler);
 315 void
 316 window_set_fullscreen_handler(struct window *window,
 317                               window_fullscreen_handler_t handler);
 318
 319 void
 320 window_set_title(struct window *window, const char *title);
 321
 322 const char *
 323 window_get_title(struct window *window);
 324
 325 void
 326 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
 327
 328 int
 329 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
 330
 331 void
 332 widget_destroy_tooltip(struct widget *parent);
 333
 334 struct widget *
 335 widget_add_widget(struct widget *parent, void *data);
 336
 337 void
 338 widget_destroy(struct widget *widget);
 339 void
 340 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
 341
 342 void
 343 widget_set_allocation(struct widget *widget,
 344                       int32_t x, int32_t y, int32_t width, int32_t height);
 345 void
 346 widget_set_size(struct widget *widget, int32_t width, int32_t height);
 347 void
 348 widget_set_transparent(struct widget *widget, int transparent);
 349 void
 350 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
 351
 352 void *
 353 widget_get_user_data(struct widget *widget);
 354
 355 void
 356 widget_set_redraw_handler(struct widget *widget,
 357                           widget_redraw_handler_t handler);
 358 void
 359 widget_set_resize_handler(struct widget *widget,
 360                           widget_resize_handler_t handler);
 361 void
 362 widget_set_enter_handler(struct widget *widget,
 363                          widget_enter_handler_t handler);
 364 void
 365 widget_set_leave_handler(struct widget *widget,
 366                          widget_leave_handler_t handler);
 367 void
 368 widget_set_motion_handler(struct widget *widget,
 369                           widget_motion_handler_t handler);
 370 void
 371 widget_set_button_handler(struct widget *widget,
 372                           widget_button_handler_t handler);
 373 void
 374 widget_set_axis_handler(struct widget *widget,
 375                         widget_axis_handler_t handler);
 376
 377 void
 378 widget_schedule_redraw(struct widget *widget);
 379
 380 struct widget *
 381 frame_create(struct window *window, void *data);
 382 void
 383 frame_set_child_size(struct widget *widget, int child_width, int child_height);
 384
 385 void
 386 input_set_pointer_image(struct input *input, int pointer);
 387
 388 void
 389 input_get_position(struct input *input, int32_t *x, int32_t *y);
 390
 391 #define MOD_SHIFT_MASK          0x01
 392 #define MOD_ALT_MASK            0x02
 393 #define MOD_CONTROL_MASK        0x04
 394
 395 uint32_t
 396 input_get_modifiers(struct input *input);
 397
 398 void
 399 input_grab(struct input *input, struct widget *widget, uint32_t button);
 400
 401 void
 402 input_ungrab(struct input *input);
 403
 404 struct widget *
 405 input_get_focus_widget(struct input *input);
 406
 407 struct display *
 408 input_get_display(struct input *input);
 409
 410 struct wl_seat *
 411 input_get_seat(struct input *input);
 412
 413 struct wl_data_device *
 414 input_get_data_device(struct input *input);
 415
 416 void
 417 input_set_selection(struct input *input,
 418                     struct wl_data_source *source, uint32_t time);
 419
 420 void
 421 input_accept(struct input *input, const char *type);
 422
 423
 424 void
 425 input_receive_drag_data(struct input *input, const char *mime_type,
 426                         data_func_t func, void *user_data);
 427
 428 int
 429 input_receive_selection_data(struct input *input, const char *mime_type,
 430                              data_func_t func, void *data);
 431 int
 432 input_receive_selection_data_to_fd(struct input *input,
 433                                    const char *mime_type, int fd);
 434
 435 void
 436 output_set_user_data(struct output *output, void *data);
 437
 438 void *
 439 output_get_user_data(struct output *output);
 440
 441 void
 442 output_set_destroy_handler(struct output *output,
 443                            display_output_handler_t handler);
 444
 445 void
 446 output_get_allocation(struct output *output, struct rectangle *allocation);
 447
 448 struct wl_output *
 449 output_get_wl_output(struct output *output);
 450
 451 #endif