Libxfce4ui.Screensaver¶

Subclasses:: None

Methods¶

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

class	`new` ()
	`inhibit` (inhibit)
	`lock` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`heartbeat-command`	`str`	r/w/c	Inhibit the screensaver from activating, e.g. xscreensaver-command –deactivate
`lock-command`	`str`	r/w/c	Lock the desktop, e.g. xscreensaver-command –lock
`lock-on-sleep`	`bool`	r/w/c	Whether to lock before suspend/hibernate

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Libxfce4ui.Screensaver(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Libxfce4ui.ScreensaverClass

classmethod new()¶

Returns:: An Libxfce4ui.Screensaver object, to be released with GObject.Object.unref() when no longer used.
Return type:: Libxfce4ui.Screensaver

Creates a new Libxfce4ui.Screensaver object or increases the reference count of the current object.

New in version 4.18.2.

inhibit(inhibit)¶

Parameters:: inhibit (bool) – whether to inhibit the screensaver from activating

Calling this function with inhibit as True will prevent the user’s screensaver from activating. This is useful when the user is watching a movie or giving a presentation.

Calling this function with inhibit as False will remove any current screensaver inhibit the Libxfce4ui.Screensaver object has.

New in version 4.18.2.

lock()¶

Returns:: True if the lock attempt returns success, False otherwise.
Return type:: bool

Attempts to lock the screen, either with one of the screensaver D-Bus proxies, the Xfconf lock command, or one of the fallback scripts such as xdg-screensaver.

New in version 4.18.2.

Property Details¶

Libxfce4ui.Screensaver.props.heartbeat_command¶

Name:: heartbeat-command
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Inhibit the screensaver from activating, e.g. xscreensaver-command –deactivate

Libxfce4ui.Screensaver.props.lock_command¶

Name:: lock-command
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

Lock the desktop, e.g. xscreensaver-command –lock

Libxfce4ui.Screensaver.props.lock_on_sleep¶

Name:: lock-on-sleep
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

Whether to lock before suspend/hibernate