Package org.freedesktop.wayland.server

Interface XdgWmBaseRequestsV5

All Superinterfaces:

XdgWmBaseRequests, XdgWmBaseRequestsV2, XdgWmBaseRequestsV3, XdgWmBaseRequestsV4

All Known Subinterfaces:

XdgWmBaseRequestsV6

public interface XdgWmBaseRequestsV5
extends XdgWmBaseRequestsV4

create desktop-style surfaces

The xdg_wm_base interface is exposed as a global object enabling clients to turn their wl_surfaces into windows in a desktop environment. It defines the basic functionality needed for clients and the compositor to create windows that can be dragged, resized, maximized, etc, as well as creating transient windows such as popup menus.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION

Method Summary

Modifier and Type	Method	Description
void	createPositioner(XdgWmBaseResource requester, int id)	create a positioner object
void	destroy(XdgWmBaseResource requester)	destroy xdg_wm_base
void	getXdgSurface(XdgWmBaseResource requester, int id, WlSurfaceResource surface)	create a shell surface from a surface
void	pong(XdgWmBaseResource requester, int serial)	respond to a ping event

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

destroy

void destroy(XdgWmBaseResource requester)

destroy xdg_wm_base

Destroy this xdg_wm_base object.

Destroying a bound xdg_wm_base object while there are surfaces still alive created by this xdg_wm_base object instance is illegal and will result in a defunct_surfaces error.

Specified by:

destroy in interface XdgWmBaseRequests

Specified by:

destroy in interface XdgWmBaseRequestsV2

Specified by:

destroy in interface XdgWmBaseRequestsV3

Specified by:

destroy in interface XdgWmBaseRequestsV4

Parameters:

requester - The protocol object that made the request.

createPositioner

void createPositioner(XdgWmBaseResource requester,
 int id)

create a positioner object

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.

Specified by:

createPositioner in interface XdgWmBaseRequests

Specified by:

createPositioner in interface XdgWmBaseRequestsV2

Specified by:

createPositioner in interface XdgWmBaseRequestsV3

Specified by:

createPositioner in interface XdgWmBaseRequestsV4

Parameters:

requester - The protocol object that made the request.

id -

getXdgSurface

void getXdgSurface(XdgWmBaseResource requester,
 int id,
 @Nonnull
 WlSurfaceResource surface)

create a shell surface from a surface

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. It is illegal to create an xdg_surface for a wl_surface which already has an assigned role and this will result in a role error.

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.

Specified by:

getXdgSurface in interface XdgWmBaseRequests

Specified by:

getXdgSurface in interface XdgWmBaseRequestsV2

Specified by:

getXdgSurface in interface XdgWmBaseRequestsV3

Specified by:

getXdgSurface in interface XdgWmBaseRequestsV4

Parameters:

requester - The protocol object that made the request.

id -

surface -

pong

void pong(XdgWmBaseResource requester,
 int serial)

respond to a ping event

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

Specified by:

pong in interface XdgWmBaseRequests

Specified by:

pong in interface XdgWmBaseRequestsV2

Specified by:

pong in interface XdgWmBaseRequestsV3

Specified by:

pong in interface XdgWmBaseRequestsV4

Parameters:

requester - The protocol object that made the request.

serial - serial of the ping event