GvaScreenSaver

GvaScreenSaver — Inhibit the screen saver

Functions

Properties

char * reason Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── GvaScreenSaver

Description

GvaScreenSaver inhibits the screen saver from starting while running a game in full-screen mode. It prefers the "org.gnome.ScreenSaver" D-Bus interface, but can also make calls to Xlib directly.

Functions

gva_screen_saver_new ()

GvaScreenSaver *
gva_screen_saver_new (void);

Creates a GvaScreenSaver object.

If the GNOME screen saver is running, it uses its D-Bus interface to inhibit the screen saver; otherwise it falls back to using the X screen saver functionality for this.

Returns

a newly created GvaScreenSaver


gva_screen_saver_enable ()

void
gva_screen_saver_enable (GvaScreenSaver *screen_saver);

Enables the screen saver.

Parameters

screen_saver

a GvaScreenSaver

 

gva_screen_saver_disable ()

void
gva_screen_saver_disable (GvaScreenSaver *screen_saver);

Disables the screen saver.

Parameters

screen_saver

a GvaScreenSaver

 

gva_screen_saver_get_reason ()

const gchar *
gva_screen_saver_get_reason (GvaScreenSaver *screen_saver);

Returns the reason for disabling the screen saver.

Parameters

screen_saver

a GvaScreenSaver

 

Returns

the reason for disabling the screen saver


gva_screen_saver_set_reason ()

void
gva_screen_saver_set_reason (GvaScreenSaver *screen_saver,
                             const gchar *reason);

Sets the reason for disabling the screen saver. This string is passed to the "org.freedesktop.ScreenSaver" D-Bus interface on subsequent calls to gva_screen_saver_disable().

Parameters

screen_saver

a GvaScreenSaver

 

reason

the reason for disabling the screen saver

 

Types and Values

struct GvaScreenSaver

struct GvaScreenSaver;

Contains only private data that should be read and manipulated using the functions below.

Property Details

The “reason” property

  “reason”                   char *

The reason for disabling the screen saver.

Owner: GvaScreenSaver

Flags: Read / Write

Default value: NULL