Enum xdg_toplevel_state

Enum Documentation

enum xdg_toplevel_state

types of state on the surface

The different state values used on the surface. This is designed for state values like maximized, fullscreen. It is paired with the configure event to ensure that both the client and the compositor setting the state can be synchronized.

States set in this way are double-buffered, see wl_surface.commit.

Values:

enumerator XDG_TOPLEVEL_STATE_MAXIMIZED

the surface is maximized the surface is maximized

The surface is maximized. The window geometry specified in the configure event must be obeyed by the client, or the xdg_wm_base.invalid_surface_state error is raised.

The client should draw without shadow or other decoration outside of the window geometry.

enumerator XDG_TOPLEVEL_STATE_FULLSCREEN

the surface is fullscreen the surface is fullscreen

The surface is fullscreen. The window geometry specified in the configure event is a maximum; the client cannot resize beyond it. For a surface to cover the whole fullscreened area, the geometry dimensions must be obeyed by the client. For more details, see xdg_toplevel.set_fullscreen.

enumerator XDG_TOPLEVEL_STATE_RESIZING

the surface is being resized the surface is being resized

The surface is being resized. The window geometry specified in the configure event is a maximum; the client cannot resize beyond it. Clients that have aspect ratio or cell sizing configuration can use a smaller size, however.

enumerator XDG_TOPLEVEL_STATE_ACTIVATED

the surface is now activated the surface is now activated

Client window decorations should be painted as if the window is active. Do not assume this means that the window actually has keyboard or pointer focus.

enumerator XDG_TOPLEVEL_STATE_TILED_LEFT

the surface’s left edge is tiled

The window is currently in a tiled layout and the left edge is considered to be adjacent to another part of the tiling grid.

The client should draw without shadow or other decoration outside of the window geometry on the left edge.

Since

2

enumerator XDG_TOPLEVEL_STATE_TILED_RIGHT

the surface’s right edge is tiled

The window is currently in a tiled layout and the right edge is considered to be adjacent to another part of the tiling grid.

The client should draw without shadow or other decoration outside of the window geometry on the right edge.

Since

2

enumerator XDG_TOPLEVEL_STATE_TILED_TOP

the surface’s top edge is tiled

The window is currently in a tiled layout and the top edge is considered to be adjacent to another part of the tiling grid.

The client should draw without shadow or other decoration outside of the window geometry on the top edge.

Since

2

enumerator XDG_TOPLEVEL_STATE_TILED_BOTTOM

the surface’s bottom edge is tiled

The window is currently in a tiled layout and the bottom edge is considered to be adjacent to another part of the tiling grid.

The client should draw without shadow or other decoration outside of the window geometry on the bottom edge.

Since

2

enumerator XDG_TOPLEVEL_STATE_SUSPENDED

surface repaint is suspended

The surface is currently not ordinarily being repainted; for example because its content is occluded by another window, or its outputs are switched off due to screen locking.

Since

6

enumerator XDG_TOPLEVEL_STATE_CONSTRAINED_LEFT

the surface’s left edge is constrained

The left edge of the window is currently constrained, meaning it shouldn’t attempt to resize from that edge. It can for example mean it’s tiled next to a monitor edge on the constrained side of the window.

Since

7

enumerator XDG_TOPLEVEL_STATE_CONSTRAINED_RIGHT

the surface’s right edge is constrained

The right edge of the window is currently constrained, meaning it shouldn’t attempt to resize from that edge. It can for example mean it’s tiled next to a monitor edge on the constrained side of the window.

Since

7

enumerator XDG_TOPLEVEL_STATE_CONSTRAINED_TOP

the surface’s top edge is constrained

The top edge of the window is currently constrained, meaning it shouldn’t attempt to resize from that edge. It can for example mean it’s tiled next to a monitor edge on the constrained side of the window.

Since

7

enumerator XDG_TOPLEVEL_STATE_CONSTRAINED_BOTTOM

the surface’s bottom edge is tiled

The bottom edge of the window is currently constrained, meaning it shouldn’t attempt to resize from that edge. It can for example mean it’s tiled next to a monitor edge on the constrained side of the window.

Since

7