1 /* 2 * This file generated automatically from screensaver.xml by c_client.py. 3 * Edit at your peril. 4 */ 5 6 /** 7 * @defgroup XCB_ScreenSaver_API XCB ScreenSaver API 8 * @brief ScreenSaver XCB Protocol Implementation. 9 * @{ 10 **/ 11 12 #ifndef __SCREENSAVER_H 13 #define __SCREENSAVER_H 14 15 #include "xcb.h" 16 #include "xproto.h" 17 18 #ifdef __cplusplus 19 extern "C" { 20 #endif 21 22 #define XCB_SCREENSAVER_MAJOR_VERSION 1 23 #define XCB_SCREENSAVER_MINOR_VERSION 1 24 25 extern xcb_extension_t xcb_screensaver_id; 26 27 typedef enum xcb_screensaver_kind_t { 28 XCB_SCREENSAVER_KIND_BLANKED = 0, 29 XCB_SCREENSAVER_KIND_INTERNAL = 1, 30 XCB_SCREENSAVER_KIND_EXTERNAL = 2 31 } xcb_screensaver_kind_t; 32 33 typedef enum xcb_screensaver_event_t { 34 XCB_SCREENSAVER_EVENT_NOTIFY_MASK = 1, 35 XCB_SCREENSAVER_EVENT_CYCLE_MASK = 2 36 } xcb_screensaver_event_t; 37 38 typedef enum xcb_screensaver_state_t { 39 XCB_SCREENSAVER_STATE_OFF = 0, 40 XCB_SCREENSAVER_STATE_ON = 1, 41 XCB_SCREENSAVER_STATE_CYCLE = 2, 42 XCB_SCREENSAVER_STATE_DISABLED = 3 43 } xcb_screensaver_state_t; 44 45 /** 46 * @brief xcb_screensaver_query_version_cookie_t 47 **/ 48 typedef struct xcb_screensaver_query_version_cookie_t { 49 unsigned int sequence; /**< */ 50 } xcb_screensaver_query_version_cookie_t; 51 52 /** Opcode for xcb_screensaver_query_version. */ 53 #define XCB_SCREENSAVER_QUERY_VERSION 0 54 55 /** 56 * @brief xcb_screensaver_query_version_request_t 57 **/ 58 typedef struct xcb_screensaver_query_version_request_t { 59 uint8_t major_opcode; /**< */ 60 uint8_t minor_opcode; /**< */ 61 uint16_t length; /**< */ 62 uint8_t client_major_version; /**< */ 63 uint8_t client_minor_version; /**< */ 64 uint8_t pad0[2]; /**< */ 65 } xcb_screensaver_query_version_request_t; 66 67 /** 68 * @brief xcb_screensaver_query_version_reply_t 69 **/ 70 typedef struct xcb_screensaver_query_version_reply_t { 71 uint8_t response_type; /**< */ 72 uint8_t pad0; /**< */ 73 uint16_t sequence; /**< */ 74 uint32_t length; /**< */ 75 uint16_t server_major_version; /**< */ 76 uint16_t server_minor_version; /**< */ 77 uint8_t pad1[20]; /**< */ 78 } xcb_screensaver_query_version_reply_t; 79 80 /** 81 * @brief xcb_screensaver_query_info_cookie_t 82 **/ 83 typedef struct xcb_screensaver_query_info_cookie_t { 84 unsigned int sequence; /**< */ 85 } xcb_screensaver_query_info_cookie_t; 86 87 /** Opcode for xcb_screensaver_query_info. */ 88 #define XCB_SCREENSAVER_QUERY_INFO 1 89 90 /** 91 * @brief xcb_screensaver_query_info_request_t 92 **/ 93 typedef struct xcb_screensaver_query_info_request_t { 94 uint8_t major_opcode; /**< */ 95 uint8_t minor_opcode; /**< */ 96 uint16_t length; /**< */ 97 xcb_drawable_t drawable; /**< */ 98 } xcb_screensaver_query_info_request_t; 99 100 /** 101 * @brief xcb_screensaver_query_info_reply_t 102 **/ 103 typedef struct xcb_screensaver_query_info_reply_t { 104 uint8_t response_type; /**< */ 105 uint8_t state; /**< */ 106 uint16_t sequence; /**< */ 107 uint32_t length; /**< */ 108 xcb_window_t saver_window; /**< */ 109 uint32_t ms_until_server; /**< */ 110 uint32_t ms_since_user_input; /**< */ 111 uint32_t event_mask; /**< */ 112 uint8_t kind; /**< */ 113 uint8_t pad0[7]; /**< */ 114 } xcb_screensaver_query_info_reply_t; 115 116 /** Opcode for xcb_screensaver_select_input. */ 117 #define XCB_SCREENSAVER_SELECT_INPUT 2 118 119 /** 120 * @brief xcb_screensaver_select_input_request_t 121 **/ 122 typedef struct xcb_screensaver_select_input_request_t { 123 uint8_t major_opcode; /**< */ 124 uint8_t minor_opcode; /**< */ 125 uint16_t length; /**< */ 126 xcb_drawable_t drawable; /**< */ 127 uint32_t event_mask; /**< */ 128 } xcb_screensaver_select_input_request_t; 129 130 /** Opcode for xcb_screensaver_set_attributes. */ 131 #define XCB_SCREENSAVER_SET_ATTRIBUTES 3 132 133 /** 134 * @brief xcb_screensaver_set_attributes_request_t 135 **/ 136 typedef struct xcb_screensaver_set_attributes_request_t { 137 uint8_t major_opcode; /**< */ 138 uint8_t minor_opcode; /**< */ 139 uint16_t length; /**< */ 140 xcb_drawable_t drawable; /**< */ 141 int16_t x; /**< */ 142 int16_t y; /**< */ 143 uint16_t width; /**< */ 144 uint16_t height; /**< */ 145 uint16_t border_width; /**< */ 146 uint8_t _class; /**< */ 147 uint8_t depth; /**< */ 148 xcb_visualid_t visual; /**< */ 149 uint32_t value_mask; /**< */ 150 } xcb_screensaver_set_attributes_request_t; 151 152 /** Opcode for xcb_screensaver_unset_attributes. */ 153 #define XCB_SCREENSAVER_UNSET_ATTRIBUTES 4 154 155 /** 156 * @brief xcb_screensaver_unset_attributes_request_t 157 **/ 158 typedef struct xcb_screensaver_unset_attributes_request_t { 159 uint8_t major_opcode; /**< */ 160 uint8_t minor_opcode; /**< */ 161 uint16_t length; /**< */ 162 xcb_drawable_t drawable; /**< */ 163 } xcb_screensaver_unset_attributes_request_t; 164 165 /** Opcode for xcb_screensaver_suspend. */ 166 #define XCB_SCREENSAVER_SUSPEND 5 167 168 /** 169 * @brief xcb_screensaver_suspend_request_t 170 **/ 171 typedef struct xcb_screensaver_suspend_request_t { 172 uint8_t major_opcode; /**< */ 173 uint8_t minor_opcode; /**< */ 174 uint16_t length; /**< */ 175 uint8_t suspend; /**< */ 176 uint8_t pad0[3]; /**< */ 177 } xcb_screensaver_suspend_request_t; 178 179 /** Opcode for xcb_screensaver_notify. */ 180 #define XCB_SCREENSAVER_NOTIFY 0 181 182 /** 183 * @brief xcb_screensaver_notify_event_t 184 **/ 185 typedef struct xcb_screensaver_notify_event_t { 186 uint8_t response_type; /**< */ 187 uint8_t state; /**< */ 188 uint16_t sequence; /**< */ 189 xcb_timestamp_t time; /**< */ 190 xcb_window_t root; /**< */ 191 xcb_window_t window; /**< */ 192 uint8_t kind; /**< */ 193 uint8_t forced; /**< */ 194 uint8_t pad0[14]; /**< */ 195 } xcb_screensaver_notify_event_t; 196 197 /** 198 * 199 * @param c The connection 200 * @return A cookie 201 * 202 * Delivers a request to the X server. 203 * 204 */ 205 206 /***************************************************************************** 207 ** 208 ** xcb_screensaver_query_version_cookie_t xcb_screensaver_query_version 209 ** 210 ** @param xcb_connection_t *c 211 ** @param uint8_t client_major_version 212 ** @param uint8_t client_minor_version 213 ** @returns xcb_screensaver_query_version_cookie_t 214 ** 215 *****************************************************************************/ 216 217 xcb_screensaver_query_version_cookie_t 218 xcb_screensaver_query_version (xcb_connection_t *c /**< */, 219 uint8_t client_major_version /**< */, 220 uint8_t client_minor_version /**< */); 221 222 /** 223 * 224 * @param c The connection 225 * @return A cookie 226 * 227 * Delivers a request to the X server. 228 * 229 * This form can be used only if the request will cause 230 * a reply to be generated. Any returned error will be 231 * placed in the event queue. 232 */ 233 234 /***************************************************************************** 235 ** 236 ** xcb_screensaver_query_version_cookie_t xcb_screensaver_query_version_unchecked 237 ** 238 ** @param xcb_connection_t *c 239 ** @param uint8_t client_major_version 240 ** @param uint8_t client_minor_version 241 ** @returns xcb_screensaver_query_version_cookie_t 242 ** 243 *****************************************************************************/ 244 245 xcb_screensaver_query_version_cookie_t 246 xcb_screensaver_query_version_unchecked (xcb_connection_t *c /**< */, 247 uint8_t client_major_version /**< */, 248 uint8_t client_minor_version /**< */); 249 250 /** 251 * Return the reply 252 * @param c The connection 253 * @param cookie The cookie 254 * @param e The xcb_generic_error_t supplied 255 * 256 * Returns the reply of the request asked by 257 * 258 * The parameter @p e supplied to this function must be NULL if 259 * xcb_screensaver_query_version_unchecked(). is used. 260 * Otherwise, it stores the error if any. 261 * 262 * The returned value must be freed by the caller using free(). 263 */ 264 265 /***************************************************************************** 266 ** 267 ** xcb_screensaver_query_version_reply_t * xcb_screensaver_query_version_reply 268 ** 269 ** @param xcb_connection_t *c 270 ** @param xcb_screensaver_query_version_cookie_t cookie 271 ** @param xcb_generic_error_t **e 272 ** @returns xcb_screensaver_query_version_reply_t * 273 ** 274 *****************************************************************************/ 275 276 xcb_screensaver_query_version_reply_t * 277 xcb_screensaver_query_version_reply (xcb_connection_t *c /**< */, 278 xcb_screensaver_query_version_cookie_t cookie /**< */, 279 xcb_generic_error_t **e /**< */); 280 281 /** 282 * 283 * @param c The connection 284 * @return A cookie 285 * 286 * Delivers a request to the X server. 287 * 288 */ 289 290 /***************************************************************************** 291 ** 292 ** xcb_screensaver_query_info_cookie_t xcb_screensaver_query_info 293 ** 294 ** @param xcb_connection_t *c 295 ** @param xcb_drawable_t drawable 296 ** @returns xcb_screensaver_query_info_cookie_t 297 ** 298 *****************************************************************************/ 299 300 xcb_screensaver_query_info_cookie_t 301 xcb_screensaver_query_info (xcb_connection_t *c /**< */, 302 xcb_drawable_t drawable /**< */); 303 304 /** 305 * 306 * @param c The connection 307 * @return A cookie 308 * 309 * Delivers a request to the X server. 310 * 311 * This form can be used only if the request will cause 312 * a reply to be generated. Any returned error will be 313 * placed in the event queue. 314 */ 315 316 /***************************************************************************** 317 ** 318 ** xcb_screensaver_query_info_cookie_t xcb_screensaver_query_info_unchecked 319 ** 320 ** @param xcb_connection_t *c 321 ** @param xcb_drawable_t drawable 322 ** @returns xcb_screensaver_query_info_cookie_t 323 ** 324 *****************************************************************************/ 325 326 xcb_screensaver_query_info_cookie_t 327 xcb_screensaver_query_info_unchecked (xcb_connection_t *c /**< */, 328 xcb_drawable_t drawable /**< */); 329 330 /** 331 * Return the reply 332 * @param c The connection 333 * @param cookie The cookie 334 * @param e The xcb_generic_error_t supplied 335 * 336 * Returns the reply of the request asked by 337 * 338 * The parameter @p e supplied to this function must be NULL if 339 * xcb_screensaver_query_info_unchecked(). is used. 340 * Otherwise, it stores the error if any. 341 * 342 * The returned value must be freed by the caller using free(). 343 */ 344 345 /***************************************************************************** 346 ** 347 ** xcb_screensaver_query_info_reply_t * xcb_screensaver_query_info_reply 348 ** 349 ** @param xcb_connection_t *c 350 ** @param xcb_screensaver_query_info_cookie_t cookie 351 ** @param xcb_generic_error_t **e 352 ** @returns xcb_screensaver_query_info_reply_t * 353 ** 354 *****************************************************************************/ 355 356 xcb_screensaver_query_info_reply_t * 357 xcb_screensaver_query_info_reply (xcb_connection_t *c /**< */, 358 xcb_screensaver_query_info_cookie_t cookie /**< */, 359 xcb_generic_error_t **e /**< */); 360 361 /** 362 * 363 * @param c The connection 364 * @return A cookie 365 * 366 * Delivers a request to the X server. 367 * 368 * This form can be used only if the request will not cause 369 * a reply to be generated. Any returned error will be 370 * saved for handling by xcb_request_check(). 371 */ 372 373 /***************************************************************************** 374 ** 375 ** xcb_void_cookie_t xcb_screensaver_select_input_checked 376 ** 377 ** @param xcb_connection_t *c 378 ** @param xcb_drawable_t drawable 379 ** @param uint32_t event_mask 380 ** @returns xcb_void_cookie_t 381 ** 382 *****************************************************************************/ 383 384 xcb_void_cookie_t 385 xcb_screensaver_select_input_checked (xcb_connection_t *c /**< */, 386 xcb_drawable_t drawable /**< */, 387 uint32_t event_mask /**< */); 388 389 /** 390 * 391 * @param c The connection 392 * @return A cookie 393 * 394 * Delivers a request to the X server. 395 * 396 */ 397 398 /***************************************************************************** 399 ** 400 ** xcb_void_cookie_t xcb_screensaver_select_input 401 ** 402 ** @param xcb_connection_t *c 403 ** @param xcb_drawable_t drawable 404 ** @param uint32_t event_mask 405 ** @returns xcb_void_cookie_t 406 ** 407 *****************************************************************************/ 408 409 xcb_void_cookie_t 410 xcb_screensaver_select_input (xcb_connection_t *c /**< */, 411 xcb_drawable_t drawable /**< */, 412 uint32_t event_mask /**< */); 413 414 int 415 xcb_screensaver_set_attributes_sizeof (const void *_buffer /**< */); 416 417 /** 418 * 419 * @param c The connection 420 * @return A cookie 421 * 422 * Delivers a request to the X server. 423 * 424 * This form can be used only if the request will not cause 425 * a reply to be generated. Any returned error will be 426 * saved for handling by xcb_request_check(). 427 */ 428 429 /***************************************************************************** 430 ** 431 ** xcb_void_cookie_t xcb_screensaver_set_attributes_checked 432 ** 433 ** @param xcb_connection_t *c 434 ** @param xcb_drawable_t drawable 435 ** @param int16_t x 436 ** @param int16_t y 437 ** @param uint16_t width 438 ** @param uint16_t height 439 ** @param uint16_t border_width 440 ** @param uint8_t _class 441 ** @param uint8_t depth 442 ** @param xcb_visualid_t visual 443 ** @param uint32_t value_mask 444 ** @param const uint32_t *value_list 445 ** @returns xcb_void_cookie_t 446 ** 447 *****************************************************************************/ 448 449 xcb_void_cookie_t 450 xcb_screensaver_set_attributes_checked (xcb_connection_t *c /**< */, 451 xcb_drawable_t drawable /**< */, 452 int16_t x /**< */, 453 int16_t y /**< */, 454 uint16_t width /**< */, 455 uint16_t height /**< */, 456 uint16_t border_width /**< */, 457 uint8_t _class /**< */, 458 uint8_t depth /**< */, 459 xcb_visualid_t visual /**< */, 460 uint32_t value_mask /**< */, 461 const uint32_t *value_list /**< */); 462 463 /** 464 * 465 * @param c The connection 466 * @return A cookie 467 * 468 * Delivers a request to the X server. 469 * 470 */ 471 472 /***************************************************************************** 473 ** 474 ** xcb_void_cookie_t xcb_screensaver_set_attributes 475 ** 476 ** @param xcb_connection_t *c 477 ** @param xcb_drawable_t drawable 478 ** @param int16_t x 479 ** @param int16_t y 480 ** @param uint16_t width 481 ** @param uint16_t height 482 ** @param uint16_t border_width 483 ** @param uint8_t _class 484 ** @param uint8_t depth 485 ** @param xcb_visualid_t visual 486 ** @param uint32_t value_mask 487 ** @param const uint32_t *value_list 488 ** @returns xcb_void_cookie_t 489 ** 490 *****************************************************************************/ 491 492 xcb_void_cookie_t 493 xcb_screensaver_set_attributes (xcb_connection_t *c /**< */, 494 xcb_drawable_t drawable /**< */, 495 int16_t x /**< */, 496 int16_t y /**< */, 497 uint16_t width /**< */, 498 uint16_t height /**< */, 499 uint16_t border_width /**< */, 500 uint8_t _class /**< */, 501 uint8_t depth /**< */, 502 xcb_visualid_t visual /**< */, 503 uint32_t value_mask /**< */, 504 const uint32_t *value_list /**< */); 505 506 /** 507 * 508 * @param c The connection 509 * @return A cookie 510 * 511 * Delivers a request to the X server. 512 * 513 * This form can be used only if the request will not cause 514 * a reply to be generated. Any returned error will be 515 * saved for handling by xcb_request_check(). 516 */ 517 518 /***************************************************************************** 519 ** 520 ** xcb_void_cookie_t xcb_screensaver_unset_attributes_checked 521 ** 522 ** @param xcb_connection_t *c 523 ** @param xcb_drawable_t drawable 524 ** @returns xcb_void_cookie_t 525 ** 526 *****************************************************************************/ 527 528 xcb_void_cookie_t 529 xcb_screensaver_unset_attributes_checked (xcb_connection_t *c /**< */, 530 xcb_drawable_t drawable /**< */); 531 532 /** 533 * 534 * @param c The connection 535 * @return A cookie 536 * 537 * Delivers a request to the X server. 538 * 539 */ 540 541 /***************************************************************************** 542 ** 543 ** xcb_void_cookie_t xcb_screensaver_unset_attributes 544 ** 545 ** @param xcb_connection_t *c 546 ** @param xcb_drawable_t drawable 547 ** @returns xcb_void_cookie_t 548 ** 549 *****************************************************************************/ 550 551 xcb_void_cookie_t 552 xcb_screensaver_unset_attributes (xcb_connection_t *c /**< */, 553 xcb_drawable_t drawable /**< */); 554 555 /** 556 * 557 * @param c The connection 558 * @return A cookie 559 * 560 * Delivers a request to the X server. 561 * 562 * This form can be used only if the request will not cause 563 * a reply to be generated. Any returned error will be 564 * saved for handling by xcb_request_check(). 565 */ 566 567 /***************************************************************************** 568 ** 569 ** xcb_void_cookie_t xcb_screensaver_suspend_checked 570 ** 571 ** @param xcb_connection_t *c 572 ** @param uint8_t suspend 573 ** @returns xcb_void_cookie_t 574 ** 575 *****************************************************************************/ 576 577 xcb_void_cookie_t 578 xcb_screensaver_suspend_checked (xcb_connection_t *c /**< */, 579 uint8_t suspend /**< */); 580 581 /** 582 * 583 * @param c The connection 584 * @return A cookie 585 * 586 * Delivers a request to the X server. 587 * 588 */ 589 590 /***************************************************************************** 591 ** 592 ** xcb_void_cookie_t xcb_screensaver_suspend 593 ** 594 ** @param xcb_connection_t *c 595 ** @param uint8_t suspend 596 ** @returns xcb_void_cookie_t 597 ** 598 *****************************************************************************/ 599 600 xcb_void_cookie_t 601 xcb_screensaver_suspend (xcb_connection_t *c /**< */, 602 uint8_t suspend /**< */); 603 604 605 #ifdef __cplusplus 606 } 607 #endif 608 609 #endif 610 611 /** 612 * @} 613 */ 614