/* Generated by wayland-scanner 1.13.0 */ // Hand-edited to resolve conflicts with xdg-shell stable // And make it build with libwayland < 1.10 #ifndef XDG_SHELL_UNSTABLE_V5_CLIENT_PROTOCOL_H #define XDG_SHELL_UNSTABLE_V5_CLIENT_PROTOCOL_H #include #include #include "wayland-client-core.h" #ifdef __cplusplus extern "C" { #endif /** * @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_v5 - create desktop-style surfaces * - @subpage page_iface_xdg_surface_v5 - A desktop window * - @subpage page_iface_xdg_popup_v5 - short-lived, popup surfaces for menus * @section page_copyright_xdg_shell_unstable_v5 Copyright *
 *
 * 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.
 * 
*/ struct wl_output; struct wl_seat; struct wl_surface; struct xdg_popup_v5; struct xdg_shell_v5; struct xdg_surface_v5; /** * @page page_iface_xdg_shell_v5 xdg_shell * @section page_iface_xdg_shell_desc Description * * xdg_shell_v5 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_v5 The xdg_shell_v5 interface * * xdg_shell_v5 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_v5 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_v5 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_v5 state and a buffer. * @section page_iface_xdg_surface_api API * See @ref iface_xdg_surface. */ /** * @defgroup iface_xdg_surface_v5 The xdg_surface_v5 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_v5 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_v5 state and a buffer. */ extern const struct wl_interface xdg_surface_v5_interface; /** * @page page_iface_xdg_popup_v5 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_v5 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_v5 or xdg_popup * role. * * Specifying an xdg_popup_v5 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_v5 state to take effect. * * For a surface to be mapped by the compositor the client must have * committed both the xdg_popup_v5 state and a buffer. * @section page_iface_xdg_popup_api API * See @ref iface_xdg_popup. */ /** * @defgroup iface_xdg_popup_v5 The xdg_popup_v5 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_v5 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_v5 or xdg_popup * role. * * Specifying an xdg_popup_v5 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_v5 state to take effect. * * For a surface to be mapped by the compositor the client must have * committed both the xdg_popup_v5 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_v5 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_listener */ struct xdg_shell_listener { /** * check if the client is alive * * The ping event asks the client if it's still alive. Pass the * serial specified in the event back to the compositor by sending * a "pong" request back with the specified serial. * * Compositors can use this to determine if the client is still * alive. It's unspecified what will happen if the client doesn't * respond to the ping request, or in what timeframe. Clients * should try to respond in a reasonable amount of time. * * A compositor is free to ping in any way it wants, but a client * must always respond to any xdg_shell_v5 object it created. * @param serial pass this to the pong request */ void (*ping)(void *data, struct xdg_shell_v5 *xdg_shell_v5, uint32_t serial); }; /** * @ingroup iface_xdg_shell */ static inline int xdg_shell_add_listener(struct xdg_shell_v5 *xdg_shell, const struct xdg_shell_listener *listener, void *data) { return wl_proxy_add_listener((struct wl_proxy *) xdg_shell, (void (**)(void)) listener, data); } #define XDG_SHELL_DESTROY 0 #define XDG_SHELL_USE_UNSTABLE_VERSION 1 #define XDG_SHELL_GET_XDG_SURFACE 2 #define XDG_SHELL_GET_XDG_POPUP 3 #define XDG_SHELL_PONG 4 /** * @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_v5 */ static inline void xdg_shell_set_user_data(struct xdg_shell_v5 *xdg_shell, void *user_data) { wl_proxy_set_user_data((struct wl_proxy *) xdg_shell, user_data); } /** @ingroup iface_xdg_shell_v5 */ static inline void * xdg_shell_get_user_data(struct xdg_shell_v5 *xdg_shell) { return wl_proxy_get_user_data((struct wl_proxy *) xdg_shell); } #if WAYLAND_VERSION_MAJOR > 1 || WAYLAND_VERSION_MINOR >= 10 static inline uint32_t xdg_shell_get_version(struct xdg_shell_v5 *xdg_shell) { return wl_proxy_get_version((struct wl_proxy *) xdg_shell); } #endif /** * @ingroup iface_xdg_shell * * Destroy this xdg_shell_v5 object. * * Destroying a bound xdg_shell_v5 object while there are surfaces * still alive created by this xdg_shell_v5 object instance is illegal * and will result in a protocol error. */ static inline void xdg_shell_destroy(struct xdg_shell_v5 *xdg_shell) { wl_proxy_marshal((struct wl_proxy *) xdg_shell, XDG_SHELL_DESTROY); wl_proxy_destroy((struct wl_proxy *) xdg_shell); } /** * @ingroup iface_xdg_shell * * 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. */ static inline void xdg_shell_use_unstable_version(struct xdg_shell_v5 *xdg_shell, int32_t version) { wl_proxy_marshal((struct wl_proxy *) xdg_shell, XDG_SHELL_USE_UNSTABLE_VERSION, version); } /** * @ingroup iface_xdg_shell * * This creates an xdg_surface_v5 for the given surface and gives it the * xdg_surface_v5 role. A wl_surface can only be given an xdg_surface_v5 role * once. If get_xdg_surface_v5 is called with a wl_surface that already has * an active xdg_surface_v5 associated with it, or if it had any other role, * an error is raised. * * See the documentation of xdg_surface_v5 for more details about what an * xdg_surface_v5 is and how it is used. */ static inline struct xdg_surface_v5 * xdg_shell_get_xdg_surface(struct xdg_shell_v5 *xdg_shell, struct wl_surface *surface) { struct wl_proxy *id; id = wl_proxy_marshal_constructor((struct wl_proxy *) xdg_shell, XDG_SHELL_GET_XDG_SURFACE, &xdg_surface_v5_interface, NULL, surface); return (struct xdg_surface_v5 *) id; } /** * @ingroup iface_xdg_shell * * This creates an xdg_popup_v5 for the given surface and gives it the * xdg_popup_v5 role. A wl_surface can only be given an xdg_popup_v5 role * once. If get_xdg_popup_v5 is called with a wl_surface that already has * an active xdg_popup_v5 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_v5 for more details about what an * xdg_popup_v5 is and how it is used. */ static inline struct xdg_popup_v5 * xdg_shell_get_xdg_popup(struct xdg_shell_v5 *xdg_shell, struct wl_surface *surface, struct wl_surface *parent, struct wl_seat *seat, uint32_t serial, int32_t x, int32_t y) { struct wl_proxy *id; id = wl_proxy_marshal_constructor((struct wl_proxy *) xdg_shell, XDG_SHELL_GET_XDG_POPUP, &xdg_popup_v5_interface, NULL, surface, parent, seat, serial, x, y); return (struct xdg_popup_v5 *) id; } /** * @ingroup iface_xdg_shell * * A client must respond to a ping event with a pong request or * the client may be deemed unresponsive. */ static inline void xdg_shell_pong(struct xdg_shell_v5 *xdg_shell, uint32_t serial) { wl_proxy_marshal((struct wl_proxy *) xdg_shell, XDG_SHELL_PONG, 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_listener */ struct xdg_surface_listener { /** * suggest a surface change * * The configure event asks the client to resize its surface or * to change its state. * * The width and height arguments specify a hint to the window * about how its surface should be resized in window geometry * coordinates. See set_window_geometry. * * If the width or height arguments are zero, it means the client * should decide its own window dimension. This may happen when the * compositor need to configure the state of the surface but * doesn't have any information about any previous or expected * dimension. * * The states listed in the event specify how the width/height * arguments should be interpreted, and possibly how it should be * drawn. * * Clients should arrange their surface for the new size and * states, and then send a ack_configure request with the serial * sent in this configure event at some point before committing the * new surface. * * If the client receives multiple configure events before it can * respond to one, it is free to discard all but the last event it * received. */ void (*configure)(void *data, struct xdg_surface_v5 *xdg_surface_v5, int32_t width, int32_t height, struct wl_array *states, uint32_t serial); /** * surface wants to be closed * * The close event is sent by the compositor when the user wants * the surface to be closed. This should be equivalent to the user * clicking the close button in client-side decorations, if your * application has any... * * This is only a request that the user intends to close your * window. The client may choose to ignore this request, or show a * dialog to ask the user to save their data... */ void (*close)(void *data, struct xdg_surface_v5 *xdg_surface_v5); }; /** * @ingroup iface_xdg_surface */ static inline int xdg_surface_add_listener(struct xdg_surface_v5 *xdg_surface, const struct xdg_surface_listener *listener, void *data) { return wl_proxy_add_listener((struct wl_proxy *) xdg_surface, (void (**)(void)) listener, data); } #define XDG_SURFACE_DESTROY 0 #define XDG_SURFACE_SET_PARENT 1 #define XDG_SURFACE_SET_TITLE 2 #define XDG_SURFACE_SET_APP_ID 3 #define XDG_SURFACE_SHOW_WINDOW_MENU 4 #define XDG_SURFACE_MOVE 5 #define XDG_SURFACE_RESIZE 6 #define XDG_SURFACE_ACK_CONFIGURE 7 #define XDG_SURFACE_SET_WINDOW_GEOMETRY 8 #define XDG_SURFACE_SET_MAXIMIZED 9 #define XDG_SURFACE_UNSET_MAXIMIZED 10 #define XDG_SURFACE_SET_FULLSCREEN 11 #define XDG_SURFACE_UNSET_FULLSCREEN 12 #define XDG_SURFACE_SET_MINIMIZED 13 /** * @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_v5 */ static inline void xdg_surface_set_user_data(struct xdg_surface_v5 *xdg_surface, void *user_data) { wl_proxy_set_user_data((struct wl_proxy *) xdg_surface, user_data); } /** @ingroup iface_xdg_surface_v5 */ static inline void * xdg_surface_get_user_data(struct xdg_surface_v5 *xdg_surface) { return wl_proxy_get_user_data((struct wl_proxy *) xdg_surface); } #if WAYLAND_VERSION_MAJOR > 1 || WAYLAND_VERSION_MINOR >= 10 static inline uint32_t xdg_surface_get_version(struct xdg_surface_v5 *xdg_surface) { return wl_proxy_get_version((struct wl_proxy *) xdg_surface); } #endif /** * @ingroup iface_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. */ static inline void xdg_surface_destroy(struct xdg_surface_v5 *xdg_surface) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_DESTROY); wl_proxy_destroy((struct wl_proxy *) xdg_surface); } /** * @ingroup iface_xdg_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. */ static inline void xdg_surface_set_parent(struct xdg_surface_v5 *xdg_surface, struct xdg_surface_v5 *parent) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_SET_PARENT, parent); } /** * @ingroup iface_xdg_surface * * 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. */ static inline void xdg_surface_set_title(struct xdg_surface_v5 *xdg_surface, const char *title) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_SET_TITLE, title); } /** * @ingroup iface_xdg_surface * * 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/ */ static inline void xdg_surface_set_app_id(struct xdg_surface_v5 *xdg_surface, const char *app_id) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_SET_APP_ID, app_id); } /** * @ingroup iface_xdg_surface * * 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. */ static inline void xdg_surface_show_window_menu(struct xdg_surface_v5 *xdg_surface, struct wl_seat *seat, uint32_t serial, int32_t x, int32_t y) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_SHOW_WINDOW_MENU, seat, serial, x, y); } /** * @ingroup iface_xdg_surface * * 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. */ static inline void xdg_surface_move(struct xdg_surface_v5 *xdg_surface, struct wl_seat *seat, uint32_t serial) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_MOVE, seat, serial); } /** * @ingroup iface_xdg_surface * * 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. */ static inline void xdg_surface_resize(struct xdg_surface_v5 *xdg_surface, struct wl_seat *seat, uint32_t serial, uint32_t edges) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_RESIZE, seat, serial, edges); } /** * @ingroup iface_xdg_surface * * 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. */ static inline void xdg_surface_ack_configure(struct xdg_surface_v5 *xdg_surface, uint32_t serial) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_ACK_CONFIGURE, serial); } /** * @ingroup iface_xdg_surface * * 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. */ static inline void xdg_surface_set_window_geometry(struct xdg_surface_v5 *xdg_surface, int32_t x, int32_t y, int32_t width, int32_t height) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_SET_WINDOW_GEOMETRY, x, y, width, height); } /** * @ingroup iface_xdg_surface * * 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. */ static inline void xdg_surface_set_maximized(struct xdg_surface_v5 *xdg_surface) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_SET_MAXIMIZED); } /** * @ingroup iface_xdg_surface * * 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. */ static inline void xdg_surface_unset_maximized(struct xdg_surface_v5 *xdg_surface) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_UNSET_MAXIMIZED); } /** * @ingroup iface_xdg_surface * * 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. */ static inline void xdg_surface_set_fullscreen(struct xdg_surface_v5 *xdg_surface, struct wl_output *output) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_SET_FULLSCREEN, output); } /** * @ingroup iface_xdg_surface */ static inline void xdg_surface_unset_fullscreen(struct xdg_surface_v5 *xdg_surface) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_UNSET_FULLSCREEN); } /** * @ingroup iface_xdg_surface * * 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. */ static inline void xdg_surface_set_minimized(struct xdg_surface_v5 *xdg_surface) { wl_proxy_marshal((struct wl_proxy *) xdg_surface, XDG_SURFACE_SET_MINIMIZED); } /** * @ingroup iface_xdg_popup * @struct xdg_popup_listener */ struct xdg_popup_listener { /** * popup interaction is done * * The popup_done event is sent out when a popup is dismissed by * the compositor. The client should destroy the xdg_popup_v5 object * at this point. */ void (*popup_done)(void *data, struct xdg_popup_v5 *xdg_popup_v5); }; /** * @ingroup iface_xdg_popup */ static inline int xdg_popup_add_listener(struct xdg_popup_v5 *xdg_popup, const struct xdg_popup_listener *listener, void *data) { return wl_proxy_add_listener((struct wl_proxy *) xdg_popup, (void (**)(void)) listener, data); } #define XDG_POPUP_DESTROY 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_v5 */ static inline void xdg_popup_set_user_data(struct xdg_popup_v5 *xdg_popup, void *user_data) { wl_proxy_set_user_data((struct wl_proxy *) xdg_popup, user_data); } /** @ingroup iface_xdg_popup_v5 */ static inline void * xdg_popup_get_user_data(struct xdg_popup_v5 *xdg_popup) { return wl_proxy_get_user_data((struct wl_proxy *) xdg_popup); } #if WAYLAND_VERSION_MAJOR > 1 || WAYLAND_VERSION_MINOR >= 10 static inline uint32_t xdg_popup_get_version(struct xdg_popup_v5 *xdg_popup) { return wl_proxy_get_version((struct wl_proxy *) xdg_popup); } #endif /** * @ingroup iface_xdg_popup * * This destroys the popup. Explicitly destroying the xdg_popup * object will also dismiss the popup, and unmap the surface. * * If this xdg_popup_v5 is not the "topmost" popup, a protocol error * will be sent. */ static inline void xdg_popup_destroy(struct xdg_popup_v5 *xdg_popup) { wl_proxy_marshal((struct wl_proxy *) xdg_popup, XDG_POPUP_DESTROY); wl_proxy_destroy((struct wl_proxy *) xdg_popup); } #ifdef __cplusplus } #endif #endif