Package org.freedesktop.wayland.client

Class XdgWmBaseProxy

java.lang.Object

org.freedesktop.wayland.client.Proxy<XdgWmBaseEvents>

org.freedesktop.wayland.client.XdgWmBaseProxy

All Implemented Interfaces:

WaylandObject

public class XdgWmBaseProxy
extends Proxy<XdgWmBaseEvents>

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 String	INTERFACE_NAME

Fields inherited from class org.freedesktop.wayland.client.Proxy

pointer

Constructor Summary

Constructors

Constructor	Description
XdgWmBaseProxy(MemorySegment pointer)
XdgWmBaseProxy(MemorySegment pointer, XdgWmBaseEvents implementation, int version)

Method Summary

Modifier and Type	Method	Description
XdgPositionerProxy	createPositioner(XdgPositionerEvents implementation)	create a positioner object
void	destroy()	destroy xdg_wm_base
XdgSurfaceProxy	getXdgSurface(XdgSurfaceEvents implementation, WlSurfaceProxy surface)	create a shell surface from a surface
void	pong(int serial)	respond to a ping event

Methods inherited from class org.freedesktop.wayland.client.Proxy

equals, getId, getImplementation, getPointer, getVersion, hashCode, marshal, marshal, marshalConstructor, setQueue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

• Constant Field Values

Constructor Details

XdgWmBaseProxy

public XdgWmBaseProxy(MemorySegment pointer,
 XdgWmBaseEvents implementation,
 int version)

XdgWmBaseProxy

public XdgWmBaseProxy(MemorySegment pointer)

Method Details

destroy

public void destroy()

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.

Overrides:

destroy in class Proxy<XdgWmBaseEvents>

createPositioner

public XdgPositionerProxy createPositioner(XdgPositionerEvents implementation)

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.

Parameters:

implementation - A protocol event listener for the newly created proxy.

getXdgSurface

public XdgSurfaceProxy getXdgSurface(XdgSurfaceEvents implementation,
 @Nonnull
 WlSurfaceProxy 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.

Parameters:

implementation - A protocol event listener for the newly created proxy.

surface -

pong

public void pong(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.

Parameters:

serial - serial of the ping event