/* Generated by wayland-scanner 1.23.0 */ #ifndef XDG_TOPLEVEL_ICON_V1_SERVER_PROTOCOL_H #define XDG_TOPLEVEL_ICON_V1_SERVER_PROTOCOL_H #include <stdint.h> #include <stddef.h> #include "wayland-server.h" #ifdef __cplusplus extern "C" { #endif struct wl_client; struct wl_resource; /** * @page page_xdg_toplevel_icon_v1 The xdg_toplevel_icon_v1 protocol * protocol to assign icons to toplevels * * @section page_desc_xdg_toplevel_icon_v1 Description * * This protocol allows clients to set icons for their toplevel surfaces * either via the XDG icon stock (using an icon name), or from pixel data. * * A toplevel icon represents the individual toplevel (unlike the application * or launcher icon, which represents the application as a whole), and may be * shown in window switchers, window overviews and taskbars that list * individual windows. * * This document adheres to RFC 2119 when using words like "must", * "should", "may", etc. * * Warning! The protocol described in this file is currently in the testing * phase. Backward compatible changes may be added together with the * corresponding interface version bump. Backward incompatible changes can * only be done by creating a new major version of the extension. * * @section page_ifaces_xdg_toplevel_icon_v1 Interfaces * - @subpage page_iface_xdg_toplevel_icon_manager_v1 - interface to manage toplevel icons * - @subpage page_iface_xdg_toplevel_icon_v1 - a toplevel window icon * @section page_copyright_xdg_toplevel_icon_v1 Copyright * <pre> * * Copyright © 2023-2024 Matthias Klumpp * Copyright © 2024 David Edmundson * * 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_buffer; struct xdg_toplevel; struct xdg_toplevel_icon_manager_v1; struct xdg_toplevel_icon_v1; #ifndef XDG_TOPLEVEL_ICON_MANAGER_V1_INTERFACE #define XDG_TOPLEVEL_ICON_MANAGER_V1_INTERFACE /** * @page page_iface_xdg_toplevel_icon_manager_v1 xdg_toplevel_icon_manager_v1 * @section page_iface_xdg_toplevel_icon_manager_v1_desc Description * * This interface allows clients to create toplevel window icons and set * them on toplevel windows to be displayed to the user. * @section page_iface_xdg_toplevel_icon_manager_v1_api API * See @ref iface_xdg_toplevel_icon_manager_v1. */ /** * @defgroup iface_xdg_toplevel_icon_manager_v1 The xdg_toplevel_icon_manager_v1 interface * * This interface allows clients to create toplevel window icons and set * them on toplevel windows to be displayed to the user. */ extern const struct wl_interface xdg_toplevel_icon_manager_v1_interface; #endif #ifndef XDG_TOPLEVEL_ICON_V1_INTERFACE #define XDG_TOPLEVEL_ICON_V1_INTERFACE /** * @page page_iface_xdg_toplevel_icon_v1 xdg_toplevel_icon_v1 * @section page_iface_xdg_toplevel_icon_v1_desc Description * * This interface defines a toplevel icon. * An icon can have a name, and multiple buffers. * In order to be applied, the icon must have either a name, or at least * one buffer assigned. Applying an empty icon (with no buffer or name) to * a toplevel should reset its icon to the default icon. * * It is up to compositor policy whether to prefer using a buffer or loading * an icon via its name. See 'set_name' and 'add_buffer' for details. * @section page_iface_xdg_toplevel_icon_v1_api API * See @ref iface_xdg_toplevel_icon_v1. */ /** * @defgroup iface_xdg_toplevel_icon_v1 The xdg_toplevel_icon_v1 interface * * This interface defines a toplevel icon. * An icon can have a name, and multiple buffers. * In order to be applied, the icon must have either a name, or at least * one buffer assigned. Applying an empty icon (with no buffer or name) to * a toplevel should reset its icon to the default icon. * * It is up to compositor policy whether to prefer using a buffer or loading * an icon via its name. See 'set_name' and 'add_buffer' for details. */ extern const struct wl_interface xdg_toplevel_icon_v1_interface; #endif /** * @ingroup iface_xdg_toplevel_icon_manager_v1 * @struct xdg_toplevel_icon_manager_v1_interface */ struct xdg_toplevel_icon_manager_v1_interface { … }; #define XDG_TOPLEVEL_ICON_MANAGER_V1_ICON_SIZE … #define XDG_TOPLEVEL_ICON_MANAGER_V1_DONE … /** * @ingroup iface_xdg_toplevel_icon_manager_v1 */ #define XDG_TOPLEVEL_ICON_MANAGER_V1_ICON_SIZE_SINCE_VERSION … /** * @ingroup iface_xdg_toplevel_icon_manager_v1 */ #define XDG_TOPLEVEL_ICON_MANAGER_V1_DONE_SINCE_VERSION … /** * @ingroup iface_xdg_toplevel_icon_manager_v1 */ #define XDG_TOPLEVEL_ICON_MANAGER_V1_DESTROY_SINCE_VERSION … /** * @ingroup iface_xdg_toplevel_icon_manager_v1 */ #define XDG_TOPLEVEL_ICON_MANAGER_V1_CREATE_ICON_SINCE_VERSION … /** * @ingroup iface_xdg_toplevel_icon_manager_v1 */ #define XDG_TOPLEVEL_ICON_MANAGER_V1_SET_ICON_SINCE_VERSION … /** * @ingroup iface_xdg_toplevel_icon_manager_v1 * Sends an icon_size event to the client owning the resource. * @param resource_ The client's resource * @param size the edge size of the square icon in surface-local coordinates, e.g. 64 */ static inline void xdg_toplevel_icon_manager_v1_send_icon_size(struct wl_resource *resource_, int32_t size) { … } /** * @ingroup iface_xdg_toplevel_icon_manager_v1 * Sends an done event to the client owning the resource. * @param resource_ The client's resource */ static inline void xdg_toplevel_icon_manager_v1_send_done(struct wl_resource *resource_) { … } #ifndef XDG_TOPLEVEL_ICON_V1_ERROR_ENUM #define XDG_TOPLEVEL_ICON_V1_ERROR_ENUM enum xdg_toplevel_icon_v1_error { … }; /** * @ingroup iface_xdg_toplevel_icon_v1 * Validate a xdg_toplevel_icon_v1 error value. * * @return true on success, false on error. * @ref xdg_toplevel_icon_v1_error */ static inline bool xdg_toplevel_icon_v1_error_is_valid(uint32_t value, uint32_t version) { … } #endif /* XDG_TOPLEVEL_ICON_V1_ERROR_ENUM */ /** * @ingroup iface_xdg_toplevel_icon_v1 * @struct xdg_toplevel_icon_v1_interface */ struct xdg_toplevel_icon_v1_interface { … }; /** * @ingroup iface_xdg_toplevel_icon_v1 */ #define XDG_TOPLEVEL_ICON_V1_DESTROY_SINCE_VERSION … /** * @ingroup iface_xdg_toplevel_icon_v1 */ #define XDG_TOPLEVEL_ICON_V1_SET_NAME_SINCE_VERSION … /** * @ingroup iface_xdg_toplevel_icon_v1 */ #define XDG_TOPLEVEL_ICON_V1_ADD_BUFFER_SINCE_VERSION … #ifdef __cplusplus } #endif #endif
Codebase Browser
chromium