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 };
 157
 158 typedef void (*window_key_handler_t)(struct window *window, struct input *input,
 159                                      uint32_t time, uint32_t key, uint32_t unicode,
 160                                      enum wl_keyboard_key_state state, void *data);
 161
 162 typedef void (*window_keyboard_focus_handler_t)(struct window *window,
 163                                                 struct input *device, void *data);
 164
 165 typedef void (*window_data_handler_t)(struct window *window,
 166                                       struct input *input,
 167                                       float x, float y,
 168                                       const char **types,
 169                                       void *data);
 170
 171 typedef void (*window_drop_handler_t)(struct window *window,
 172                                       struct input *input,
 173                                       int32_t x, int32_t y, void *data);
 174
 175 typedef void (*window_close_handler_t)(struct window *window, void *data);
 176
 177 typedef void (*widget_resize_handler_t)(struct widget *widget,
 178                                         int32_t width, int32_t height,
 179                                         void *data);
 180 typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
 181
 182 typedef int (*widget_enter_handler_t)(struct widget *widget,
 183                                       struct input *input,
 184                                       float x, float y, void *data);
 185 typedef void (*widget_leave_handler_t)(struct widget *widget,
 186                                        struct input *input, void *data);
 187 typedef int (*widget_motion_handler_t)(struct widget *widget,
 188                                        struct input *input, uint32_t time,
 189                                        float x, float y, void *data);
 190 typedef void (*widget_button_handler_t)(struct widget *widget,
 191                                         struct input *input, uint32_t time,
 192                                         uint32_t button,
 193                                         enum wl_pointer_button_state state,
 194                                         void *data);
 195
 196 struct window *
 197 window_create(struct display *display);
 198 struct window *
 199 window_create_transient(struct display *display, struct window *parent,
 200                         int32_t x, int32_t y, uint32_t flags);
 201
 202 typedef void (*menu_func_t)(struct window *window, int index, void *data);
 203
 204 void
 205 window_show_menu(struct display *display,
 206                  struct input *input, uint32_t time, struct window *parent,
 207                  int32_t x, int32_t y,
 208                  menu_func_t func, const char **entries, int count);
 209
 210 void
 211 window_show_frame_menu(struct window *window,
 212                        struct input *input, uint32_t time);
 213
 214 void
 215 window_destroy(struct window *window);
 216
 217 struct widget *
 218 window_add_widget(struct window *window, void *data);
 219
 220 typedef void (*data_func_t)(void *data, size_t len,
 221                             int32_t x, int32_t y, void *user_data);
 222
 223 struct display *
 224 window_get_display(struct window *window);
 225 void
 226 window_move(struct window *window, struct input *input, uint32_t time);
 227 void
 228 window_get_allocation(struct window *window, struct rectangle *allocation);
 229 void
 230 window_set_transparent(struct window *window, int transparent);
 231 void
 232 window_schedule_redraw(struct window *window);
 233 void
 234 window_schedule_resize(struct window *window, int width, int height);
 235
 236 void
 237 window_damage(struct window *window, int32_t x, int32_t y,
 238               int32_t width, int32_t height);
 239
 240 cairo_surface_t *
 241 window_get_surface(struct window *window);
 242
 243 struct wl_surface *
 244 window_get_wl_surface(struct window *window);
 245
 246 struct wl_shell_surface *
 247 window_get_wl_shell_surface(struct window *window);
 248
 249 void
 250 window_flush(struct window *window);
 251
 252 void
 253 window_set_surface(struct window *window, cairo_surface_t *surface);
 254
 255 void
 256 window_create_surface(struct window *window);
 257
 258 enum window_buffer_type {
 259         WINDOW_BUFFER_TYPE_EGL_WINDOW,
 260         WINDOW_BUFFER_TYPE_SHM,
 261 };
 262
 263 void
 264 display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
 265                        int32_t x, int32_t y, int32_t width, int32_t height);
 266
 267 void
 268 window_set_buffer_type(struct window *window, enum window_buffer_type type);
 269
 270 void
 271 window_set_fullscreen(struct window *window, int fullscreen);
 272
 273 void
 274 window_set_maximized(struct window *window, int maximized);
 275
 276 void
 277 window_set_custom(struct window *window);
 278
 279 void
 280 window_set_user_data(struct window *window, void *data);
 281
 282 void *
 283 window_get_user_data(struct window *window);
 284
 285 void
 286 window_set_key_handler(struct window *window,
 287                        window_key_handler_t handler);
 288
 289 void
 290 window_set_keyboard_focus_handler(struct window *window,
 291                                   window_keyboard_focus_handler_t handler);
 292
 293 void
 294 window_set_data_handler(struct window *window,
 295                         window_data_handler_t handler);
 296
 297 void
 298 window_set_drop_handler(struct window *window,
 299                         window_drop_handler_t handler);
 300
 301 void
 302 window_set_close_handler(struct window *window,
 303                          window_close_handler_t handler);
 304
 305 void
 306 window_set_title(struct window *window, const char *title);
 307
 308 const char *
 309 window_get_title(struct window *window);
 310
 311 void
 312 window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
 313
 314 int
 315 widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
 316
 317 void
 318 widget_destroy_tooltip(struct widget *parent);
 319
 320 struct widget *
 321 widget_add_widget(struct widget *parent, void *data);
 322
 323 void
 324 widget_destroy(struct widget *widget);
 325 void
 326 widget_get_allocation(struct widget *widget, struct rectangle *allocation);
 327
 328 void
 329 widget_set_allocation(struct widget *widget,
 330                       int32_t x, int32_t y, int32_t width, int32_t height);
 331 void
 332 widget_set_size(struct widget *widget, int32_t width, int32_t height);
 333 void
 334 widget_set_transparent(struct widget *widget, int transparent);
 335 void
 336 widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
 337
 338 void *
 339 widget_get_user_data(struct widget *widget);
 340
 341 void
 342 widget_set_redraw_handler(struct widget *widget,
 343                           widget_redraw_handler_t handler);
 344 void
 345 widget_set_resize_handler(struct widget *widget,
 346                           widget_resize_handler_t handler);
 347 void
 348 widget_set_enter_handler(struct widget *widget,
 349                          widget_enter_handler_t handler);
 350 void
 351 widget_set_leave_handler(struct widget *widget,
 352                          widget_leave_handler_t handler);
 353 void
 354 widget_set_motion_handler(struct widget *widget,
 355                           widget_motion_handler_t handler);
 356 void
 357 widget_set_button_handler(struct widget *widget,
 358                           widget_button_handler_t handler);
 359
 360 void
 361 widget_schedule_redraw(struct widget *widget);
 362
 363 struct widget *
 364 frame_create(struct window *window, void *data);
 365
 366 void
 367 input_set_pointer_image(struct input *input, int pointer);
 368
 369 void
 370 input_get_position(struct input *input, int32_t *x, int32_t *y);
 371
 372 #define MOD_SHIFT_MASK          0x01
 373 #define MOD_ALT_MASK            0x02
 374 #define MOD_CONTROL_MASK        0x04
 375
 376 uint32_t
 377 input_get_modifiers(struct input *input);
 378
 379 void
 380 input_grab(struct input *input, struct widget *widget, uint32_t button);
 381
 382 void
 383 input_ungrab(struct input *input);
 384
 385 struct widget *
 386 input_get_focus_widget(struct input *input);
 387
 388 struct wl_seat *
 389 input_get_seat(struct input *input);
 390
 391 struct wl_data_device *
 392 input_get_data_device(struct input *input);
 393
 394 void
 395 input_set_selection(struct input *input,
 396                     struct wl_data_source *source, uint32_t time);
 397
 398 void
 399 input_accept(struct input *input, const char *type);
 400
 401
 402 void
 403 input_receive_drag_data(struct input *input, const char *mime_type,
 404                         data_func_t func, void *user_data);
 405
 406 int
 407 input_receive_selection_data(struct input *input, const char *mime_type,
 408                              data_func_t func, void *data);
 409 int
 410 input_receive_selection_data_to_fd(struct input *input,
 411                                    const char *mime_type, int fd);
 412
 413 void
 414 output_set_user_data(struct output *output, void *data);
 415
 416 void *
 417 output_get_user_data(struct output *output);
 418
 419 void
 420 output_set_destroy_handler(struct output *output,
 421                            display_output_handler_t handler);
 422
 423 void
 424 output_get_allocation(struct output *output, struct rectangle *allocation);
 425
 426 struct wl_output *
 427 output_get_wl_output(struct output *output);
 428
 429 #endif