1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
|
/* Generated by wayland-scanner 1.15.92 */
// Hand edited to resolve conflicts with xdg-shell stable
#ifndef XDG_SHELL_UNSTABLE_V5_SERVER_PROTOCOL_H
#define XDG_SHELL_UNSTABLE_V5_SERVER_PROTOCOL_H
#include <stdint.h>
#include <stddef.h>
#include "wayland-server-core.h"
#ifdef __cplusplus
extern "C" {
#endif
struct wl_client;
struct wl_resource;
/**
* @page page_xdg_shell_unstable_v5 The xdg_shell_unstable_v5 protocol
* @section page_ifaces_xdg_shell_unstable_v5 Interfaces
* - @subpage page_iface_xdg_shell - create desktop-style surfaces
* - @subpage page_iface_xdg_surface - A desktop window
* - @subpage page_iface_xdg_popup - short-lived, popup surfaces for menus
* @section page_copyright_xdg_shell_unstable_v5 Copyright
* <pre>
*
* Copyright © 2008-2013 Kristian Høgsberg
* Copyright © 2013 Rafael Antognolli
* Copyright © 2013 Jasper St. Pierre
* Copyright © 2010-2013 Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
* </pre>
*/
struct wl_output;
struct wl_seat;
struct wl_surface;
struct xdg_popup;
struct xdg_shell;
struct xdg_surface;
/**
* @page page_iface_xdg_shell xdg_shell
* @section page_iface_xdg_shell_desc Description
*
* xdg_shell allows clients to turn a wl_surface into a "real window"
* which can be dragged, resized, stacked, and moved around by the
* user. Everything about this interface is suited towards traditional
* desktop environments.
* @section page_iface_xdg_shell_api API
* See @ref iface_xdg_shell.
*/
/**
* @defgroup iface_xdg_shell The xdg_shell interface
*
* xdg_shell allows clients to turn a wl_surface into a "real window"
* which can be dragged, resized, stacked, and moved around by the
* user. Everything about this interface is suited towards traditional
* desktop environments.
*/
extern const struct wl_interface xdg_shell_v5_interface;
/**
* @page page_iface_xdg_surface xdg_surface
* @section page_iface_xdg_surface_desc Description
*
* An interface that may be implemented by a wl_surface, for
* implementations that provide a desktop-style user interface.
*
* It provides requests to treat surfaces like windows, allowing to set
* properties like maximized, fullscreen, minimized, and to move and resize
* them, and associate metadata like title and app id.
*
* The client must call wl_surface.commit on the corresponding wl_surface
* for the xdg_surface state to take effect. Prior to committing the new
* state, it can set up initial configuration, such as maximizing or setting
* a window geometry.
*
* Even without attaching a buffer the compositor must respond to initial
* committed configuration, for instance sending a configure event with
* expected window geometry if the client maximized its surface during
* initialization.
*
* For a surface to be mapped by the compositor the client must have
* committed both an xdg_surface state and a buffer.
* @section page_iface_xdg_surface_api API
* See @ref iface_xdg_surface.
*/
/**
* @defgroup iface_xdg_surface The xdg_surface interface
*
* An interface that may be implemented by a wl_surface, for
* implementations that provide a desktop-style user interface.
*
* It provides requests to treat surfaces like windows, allowing to set
* properties like maximized, fullscreen, minimized, and to move and resize
* them, and associate metadata like title and app id.
*
* The client must call wl_surface.commit on the corresponding wl_surface
* for the xdg_surface state to take effect. Prior to committing the new
* state, it can set up initial configuration, such as maximizing or setting
* a window geometry.
*
* Even without attaching a buffer the compositor must respond to initial
* committed configuration, for instance sending a configure event with
* expected window geometry if the client maximized its surface during
* initialization.
*
* For a surface to be mapped by the compositor the client must have
* committed both an xdg_surface state and a buffer.
*/
extern const struct wl_interface xdg_surface_v5_interface;
/**
* @page page_iface_xdg_popup xdg_popup
* @section page_iface_xdg_popup_desc Description
*
* A popup surface is a short-lived, temporary surface that can be
* used to implement menus. It takes an explicit grab on the surface
* that will be dismissed when the user dismisses the popup. This can
* be done by the user clicking outside the surface, using the keyboard,
* or even locking the screen through closing the lid or a timeout.
*
* When the popup is dismissed, a popup_done event will be sent out,
* and at the same time the surface will be unmapped. The xdg_popup
* object is now inert and cannot be reactivated, so clients should
* destroy it. Explicitly destroying the xdg_popup object will also
* dismiss the popup and unmap the surface.
*
* Clients will receive events for all their surfaces during this
* grab (which is an "owner-events" grab in X11 parlance). This is
* done so that users can navigate through submenus and other
* "nested" popup windows without having to dismiss the topmost
* popup.
*
* Clients that want to dismiss the popup when another surface of
* their own is clicked should dismiss the popup using the destroy
* request.
*
* The parent surface must have either an xdg_surface or xdg_popup
* role.
*
* Specifying an xdg_popup for the parent means that the popups are
* nested, with this popup now being the topmost popup. Nested
* popups must be destroyed in the reverse order they were created
* in, e.g. the only popup you are allowed to destroy at all times
* is the topmost one.
*
* If there is an existing popup when creating a new popup, the
* parent must be the current topmost popup.
*
* A parent surface must be mapped before the new popup is mapped.
*
* When compositors choose to dismiss a popup, they will likely
* dismiss every nested popup as well. When a compositor dismisses
* popups, it will follow the same dismissing order as required
* from the client.
*
* The x and y arguments passed when creating the popup object specify
* where the top left of the popup should be placed, relative to the
* local surface coordinates of the parent surface. See
* xdg_shell.get_xdg_popup.
*
* The client must call wl_surface.commit on the corresponding wl_surface
* for the xdg_popup state to take effect.
*
* For a surface to be mapped by the compositor the client must have
* committed both the xdg_popup state and a buffer.
* @section page_iface_xdg_popup_api API
* See @ref iface_xdg_popup.
*/
/**
* @defgroup iface_xdg_popup The xdg_popup interface
*
* A popup surface is a short-lived, temporary surface that can be
* used to implement menus. It takes an explicit grab on the surface
* that will be dismissed when the user dismisses the popup. This can
* be done by the user clicking outside the surface, using the keyboard,
* or even locking the screen through closing the lid or a timeout.
*
* When the popup is dismissed, a popup_done event will be sent out,
* and at the same time the surface will be unmapped. The xdg_popup
* object is now inert and cannot be reactivated, so clients should
* destroy it. Explicitly destroying the xdg_popup object will also
* dismiss the popup and unmap the surface.
*
* Clients will receive events for all their surfaces during this
* grab (which is an "owner-events" grab in X11 parlance). This is
* done so that users can navigate through submenus and other
* "nested" popup windows without having to dismiss the topmost
* popup.
*
* Clients that want to dismiss the popup when another surface of
* their own is clicked should dismiss the popup using the destroy
* request.
*
* The parent surface must have either an xdg_surface or xdg_popup
* role.
*
* Specifying an xdg_popup for the parent means that the popups are
* nested, with this popup now being the topmost popup. Nested
* popups must be destroyed in the reverse order they were created
* in, e.g. the only popup you are allowed to destroy at all times
* is the topmost one.
*
* If there is an existing popup when creating a new popup, the
* parent must be the current topmost popup.
*
* A parent surface must be mapped before the new popup is mapped.
*
* When compositors choose to dismiss a popup, they will likely
* dismiss every nested popup as well. When a compositor dismisses
* popups, it will follow the same dismissing order as required
* from the client.
*
* The x and y arguments passed when creating the popup object specify
* where the top left of the popup should be placed, relative to the
* local surface coordinates of the parent surface. See
* xdg_shell.get_xdg_popup.
*
* The client must call wl_surface.commit on the corresponding wl_surface
* for the xdg_popup state to take effect.
*
* For a surface to be mapped by the compositor the client must have
* committed both the xdg_popup state and a buffer.
*/
extern const struct wl_interface xdg_popup_v5_interface;
#ifndef XDG_SHELL_VERSION_ENUM
#define XDG_SHELL_VERSION_ENUM
/**
* @ingroup iface_xdg_shell
* latest protocol version
*
* The 'current' member of this enum gives the version of the
* protocol. Implementations can compare this to the version
* they implement using static_assert to ensure the protocol and
* implementation versions match.
*/
enum xdg_shell_version {
/**
* Always the latest version
*/
XDG_SHELL_VERSION_CURRENT = 5,
};
#endif /* XDG_SHELL_VERSION_ENUM */
#ifndef XDG_SHELL_ERROR_ENUM
#define XDG_SHELL_ERROR_ENUM
enum xdg_shell_error {
/**
* given wl_surface has another role
*/
XDG_SHELL_ERROR_ROLE = 0,
/**
* xdg_shell was destroyed before children
*/
XDG_SHELL_ERROR_DEFUNCT_SURFACES = 1,
/**
* the client tried to map or destroy a non-topmost popup
*/
XDG_SHELL_ERROR_NOT_THE_TOPMOST_POPUP = 2,
/**
* the client specified an invalid popup parent surface
*/
XDG_SHELL_ERROR_INVALID_POPUP_PARENT = 3,
};
#endif /* XDG_SHELL_ERROR_ENUM */
/**
* @ingroup iface_xdg_shell
* @struct xdg_shell_v5_interface
*/
struct xdg_shell_v5_interface {
/**
* destroy xdg_shell
*
* Destroy this xdg_shell object.
*
* Destroying a bound xdg_shell object while there are surfaces
* still alive created by this xdg_shell object instance is illegal
* and will result in a protocol error.
*/
void (*destroy)(struct wl_client *client,
struct wl_resource *resource);
/**
* enable use of this unstable version
*
* Negotiate the unstable version of the interface. This
* mechanism is in place to ensure client and server agree on the
* unstable versions of the protocol that they speak or exit
* cleanly if they don't agree. This request will go away once the
* xdg-shell protocol is stable.
*/
void (*use_unstable_version)(struct wl_client *client,
struct wl_resource *resource,
int32_t version);
/**
* create a shell surface from a surface
*
* This creates an xdg_surface for the given surface and gives it
* the xdg_surface role. A wl_surface can only be given an
* xdg_surface role once. If get_xdg_surface is called with a
* wl_surface that already has an active xdg_surface associated
* with it, or if it had any other role, an error is raised.
*
* See the documentation of xdg_surface for more details about what
* an xdg_surface is and how it is used.
*/
void (*get_xdg_surface)(struct wl_client *client,
struct wl_resource *resource,
uint32_t id,
struct wl_resource *surface);
/**
* create a popup for a surface
*
* This creates an xdg_popup for the given surface and gives it
* the xdg_popup role. A wl_surface can only be given an xdg_popup
* role once. If get_xdg_popup is called with a wl_surface that
* already has an active xdg_popup associated with it, or if it had
* any other role, an error is raised.
*
* This request must be used in response to some sort of user
* action like a button press, key press, or touch down event.
*
* See the documentation of xdg_popup for more details about what
* an xdg_popup is and how it is used.
* @param seat the wl_seat of the user event
* @param serial the serial of the user event
*/
void (*get_xdg_popup)(struct wl_client *client,
struct wl_resource *resource,
uint32_t id,
struct wl_resource *surface,
struct wl_resource *parent,
struct wl_resource *seat,
uint32_t serial,
int32_t x,
int32_t y);
/**
* respond to a ping event
*
* A client must respond to a ping event with a pong request or
* the client may be deemed unresponsive.
* @param serial serial of the ping event
*/
void (*pong)(struct wl_client *client,
struct wl_resource *resource,
uint32_t serial);
};
#define XDG_SHELL_PING 0
/**
* @ingroup iface_xdg_shell
*/
#define XDG_SHELL_PING_SINCE_VERSION 1
/**
* @ingroup iface_xdg_shell
*/
#define XDG_SHELL_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_shell
*/
#define XDG_SHELL_USE_UNSTABLE_VERSION_SINCE_VERSION 1
/**
* @ingroup iface_xdg_shell
*/
#define XDG_SHELL_GET_XDG_SURFACE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_shell
*/
#define XDG_SHELL_GET_XDG_POPUP_SINCE_VERSION 1
/**
* @ingroup iface_xdg_shell
*/
#define XDG_SHELL_PONG_SINCE_VERSION 1
/**
* @ingroup iface_xdg_shell
* Sends an ping event to the client owning the resource.
* @param resource_ The client's resource
* @param serial pass this to the pong request
*/
static inline void
xdg_shell_send_ping(struct wl_resource *resource_, uint32_t serial)
{
wl_resource_post_event(resource_, XDG_SHELL_PING, serial);
}
#ifndef XDG_SURFACE_RESIZE_EDGE_ENUM
#define XDG_SURFACE_RESIZE_EDGE_ENUM
/**
* @ingroup iface_xdg_surface
* edge values for resizing
*
* These values are used to indicate which edge of a surface
* is being dragged in a resize operation.
*/
enum xdg_surface_resize_edge {
XDG_SURFACE_RESIZE_EDGE_NONE = 0,
XDG_SURFACE_RESIZE_EDGE_TOP = 1,
XDG_SURFACE_RESIZE_EDGE_BOTTOM = 2,
XDG_SURFACE_RESIZE_EDGE_LEFT = 4,
XDG_SURFACE_RESIZE_EDGE_TOP_LEFT = 5,
XDG_SURFACE_RESIZE_EDGE_BOTTOM_LEFT = 6,
XDG_SURFACE_RESIZE_EDGE_RIGHT = 8,
XDG_SURFACE_RESIZE_EDGE_TOP_RIGHT = 9,
XDG_SURFACE_RESIZE_EDGE_BOTTOM_RIGHT = 10,
};
#endif /* XDG_SURFACE_RESIZE_EDGE_ENUM */
#ifndef XDG_SURFACE_STATE_ENUM
#define XDG_SURFACE_STATE_ENUM
/**
* @ingroup iface_xdg_surface
* types of state on the surface
*
* The different state values used on the surface. This is designed for
* state values like maximized, fullscreen. It is paired with the
* configure event to ensure that both the client and the compositor
* setting the state can be synchronized.
*
* States set in this way are double-buffered. They will get applied on
* the next commit.
*
* Desktop environments may extend this enum by taking up a range of
* values and documenting the range they chose in this description.
* They are not required to document the values for the range that they
* chose. Ideally, any good extensions from a desktop environment should
* make its way into standardization into this enum.
*
* The current reserved ranges are:
*
* 0x0000 - 0x0FFF: xdg-shell core values, documented below.
* 0x1000 - 0x1FFF: GNOME
*/
enum xdg_surface_state {
/**
* the surface is maximized
*/
XDG_SURFACE_STATE_MAXIMIZED = 1,
/**
* the surface is fullscreen
*/
XDG_SURFACE_STATE_FULLSCREEN = 2,
XDG_SURFACE_STATE_RESIZING = 3,
XDG_SURFACE_STATE_ACTIVATED = 4,
};
#endif /* XDG_SURFACE_STATE_ENUM */
/**
* @ingroup iface_xdg_surface
* @struct xdg_surface_v5_interface
*/
struct xdg_surface_v5_interface {
/**
* Destroy the xdg_surface
*
* Unmap and destroy the window. The window will be effectively
* hidden from the user's point of view, and all state like
* maximization, fullscreen, and so on, will be lost.
*/
void (*destroy)(struct wl_client *client,
struct wl_resource *resource);
/**
* set the parent of this surface
*
* Set the "parent" of this surface. This window should be
* stacked above a parent. The parent surface must be mapped as
* long as this surface is mapped.
*
* Parent windows should be set on dialogs, toolboxes, or other
* "auxiliary" surfaces, so that the parent is raised when the
* dialog is raised.
*/
void (*set_parent)(struct wl_client *client,
struct wl_resource *resource,
struct wl_resource *parent);
/**
* set surface title
*
* Set a short title for the surface.
*
* This string may be used to identify the surface in a task bar,
* window list, or other user interface elements provided by the
* compositor.
*
* The string must be encoded in UTF-8.
*/
void (*set_title)(struct wl_client *client,
struct wl_resource *resource,
const char *title);
/**
* set application ID
*
* Set an application identifier for the surface.
*
* The app ID identifies the general class of applications to which
* the surface belongs. The compositor can use this to group
* multiple surfaces together, or to determine how to launch a new
* application.
*
* For D-Bus activatable applications, the app ID is used as the
* D-Bus service name.
*
* The compositor shell will try to group application surfaces
* together by their app ID. As a best practice, it is suggested to
* select app ID's that match the basename of the application's
* .desktop file. For example, "org.freedesktop.FooViewer" where
* the .desktop file is "org.freedesktop.FooViewer.desktop".
*
* See the desktop-entry specification [0] for more details on
* application identifiers and how they relate to well-known D-Bus
* names and .desktop files.
*
* [0] http://standards.freedesktop.org/desktop-entry-spec/
*/
void (*set_app_id)(struct wl_client *client,
struct wl_resource *resource,
const char *app_id);
/**
* show the window menu
*
* Clients implementing client-side decorations might want to
* show a context menu when right-clicking on the decorations,
* giving the user a menu that they can use to maximize or minimize
* the window.
*
* This request asks the compositor to pop up such a window menu at
* the given position, relative to the local surface coordinates of
* the parent surface. There are no guarantees as to what menu
* items the window menu contains.
*
* This request must be used in response to some sort of user
* action like a button press, key press, or touch down event.
* @param seat the wl_seat of the user event
* @param serial the serial of the user event
* @param x the x position to pop up the window menu at
* @param y the y position to pop up the window menu at
*/
void (*show_window_menu)(struct wl_client *client,
struct wl_resource *resource,
struct wl_resource *seat,
uint32_t serial,
int32_t x,
int32_t y);
/**
* start an interactive move
*
* Start an interactive, user-driven move of the surface.
*
* This request must be used in response to some sort of user
* action like a button press, key press, or touch down event. The
* passed serial is used to determine the type of interactive move
* (touch, pointer, etc).
*
* The server may ignore move requests depending on the state of
* the surface (e.g. fullscreen or maximized), or if the passed
* serial is no longer valid.
*
* If triggered, the surface will lose the focus of the device
* (wl_pointer, wl_touch, etc) used for the move. It is up to the
* compositor to visually indicate that the move is taking place,
* such as updating a pointer cursor, during the move. There is no
* guarantee that the device focus will return when the move is
* completed.
* @param seat the wl_seat of the user event
* @param serial the serial of the user event
*/
void (*move)(struct wl_client *client,
struct wl_resource *resource,
struct wl_resource *seat,
uint32_t serial);
/**
* start an interactive resize
*
* Start a user-driven, interactive resize of the surface.
*
* This request must be used in response to some sort of user
* action like a button press, key press, or touch down event. The
* passed serial is used to determine the type of interactive
* resize (touch, pointer, etc).
*
* The server may ignore resize requests depending on the state of
* the surface (e.g. fullscreen or maximized).
*
* If triggered, the client will receive configure events with the
* "resize" state enum value and the expected sizes. See the
* "resize" enum value for more details about what is required. The
* client must also acknowledge configure events using
* "ack_configure". After the resize is completed, the client will
* receive another "configure" event without the resize state.
*
* If triggered, the surface also will lose the focus of the device
* (wl_pointer, wl_touch, etc) used for the resize. It is up to the
* compositor to visually indicate that the resize is taking place,
* such as updating a pointer cursor, during the resize. There is
* no guarantee that the device focus will return when the resize
* is completed.
*
* The edges parameter specifies how the surface should be resized,
* and is one of the values of the resize_edge enum. The compositor
* may use this information to update the surface position for
* example when dragging the top left corner. The compositor may
* also use this information to adapt its behavior, e.g. choose an
* appropriate cursor image.
* @param seat the wl_seat of the user event
* @param serial the serial of the user event
* @param edges which edge or corner is being dragged
*/
void (*resize)(struct wl_client *client,
struct wl_resource *resource,
struct wl_resource *seat,
uint32_t serial,
uint32_t edges);
/**
* ack a configure event
*
* When a configure event is received, if a client commits the
* surface in response to the configure event, then the client must
* make a ack_configure request before the commit request, passing
* along the serial of the configure event.
*
* For instance, the compositor might use this information to move
* a surface to the top left only when the client has drawn itself
* for the maximized or fullscreen state.
*
* If the client receives multiple configure events before it can
* respond to one, it only has to ack the last configure event.
* @param serial the serial from the configure event
*/
void (*ack_configure)(struct wl_client *client,
struct wl_resource *resource,
uint32_t serial);
/**
* set the new window geometry
*
* The window geometry of a window is its "visible bounds" from
* the user's perspective. Client-side decorations often have
* invisible portions like drop-shadows which should be ignored for
* the purposes of aligning, placing and constraining windows.
*
* The window geometry is double buffered, and will be applied at
* the time wl_surface.commit of the corresponding wl_surface is
* called.
*
* Once the window geometry of the surface is set once, it is not
* possible to unset it, and it will remain the same until
* set_window_geometry is called again, even if a new subsurface or
* buffer is attached.
*
* If never set, the value is the full bounds of the surface,
* including any subsurfaces. This updates dynamically on every
* commit. This unset mode is meant for extremely simple clients.
*
* If responding to a configure event, the window geometry in here
* must respect the sizing negotiations specified by the states in
* the configure event.
*
* The arguments are given in the surface local coordinate space of
* the wl_surface associated with this xdg_surface.
*
* The width and height must be greater than zero.
*/
void (*set_window_geometry)(struct wl_client *client,
struct wl_resource *resource,
int32_t x,
int32_t y,
int32_t width,
int32_t height);
/**
* maximize the window
*
* Maximize the surface.
*
* After requesting that the surface should be maximized, the
* compositor will respond by emitting a configure event with the
* "maximized" state and the required window geometry. The client
* should then update its content, drawing it in a maximized state,
* i.e. without shadow or other decoration outside of the window
* geometry. The client must also acknowledge the configure when
* committing the new content (see ack_configure).
*
* It is up to the compositor to decide how and where to maximize
* the surface, for example which output and what region of the
* screen should be used.
*
* If the surface was already maximized, the compositor will still
* emit a configure event with the "maximized" state.
*/
void (*set_maximized)(struct wl_client *client,
struct wl_resource *resource);
/**
* unmaximize the window
*
* Unmaximize the surface.
*
* After requesting that the surface should be unmaximized, the
* compositor will respond by emitting a configure event without
* the "maximized" state. If available, the compositor will include
* the window geometry dimensions the window had prior to being
* maximized in the configure request. The client must then update
* its content, drawing it in a regular state, i.e. potentially
* with shadow, etc. The client must also acknowledge the configure
* when committing the new content (see ack_configure).
*
* It is up to the compositor to position the surface after it was
* unmaximized; usually the position the surface had before
* maximizing, if applicable.
*
* If the surface was already not maximized, the compositor will
* still emit a configure event without the "maximized" state.
*/
void (*unset_maximized)(struct wl_client *client,
struct wl_resource *resource);
/**
* set the window as fullscreen on a monitor
*
* Make the surface fullscreen.
*
* You can specify an output that you would prefer to be
* fullscreen. If this value is NULL, it's up to the compositor to
* choose which display will be used to map this surface.
*
* If the surface doesn't cover the whole output, the compositor
* will position the surface in the center of the output and
* compensate with black borders filling the rest of the output.
*/
void (*set_fullscreen)(struct wl_client *client,
struct wl_resource *resource,
struct wl_resource *output);
/**
*/
void (*unset_fullscreen)(struct wl_client *client,
struct wl_resource *resource);
/**
* set the window as minimized
*
* Request that the compositor minimize your surface. There is no
* way to know if the surface is currently minimized, nor is there
* any way to unset minimization on this surface.
*
* If you are looking to throttle redrawing when minimized, please
* instead use the wl_surface.frame event for this, as this will
* also work with live previews on windows in Alt-Tab, Expose or
* similar compositor features.
*/
void (*set_minimized)(struct wl_client *client,
struct wl_resource *resource);
};
#define XDG_SURFACE_CONFIGURE 0
#define XDG_SURFACE_CLOSE 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_CONFIGURE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_CLOSE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_SET_PARENT_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_SET_TITLE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_SET_APP_ID_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_SHOW_WINDOW_MENU_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_MOVE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_RESIZE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_ACK_CONFIGURE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_SET_WINDOW_GEOMETRY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_SET_MAXIMIZED_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_UNSET_MAXIMIZED_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_SET_FULLSCREEN_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_UNSET_FULLSCREEN_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_SET_MINIMIZED_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
* Sends an configure event to the client owning the resource.
* @param resource_ The client's resource
*/
static inline void
xdg_surface_send_configure(struct wl_resource *resource_, int32_t width, int32_t height, struct wl_array *states, uint32_t serial)
{
wl_resource_post_event(resource_, XDG_SURFACE_CONFIGURE, width, height, states, serial);
}
/**
* @ingroup iface_xdg_surface
* Sends an close event to the client owning the resource.
* @param resource_ The client's resource
*/
static inline void
xdg_surface_send_close(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, XDG_SURFACE_CLOSE);
}
/**
* @ingroup iface_xdg_popup
* @struct xdg_popup_v5_interface
*/
struct xdg_popup_v5_interface {
/**
* remove xdg_popup interface
*
* This destroys the popup. Explicitly destroying the xdg_popup
* object will also dismiss the popup, and unmap the surface.
*
* If this xdg_popup is not the "topmost" popup, a protocol error
* will be sent.
*/
void (*destroy)(struct wl_client *client,
struct wl_resource *resource);
};
#define XDG_POPUP_POPUP_DONE 0
/**
* @ingroup iface_xdg_popup
*/
#define XDG_POPUP_POPUP_DONE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_popup
*/
#define XDG_POPUP_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_popup
* Sends an popup_done event to the client owning the resource.
* @param resource_ The client's resource
*/
static inline void
xdg_popup_send_popup_done(struct wl_resource *resource_)
{
wl_resource_post_event(resource_, XDG_POPUP_POPUP_DONE);
}
#ifdef __cplusplus
}
#endif
#endif
|