Ecore_X_ScrenSaver_Group (3) - Linux Manuals

Ecore_X_ScrenSaver_Group: These functions use the shape extension of the X server to change shape of given windows.

NAME

X Shape extension - These functions use the shape extension of the X server to change shape of given windows.

Functions

EAPI int ecore_x_screensaver_event_available_get (void)
Return whether the X server supports the ScrenSaver Extension.
EAPI void ecore_x_screensaver_idle_time_prefetch (void)
Sends the QueryInfo request.
EAPI void ecore_x_screensaver_idle_time_fetch (void)
Gets the reply of the QueryInfo request sent by ecore_x_get_screensaver_prefetch().
EAPI int ecore_x_screensaver_idle_time_get (void)
Get the number of seconds since the last input was received.
EAPI void ecore_x_screensaver_set (int timeout, int interval, int blank, int expose)
Set the parameters of the screen saver.
EAPI void ecore_x_get_screensaver_prefetch (void)
Sends the GetScreenSaver request.
EAPI void ecore_x_get_screensaver_fetch (void)
Gets the reply of the GetScreenSaver request sent by ecore_x_get_screensaver_prefetch().
EAPI void ecore_x_screensaver_timeout_set (int timeout)
Set the timeout of the screen saver.
EAPI int ecore_x_screensaver_timeout_get (void)
Get the timeout of the screen saver.
EAPI void ecore_x_screensaver_interval_set (int interval)
Set the interval of the screen saver.
EAPI int ecore_x_screensaver_interval_get (void)
Get the interval of the screen saver.
EAPI void ecore_x_screensaver_blank_set (int blank)
Set the screen blanking.
EAPI int ecore_x_screensaver_blank_get (void)
Get the screen blanking.
EAPI void ecore_x_screensaver_expose_set (int expose)
Set the screen save control values.
EAPI int ecore_x_screensaver_expose_get (void)
Get the screen save control values.
EAPI void ecore_x_screensaver_event_listen_set (int on)
Specifies if the Screen Saver NotifyMask event should be generated.

Detailed Description

These functions use the shape extension of the X server to change shape of given windows.

Function Documentation

EAPI int ecore_x_screensaver_blank_get (void)

Get the screen blanking.

Returns:

The blanking.

Get the screen blanking.

To use this function, you must call before, and in order, ecore_x_get_screensaver_prefetch(), which sends the GetScreenSaver request, then ecore_x_get_screensaver_fetch(), which gets the reply.

EAPI void ecore_x_screensaver_blank_set (int blank)

Set the screen blanking.

Parameters:

blank The blank to set.

blank specifies how to enable screen blanking.

To use this function, you must call before, and in order, ecore_x_get_screensaver_prefetch(), which sends the GetScreenSaver request, then ecore_x_get_screensaver_fetch(), which gets the reply.

EAPI int ecore_x_screensaver_event_available_get (void)

Return whether the X server supports the ScrenSaver Extension.

Returns:

1 if the X ScrenSaver Extension is available, 0 otherwise.

Return 1 if the X server supports the ScrenSaver Extension version 1.0, 0 otherwise.

EAPI void ecore_x_screensaver_event_listen_set (int on)

Specifies if the Screen Saver NotifyMask event should be generated.

Parameters:

on 0 to disable the generation of the event, otherwise enable it.

Specifies if the Screen Saver NotifyMask event on the screen associated with drawable should be generated for this client. If on is set to 0, the generation is disabled, otherwise, it is enabled.

EAPI int ecore_x_screensaver_expose_get (void)

Get the screen save control values.

Returns:

The expose.

Get the screen save control values.

To use this function, you must call before, and in order, ecore_x_get_screensaver_prefetch(), which sends the GetScreenSaver request, then ecore_x_get_screensaver_fetch(), which gets the reply.

EAPI void ecore_x_screensaver_expose_set (int expose)

Set the screen save control values.

Parameters:

expose The expose to set.

Set the screen save control values.

To use this function, you must call before, and in order, ecore_x_get_screensaver_prefetch(), which sends the GetScreenSaver request, then ecore_x_get_screensaver_fetch(), which gets the reply.

EAPI int ecore_x_screensaver_idle_time_get (void)

Get the number of seconds since the last input was received.

Returns:

The number of seconds.

Get the number of milliseconds since the last input was received from the user on any of the input devices.

To use this function, you must call before, and in order, ecore_x_get_screensaver_prefetch(), which sends the GetScreenSaver request, then ecore_x_get_screensaver_fetch(), which gets the reply.

EAPI int ecore_x_screensaver_interval_get (void)

Get the interval of the screen saver.

Returns:

The interval.

Get the interval, in seconds, between screen saver alterations.

To use this function, you must call before, and in order, ecore_x_get_screensaver_prefetch(), which sends the GetScreenSaver request, then ecore_x_get_screensaver_fetch(), which gets the reply.

EAPI void ecore_x_screensaver_interval_set (int interval)

Set the interval of the screen saver.

Parameters:

interval The interval to set.

Set the interval, in seconds, between screen saver alterations.

To use this function, you must call before, and in order, ecore_x_get_screensaver_prefetch(), which sends the GetScreenSaver request, then ecore_x_get_screensaver_fetch(), which gets the reply.

EAPI void ecore_x_screensaver_set (int timeout, int interval, int blank, int expose)

Set the parameters of the screen saver.

Parameters:

timeout The timeout, in second.
interval The interval, in seconds.
blank 0 to disable screen blanking, otherwise enable it.
expose Allow Expose generation event or not.

Set the parameters of the screen saver. timeout is the timeout, in seconds, until the screen saver turns on. interval is the interval, in seconds, between screen saver alterations. blank specifies how to enable screen blanking. expose specifies the screen save control values.

EAPI int ecore_x_screensaver_timeout_get (void)

Get the timeout of the screen saver.

Returns:

The timeout.

Get the timeout, in seconds, until the screen saver turns on.

To use this function, you must call before, and in order, ecore_x_get_screensaver_prefetch(), which sends the GetScreenSaver request, then ecore_x_get_screensaver_fetch(), which gets the reply.

EAPI void ecore_x_screensaver_timeout_set (int timeout)

Set the timeout of the screen saver.

Parameters:

timeout The timeout to set.

Set the timeout, in seconds, until the screen saver turns on.

To use this function, you must call before, and in order, ecore_x_get_screensaver_prefetch(), which sends the GetScreenSaver request, then ecore_x_get_screensaver_fetch(), which gets the reply.

Author

Generated automatically by Doxygen for Ecore from the source code.