Package org.freedesktop.wayland.server

Interface WlShellSurfaceRequests

public interface WlShellSurfaceRequests

desktop-style metadata 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 toplevel, fullscreen or popup windows, move, resize or maximize them, associate metadata like title and class, etc.

On the server side the object is automatically destroyed when the related wl_surface is destroyed. On the client side, wl_shell_surface_destroy() must be called before destroying the wl_surface object.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VERSION

Method Summary

Modifier and Type	Method	Description
void	move(WlShellSurfaceResource requester, WlSeatResource seat, int serial)	start an interactive move
void	pong(WlShellSurfaceResource requester, int serial)	respond to a ping event
void	resize(WlShellSurfaceResource requester, WlSeatResource seat, int serial, int edges)	start an interactive resize
void	setClass(WlShellSurfaceResource requester, String class_)	set surface class
void	setFullscreen(WlShellSurfaceResource requester, int method, int framerate, WlOutputResource output)	make the surface a fullscreen surface
void	setMaximized(WlShellSurfaceResource requester, WlOutputResource output)	make the surface a maximized surface
void	setPopup(WlShellSurfaceResource requester, WlSeatResource seat, int serial, WlSurfaceResource parent, int x, int y, int flags)	make the surface a popup surface
void	setTitle(WlShellSurfaceResource requester, String title)	set surface title
void	setToplevel(WlShellSurfaceResource requester)	make the surface a toplevel surface
void	setTransient(WlShellSurfaceResource requester, WlSurfaceResource parent, int x, int y, int flags)	make the surface a transient surface

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

pong

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

Parameters:

requester - The protocol object that made the request.

serial - serial number of the ping event

move

void move(WlShellSurfaceResource requester,
 @Nonnull
 WlSeatResource seat,
 int serial)

start an interactive move

Start a pointer-driven move of the surface.

This request must be used in response to a button press event. The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized).

Parameters:

requester - The protocol object that made the request.

seat - seat whose pointer is used

serial - serial number of the implicit grab on the pointer

resize

void resize(WlShellSurfaceResource requester,
 @Nonnull
 WlSeatResource seat,
 int serial,
 int edges)

start an interactive resize

Start a pointer-driven resizing of the surface.

This request must be used in response to a button press event. The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized).

Parameters:

requester - The protocol object that made the request.

seat - seat whose pointer is used

serial - serial number of the implicit grab on the pointer

edges - which edge or corner is being dragged

setToplevel

void setToplevel(WlShellSurfaceResource requester)

make the surface a toplevel surface

Map the surface as a toplevel surface.

A toplevel surface is not fullscreen, maximized or transient.

Parameters:

requester - The protocol object that made the request.

setTransient

void setTransient(WlShellSurfaceResource requester,
 @Nonnull
 WlSurfaceResource parent,
 int x,
 int y,
 int flags)

make the surface a transient surface

Map the surface relative to an existing surface.

The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates.

The flags argument controls details of the transient behaviour.

Parameters:

requester - The protocol object that made the request.

parent - parent surface

x - surface-local x coordinate

y - surface-local y coordinate

flags - transient surface behavior

setFullscreen

void setFullscreen(WlShellSurfaceResource requester,
 int method,
 int framerate,
 @Nullable
 WlOutputResource output)

make the surface a fullscreen surface

Map the surface as a fullscreen surface.

If an output parameter is given then the surface will be made fullscreen on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area.

The client may specify a method to resolve a size conflict between the output size and the surface size - this is provided through the method parameter.

The framerate parameter is used only when the method is set to "driver", to indicate the preferred framerate. A value of 0 indicates that the client does not care about framerate. The framerate is specified in mHz, that is framerate of 60000 is 60Hz.

A method of "scale" or "driver" implies a scaling operation of the surface, either via a direct scaling operation or a change of the output mode. This will override any kind of output scaling, so that mapping a surface with a buffer size equal to the mode can fill the screen independent of buffer_scale.

A method of "fill" means we don't scale up the buffer, however any output scale is applied. This means that you may run into an edge case where the application maps a buffer with the same size of the output mode but buffer_scale 1 (thus making a surface larger than the output). In this case it is allowed to downscale the results to fit the screen.

The compositor must reply to this request with a configure event with the dimensions for the output on which the surface will be made fullscreen.

Parameters:

requester - The protocol object that made the request.

method - method for resolving size conflict

framerate - framerate in mHz

output - output on which the surface is to be fullscreen

setPopup

void setPopup(WlShellSurfaceResource requester,
 @Nonnull
 WlSeatResource seat,
 int serial,
 @Nonnull
 WlSurfaceResource parent,
 int x,
 int y,
 int flags)

make the surface a popup surface

Map the surface as a popup.

A popup surface is a transient surface with an added pointer grab.

An existing implicit grab will be changed to owner-events mode, and the popup grab will continue after the implicit grab ends (i.e. releasing the mouse button does not cause the popup to be unmapped).

The popup grab continues until the window is destroyed or a mouse button is pressed in any other client's window. A click in any of the client's surfaces is reported as normal, however, clicks in other clients' surfaces will be discarded and trigger the callback.

The x and y arguments specify the location of the upper left corner of the surface relative to the upper left corner of the parent surface, in surface-local coordinates.

Parameters:

requester - The protocol object that made the request.

seat - seat whose pointer is used

serial - serial number of the implicit grab on the pointer

parent - parent surface

x - surface-local x coordinate

y - surface-local y coordinate

flags - transient surface behavior

setMaximized

void setMaximized(WlShellSurfaceResource requester,
 @Nullable
 WlOutputResource output)

make the surface a maximized surface

Map the surface as a maximized surface.

If an output parameter is given then the surface will be maximized on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area.

The compositor will reply with a configure event telling the expected new surface size. The operation is completed on the next buffer attach to this surface.

A maximized surface typically fills the entire output it is bound to, except for desktop elements such as panels. This is the main difference between a maximized shell surface and a fullscreen shell surface.

The details depend on the compositor implementation.

Parameters:

requester - The protocol object that made the request.

output - output on which the surface is to be maximized

setTitle

void setTitle(WlShellSurfaceResource requester,
 @Nonnull
 String title)

set surface title

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.

Parameters:

requester - The protocol object that made the request.

title - surface title

setClass

void setClass(WlShellSurfaceResource requester,
 @Nonnull
 String class_)

set surface class

Set a class for the surface.

The surface class identifies the general class of applications to which the surface belongs. A common convention is to use the file name (or the full path if it is a non-standard location) of the application's .desktop file as the class.

Parameters:

requester - The protocol object that made the request.

class_ - surface class