Data Structures | Macros | Functions
The zxdg_shell_v6 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. More...

Data Structures

struct  zxdg_shell_v6_listener
 
struct  zxdg_shell_v6_interface
 

Macros

#define ZXDG_SHELL_V6_PING_SINCE_VERSION   1
 
#define ZXDG_SHELL_V6_DESTROY_SINCE_VERSION   1
 
#define ZXDG_SHELL_V6_CREATE_POSITIONER_SINCE_VERSION   1
 
#define ZXDG_SHELL_V6_GET_XDG_SURFACE_SINCE_VERSION   1
 
#define ZXDG_SHELL_V6_PONG_SINCE_VERSION   1
 
#define ZXDG_SHELL_V6_PING_SINCE_VERSION   1
 
#define ZXDG_SHELL_V6_DESTROY_SINCE_VERSION   1
 
#define ZXDG_SHELL_V6_CREATE_POSITIONER_SINCE_VERSION   1
 
#define ZXDG_SHELL_V6_GET_XDG_SURFACE_SINCE_VERSION   1
 
#define ZXDG_SHELL_V6_PONG_SINCE_VERSION   1
 

Functions

static int zxdg_shell_v6_add_listener (struct zxdg_shell_v6 *zxdg_shell_v6, const struct zxdg_shell_v6_listener *listener, void *data)
 
static void zxdg_shell_v6_set_user_data (struct zxdg_shell_v6 *zxdg_shell_v6, void *user_data)
 
static void * zxdg_shell_v6_get_user_data (struct zxdg_shell_v6 *zxdg_shell_v6)
 
static void zxdg_shell_v6_destroy (struct zxdg_shell_v6 *zxdg_shell_v6)
 Destroy this xdg_shell object. More...
 
static struct zxdg_positioner_v6 * zxdg_shell_v6_create_positioner (struct zxdg_shell_v6 *zxdg_shell_v6)
 Create a positioner object. More...
 
static struct zxdg_surface_v6 * zxdg_shell_v6_get_xdg_surface (struct zxdg_shell_v6 *zxdg_shell_v6, struct wl_surface *surface)
 This creates an xdg_surface for the given surface. More...
 
static void zxdg_shell_v6_pong (struct zxdg_shell_v6 *zxdg_shell_v6, uint32_t serial)
 A client must respond to a ping event with a pong request or the client may be deemed unresponsive. More...
 
static void zxdg_shell_v6_send_ping (struct wl_resource *resource_, uint32_t serial)
 Sends an ping event to the client owning the resource. More...
 

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.

Function Documentation

◆ zxdg_shell_v6_destroy()

static void zxdg_shell_v6_destroy ( struct zxdg_shell_v6 *  zxdg_shell_v6)
inlinestatic

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.

◆ zxdg_shell_v6_create_positioner()

static struct zxdg_positioner_v6* zxdg_shell_v6_create_positioner ( struct zxdg_shell_v6 *  zxdg_shell_v6)
inlinestatic

Create a positioner object.

A positioner object is used to position surfaces relative to some parent surface. See the interface description and xdg_surface.get_popup for details.

◆ zxdg_shell_v6_get_xdg_surface()

static struct zxdg_surface_v6* zxdg_shell_v6_get_xdg_surface ( struct zxdg_shell_v6 *  zxdg_shell_v6,
struct wl_surface *  surface 
)
inlinestatic

This creates an xdg_surface for the given surface.

While xdg_surface itself is not a role, the corresponding surface may only be assigned a role extending xdg_surface, such as xdg_toplevel or xdg_popup.

This creates an xdg_surface for the given surface. An xdg_surface is used as basis to define a role to a given surface, such as xdg_toplevel or xdg_popup. It also manages functionality shared between xdg_surface based surface roles.

See the documentation of xdg_surface for more details about what an xdg_surface is and how it is used.

◆ zxdg_shell_v6_pong()

static void zxdg_shell_v6_pong ( struct zxdg_shell_v6 *  zxdg_shell_v6,
uint32_t  serial 
)
inlinestatic

A client must respond to a ping event with a pong request or the client may be deemed unresponsive.

See xdg_shell.ping.

◆ zxdg_shell_v6_send_ping()

static void zxdg_shell_v6_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