package wayland

  1. Overview
  2. Docs
package wayland
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Xdg_shell_server.Xdg_wm_baseSource

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.

Sourcetype 'v t = ([ `Xdg_wm_base ], 'v, [ `Server ]) Wayland.Proxy.t

Version 1, 2, 3, 4, 5, 6

Sourceval ping : [< `V1 | `V2 | `V3 | `V4 | `V5 | `V6 ] t -> serial:int32 -> unit

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_wm_base.pong.

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. The “unresponsive” error is provided for compositors that wish to disconnect unresponsive clients.

A compositor is free to ping in any way it wants, but a client must always respond to any xdg_wm_base object it created.

Handlers

Note: Servers will always want to use v1.

Sourceclass virtual +'a v1 : object ... end

Handler for a proxy with version >= 1.

Sourceclass virtual +'a v2 : object ... end

Handler for a proxy with version >= 2.

Sourceclass virtual +'a v3 : object ... end

Handler for a proxy with version >= 3.

Sourceclass virtual +'a v4 : object ... end

Handler for a proxy with version >= 4.

Sourceclass virtual +'a v5 : object ... end

Handler for a proxy with version >= 5.

Sourceclass virtual +'a v6 : object ... end

Handler for a proxy with version >= 6.