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