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_client/Xdg_toplevel/class-v3/index.html

Class Xdg_toplevel.v3Source

Handler for a proxy with version >= 3.

constraint 'a = [< `V3 ]
method private virtual on_configure : [> `V3 ] t -> width:int32 -> height:int32 -> states:string -> unit

Suggest a surface change.

This configure event asks the client to resize its toplevel surface or to change its state. The configured state should not be applied immediately. See xdg_surface.configure for details.

The width and height arguments specify a hint to the window about how its surface should be resized in window geometry coordinates. See set_window_geometry.

If the width or height arguments are zero, it means the client should decide its own window dimension. This may happen when the compositor needs to configure the state of the surface but doesn't have any information about any previous or expected dimension.

The states listed in the event specify how the width/height arguments should be interpreted, and possibly how it should be drawn.

Clients must send an ack_configure in response to this event. See xdg_surface.configure and xdg_surface.ack_configure for details.

method private virtual on_close : [> `V3 ] t -> unit

Surface wants to be closed.

The close event is sent by the compositor when the user wants the surface to be closed. This should be equivalent to the user clicking the close button in client-side decorations, if your application has any.

This is only a request that the user intends to close the window. The client may choose to ignore this request, or show a dialog to ask the user to save their data, etc.

method min_version : int32
OCaml

Innovation. Community. Security.