Module gtk_layer_shell::functions

Functions

When auto exclusive zone is enabled, exclusive zone is automatically set to the size of the window + relevant margin. To disable auto exclusive zone, just set the exclusive zone to 0 or any other fixed value.

auto_exclusive_zone_is_enabledv0_5

window

exclusive_zonev0_5

window

init_for_window

Set the window up to be a layer surface once it is mapped. this must be called before the window is realized.

is_anchorv0_5

window

is_keyboard_interactivityv0_5

Deprecated since 0.6

is_layer_windowv0_5

window

is_supportedv0_5

May block for a Wayland roundtrip the first time it’s called.

keyboard_modev0_6

window

layerv0_5

window

major_versionv0_4

Returns

marginv0_5

window

micro_versionv0_4

Returns

minor_versionv0_4

Returns

monitorv0_5

NOTE: To get which monitor the surface is actually on, use gdk_display_get_monitor_at_window().

namespacev0_5

NOTE: this function does not return ownership of the string. Do not free the returned string. Future calls into the library may invalidate the returned string.

protocol_versionv0_6

May block for a Wayland roundtrip the first time it’s called.

set_anchor

Set whether window should be anchored to edge.

set_exclusive_zone

Has no effect unless the surface is anchored to an edge. Requests that the compositor does not place other surfaces within the given exclusive zone of the anchored edge. For example, a panel can request to not be covered by maximized windows. See wlr-layer-shell-unstable-v1.xml for details.

set_keyboard_interactivity

Whether the window should receive keyboard events from the compositor.

set_keyboard_modev0_6

Sets if/when window should receive keyboard events from the compositor, see GtkLayerShellKeyboardMode for details.

set_layer

Set the “layer” on which the surface appears (controls if it is over top of or below other surfaces). The layer may be changed on-the-fly in the current version of the layer shell protocol, but on compositors that only support an older version the window is remapped so the change can take effect.

set_margin

Set the margin for a specific edge of a window. Effects both surface’s distance from the edge and its exclusive zone size (if auto exclusive zone enabled).

set_monitor

Set the output for the window to be placed on, or None to let the compositor choose. If the window is currently mapped, it will get remapped so the change can take effect.

set_namespace

Set the “namespace” of the surface.