zxdg_shell_v6¤
Create desktop-style surfaces
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.
Methods:
-
destroy–Destroy
xdg_shell -
create_positioner–Create a positioner object
-
get_xdg_surface–Create a shell surface from a surface
-
pong–Respond to a ping event
-
on_ping–Check if the client is alive.
-
role–Given `wl_surface` has another role -
defunct_surfaces–`xdg_shell` was destroyed before children -
not_the_topmost_popup–The client tried to map or destroy a non-topmost popup -
invalid_popup_parent–The client specified an invalid popup parent surface -
invalid_surface_state–The client provided an invalid surface state -
invalid_positioner–The client provided an invalid positioner
Check if the client is alive
The ping event asks the client if it's still alive. Pass the serial specified in the event back to the compositor by sending a "pong" request back with the specified serial. See xdg_shell.ping.
Compositors can use this to determine if the client is still alive. It's unspecified what will happen if the client doesn't respond to the ping request, or in what timeframe. Clients should try to respond in a reasonable amount of time.
A compositor is free to ping in any way it wants, but a client must always respond to any xdg_shell object it created.
Parameters:
destroy() -> None
Destroy xdg_shell
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.
create_positioner() -> zxdg_positioner_v6
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.
Returns:
-
zxdg_positioner_v6(zxdg_positioner_v6) –The created object
get_xdg_surface(surface: wl_surface) -> zxdg_surface_v6
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.
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.
Returns:
-
zxdg_surface_v6(zxdg_surface_v6) –The created object
on_ping(serial: int) -> None
Check if the client is alive.
Override to handle wayland.zxdg_shell_v6.events.ping.