org.freedesktop.ScreenSaver
Prev Chapter 5. Interfaces Next

org.freedesktop.ScreenSaver

org.freedesktop.ScreenSaver — The Idle Inhibition Service manages the inhibition requests.

Synopsis

Methods

Inhibit (IN String application_name,
 IN String reason_for_inhibit,
 OUT UInt32 cookie);
 
UnInhibit (IN UInt32 cookie);
 

Methods

org.freedesktop.ScreenSaver.Inhibit

Inhibit (IN String application_name,
 IN String reason_for_inhibit,
 OUT UInt32 cookie);
 

Inhibit idleness for the caller application.

application_name

A unique identifier for the application, usually a reverse domain (such as 'org.freedesktop.example').

reason_for_inhibit

A human-readable and possibly translated string explaining the reason why idleness is inhibited (such as 'Playing a movie').

cookie

A cookie uniquely representing the inhibition request, to be passed to UnInhibit when done.

org.freedesktop.ScreenSaver.UnInhibit

UnInhibit (IN UInt32 cookie);
 

Disable inhibit idleness for the caller application.

cookie

A cookie representing the inhibition request, as returned by the 'Inhibit' function.

Prev Up Next
Chapter 5. Interfaces Home Part III. References