XCB ScreenSaver API

ScreenSaver XCB Protocol Implementation. More...

Data Structures

struct  xcb_screensaver_query_version_cookie_t
 xcb_screensaver_query_version_cookie_t More...
struct  xcb_screensaver_query_version_request_t
 xcb_screensaver_query_version_request_t More...
struct  xcb_screensaver_query_version_reply_t
 xcb_screensaver_query_version_reply_t More...
struct  xcb_screensaver_query_info_cookie_t
 xcb_screensaver_query_info_cookie_t More...
struct  xcb_screensaver_query_info_request_t
 xcb_screensaver_query_info_request_t More...
struct  xcb_screensaver_query_info_reply_t
 xcb_screensaver_query_info_reply_t More...
struct  xcb_screensaver_select_input_request_t
 xcb_screensaver_select_input_request_t More...
struct  xcb_screensaver_set_attributes_request_t
 xcb_screensaver_set_attributes_request_t More...
struct  xcb_screensaver_unset_attributes_request_t
 xcb_screensaver_unset_attributes_request_t More...
struct  xcb_screensaver_suspend_request_t
 xcb_screensaver_suspend_request_t More...
struct  xcb_screensaver_notify_event_t
 xcb_screensaver_notify_event_t More...

Defines

#define XCB_SCREENSAVER_MAJOR_VERSION   1
#define XCB_SCREENSAVER_MINOR_VERSION   1
#define XCB_SCREENSAVER_QUERY_VERSION   0
#define XCB_SCREENSAVER_QUERY_INFO   1
#define XCB_SCREENSAVER_SELECT_INPUT   2
#define XCB_SCREENSAVER_SET_ATTRIBUTES   3
#define XCB_SCREENSAVER_UNSET_ATTRIBUTES   4
#define XCB_SCREENSAVER_SUSPEND   5
#define XCB_SCREENSAVER_NOTIFY   0

Enumerations

enum  xcb_screensaver_kind_t { XCB_SCREENSAVER_KIND_BLANKED, XCB_SCREENSAVER_KIND_INTERNAL, XCB_SCREENSAVER_KIND_EXTERNAL }
enum  xcb_screensaver_event_t { XCB_SCREENSAVER_EVENT_NOTIFY_MASK = (1 << 0), XCB_SCREENSAVER_EVENT_CYCLE_MASK = (1 << 1) }
enum  xcb_screensaver_state_t { XCB_SCREENSAVER_STATE_OFF, XCB_SCREENSAVER_STATE_ON, XCB_SCREENSAVER_STATE_CYCLE, XCB_SCREENSAVER_STATE_DISABLED }

Functions

xcb_screensaver_query_version_cookie_t xcb_screensaver_query_version (xcb_connection_t *c, uint8_t client_major_version, uint8_t client_minor_version)
xcb_screensaver_query_version_cookie_t xcb_screensaver_query_version_unchecked (xcb_connection_t *c, uint8_t client_major_version, uint8_t client_minor_version)
xcb_screensaver_query_version_reply_txcb_screensaver_query_version_reply (xcb_connection_t *c, xcb_screensaver_query_version_cookie_t cookie, xcb_generic_error_t **e)
xcb_screensaver_query_info_cookie_t xcb_screensaver_query_info (xcb_connection_t *c, xcb_drawable_t drawable)
xcb_screensaver_query_info_cookie_t xcb_screensaver_query_info_unchecked (xcb_connection_t *c, xcb_drawable_t drawable)
xcb_screensaver_query_info_reply_txcb_screensaver_query_info_reply (xcb_connection_t *c, xcb_screensaver_query_info_cookie_t cookie, xcb_generic_error_t **e)
xcb_void_cookie_t xcb_screensaver_select_input_checked (xcb_connection_t *c, xcb_drawable_t drawable, uint32_t event_mask)
xcb_void_cookie_t xcb_screensaver_select_input (xcb_connection_t *c, xcb_drawable_t drawable, uint32_t event_mask)
xcb_void_cookie_t xcb_screensaver_set_attributes_checked (xcb_connection_t *c, xcb_drawable_t drawable, int16_t x, int16_t y, uint16_t width, uint16_t height, uint16_t border_width, uint8_t _class, uint8_t depth, xcb_visualid_t visual, uint32_t value_mask, const uint32_t *value_list)
xcb_void_cookie_t xcb_screensaver_set_attributes (xcb_connection_t *c, xcb_drawable_t drawable, int16_t x, int16_t y, uint16_t width, uint16_t height, uint16_t border_width, uint8_t _class, uint8_t depth, xcb_visualid_t visual, uint32_t value_mask, const uint32_t *value_list)
xcb_void_cookie_t xcb_screensaver_unset_attributes_checked (xcb_connection_t *c, xcb_drawable_t drawable)
xcb_void_cookie_t xcb_screensaver_unset_attributes (xcb_connection_t *c, xcb_drawable_t drawable)
xcb_void_cookie_t xcb_screensaver_suspend_checked (xcb_connection_t *c, uint8_t suspend)
xcb_void_cookie_t xcb_screensaver_suspend (xcb_connection_t *c, uint8_t suspend)

