Module wayland_protocols::unstable::xdg_shell::v5::client::xdg_surface

A desktop window

An interface that may be implemented by a wl_surface, for implementations that provide a desktop-style user interface.

It provides requests to treat surfaces like windows, allowing to set properties like maximized, fullscreen, minimized, and to move and resize them, and associate metadata like title and app id.

The client must call wl_surface.commit on the corresponding wl_surface for the xdg_surface state to take effect. Prior to committing the new state, it can set up initial configuration, such as maximizing or setting a window geometry.

Even without attaching a buffer the compositor must respond to initial committed configuration, for instance sending a configure event with expected window geometry if the client maximized its surface during initialization.

For a surface to be mapped by the compositor the client must have committed both an xdg_surface state and a buffer.

Structs

XdgSurface

Enums

Event
Request
ResizeEdge	edge values for resizing
State	types of state on the surface

Constants

EVT_CLOSE_SINCE	The minimal object version supporting this event
EVT_CONFIGURE_SINCE	The minimal object version supporting this event
REQ_ACK_CONFIGURE_SINCE	The minimal object version supporting this request
REQ_DESTROY_SINCE	The minimal object version supporting this request
REQ_MOVE_SINCE	The minimal object version supporting this request
REQ_RESIZE_SINCE	The minimal object version supporting this request
REQ_SET_APP_ID_SINCE	The minimal object version supporting this request
REQ_SET_FULLSCREEN_SINCE	The minimal object version supporting this request
REQ_SET_MAXIMIZED_SINCE	The minimal object version supporting this request
REQ_SET_MINIMIZED_SINCE	The minimal object version supporting this request
REQ_SET_PARENT_SINCE	The minimal object version supporting this request
REQ_SET_TITLE_SINCE	The minimal object version supporting this request
REQ_SET_WINDOW_GEOMETRY_SINCE	The minimal object version supporting this request
REQ_SHOW_WINDOW_MENU_SINCE	The minimal object version supporting this request
REQ_UNSET_FULLSCREEN_SINCE	The minimal object version supporting this request
REQ_UNSET_MAXIMIZED_SINCE	The minimal object version supporting this request

Statics

xdg_surface_events	C-representation of the messages of this interface, for interop
xdg_surface_interface	C representation of this interface, for interop
xdg_surface_requests	C-representation of the messages of this interface, for interop

Traits

EventHandler

An interface for handling events.