xdg_decoration_unstable_v1 Module

ZxdgToplevelDecorationV1

class pywayland.protocol.xdg_decoration_unstable_v1.ZxdgToplevelDecorationV1

Decoration object for a toplevel surface

The decoration object allows the compositor to toggle server-side window decorations for a toplevel surface. The client can request to switch to another mode.

The xdg_toplevel_decoration object must be destroyed before its XdgToplevel.

destroy() → 'None'

Request – opcode 0 (attached to Resource instance)

Destroy the decoration object

Switch back to a mode without any server-side decorations at the next commit.

set_mode(mode: 'int') → 'None'

Request – opcode 1 (attached to Resource instance)

Set the decoration mode

Set the toplevel surface decoration mode. This informs the compositor that the client prefers the provided decoration mode.

After requesting a decoration mode, the compositor will respond by emitting an XdgSurface.configure() event. The client should then update its content, drawing it without decorations if the received mode is server-side decorations. The client must also acknowledge the configure when committing the new content (see XdgSurface.ack_configure()).

The compositor can decide not to use the client’s mode and enforce a different mode instead.

Clients whose decoration mode depend on the XdgToplevel state may send a set_mode request in response to an XdgSurface.configure() event and wait for the next XdgSurface.configure() event to prevent unwanted state. Such clients are responsible for preventing configure loops and must make sure not to send multiple successive set_mode requests with the same decoration mode.

Parameters:mode (ArgumentType.Uint) – the decoration mode

unset_mode() → 'None'

Request – opcode 2 (attached to Resource instance)

Unset the decoration mode

Unset the toplevel surface decoration mode. This informs the compositor that the client doesn’t prefer a particular decoration mode.

This request has the same semantics as set_mode.

configure(mode: 'int') → 'None'

Event – opcode 0 (attached to Proxy instance)

Suggest a surface change

The configure event asks the client to change its decoration mode. The configured state should not be applied immediately. Clients must send an ack_configure in response to this event. See XdgSurface.configure() and XdgSurface.ack_configure() for details.

A configure event can be sent at any time. The specified mode must be obeyed by the client.

Parameters:mode (ArgumentType.Uint) – the decoration mode

ZxdgDecorationManagerV1

class pywayland.protocol.xdg_decoration_unstable_v1.ZxdgDecorationManagerV1

Window decoration manager

This interface allows a compositor to announce support for server-side decorations.

A window decoration is a set of window controls as deemed appropriate by the party managing them, such as user interface components used to move, resize and change a window’s state.

A client can use this protocol to request being decorated by a supporting compositor.

If compositor and client do not negotiate the use of a server-side decoration using this protocol, clients continue to self-decorate as they see fit.

Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the ‘z’ prefix and the version number in the protocol and interface names are removed and the interface version number is reset.

destroy() → 'None'

Request – opcode 0 (attached to Resource instance)

Destroy the decoration manager object

Destroy the decoration manager. This doesn’t destroy objects created with the manager.

get_toplevel_decoration(toplevel: 'XdgToplevel') → 'Proxy[ZxdgToplevelDecorationV1]'

Request – opcode 1 (attached to Resource instance)

Create a new toplevel decoration object

Create a new decoration object associated with the given toplevel.

Creating an xdg_toplevel_decoration from an XdgToplevel which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first xdg_toplevel_decoration.configure event must also be treated as errors.

Parameters:toplevel (XdgToplevel) – Returns:ZxdgToplevelDecorationV1