/* Generated by wayland-scanner 1.23.0 */ #ifndef XDG_TOPLEVEL_ICON_V1_CLIENT_PROTOCOL_H #define XDG_TOPLEVEL_ICON_V1_CLIENT_PROTOCOL_H #include <stdint.h> #include <stddef.h> #include "wayland-client.h" #ifdef __cplusplus extern "C" { #endif /** * @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_listener */ struct xdg_toplevel_icon_manager_v1_listener { … }; /** * @ingroup iface_xdg_toplevel_icon_manager_v1 */ static inline int xdg_toplevel_icon_manager_v1_add_listener(struct xdg_toplevel_icon_manager_v1 *xdg_toplevel_icon_manager_v1, const struct xdg_toplevel_icon_manager_v1_listener *listener, void *data) { … } #define XDG_TOPLEVEL_ICON_MANAGER_V1_DESTROY … #define XDG_TOPLEVEL_ICON_MANAGER_V1_CREATE_ICON … #define XDG_TOPLEVEL_ICON_MANAGER_V1_SET_ICON … /** * @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 */ static inline void xdg_toplevel_icon_manager_v1_set_user_data(struct xdg_toplevel_icon_manager_v1 *xdg_toplevel_icon_manager_v1, void *user_data) { … } /** @ingroup iface_xdg_toplevel_icon_manager_v1 */ static inline void * xdg_toplevel_icon_manager_v1_get_user_data(struct xdg_toplevel_icon_manager_v1 *xdg_toplevel_icon_manager_v1) { … } static inline uint32_t xdg_toplevel_icon_manager_v1_get_version(struct xdg_toplevel_icon_manager_v1 *xdg_toplevel_icon_manager_v1) { … } /** * @ingroup iface_xdg_toplevel_icon_manager_v1 * * Destroy the toplevel icon manager. * This does not destroy objects created with the manager. */ static inline void xdg_toplevel_icon_manager_v1_destroy(struct xdg_toplevel_icon_manager_v1 *xdg_toplevel_icon_manager_v1) { … } /** * @ingroup iface_xdg_toplevel_icon_manager_v1 * * Creates a new icon object. This icon can then be attached to a * xdg_toplevel via the 'set_icon' request. */ static inline struct xdg_toplevel_icon_v1 * xdg_toplevel_icon_manager_v1_create_icon(struct xdg_toplevel_icon_manager_v1 *xdg_toplevel_icon_manager_v1) { … } /** * @ingroup iface_xdg_toplevel_icon_manager_v1 * * This request assigns the icon 'icon' to 'toplevel', or clears the * toplevel icon if 'icon' was null. * This state is double-buffered and is applied on the next * wl_surface.commit of the toplevel. * * After making this call, the xdg_toplevel_icon_v1 provided as 'icon' * can be destroyed by the client without 'toplevel' losing its icon. * The xdg_toplevel_icon_v1 is immutable from this point, and any * future attempts to change it must raise the * 'xdg_toplevel_icon_v1.immutable' protocol error. * * The compositor must set the toplevel icon from either the pixel data * the icon provides, or by loading a stock icon using the icon name. * See the description of 'xdg_toplevel_icon_v1' for details. * * If 'icon' is set to null, the icon of the respective toplevel is reset * to its default icon (usually the icon of the application, derived from * its desktop-entry file, or a placeholder icon). * If this request is passed an icon with no pixel buffers or icon name * assigned, the icon must be reset just like if 'icon' was null. */ static inline void xdg_toplevel_icon_manager_v1_set_icon(struct xdg_toplevel_icon_manager_v1 *xdg_toplevel_icon_manager_v1, struct xdg_toplevel *toplevel, struct xdg_toplevel_icon_v1 *icon) { … } #ifndef XDG_TOPLEVEL_ICON_V1_ERROR_ENUM #define XDG_TOPLEVEL_ICON_V1_ERROR_ENUM enum xdg_toplevel_icon_v1_error { … }; #endif /* XDG_TOPLEVEL_ICON_V1_ERROR_ENUM */ #define XDG_TOPLEVEL_ICON_V1_DESTROY … #define XDG_TOPLEVEL_ICON_V1_SET_NAME … #define XDG_TOPLEVEL_ICON_V1_ADD_BUFFER … /** * @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 … /** @ingroup iface_xdg_toplevel_icon_v1 */ static inline void xdg_toplevel_icon_v1_set_user_data(struct xdg_toplevel_icon_v1 *xdg_toplevel_icon_v1, void *user_data) { … } /** @ingroup iface_xdg_toplevel_icon_v1 */ static inline void * xdg_toplevel_icon_v1_get_user_data(struct xdg_toplevel_icon_v1 *xdg_toplevel_icon_v1) { … } static inline uint32_t xdg_toplevel_icon_v1_get_version(struct xdg_toplevel_icon_v1 *xdg_toplevel_icon_v1) { … } /** * @ingroup iface_xdg_toplevel_icon_v1 * * Destroys the 'xdg_toplevel_icon_v1' object. * The icon must still remain set on every toplevel it was assigned to, * until the toplevel icon is reset explicitly. */ static inline void xdg_toplevel_icon_v1_destroy(struct xdg_toplevel_icon_v1 *xdg_toplevel_icon_v1) { … } /** * @ingroup iface_xdg_toplevel_icon_v1 * * This request assigns an icon name to this icon. * Any previously set name is overridden. * * The compositor must resolve 'icon_name' according to the lookup rules * described in the XDG icon theme specification[1] using the * environment's current icon theme. * * If the compositor does not support icon names or cannot resolve * 'icon_name' according to the XDG icon theme specification it must * fall back to using pixel buffer data instead. * * If this request is made after the icon has been assigned to a toplevel * via 'set_icon', a 'immutable' error must be raised. * * [1]: https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html */ static inline void xdg_toplevel_icon_v1_set_name(struct xdg_toplevel_icon_v1 *xdg_toplevel_icon_v1, const char *icon_name) { … } /** * @ingroup iface_xdg_toplevel_icon_v1 * * This request adds pixel data supplied as wl_buffer to the icon. * * The client should add pixel data for all icon sizes and scales that * it can provide, or which are explicitly requested by the compositor * via 'icon_size' events on xdg_toplevel_icon_manager_v1. * * The wl_buffer supplying pixel data as 'buffer' must be backed by wl_shm * and must be a square (width and height being equal). * If any of these buffer requirements are not fulfilled, a 'invalid_buffer' * error must be raised. * * If this icon instance already has a buffer of the same size and scale * from a previous 'add_buffer' request, data from the last request * overrides the preexisting pixel data. * * The wl_buffer must be kept alive for as long as the xdg_toplevel_icon * it is associated with is not destroyed. The buffer contents must not be * modified after it was assigned to the icon. * * If this request is made after the icon has been assigned to a toplevel * via 'set_icon', a 'immutable' error must be raised. */ static inline void xdg_toplevel_icon_v1_add_buffer(struct xdg_toplevel_icon_v1 *xdg_toplevel_icon_v1, struct wl_buffer *buffer, int32_t scale) { … } #ifdef __cplusplus } #endif #endif
Codebase Browser
chromium