Functions

	get_ext_session_lock_surface_v1 (window)
	get_major_version ()
	get_micro_version ()
	get_minor_version ()
	get_protocol_version ()
	is_lock_window (window)
	is_supported ()
	prepare_lock ()
	unmap_lock_window (window)

Details

GtkSessionLock.get_ext_session_lock_surface_v1(window)

Parameters:

window (Gtk.Window) – A lock surface.

Returns:

The underlying lock surface Wayland object

Return type:

object or None

GtkSessionLock.get_major_version()

Returns:

the major version number of the GTK Session Lock library

Return type:

int

GtkSessionLock.get_micro_version()

Returns:

the micro/patch version number of the GTK Session Lock library

Return type:

int

GtkSessionLock.get_minor_version()

Returns:

the minor version number of the GTK Session Lock library

Return type:

int

GtkSessionLock.get_protocol_version()

Returns:

version of the ext_session_lock_v1 protocol supported by the compositor or 0 if the protocol is not supported.

Return type:

int

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

GtkSessionLock.is_lock_window(window)

Parameters:

window (Gtk.Window) – A Gtk.Window that may or may not have a lock surface.

Returns:

if window has been initialized as a lock surface.

Return type:

bool

GtkSessionLock.is_supported()

Returns:

True if the platform is Wayland and Wayland compositor supports the ext_session_lock_v1 protocol.

Return type:

bool

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

GtkSessionLock.prepare_lock()

Returns:

A new #SessionLockLock.

Return type:

GtkSessionLock.Lock

Prepare a new #SessionLockLock. You should connect signals to it before calling its lock method.

GtkSessionLock.unmap_lock_window(window)

Parameters:

window (Gtk.Window) –

If the given window is a lock window, unmap the surface. This must be called before the window is unmapped (e.g. hidden).

New in version 0.2.