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