include/xcb/screensaver.h

0001 /*
0002  * This file generated automatically from screensaver.xml by c_client.py.
0003  * Edit at your peril.
0004  */
0005
0006 /**
0007  * @defgroup XCB_ScreenSaver_API XCB ScreenSaver API
0008  * @brief ScreenSaver XCB Protocol Implementation.
0009  * @{
0010  **/
0011
0012 #ifndef __SCREENSAVER_H
0013 #define __SCREENSAVER_H
0014
0015 #include "xcb.h"
0016 #include "xproto.h"
0017
0018 #ifdef __cplusplus
0019 extern "C" {
0020 #endif
0021
0022 #define XCB_SCREENSAVER_MAJOR_VERSION 1
0023 #define XCB_SCREENSAVER_MINOR_VERSION 1
0024
0025 extern xcb_extension_t xcb_screensaver_id;
0026
0027 typedef enum xcb_screensaver_kind_t {
0028     XCB_SCREENSAVER_KIND_BLANKED = 0,
0029     XCB_SCREENSAVER_KIND_INTERNAL = 1,
0030     XCB_SCREENSAVER_KIND_EXTERNAL = 2
0031 } xcb_screensaver_kind_t;
0032
0033 typedef enum xcb_screensaver_event_t {
0034     XCB_SCREENSAVER_EVENT_NOTIFY_MASK = 1,
0035     XCB_SCREENSAVER_EVENT_CYCLE_MASK = 2
0036 } xcb_screensaver_event_t;
0037
0038 typedef enum xcb_screensaver_state_t {
0039     XCB_SCREENSAVER_STATE_OFF = 0,
0040     XCB_SCREENSAVER_STATE_ON = 1,
0041     XCB_SCREENSAVER_STATE_CYCLE = 2,
0042     XCB_SCREENSAVER_STATE_DISABLED = 3
0043 } xcb_screensaver_state_t;
0044
0045 /**
0046  * @brief xcb_screensaver_query_version_cookie_t
0047  **/
0048 typedef struct xcb_screensaver_query_version_cookie_t {
0049     unsigned int sequence;
0050 } xcb_screensaver_query_version_cookie_t;
0051
0052 /** Opcode for xcb_screensaver_query_version. */
0053 #define XCB_SCREENSAVER_QUERY_VERSION 0
0054
0055 /**
0056  * @brief xcb_screensaver_query_version_request_t
0057  **/
0058 typedef struct xcb_screensaver_query_version_request_t {
0059     uint8_t  major_opcode;
0060     uint8_t  minor_opcode;
0061     uint16_t length;
0062     uint8_t  client_major_version;
0063     uint8_t  client_minor_version;
0064     uint8_t  pad0[2];
0065 } xcb_screensaver_query_version_request_t;
0066
0067 /**
0068  * @brief xcb_screensaver_query_version_reply_t
0069  **/
0070 typedef struct xcb_screensaver_query_version_reply_t {
0071     uint8_t  response_type;
0072     uint8_t  pad0;
0073     uint16_t sequence;
0074     uint32_t length;
0075     uint16_t server_major_version;
0076     uint16_t server_minor_version;
0077     uint8_t  pad1[20];
0078 } xcb_screensaver_query_version_reply_t;
0079
0080 /**
0081  * @brief xcb_screensaver_query_info_cookie_t
0082  **/
0083 typedef struct xcb_screensaver_query_info_cookie_t {
0084     unsigned int sequence;
0085 } xcb_screensaver_query_info_cookie_t;
0086
0087 /** Opcode for xcb_screensaver_query_info. */
0088 #define XCB_SCREENSAVER_QUERY_INFO 1
0089
0090 /**
0091  * @brief xcb_screensaver_query_info_request_t
0092  **/
0093 typedef struct xcb_screensaver_query_info_request_t {
0094     uint8_t        major_opcode;
0095     uint8_t        minor_opcode;
0096     uint16_t       length;
0097     xcb_drawable_t drawable;
0098 } xcb_screensaver_query_info_request_t;
0099
0100 /**
0101  * @brief xcb_screensaver_query_info_reply_t
0102  **/
0103 typedef struct xcb_screensaver_query_info_reply_t {
0104     uint8_t      response_type;
0105     uint8_t      state;
0106     uint16_t     sequence;
0107     uint32_t     length;
0108     xcb_window_t saver_window;
0109     uint32_t     ms_until_server;
0110     uint32_t     ms_since_user_input;
0111     uint32_t     event_mask;
0112     uint8_t      kind;
0113     uint8_t      pad0[7];
0114 } xcb_screensaver_query_info_reply_t;
0115
0116 /** Opcode for xcb_screensaver_select_input. */
0117 #define XCB_SCREENSAVER_SELECT_INPUT 2
0118
0119 /**
0120  * @brief xcb_screensaver_select_input_request_t
0121  **/
0122 typedef struct xcb_screensaver_select_input_request_t {
0123     uint8_t        major_opcode;
0124     uint8_t        minor_opcode;
0125     uint16_t       length;
0126     xcb_drawable_t drawable;
0127     uint32_t       event_mask;
0128 } xcb_screensaver_select_input_request_t;
0129
0130 /**
0131  * @brief xcb_screensaver_set_attributes_value_list_t
0132  **/
0133 typedef struct xcb_screensaver_set_attributes_value_list_t {
0134     xcb_pixmap_t   background_pixmap;
0135     uint32_t       background_pixel;
0136     xcb_pixmap_t   border_pixmap;
0137     uint32_t       border_pixel;
0138     uint32_t       bit_gravity;
0139     uint32_t       win_gravity;
0140     uint32_t       backing_store;
0141     uint32_t       backing_planes;
0142     uint32_t       backing_pixel;
0143     xcb_bool32_t   override_redirect;
0144     xcb_bool32_t   save_under;
0145     uint32_t       event_mask;
0146     uint32_t       do_not_propogate_mask;
0147     xcb_colormap_t colormap;
0148     xcb_cursor_t   cursor;
0149 } xcb_screensaver_set_attributes_value_list_t;
0150
0151 /** Opcode for xcb_screensaver_set_attributes. */
0152 #define XCB_SCREENSAVER_SET_ATTRIBUTES 3
0153
0154 /**
0155  * @brief xcb_screensaver_set_attributes_request_t
0156  **/
0157 typedef struct xcb_screensaver_set_attributes_request_t {
0158     uint8_t        major_opcode;
0159     uint8_t        minor_opcode;
0160     uint16_t       length;
0161     xcb_drawable_t drawable;
0162     int16_t        x;
0163     int16_t        y;
0164     uint16_t       width;
0165     uint16_t       height;
0166     uint16_t       border_width;
0167     uint8_t        _class;
0168     uint8_t        depth;
0169     xcb_visualid_t visual;
0170     uint32_t       value_mask;
0171 } xcb_screensaver_set_attributes_request_t;
0172
0173 /** Opcode for xcb_screensaver_unset_attributes. */
0174 #define XCB_SCREENSAVER_UNSET_ATTRIBUTES 4
0175
0176 /**
0177  * @brief xcb_screensaver_unset_attributes_request_t
0178  **/
0179 typedef struct xcb_screensaver_unset_attributes_request_t {
0180     uint8_t        major_opcode;
0181     uint8_t        minor_opcode;
0182     uint16_t       length;
0183     xcb_drawable_t drawable;
0184 } xcb_screensaver_unset_attributes_request_t;
0185
0186 /** Opcode for xcb_screensaver_suspend. */
0187 #define XCB_SCREENSAVER_SUSPEND 5
0188
0189 /**
0190  * @brief xcb_screensaver_suspend_request_t
0191  **/
0192 typedef struct xcb_screensaver_suspend_request_t {
0193     uint8_t  major_opcode;
0194     uint8_t  minor_opcode;
0195     uint16_t length;
0196     uint32_t suspend;
0197 } xcb_screensaver_suspend_request_t;
0198
0199 /** Opcode for xcb_screensaver_notify. */
0200 #define XCB_SCREENSAVER_NOTIFY 0
0201
0202 /**
0203  * @brief xcb_screensaver_notify_event_t
0204  **/
0205 typedef struct xcb_screensaver_notify_event_t {
0206     uint8_t         response_type;
0207     uint8_t         state;
0208     uint16_t        sequence;
0209     xcb_timestamp_t time;
0210     xcb_window_t    root;
0211     xcb_window_t    window;
0212     uint8_t         kind;
0213     uint8_t         forced;
0214     uint8_t         pad0[14];
0215 } xcb_screensaver_notify_event_t;
0216
0217 /**
0218  *
0219  * @param c The connection
0220  * @return A cookie
0221  *
0222  * Delivers a request to the X server.
0223  *
0224  */
0225 xcb_screensaver_query_version_cookie_t
0226 xcb_screensaver_query_version (xcb_connection_t *c,
0227                                uint8_t           client_major_version,
0228                                uint8_t           client_minor_version);
0229
0230 /**
0231  *
0232  * @param c The connection
0233  * @return A cookie
0234  *
0235  * Delivers a request to the X server.
0236  *
0237  * This form can be used only if the request will cause
0238  * a reply to be generated. Any returned error will be
0239  * placed in the event queue.
0240  */
0241 xcb_screensaver_query_version_cookie_t
0242 xcb_screensaver_query_version_unchecked (xcb_connection_t *c,
0243                                          uint8_t           client_major_version,
0244                                          uint8_t           client_minor_version);
0245
0246 /**
0247  * Return the reply
0248  * @param c      The connection
0249  * @param cookie The cookie
0250  * @param e      The xcb_generic_error_t supplied
0251  *
0252  * Returns the reply of the request asked by
0253  *
0254  * The parameter @p e supplied to this function must be NULL if
0255  * xcb_screensaver_query_version_unchecked(). is used.
0256  * Otherwise, it stores the error if any.
0257  *
0258  * The returned value must be freed by the caller using free().
0259  */
0260 xcb_screensaver_query_version_reply_t *
0261 xcb_screensaver_query_version_reply (xcb_connection_t                        *c,
0262                                      xcb_screensaver_query_version_cookie_t   cookie  /**< */,
0263                                      xcb_generic_error_t                    **e);
0264
0265 /**
0266  *
0267  * @param c The connection
0268  * @return A cookie
0269  *
0270  * Delivers a request to the X server.
0271  *
0272  */
0273 xcb_screensaver_query_info_cookie_t
0274 xcb_screensaver_query_info (xcb_connection_t *c,
0275                             xcb_drawable_t    drawable);
0276
0277 /**
0278  *
0279  * @param c The connection
0280  * @return A cookie
0281  *
0282  * Delivers a request to the X server.
0283  *
0284  * This form can be used only if the request will cause
0285  * a reply to be generated. Any returned error will be
0286  * placed in the event queue.
0287  */
0288 xcb_screensaver_query_info_cookie_t
0289 xcb_screensaver_query_info_unchecked (xcb_connection_t *c,
0290                                       xcb_drawable_t    drawable);
0291
0292 /**
0293  * Return the reply
0294  * @param c      The connection
0295  * @param cookie The cookie
0296  * @param e      The xcb_generic_error_t supplied
0297  *
0298  * Returns the reply of the request asked by
0299  *
0300  * The parameter @p e supplied to this function must be NULL if
0301  * xcb_screensaver_query_info_unchecked(). is used.
0302  * Otherwise, it stores the error if any.
0303  *
0304  * The returned value must be freed by the caller using free().
0305  */
0306 xcb_screensaver_query_info_reply_t *
0307 xcb_screensaver_query_info_reply (xcb_connection_t                     *c,
0308                                   xcb_screensaver_query_info_cookie_t   cookie  /**< */,
0309                                   xcb_generic_error_t                 **e);
0310
0311 /**
0312  *
0313  * @param c The connection
0314  * @return A cookie
0315  *
0316  * Delivers a request to the X server.
0317  *
0318  * This form can be used only if the request will not cause
0319  * a reply to be generated. Any returned error will be
0320  * saved for handling by xcb_request_check().
0321  */
0322 xcb_void_cookie_t
0323 xcb_screensaver_select_input_checked (xcb_connection_t *c,
0324                                       xcb_drawable_t    drawable,
0325                                       uint32_t          event_mask);
0326
0327 /**
0328  *
0329  * @param c The connection
0330  * @return A cookie
0331  *
0332  * Delivers a request to the X server.
0333  *
0334  */
0335 xcb_void_cookie_t
0336 xcb_screensaver_select_input (xcb_connection_t *c,
0337                               xcb_drawable_t    drawable,
0338                               uint32_t          event_mask);
0339
0340 int
0341 xcb_screensaver_set_attributes_value_list_serialize (void                                              **_buffer,
0342                                                      uint32_t                                            value_mask,
0343                                                      const xcb_screensaver_set_attributes_value_list_t  *_aux);
0344
0345 int
0346 xcb_screensaver_set_attributes_value_list_unpack (const void                                   *_buffer,
0347                                                   uint32_t                                      value_mask,
0348                                                   xcb_screensaver_set_attributes_value_list_t  *_aux);
0349
0350 int
0351 xcb_screensaver_set_attributes_value_list_sizeof (const void  *_buffer,
0352                                                   uint32_t     value_mask);
0353
0354 int
0355 xcb_screensaver_set_attributes_sizeof (const void  *_buffer);
0356
0357 /**
0358  *
0359  * @param c The connection
0360  * @return A cookie
0361  *
0362  * Delivers a request to the X server.
0363  *
0364  * This form can be used only if the request will not cause
0365  * a reply to be generated. Any returned error will be
0366  * saved for handling by xcb_request_check().
0367  */
0368 xcb_void_cookie_t
0369 xcb_screensaver_set_attributes_checked (xcb_connection_t *c,
0370                                         xcb_drawable_t    drawable,
0371                                         int16_t           x,
0372                                         int16_t           y,
0373                                         uint16_t          width,
0374                                         uint16_t          height,
0375                                         uint16_t          border_width,
0376                                         uint8_t           _class,
0377                                         uint8_t           depth,
0378                                         xcb_visualid_t    visual,
0379                                         uint32_t          value_mask,
0380                                         const void       *value_list);
0381
0382 /**
0383  *
0384  * @param c The connection
0385  * @return A cookie
0386  *
0387  * Delivers a request to the X server.
0388  *
0389  */
0390 xcb_void_cookie_t
0391 xcb_screensaver_set_attributes (xcb_connection_t *c,
0392                                 xcb_drawable_t    drawable,
0393                                 int16_t           x,
0394                                 int16_t           y,
0395                                 uint16_t          width,
0396                                 uint16_t          height,
0397                                 uint16_t          border_width,
0398                                 uint8_t           _class,
0399                                 uint8_t           depth,
0400                                 xcb_visualid_t    visual,
0401                                 uint32_t          value_mask,
0402                                 const void       *value_list);
0403
0404 /**
0405  *
0406  * @param c The connection
0407  * @return A cookie
0408  *
0409  * Delivers a request to the X server.
0410  *
0411  * This form can be used only if the request will not cause
0412  * a reply to be generated. Any returned error will be
0413  * saved for handling by xcb_request_check().
0414  */
0415 xcb_void_cookie_t
0416 xcb_screensaver_set_attributes_aux_checked (xcb_connection_t                                  *c,
0417                                             xcb_drawable_t                                     drawable,
0418                                             int16_t                                            x,
0419                                             int16_t                                            y,
0420                                             uint16_t                                           width,
0421                                             uint16_t                                           height,
0422                                             uint16_t                                           border_width,
0423                                             uint8_t                                            _class,
0424                                             uint8_t                                            depth,
0425                                             xcb_visualid_t                                     visual,
0426                                             uint32_t                                           value_mask,
0427                                             const xcb_screensaver_set_attributes_value_list_t *value_list);
0428
0429 /**
0430  *
0431  * @param c The connection
0432  * @return A cookie
0433  *
0434  * Delivers a request to the X server.
0435  *
0436  */
0437 xcb_void_cookie_t
0438 xcb_screensaver_set_attributes_aux (xcb_connection_t                                  *c,
0439                                     xcb_drawable_t                                     drawable,
0440                                     int16_t                                            x,
0441                                     int16_t                                            y,
0442                                     uint16_t                                           width,
0443                                     uint16_t                                           height,
0444                                     uint16_t                                           border_width,
0445                                     uint8_t                                            _class,
0446                                     uint8_t                                            depth,
0447                                     xcb_visualid_t                                     visual,
0448                                     uint32_t                                           value_mask,
0449                                     const xcb_screensaver_set_attributes_value_list_t *value_list);
0450
0451 void *
0452 xcb_screensaver_set_attributes_value_list (const xcb_screensaver_set_attributes_request_t *R);
0453
0454 /**
0455  *
0456  * @param c The connection
0457  * @return A cookie
0458  *
0459  * Delivers a request to the X server.
0460  *
0461  * This form can be used only if the request will not cause
0462  * a reply to be generated. Any returned error will be
0463  * saved for handling by xcb_request_check().
0464  */
0465 xcb_void_cookie_t
0466 xcb_screensaver_unset_attributes_checked (xcb_connection_t *c,
0467                                           xcb_drawable_t    drawable);
0468
0469 /**
0470  *
0471  * @param c The connection
0472  * @return A cookie
0473  *
0474  * Delivers a request to the X server.
0475  *
0476  */
0477 xcb_void_cookie_t
0478 xcb_screensaver_unset_attributes (xcb_connection_t *c,
0479                                   xcb_drawable_t    drawable);
0480
0481 /**
0482  *
0483  * @param c The connection
0484  * @return A cookie
0485  *
0486  * Delivers a request to the X server.
0487  *
0488  * This form can be used only if the request will not cause
0489  * a reply to be generated. Any returned error will be
0490  * saved for handling by xcb_request_check().
0491  */
0492 xcb_void_cookie_t
0493 xcb_screensaver_suspend_checked (xcb_connection_t *c,
0494                                  uint32_t          suspend);
0495
0496 /**
0497  *
0498  * @param c The connection
0499  * @return A cookie
0500  *
0501  * Delivers a request to the X server.
0502  *
0503  */
0504 xcb_void_cookie_t
0505 xcb_screensaver_suspend (xcb_connection_t *c,
0506                          uint32_t          suspend);
0507
0508
0509 #ifdef __cplusplus
0510 }
0511 #endif
0512
0513 #endif
0514
0515 /**
0516  * @}
0517  */