GtkSessionLock.Lock¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`destroy` ()
	`lock_lock` ()
	`new_surface` (gtk_window, monitor)
	`unlock_and_destroy` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`lock-manager`	`int`	r/w/co	The lock manager
`lock-obj`	`int`	r/w	The lock object

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`finished`
`locked`

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class GtkSessionLock.Lock(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: GtkSessionLock.LockClass

destroy()¶: Destory an inactive lock object. You should call this method only after receiving the finished signal.

lock_lock()¶

Actually perform the locking operation. This should be run after connecting to this object’s signals.

The compositor will hide all surfaces except those created via the GtkSessionLock.Lock.new_surface method.

new_surface(gtk_window, monitor)¶

Parameters:

gtk_window (Gtk.Window) –
monitor (Gdk.Monitor) –

This method must be called after GtkSessionLock.Lock.lock_lock. If the session is locked successfully, the specified window will be shown on the given monitor. You must only ever call this method once for a given lock and monitor. The window will automatically be stretched to cover the entire screen.

unlock_and_destroy()¶: Unlock an active session lock and dispose of it. It cannot be reused. You should generally call this method only after verifying a user’s identity.

Signal Details¶

GtkSessionLock.Lock.signals.finished(lock)¶

Signal Name:: finished
Flags:: RUN_FIRST
Parameters:: lock (GtkSessionLock.Lock) – The object which received the signal

GtkSessionLock.Lock.signals.locked(lock)¶

Signal Name:: locked
Flags:: RUN_FIRST
Parameters:: lock (GtkSessionLock.Lock) – The object which received the signal

Property Details¶

GtkSessionLock.Lock.props.lock_manager¶

Name:: lock-manager
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The lock manager

GtkSessionLock.Lock.props.lock_obj¶

Name:: lock-obj
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE

The lock object