Note on popups

Popups (such as menus and tooltips) do not currently display while the screen is locked. Please use alternatives, such as GtkPopover (which is backed by a subsurface instead of a popup).

Note On Linking

If you link against libwayland you must link this library before libwayland. See linking.md for details.

gtk_session_lock_is_supported ()

gboolean
gtk_session_lock_is_supported ();

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

gtk_session_lock_instance_new ()

GtkSessionLockInstance *
gtk_session_lock_instance_new ();

gtk_session_lock_instance_lock ()

gboolean
gtk_session_lock_instance_lock (GtkSessionLockInstance *self);

Lock the screen. This should be called before assigning any windows to monitors. If this function fails the ::failed signal is emitted, if it succeeds the ::locked signal is emitted. The ::failed signal may be emitted before the function returns (for example, if another GtkSessionLockInstance holds a lock) or later (if another process holds a lock). The only case where neither signal is triggered is if the instance is already locked.

gtk_session_lock_instance_unlock ()

void
gtk_session_lock_instance_unlock (GtkSessionLockInstance *self);

If the screen is locked by this instance unlocks it and fires ::unlocked. Otherwise has no effect

gtk_session_lock_instance_is_locked ()

gboolean
gtk_session_lock_instance_is_locked (GtkSessionLockInstance *self);

Returns if this instance currently holds a lock.

gtk_session_lock_instance_assign_window_to_monitor ()

void
gtk_session_lock_instance_assign_window_to_monitor
                               (GtkSessionLockInstance *self,
                                GtkWindow *window,
                                GdkMonitor *monitor);

This should be called with a different window once for each monitor immediately after calling gtk_session_lock_lock(). Hiding a window that is active on a monitor or not letting a window be resized by the library may result in a Wayland protocol error.

GtkSessionLockInstance

typedef struct _GtkSessionLockInstance GtkSessionLockInstance;

An instance of the object used to control locking the screen. Multiple instances can exist at once, but only one can be locked at a time.

The “failed” signal

void
user_function (GtkSessionLockInstance *sessionlockinstance,
               gpointer                user_data)

The ::failed signal is fired when the lock could not be acquired.

Flags: Run First

The “locked” signal

void
user_function (GtkSessionLockInstance *sessionlockinstance,
               gpointer                user_data)

The ::locked signal is fired when the screen is successfully locked.

Flags: Run First

The “unlocked” signal

void
user_function (GtkSessionLockInstance *sessionlockinstance,
               gpointer                user_data)

The ::unlocked signal is fired when the session is unlocked, which may have been caused by a call to gtk_session_lock_instance_unlock() or by the compositor.

Flags: Run First