Variables

xcb_extension_t xcb_screensaver_id

Detailed Description

ScreenSaver XCB Protocol Implementation.


Define Documentation

#define XCB_SCREENSAVER_NOTIFY   0

Opcode for xcb_screensaver_notify.

#define XCB_SCREENSAVER_QUERY_INFO   1

Opcode for xcb_screensaver_query_info.

Referenced by xcb_screensaver_query_info(), and xcb_screensaver_query_info_unchecked().

#define XCB_SCREENSAVER_QUERY_VERSION   0

Opcode for xcb_screensaver_query_version.

Referenced by xcb_screensaver_query_version(), and xcb_screensaver_query_version_unchecked().

#define XCB_SCREENSAVER_SELECT_INPUT   2

Opcode for xcb_screensaver_select_input.

Referenced by xcb_screensaver_select_input(), and xcb_screensaver_select_input_checked().

#define XCB_SCREENSAVER_SET_ATTRIBUTES   3

Opcode for xcb_screensaver_set_attributes.

Referenced by xcb_screensaver_set_attributes(), and xcb_screensaver_set_attributes_checked().

#define XCB_SCREENSAVER_SUSPEND   5

Opcode for xcb_screensaver_suspend.

Referenced by xcb_screensaver_suspend(), and xcb_screensaver_suspend_checked().

#define XCB_SCREENSAVER_UNSET_ATTRIBUTES   4

Opcode for xcb_screensaver_unset_attributes.

Referenced by xcb_screensaver_unset_attributes(), and xcb_screensaver_unset_attributes_checked().


Function Documentation

