home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / xcb / xevie.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-09-17  |  18.2 KB  |  650 lines
  1. /*
  2.  * This file generated automatically from xevie.xml by c-client.xsl using XSLT.
  3.  * Edit at your peril.
  4.  */
  5.  
  6. /**
  7.  * @defgroup XCB_Xevie_API XCB Xevie API
  8.  * @brief Xevie XCB Protocol Implementation.
  9.  * @{
  10.  **/
  11.  
  12. #ifndef __XEVIE_H
  13. #define __XEVIE_H
  14.  
  15. #include "xcb.h"
  16.  
  17. #define XCB_XEVIE_MAJOR_VERSION 1
  18. #define XCB_XEVIE_MINOR_VERSION 0
  19.   
  20. extern xcb_extension_t xcb_xevie_id;
  21.  
  22. /**
  23.  * @brief xcb_xevie_query_version_cookie_t
  24.  **/
  25. typedef struct xcb_xevie_query_version_cookie_t {
  26.     unsigned int sequence; /**<  */
  27. } xcb_xevie_query_version_cookie_t;
  28.  
  29. /** Opcode for xcb_xevie_query_version. */
  30. #define XCB_XEVIE_QUERY_VERSION 0
  31.  
  32. /**
  33.  * @brief xcb_xevie_query_version_request_t
  34.  **/
  35. typedef struct xcb_xevie_query_version_request_t {
  36.     uint8_t  major_opcode; /**<  */
  37.     uint8_t  minor_opcode; /**<  */
  38.     uint16_t length; /**<  */
  39.     uint16_t client_major_version; /**<  */
  40.     uint16_t client_minor_version; /**<  */
  41. } xcb_xevie_query_version_request_t;
  42.  
  43. /**
  44.  * @brief xcb_xevie_query_version_reply_t
  45.  **/
  46. typedef struct xcb_xevie_query_version_reply_t {
  47.     uint8_t  response_type; /**<  */
  48.     uint8_t  pad0; /**<  */
  49.     uint16_t sequence; /**<  */
  50.     uint32_t length; /**<  */
  51.     uint16_t server_major_version; /**<  */
  52.     uint16_t server_minor_version; /**<  */
  53.     uint8_t  pad1[20]; /**<  */
  54. } xcb_xevie_query_version_reply_t;
  55.  
  56. /**
  57.  * @brief xcb_xevie_start_cookie_t
  58.  **/
  59. typedef struct xcb_xevie_start_cookie_t {
  60.     unsigned int sequence; /**<  */
  61. } xcb_xevie_start_cookie_t;
  62.  
  63. /** Opcode for xcb_xevie_start. */
  64. #define XCB_XEVIE_START 1
  65.  
  66. /**
  67.  * @brief xcb_xevie_start_request_t
  68.  **/
  69. typedef struct xcb_xevie_start_request_t {
  70.     uint8_t  major_opcode; /**<  */
  71.     uint8_t  minor_opcode; /**<  */
  72.     uint16_t length; /**<  */
  73.     uint32_t screen; /**<  */
  74. } xcb_xevie_start_request_t;
  75.  
  76. /**
  77.  * @brief xcb_xevie_start_reply_t
  78.  **/
  79. typedef struct xcb_xevie_start_reply_t {
  80.     uint8_t  response_type; /**<  */
  81.     uint8_t  pad0; /**<  */
  82.     uint16_t sequence; /**<  */
  83.     uint32_t length; /**<  */
  84.     uint8_t  pad1[24]; /**<  */
  85. } xcb_xevie_start_reply_t;
  86.  
  87. /**
  88.  * @brief xcb_xevie_end_cookie_t
  89.  **/
  90. typedef struct xcb_xevie_end_cookie_t {
  91.     unsigned int sequence; /**<  */
  92. } xcb_xevie_end_cookie_t;
  93.  
  94. /** Opcode for xcb_xevie_end. */
  95. #define XCB_XEVIE_END 2
  96.  
  97. /**
  98.  * @brief xcb_xevie_end_request_t
  99.  **/
  100. typedef struct xcb_xevie_end_request_t {
  101.     uint8_t  major_opcode; /**<  */
  102.     uint8_t  minor_opcode; /**<  */
  103.     uint16_t length; /**<  */
  104.     uint32_t cmap; /**<  */
  105. } xcb_xevie_end_request_t;
  106.  
  107. /**
  108.  * @brief xcb_xevie_end_reply_t
  109.  **/
  110. typedef struct xcb_xevie_end_reply_t {
  111.     uint8_t  response_type; /**<  */
  112.     uint8_t  pad0; /**<  */
  113.     uint16_t sequence; /**<  */
  114.     uint32_t length; /**<  */
  115.     uint8_t  pad1[24]; /**<  */
  116. } xcb_xevie_end_reply_t;
  117.  
  118. typedef enum xcb_xevie_datatype_t {
  119.     XCB_XEVIE_DATATYPE_UNMODIFIED,
  120.     XCB_XEVIE_DATATYPE_MODIFIED
  121. } xcb_xevie_datatype_t;
  122.  
  123. /**
  124.  * @brief xcb_xevie_event_t
  125.  **/
  126. typedef struct xcb_xevie_event_t {
  127.     uint8_t pad0[32]; /**<  */
  128. } xcb_xevie_event_t;
  129.  
  130. /**
  131.  * @brief xcb_xevie_event_iterator_t
  132.  **/
  133. typedef struct xcb_xevie_event_iterator_t {
  134.     xcb_xevie_event_t *data; /**<  */
  135.     int                rem; /**<  */
  136.     int                index; /**<  */
  137. } xcb_xevie_event_iterator_t;
  138.  
  139. /**
  140.  * @brief xcb_xevie_send_cookie_t
  141.  **/
  142. typedef struct xcb_xevie_send_cookie_t {
  143.     unsigned int sequence; /**<  */
  144. } xcb_xevie_send_cookie_t;
  145.  
  146. /** Opcode for xcb_xevie_send. */
  147. #define XCB_XEVIE_SEND 3
  148.  
  149. /**
  150.  * @brief xcb_xevie_send_request_t
  151.  **/
  152. typedef struct xcb_xevie_send_request_t {
  153.     uint8_t           major_opcode; /**<  */
  154.     uint8_t           minor_opcode; /**<  */
  155.     uint16_t          length; /**<  */
  156.     xcb_xevie_event_t event; /**<  */
  157.     uint32_t          data_type; /**<  */
  158.     uint8_t           pad0[64]; /**<  */
  159. } xcb_xevie_send_request_t;
  160.  
  161. /**
  162.  * @brief xcb_xevie_send_reply_t
  163.  **/
  164. typedef struct xcb_xevie_send_reply_t {
  165.     uint8_t  response_type; /**<  */
  166.     uint8_t  pad0; /**<  */
  167.     uint16_t sequence; /**<  */
  168.     uint32_t length; /**<  */
  169.     uint8_t  pad1[24]; /**<  */
  170. } xcb_xevie_send_reply_t;
  171.  
  172. /**
  173.  * @brief xcb_xevie_select_input_cookie_t
  174.  **/
  175. typedef struct xcb_xevie_select_input_cookie_t {
  176.     unsigned int sequence; /**<  */
  177. } xcb_xevie_select_input_cookie_t;
  178.  
  179. /** Opcode for xcb_xevie_select_input. */
  180. #define XCB_XEVIE_SELECT_INPUT 4
  181.  
  182. /**
  183.  * @brief xcb_xevie_select_input_request_t
  184.  **/
  185. typedef struct xcb_xevie_select_input_request_t {
  186.     uint8_t  major_opcode; /**<  */
  187.     uint8_t  minor_opcode; /**<  */
  188.     uint16_t length; /**<  */
  189.     uint32_t event_mask; /**<  */
  190. } xcb_xevie_select_input_request_t;
  191.  
  192. /**
  193.  * @brief xcb_xevie_select_input_reply_t
  194.  **/
  195. typedef struct xcb_xevie_select_input_reply_t {
  196.     uint8_t  response_type; /**<  */
  197.     uint8_t  pad0; /**<  */
  198.     uint16_t sequence; /**<  */
  199.     uint32_t length; /**<  */
  200.     uint8_t  pad1[24]; /**<  */
  201. } xcb_xevie_select_input_reply_t;
  202.  
  203. /**
  204.  * Delivers a request to the X server
  205.  * @param c The connection
  206.  * @return A cookie
  207.  *
  208.  * Delivers a request to the X server.
  209.  * 
  210.  */
  211.  
  212. /*****************************************************************************
  213.  **
  214.  ** xcb_xevie_query_version_cookie_t xcb_xevie_query_version
  215.  ** 
  216.  ** @param xcb_connection_t *c
  217.  ** @param uint16_t          client_major_version
  218.  ** @param uint16_t          client_minor_version
  219.  ** @returns xcb_xevie_query_version_cookie_t
  220.  **
  221.  *****************************************************************************/
  222.  
  223. xcb_xevie_query_version_cookie_t
  224. xcb_xevie_query_version (xcb_connection_t *c  /**< */,
  225.                          uint16_t          client_major_version  /**< */,
  226.                          uint16_t          client_minor_version  /**< */);
  227.  
  228. /**
  229.  * Delivers a request to the X server
  230.  * @param c The connection
  231.  * @return A cookie
  232.  *
  233.  * Delivers a request to the X server.
  234.  * 
  235.  * This form can be used only if the request will cause
  236.  * a reply to be generated. Any returned error will be
  237.  * placed in the event queue.
  238.  */
  239.  
  240. /*****************************************************************************
  241.  **
  242.  ** xcb_xevie_query_version_cookie_t xcb_xevie_query_version_unchecked
  243.  ** 
  244.  ** @param xcb_connection_t *c
  245.  ** @param uint16_t          client_major_version
  246.  ** @param uint16_t          client_minor_version
  247.  ** @returns xcb_xevie_query_version_cookie_t
  248.  **
  249.  *****************************************************************************/
  250.  
  251. xcb_xevie_query_version_cookie_t
  252. xcb_xevie_query_version_unchecked (xcb_connection_t *c  /**< */,
  253.                                    uint16_t          client_major_version  /**< */,
  254.                                    uint16_t          client_minor_version  /**< */);
  255.  
  256. /**
  257.  * Return the reply
  258.  * @param c      The connection
  259.  * @param cookie The cookie
  260.  * @param e      The xcb_generic_error_t supplied
  261.  *
  262.  * Returns the reply of the request asked by
  263.  * 
  264.  * The parameter @p e supplied to this function must be NULL if
  265.  * xcb_xevie_query_version_unchecked(). is used.
  266.  * Otherwise, it stores the error if any.
  267.  */
  268.  
  269. /*****************************************************************************
  270.  **
  271.  ** xcb_xevie_query_version_reply_t * xcb_xevie_query_version_reply
  272.  ** 
  273.  ** @param xcb_connection_t                  *c
  274.  ** @param xcb_xevie_query_version_cookie_t   cookie
  275.  ** @param xcb_generic_error_t              **e
  276.  ** @returns xcb_xevie_query_version_reply_t *
  277.  **
  278.  *****************************************************************************/
  279.  
  280. xcb_xevie_query_version_reply_t *
  281. xcb_xevie_query_version_reply (xcb_connection_t                  *c  /**< */,
  282.                                xcb_xevie_query_version_cookie_t   cookie  /**< */,
  283.                                xcb_generic_error_t              **e  /**< */);
  284.  
  285. /**
  286.  * Delivers a request to the X server
  287.  * @param c The connection
  288.  * @return A cookie
  289.  *
  290.  * Delivers a request to the X server.
  291.  * 
  292.  */
  293.  
  294. /*****************************************************************************
  295.  **
  296.  ** xcb_xevie_start_cookie_t xcb_xevie_start
  297.  ** 
  298.  ** @param xcb_connection_t *c
  299.  ** @param uint32_t          screen
  300.  ** @returns xcb_xevie_start_cookie_t
  301.  **
  302.  *****************************************************************************/
  303.  
  304. xcb_xevie_start_cookie_t
  305. xcb_xevie_start (xcb_connection_t *c  /**< */,
  306.                  uint32_t          screen  /**< */);
  307.  
  308. /**
  309.  * Delivers a request to the X server
  310.  * @param c The connection
  311.  * @return A cookie
  312.  *
  313.  * Delivers a request to the X server.
  314.  * 
  315.  * This form can be used only if the request will cause
  316.  * a reply to be generated. Any returned error will be
  317.  * placed in the event queue.
  318.  */
  319.  
  320. /*****************************************************************************
  321.  **
  322.  ** xcb_xevie_start_cookie_t xcb_xevie_start_unchecked
  323.  ** 
  324.  ** @param xcb_connection_t *c
  325.  ** @param uint32_t          screen
  326.  ** @returns xcb_xevie_start_cookie_t
  327.  **
  328.  *****************************************************************************/
  329.  
  330. xcb_xevie_start_cookie_t
  331. xcb_xevie_start_unchecked (xcb_connection_t *c  /**< */,
  332.                            uint32_t          screen  /**< */);
  333.  
  334. /**
  335.  * Return the reply
  336.  * @param c      The connection
  337.  * @param cookie The cookie
  338.  * @param e      The xcb_generic_error_t supplied
  339.  *
  340.  * Returns the reply of the request asked by
  341.  * 
  342.  * The parameter @p e supplied to this function must be NULL if
  343.  * xcb_xevie_start_unchecked(). is used.
  344.  * Otherwise, it stores the error if any.
  345.  */
  346.  
  347. /*****************************************************************************
  348.  **
  349.  ** xcb_xevie_start_reply_t * xcb_xevie_start_reply
  350.  ** 
  351.  ** @param xcb_connection_t          *c
  352.  ** @param xcb_xevie_start_cookie_t   cookie
  353.  ** @param xcb_generic_error_t      **e
  354.  ** @returns xcb_xevie_start_reply_t *
  355.  **
  356.  *****************************************************************************/
  357.  
  358. xcb_xevie_start_reply_t *
  359. xcb_xevie_start_reply (xcb_connection_t          *c  /**< */,
  360.                        xcb_xevie_start_cookie_t   cookie  /**< */,
  361.                        xcb_generic_error_t      **e  /**< */);
  362.  
  363. /**
  364.  * Delivers a request to the X server
  365.  * @param c The connection
  366.  * @return A cookie
  367.  *
  368.  * Delivers a request to the X server.
  369.  * 
  370.  */
  371.  
  372. /*****************************************************************************
  373.  **
  374.  ** xcb_xevie_end_cookie_t xcb_xevie_end
  375.  ** 
  376.  ** @param xcb_connection_t *c
  377.  ** @param uint32_t          cmap
  378.  ** @returns xcb_xevie_end_cookie_t
  379.  **
  380.  *****************************************************************************/
  381.  
  382. xcb_xevie_end_cookie_t
  383. xcb_xevie_end (xcb_connection_t *c  /**< */,
  384.                uint32_t          cmap  /**< */);
  385.  
  386. /**
  387.  * Delivers a request to the X server
  388.  * @param c The connection
  389.  * @return A cookie
  390.  *
  391.  * Delivers a request to the X server.
  392.  * 
  393.  * This form can be used only if the request will cause
  394.  * a reply to be generated. Any returned error will be
  395.  * placed in the event queue.
  396.  */
  397.  
  398. /*****************************************************************************
  399.  **
  400.  ** xcb_xevie_end_cookie_t xcb_xevie_end_unchecked
  401.  ** 
  402.  ** @param xcb_connection_t *c
  403.  ** @param uint32_t          cmap
  404.  ** @returns xcb_xevie_end_cookie_t
  405.  **
  406.  *****************************************************************************/
  407.  
  408. xcb_xevie_end_cookie_t
  409. xcb_xevie_end_unchecked (xcb_connection_t *c  /**< */,
  410.                          uint32_t          cmap  /**< */);
  411.  
  412. /**
  413.  * Return the reply
  414.  * @param c      The connection
  415.  * @param cookie The cookie
  416.  * @param e      The xcb_generic_error_t supplied
  417.  *
  418.  * Returns the reply of the request asked by
  419.  * 
  420.  * The parameter @p e supplied to this function must be NULL if
  421.  * xcb_xevie_end_unchecked(). is used.
  422.  * Otherwise, it stores the error if any.
  423.  */
  424.  
  425. /*****************************************************************************
  426.  **
  427.  ** xcb_xevie_end_reply_t * xcb_xevie_end_reply
  428.  ** 
  429.  ** @param xcb_connection_t        *c
  430.  ** @param xcb_xevie_end_cookie_t   cookie
  431.  ** @param xcb_generic_error_t    **e
  432.  ** @returns xcb_xevie_end_reply_t *
  433.  **
  434.  *****************************************************************************/
  435.  
  436. xcb_xevie_end_reply_t *
  437. xcb_xevie_end_reply (xcb_connection_t        *c  /**< */,
  438.                      xcb_xevie_end_cookie_t   cookie  /**< */,
  439.                      xcb_generic_error_t    **e  /**< */);
  440.  
  441. /**
  442.  * Get the next element of the iterator
  443.  * @param i Pointer to a xcb_xevie_event_iterator_t
  444.  *
  445.  * Get the next element in the iterator. The member rem is
  446.  * decreased by one. The member data points to the next
  447.  * element. The member index is increased by sizeof(xcb_xevie_event_t)
  448.  */
  449.  
  450. /*****************************************************************************
  451.  **
  452.  ** void xcb_xevie_event_next
  453.  ** 
  454.  ** @param xcb_xevie_event_iterator_t *i
  455.  ** @returns void
  456.  **
  457.  *****************************************************************************/
  458.  
  459. void
  460. xcb_xevie_event_next (xcb_xevie_event_iterator_t *i  /**< */);
  461.  
  462. /**
  463.  * Return the iterator pointing to the last element
  464.  * @param i An xcb_xevie_event_iterator_t
  465.  * @return  The iterator pointing to the last element
  466.  *
  467.  * Set the current element in the iterator to the last element.
  468.  * The member rem is set to 0. The member data points to the
  469.  * last element.
  470.  */
  471.  
  472. /*****************************************************************************
  473.  **
  474.  ** xcb_generic_iterator_t xcb_xevie_event_end
  475.  ** 
  476.  ** @param xcb_xevie_event_iterator_t i
  477.  ** @returns xcb_generic_iterator_t
  478.  **
  479.  *****************************************************************************/
  480.  
  481. xcb_generic_iterator_t
  482. xcb_xevie_event_end (xcb_xevie_event_iterator_t i  /**< */);
  483.  
  484. /**
  485.  * Delivers a request to the X server
  486.  * @param c The connection
  487.  * @return A cookie
  488.  *
  489.  * Delivers a request to the X server.
  490.  * 
  491.  */
  492.  
  493. /*****************************************************************************
  494.  **
  495.  ** xcb_xevie_send_cookie_t xcb_xevie_send
  496.  ** 
  497.  ** @param xcb_connection_t  *c
  498.  ** @param xcb_xevie_event_t  event
  499.  ** @param uint32_t           data_type
  500.  ** @returns xcb_xevie_send_cookie_t
  501.  **
  502.  *****************************************************************************/
  503.  
  504. xcb_xevie_send_cookie_t
  505. xcb_xevie_send (xcb_connection_t  *c  /**< */,
  506.                 xcb_xevie_event_t  event  /**< */,
  507.                 uint32_t           data_type  /**< */);
  508.  
  509. /**
  510.  * Delivers a request to the X server
  511.  * @param c The connection
  512.  * @return A cookie
  513.  *
  514.  * Delivers a request to the X server.
  515.  * 
  516.  * This form can be used only if the request will cause
  517.  * a reply to be generated. Any returned error will be
  518.  * placed in the event queue.
  519.  */
  520.  
  521. /*****************************************************************************
  522.  **
  523.  ** xcb_xevie_send_cookie_t xcb_xevie_send_unchecked
  524.  ** 
  525.  ** @param xcb_connection_t  *c
  526.  ** @param xcb_xevie_event_t  event
  527.  ** @param uint32_t           data_type
  528.  ** @returns xcb_xevie_send_cookie_t
  529.  **
  530.  *****************************************************************************/
  531.  
  532. xcb_xevie_send_cookie_t
  533. xcb_xevie_send_unchecked (xcb_connection_t  *c  /**< */,
  534.                           xcb_xevie_event_t  event  /**< */,
  535.                           uint32_t           data_type  /**< */);
  536.  
  537. /**
  538.  * Return the reply
  539.  * @param c      The connection
  540.  * @param cookie The cookie
  541.  * @param e      The xcb_generic_error_t supplied
  542.  *
  543.  * Returns the reply of the request asked by
  544.  * 
  545.  * The parameter @p e supplied to this function must be NULL if
  546.  * xcb_xevie_send_unchecked(). is used.
  547.  * Otherwise, it stores the error if any.
  548.  */
  549.  
  550. /*****************************************************************************
  551.  **
  552.  ** xcb_xevie_send_reply_t * xcb_xevie_send_reply
  553.  ** 
  554.  ** @param xcb_connection_t         *c
  555.  ** @param xcb_xevie_send_cookie_t   cookie
  556.  ** @param xcb_generic_error_t     **e
  557.  ** @returns xcb_xevie_send_reply_t *
  558.  **
  559.  *****************************************************************************/
  560.  
  561. xcb_xevie_send_reply_t *
  562. xcb_xevie_send_reply (xcb_connection_t         *c  /**< */,
  563.                       xcb_xevie_send_cookie_t   cookie  /**< */,
  564.                       xcb_generic_error_t     **e  /**< */);
  565.  
  566. /**
  567.  * Delivers a request to the X server
  568.  * @param c The connection
  569.  * @return A cookie
  570.  *
  571.  * Delivers a request to the X server.
  572.  * 
  573.  */
  574.  
  575. /*****************************************************************************
  576.  **
  577.  ** xcb_xevie_select_input_cookie_t xcb_xevie_select_input
  578.  ** 
  579.  ** @param xcb_connection_t *c
  580.  ** @param uint32_t          event_mask
  581.  ** @returns xcb_xevie_select_input_cookie_t
  582.  **
  583.  *****************************************************************************/
  584.  
  585. xcb_xevie_select_input_cookie_t
  586. xcb_xevie_select_input (xcb_connection_t *c  /**< */,
  587.                         uint32_t          event_mask  /**< */);
  588.  
  589. /**
  590.  * Delivers a request to the X server
  591.  * @param c The connection
  592.  * @return A cookie
  593.  *
  594.  * Delivers a request to the X server.
  595.  * 
  596.  * This form can be used only if the request will cause
  597.  * a reply to be generated. Any returned error will be
  598.  * placed in the event queue.
  599.  */
  600.  
  601. /*****************************************************************************
  602.  **
  603.  ** xcb_xevie_select_input_cookie_t xcb_xevie_select_input_unchecked
  604.  ** 
  605.  ** @param xcb_connection_t *c
  606.  ** @param uint32_t          event_mask
  607.  ** @returns xcb_xevie_select_input_cookie_t
  608.  **
  609.  *****************************************************************************/
  610.  
  611. xcb_xevie_select_input_cookie_t
  612. xcb_xevie_select_input_unchecked (xcb_connection_t *c  /**< */,
  613.                                   uint32_t          event_mask  /**< */);
  614.  
  615. /**
  616.  * Return the reply
  617.  * @param c      The connection
  618.  * @param cookie The cookie
  619.  * @param e      The xcb_generic_error_t supplied
  620.  *
  621.  * Returns the reply of the request asked by
  622.  * 
  623.  * The parameter @p e supplied to this function must be NULL if
  624.  * xcb_xevie_select_input_unchecked(). is used.
  625.  * Otherwise, it stores the error if any.
  626.  */
  627.  
  628. /*****************************************************************************
  629.  **
  630.  ** xcb_xevie_select_input_reply_t * xcb_xevie_select_input_reply
  631.  ** 
  632.  ** @param xcb_connection_t                 *c
  633.  ** @param xcb_xevie_select_input_cookie_t   cookie
  634.  ** @param xcb_generic_error_t             **e
  635.  ** @returns xcb_xevie_select_input_reply_t *
  636.  **
  637.  *****************************************************************************/
  638.  
  639. xcb_xevie_select_input_reply_t *
  640. xcb_xevie_select_input_reply (xcb_connection_t                 *c  /**< */,
  641.                               xcb_xevie_select_input_cookie_t   cookie  /**< */,
  642.                               xcb_generic_error_t             **e  /**< */);
  643.  
  644.  
  645. #endif
  646.  
  647. /**
  648.  * @}
  649.  */
  650.