KWayland

The xdg_shell interface

Macros

#define ZXDG_SHELL_V5_DESTROY_SINCE_VERSION   1
 
#define ZXDG_SHELL_V5_GET_ZXDG_POPUP_v5_SINCE_VERSION   1
 
#define ZXDG_SHELL_V5_GET_ZXDG_SURFACE_V5_SINCE_VERSION   1
 
#define ZXDG_SHELL_V5_PING_SINCE_VERSION   1
 
#define ZXDG_SHELL_V5_PONG_SINCE_VERSION   1
 
#define ZXDG_SHELL_V5_USE_UNSTABLE_VERSION_SINCE_VERSION   1
 

Enumerations

enum  zxdg_shell_v5_version { ZXDG_SHELL_V5_VERSION_CURRENT = 5, ZXDG_SHELL_V5_VERSION_CURRENT = 5 }
 

Functions

static void * zxdg_shell_v5_get_user_data (struct xdg_shell *xdg_shell)
 
static void zxdg_shell_v5_send_ping (struct wl_resource *resource_, uint32_t serial)
 
static void zxdg_shell_v5_set_user_data (struct xdg_shell *xdg_shell, void *user_data)
 

Detailed 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.

Enumeration Type Documentation

enum zxdg_shell_v5_version

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.

Enumerator
ZXDG_SHELL_V5_VERSION_CURRENT 

Always the latest version.

ZXDG_SHELL_V5_VERSION_CURRENT 

Always the latest version.

Definition at line 240 of file wayland-xdg-shell-v5-server-protocol.h.

Function Documentation

static void zxdg_shell_v5_send_ping ( struct wl_resource *  resource_,
uint32_t  serial 
)
inlinestatic

Sends an ping event to the client owning the resource.

Parameters
resource_The client's resource
serialpass this to the pong request

Definition at line 387 of file wayland-xdg-shell-v5-server-protocol.h.

This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Aug 12 2020 22:50:26 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.