xcb_screensaver_query_info_cookie_t xcb_screensaver_query_info ( xcb_connection_t c,
xcb_drawable_t  drawable 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

References xcb_screensaver_query_info_request_t::drawable, and XCB_SCREENSAVER_QUERY_INFO.

Return the reply

Parameters:
c The connection
cookie The cookie
e The xcb_generic_error_t supplied
Returns the reply of the request asked by

The parameter e supplied to this function must be NULL if xcb_screensaver_query_info_unchecked(). is used. Otherwise, it stores the error if any.

References xcb_screensaver_query_info_cookie_t::sequence.

xcb_screensaver_query_info_cookie_t xcb_screensaver_query_info_unchecked ( xcb_connection_t c,
xcb_drawable_t  drawable 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

This form can be used only if the request will cause a reply to be generated. Any returned error will be placed in the event queue.

References xcb_screensaver_query_info_request_t::drawable, and XCB_SCREENSAVER_QUERY_INFO.

xcb_screensaver_query_version_cookie_t xcb_screensaver_query_version ( xcb_connection_t c,
uint8_t  client_major_version,
uint8_t  client_minor_version 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

References xcb_screensaver_query_version_request_t::client_major_version, xcb_screensaver_query_version_request_t::client_minor_version, xcb_screensaver_query_version_request_t::pad0, and XCB_SCREENSAVER_QUERY_VERSION.

Return the reply

Parameters:
c The connection
cookie The cookie
e The xcb_generic_error_t supplied
Returns the reply of the request asked by

The parameter e supplied to this function must be NULL if xcb_screensaver_query_version_unchecked(). is used. Otherwise, it stores the error if any.

References xcb_screensaver_query_version_cookie_t::sequence.

xcb_screensaver_query_version_cookie_t xcb_screensaver_query_version_unchecked ( xcb_connection_t c,
uint8_t  client_major_version,
uint8_t  client_minor_version 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

This form can be used only if the request will cause a reply to be generated. Any returned error will be placed in the event queue.

References xcb_screensaver_query_version_request_t::client_major_version, xcb_screensaver_query_version_request_t::client_minor_version, xcb_screensaver_query_version_request_t::pad0, and XCB_SCREENSAVER_QUERY_VERSION.

xcb_void_cookie_t xcb_screensaver_select_input ( xcb_connection_t c,
xcb_drawable_t  drawable,
uint32_t  event_mask 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

References xcb_screensaver_select_input_request_t::drawable, xcb_screensaver_select_input_request_t::event_mask, and XCB_SCREENSAVER_SELECT_INPUT.

xcb_void_cookie_t xcb_screensaver_select_input_checked ( xcb_connection_t c,
xcb_drawable_t  drawable,
uint32_t  event_mask 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

This form can be used only if the request will not cause a reply to be generated. Any returned error will be saved for handling by xcb_request_check().

References xcb_screensaver_select_input_request_t::drawable, xcb_screensaver_select_input_request_t::event_mask, and XCB_SCREENSAVER_SELECT_INPUT.

xcb_void_cookie_t xcb_screensaver_set_attributes ( xcb_connection_t c,
xcb_drawable_t  drawable,
int16_t  x,
int16_t  y,
uint16_t  width,
uint16_t  height,
uint16_t  border_width,
uint8_t  _class,
uint8_t  depth,
xcb_visualid_t  visual,
uint32_t  value_mask,
const uint32_t *  value_list 
)

xcb_void_cookie_t xcb_screensaver_set_attributes_checked ( xcb_connection_t c,
xcb_drawable_t  drawable,
int16_t  x,
int16_t  y,
uint16_t  width,
uint16_t  height,
uint16_t  border_width,
uint8_t  _class,
uint8_t  depth,
xcb_visualid_t  visual,
uint32_t  value_mask,
const uint32_t *  value_list 
)

xcb_void_cookie_t xcb_screensaver_suspend ( xcb_connection_t c,
uint8_t  suspend 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

References xcb_screensaver_suspend_request_t::pad0, xcb_screensaver_suspend_request_t::suspend, and XCB_SCREENSAVER_SUSPEND.

xcb_void_cookie_t xcb_screensaver_suspend_checked ( xcb_connection_t c,
uint8_t  suspend 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

This form can be used only if the request will not cause a reply to be generated. Any returned error will be saved for handling by xcb_request_check().

References xcb_screensaver_suspend_request_t::pad0, xcb_screensaver_suspend_request_t::suspend, and XCB_SCREENSAVER_SUSPEND.

xcb_void_cookie_t xcb_screensaver_unset_attributes ( xcb_connection_t c,
xcb_drawable_t  drawable 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

References xcb_screensaver_unset_attributes_request_t::drawable, and XCB_SCREENSAVER_UNSET_ATTRIBUTES.

xcb_void_cookie_t xcb_screensaver_unset_attributes_checked ( xcb_connection_t c,
xcb_drawable_t  drawable 
)

Delivers a request to the X server

Parameters:
c The connection
Returns:
A cookie
Delivers a request to the X server.

This form can be used only if the request will not cause a reply to be generated. Any returned error will be saved for handling by xcb_request_check().

References xcb_screensaver_unset_attributes_request_t::drawable, and XCB_SCREENSAVER_UNSET_ATTRIBUTES.


Generated on Sun Jul 27 21:19:01 2008 for XCB by  doxygen 1.5.6