package wayland

  1. Overview
  2. Docs
Pure OCaml Wayland protocol library

Install

Dune Dependency

Authors

Maintainers

Sources

wayland-1.0.tbz
sha256=bf8fd0057242d11f1c265c11cfa5de3c517ec0ad5994eae45e1efe3aac034510
sha512=da639e0903325e124933a03156ffd76188d2dfa2a9a61c5cee808fc8783833b81bb68ab59364ccc7c54a98bafa45d5b5a6c0571179f48178b5667b180a6d5a73

doc/wayland.protocols/Wayland_protocols/Xdg_shell_server/Xdg_wm_base/class-v3/index.html

Class Xdg_wm_base.v3Source

Handler for a proxy with version >= 3.

constraint 'a = [< `V3 ]
method private virtual on_destroy : [> `V3 ] t -> unit

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 protocol error.

method private virtual on_create_positioner : [> `V3 ] t -> ([ `Xdg_positioner ], 'a, [ `Server ]) Proxy.t -> unit

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.

method private virtual on_get_xdg_surface : [> `V3 ] t -> ([ `Xdg_surface ], 'a, [ `Server ]) Proxy.t -> surface: ([ `Wl_surface ], [> Imports.Wl_surface.versions ], [ `Server ]) Proxy.t -> unit

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.

method private virtual on_pong : [> `V3 ] t -> serial:int32 -> unit

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.

method min_version : int32
method bind_version : [ `V3 ]
OCaml

Innovation. Community. Security.