Skip to content

xdg_shell¤

wayland.xdg_shell ¤

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:

error ¤

events

ping ¤

ping(serial: int) -> None

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.

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:

  • serial ¤

    (int) –

    Pass this to the pong request

destroy ¤

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.

get_xdg_surface ¤

get_xdg_surface(surface: wl_surface) -> xdg_surface

Create a shell surface from a surface

This creates an xdg_surface for the given surface and gives it the xdg_surface role. A wl_surface can only be given an xdg_surface role once. If get_xdg_surface is called with a wl_surface that already has an active xdg_surface associated with it, or if it had any other role, an error is raised.

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

Returns:

get_xdg_popup ¤

get_xdg_popup(
    surface: wl_surface,
    parent: wl_surface,
    seat: wl_seat,
    serial: int,
    x: int,
    y: int,
) -> xdg_popup

Create a popup for a surface

This creates an xdg_popup for the given surface and gives it the xdg_popup role. A wl_surface can only be given an xdg_popup role once. If get_xdg_popup is called with a wl_surface that already has an active xdg_popup associated with it, or if it had any other role, an error is raised.

This request must be used in response to some sort of user action like a button press, key press, or touch down event.

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

Parameters:

  • seat ¤

    (wl_seat) –

    The wl_seat of the user event

  • serial ¤

    (int) –

    The serial of the user event

Returns:

  • xdg_popup ( xdg_popup ) –

    The created object

pong ¤

pong(serial: int) -> None

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:

  • serial ¤

    (int) –

    Serial of the ping event

on_ping ¤

on_ping(serial: int) -> None

Check if the client is alive.

Override to handle wayland.xdg_shell.events.ping.