Class

PhoshLockscreen

[]

Description [src]

class Phosh.Lockscreen : Phosh.LayerSurface
  implements Atk.ImplementorIface, Gtk.Buildable {
  /* No available fields */
}

The main lock screen

The lock screen displayed on the primary output featuring the clock and unlock keypad. It handles displaying ongoing calls when the shell is locked and can be extended via plugins.

Other outputs are locked via PhoshLockshields.

CSS nodes

PhoshLockscreen has a CSS name with the name phosh-lockscreen.

[]

Instance methods

phosh_lockscreen_add_extra_page

Inserts a custom widget into the “extra” page of the lockscreen. This page sits in-between the info page and the keypad page. By default, this page does not exist and is not used. Once an extra page is added, it can be navigated to by swiping and also via calls to phosh_lockscreen_set_default_page().

phosh_lockscreen_clear_pin_entry

Clears the current contents of the keypad PIN entry buffer.

phosh_lockscreen_get_page
No description available.

phosh_lockscreen_get_pin_entry

Get the current contents of the keypad PIN entry buffer.

phosh_lockscreen_set_default_page

Specifies which page should be shown by default when the lockscreen is made visible. This will also be the page that is shown when the keypad idle timer is reached.

phosh_lockscreen_set_page

Scrolls to a specific page in the carousel. The state of the deck isn’t changed.

phosh_lockscreen_set_unlock_status

Sets the text displayed in the unlock status label.

phosh_lockscreen_shake_pin_entry

Triggers an animation that shakes the PIN entry left and right for a brief period. After the animation is complete, the PIN entry buffer is cleared. Used to visually indicate authentication errors.

Methods inherited from GtkWindow (109)
Methods inherited from GtkBin (1)
Methods inherited from GtkContainer (33)
Methods inherited from GtkWidget (263)
Methods inherited from GObject (43)
Methods inherited from GtkBuildable (10)
[]

Properties

Phosh.Lockscreen:calls-manager

The calls manager handling incoming and active calls.

Phosh.Lockscreen:page

The currently active carousel page.

Phosh.Lockscreen:require-unlock

Require entering PIN or password to unlock. If false, unlock by swiping up.

Properties inherited from PhoshLayerSurface (15)
Properties inherited from GtkWindow (33)
Properties inherited from GtkContainer (3)
Properties inherited from GtkWidget (39)
[]

Signals

Phosh.Lockscreen::lockscreen-unlock

This signal is emitted when authentication was successful and the session should be unlocked.

Phosh.Lockscreen::wakeup-output

Emitted when the output showing the lock screen should be woken up.

Signals inherited from PhoshLayerSurface (1)
Signals inherited from GtkWindow (5)
Signals inherited from GtkContainer (4)
Signals inherited from GtkWidget (69)
Signals inherited from GObject (1)

Class structure

[]

Virtual methods

Phosh.LockscreenClass.unlock_submit

This function is invoked when a PIN or password is submitted from the lockscreen keypad. It allows to implement a custom authentication mechanism. To indicate success the lockscreen-unlock signal should be emitted.