include/xcb/xevie.h

0001 /*
0002  * This file generated automatically from xevie.xml by c_client.py.
0003  * Edit at your peril.
0004  */
0005
0006 /**
0007  * @defgroup XCB_Xevie_API XCB Xevie API
0008  * @brief Xevie XCB Protocol Implementation.
0009  * @{
0010  **/
0011
0012 #ifndef __XEVIE_H
0013 #define __XEVIE_H
0014
0015 #include "xcb.h"
0016
0017 #ifdef __cplusplus
0018 extern "C" {
0019 #endif
0020
0021 #define XCB_XEVIE_MAJOR_VERSION 1
0022 #define XCB_XEVIE_MINOR_VERSION 0
0023
0024 extern xcb_extension_t xcb_xevie_id;
0025
0026 /**
0027  * @brief xcb_xevie_query_version_cookie_t
0028  **/
0029 typedef struct xcb_xevie_query_version_cookie_t {
0030     unsigned int sequence;
0031 } xcb_xevie_query_version_cookie_t;
0032
0033 /** Opcode for xcb_xevie_query_version. */
0034 #define XCB_XEVIE_QUERY_VERSION 0
0035
0036 /**
0037  * @brief xcb_xevie_query_version_request_t
0038  **/
0039 typedef struct xcb_xevie_query_version_request_t {
0040     uint8_t  major_opcode;
0041     uint8_t  minor_opcode;
0042     uint16_t length;
0043     uint16_t client_major_version;
0044     uint16_t client_minor_version;
0045 } xcb_xevie_query_version_request_t;
0046
0047 /**
0048  * @brief xcb_xevie_query_version_reply_t
0049  **/
0050 typedef struct xcb_xevie_query_version_reply_t {
0051     uint8_t  response_type;
0052     uint8_t  pad0;
0053     uint16_t sequence;
0054     uint32_t length;
0055     uint16_t server_major_version;
0056     uint16_t server_minor_version;
0057     uint8_t  pad1[20];
0058 } xcb_xevie_query_version_reply_t;
0059
0060 /**
0061  * @brief xcb_xevie_start_cookie_t
0062  **/
0063 typedef struct xcb_xevie_start_cookie_t {
0064     unsigned int sequence;
0065 } xcb_xevie_start_cookie_t;
0066
0067 /** Opcode for xcb_xevie_start. */
0068 #define XCB_XEVIE_START 1
0069
0070 /**
0071  * @brief xcb_xevie_start_request_t
0072  **/
0073 typedef struct xcb_xevie_start_request_t {
0074     uint8_t  major_opcode;
0075     uint8_t  minor_opcode;
0076     uint16_t length;
0077     uint32_t screen;
0078 } xcb_xevie_start_request_t;
0079
0080 /**
0081  * @brief xcb_xevie_start_reply_t
0082  **/
0083 typedef struct xcb_xevie_start_reply_t {
0084     uint8_t  response_type;
0085     uint8_t  pad0;
0086     uint16_t sequence;
0087     uint32_t length;
0088     uint8_t  pad1[24];
0089 } xcb_xevie_start_reply_t;
0090
0091 /**
0092  * @brief xcb_xevie_end_cookie_t
0093  **/
0094 typedef struct xcb_xevie_end_cookie_t {
0095     unsigned int sequence;
0096 } xcb_xevie_end_cookie_t;
0097
0098 /** Opcode for xcb_xevie_end. */
0099 #define XCB_XEVIE_END 2
0100
0101 /**
0102  * @brief xcb_xevie_end_request_t
0103  **/
0104 typedef struct xcb_xevie_end_request_t {
0105     uint8_t  major_opcode;
0106     uint8_t  minor_opcode;
0107     uint16_t length;
0108     uint32_t cmap;
0109 } xcb_xevie_end_request_t;
0110
0111 /**
0112  * @brief xcb_xevie_end_reply_t
0113  **/
0114 typedef struct xcb_xevie_end_reply_t {
0115     uint8_t  response_type;
0116     uint8_t  pad0;
0117     uint16_t sequence;
0118     uint32_t length;
0119     uint8_t  pad1[24];
0120 } xcb_xevie_end_reply_t;
0121
0122 typedef enum xcb_xevie_datatype_t {
0123     XCB_XEVIE_DATATYPE_UNMODIFIED = 0,
0124     XCB_XEVIE_DATATYPE_MODIFIED = 1
0125 } xcb_xevie_datatype_t;
0126
0127 /**
0128  * @brief xcb_xevie_event_t
0129  **/
0130 typedef struct xcb_xevie_event_t {
0131     uint8_t pad0[32];
0132 } xcb_xevie_event_t;
0133
0134 /**
0135  * @brief xcb_xevie_event_iterator_t
0136  **/
0137 typedef struct xcb_xevie_event_iterator_t {
0138     xcb_xevie_event_t *data;
0139     int                rem;
0140     int                index;
0141 } xcb_xevie_event_iterator_t;
0142
0143 /**
0144  * @brief xcb_xevie_send_cookie_t
0145  **/
0146 typedef struct xcb_xevie_send_cookie_t {
0147     unsigned int sequence;
0148 } xcb_xevie_send_cookie_t;
0149
0150 /** Opcode for xcb_xevie_send. */
0151 #define XCB_XEVIE_SEND 3
0152
0153 /**
0154  * @brief xcb_xevie_send_request_t
0155  **/
0156 typedef struct xcb_xevie_send_request_t {
0157     uint8_t           major_opcode;
0158     uint8_t           minor_opcode;
0159     uint16_t          length;
0160     xcb_xevie_event_t event;
0161     uint32_t          data_type;
0162     uint8_t           pad0[64];
0163 } xcb_xevie_send_request_t;
0164
0165 /**
0166  * @brief xcb_xevie_send_reply_t
0167  **/
0168 typedef struct xcb_xevie_send_reply_t {
0169     uint8_t  response_type;
0170     uint8_t  pad0;
0171     uint16_t sequence;
0172     uint32_t length;
0173     uint8_t  pad1[24];
0174 } xcb_xevie_send_reply_t;
0175
0176 /**
0177  * @brief xcb_xevie_select_input_cookie_t
0178  **/
0179 typedef struct xcb_xevie_select_input_cookie_t {
0180     unsigned int sequence;
0181 } xcb_xevie_select_input_cookie_t;
0182
0183 /** Opcode for xcb_xevie_select_input. */
0184 #define XCB_XEVIE_SELECT_INPUT 4
0185
0186 /**
0187  * @brief xcb_xevie_select_input_request_t
0188  **/
0189 typedef struct xcb_xevie_select_input_request_t {
0190     uint8_t  major_opcode;
0191     uint8_t  minor_opcode;
0192     uint16_t length;
0193     uint32_t event_mask;
0194 } xcb_xevie_select_input_request_t;
0195
0196 /**
0197  * @brief xcb_xevie_select_input_reply_t
0198  **/
0199 typedef struct xcb_xevie_select_input_reply_t {
0200     uint8_t  response_type;
0201     uint8_t  pad0;
0202     uint16_t sequence;
0203     uint32_t length;
0204     uint8_t  pad1[24];
0205 } xcb_xevie_select_input_reply_t;
0206
0207 /**
0208  *
0209  * @param c The connection
0210  * @return A cookie
0211  *
0212  * Delivers a request to the X server.
0213  *
0214  */
0215 xcb_xevie_query_version_cookie_t
0216 xcb_xevie_query_version (xcb_connection_t *c,
0217                          uint16_t          client_major_version,
0218                          uint16_t          client_minor_version);
0219
0220 /**
0221  *
0222  * @param c The connection
0223  * @return A cookie
0224  *
0225  * Delivers a request to the X server.
0226  *
0227  * This form can be used only if the request will cause
0228  * a reply to be generated. Any returned error will be
0229  * placed in the event queue.
0230  */
0231 xcb_xevie_query_version_cookie_t
0232 xcb_xevie_query_version_unchecked (xcb_connection_t *c,
0233                                    uint16_t          client_major_version,
0234                                    uint16_t          client_minor_version);
0235
0236 /**
0237  * Return the reply
0238  * @param c      The connection
0239  * @param cookie The cookie
0240  * @param e      The xcb_generic_error_t supplied
0241  *
0242  * Returns the reply of the request asked by
0243  *
0244  * The parameter @p e supplied to this function must be NULL if
0245  * xcb_xevie_query_version_unchecked(). is used.
0246  * Otherwise, it stores the error if any.
0247  *
0248  * The returned value must be freed by the caller using free().
0249  */
0250 xcb_xevie_query_version_reply_t *
0251 xcb_xevie_query_version_reply (xcb_connection_t                  *c,
0252                                xcb_xevie_query_version_cookie_t   cookie  /**< */,
0253                                xcb_generic_error_t              **e);
0254
0255 /**
0256  *
0257  * @param c The connection
0258  * @return A cookie
0259  *
0260  * Delivers a request to the X server.
0261  *
0262  */
0263 xcb_xevie_start_cookie_t
0264 xcb_xevie_start (xcb_connection_t *c,
0265                  uint32_t          screen);
0266
0267 /**
0268  *
0269  * @param c The connection
0270  * @return A cookie
0271  *
0272  * Delivers a request to the X server.
0273  *
0274  * This form can be used only if the request will cause
0275  * a reply to be generated. Any returned error will be
0276  * placed in the event queue.
0277  */
0278 xcb_xevie_start_cookie_t
0279 xcb_xevie_start_unchecked (xcb_connection_t *c,
0280                            uint32_t          screen);
0281
0282 /**
0283  * Return the reply
0284  * @param c      The connection
0285  * @param cookie The cookie
0286  * @param e      The xcb_generic_error_t supplied
0287  *
0288  * Returns the reply of the request asked by
0289  *
0290  * The parameter @p e supplied to this function must be NULL if
0291  * xcb_xevie_start_unchecked(). is used.
0292  * Otherwise, it stores the error if any.
0293  *
0294  * The returned value must be freed by the caller using free().
0295  */
0296 xcb_xevie_start_reply_t *
0297 xcb_xevie_start_reply (xcb_connection_t          *c,
0298                        xcb_xevie_start_cookie_t   cookie  /**< */,
0299                        xcb_generic_error_t      **e);
0300
0301 /**
0302  *
0303  * @param c The connection
0304  * @return A cookie
0305  *
0306  * Delivers a request to the X server.
0307  *
0308  */
0309 xcb_xevie_end_cookie_t
0310 xcb_xevie_end (xcb_connection_t *c,
0311                uint32_t          cmap);
0312
0313 /**
0314  *
0315  * @param c The connection
0316  * @return A cookie
0317  *
0318  * Delivers a request to the X server.
0319  *
0320  * This form can be used only if the request will cause
0321  * a reply to be generated. Any returned error will be
0322  * placed in the event queue.
0323  */
0324 xcb_xevie_end_cookie_t
0325 xcb_xevie_end_unchecked (xcb_connection_t *c,
0326                          uint32_t          cmap);
0327
0328 /**
0329  * Return the reply
0330  * @param c      The connection
0331  * @param cookie The cookie
0332  * @param e      The xcb_generic_error_t supplied
0333  *
0334  * Returns the reply of the request asked by
0335  *
0336  * The parameter @p e supplied to this function must be NULL if
0337  * xcb_xevie_end_unchecked(). is used.
0338  * Otherwise, it stores the error if any.
0339  *
0340  * The returned value must be freed by the caller using free().
0341  */
0342 xcb_xevie_end_reply_t *
0343 xcb_xevie_end_reply (xcb_connection_t        *c,
0344                      xcb_xevie_end_cookie_t   cookie  /**< */,
0345                      xcb_generic_error_t    **e);
0346
0347 /**
0348  * Get the next element of the iterator
0349  * @param i Pointer to a xcb_xevie_event_iterator_t
0350  *
0351  * Get the next element in the iterator. The member rem is
0352  * decreased by one. The member data points to the next
0353  * element. The member index is increased by sizeof(xcb_xevie_event_t)
0354  */
0355 void
0356 xcb_xevie_event_next (xcb_xevie_event_iterator_t *i);
0357
0358 /**
0359  * Return the iterator pointing to the last element
0360  * @param i An xcb_xevie_event_iterator_t
0361  * @return  The iterator pointing to the last element
0362  *
0363  * Set the current element in the iterator to the last element.
0364  * The member rem is set to 0. The member data points to the
0365  * last element.
0366  */
0367 xcb_generic_iterator_t
0368 xcb_xevie_event_end (xcb_xevie_event_iterator_t i);
0369
0370 /**
0371  *
0372  * @param c The connection
0373  * @return A cookie
0374  *
0375  * Delivers a request to the X server.
0376  *
0377  */
0378 xcb_xevie_send_cookie_t
0379 xcb_xevie_send (xcb_connection_t  *c,
0380                 xcb_xevie_event_t  event,
0381                 uint32_t           data_type);
0382
0383 /**
0384  *
0385  * @param c The connection
0386  * @return A cookie
0387  *
0388  * Delivers a request to the X server.
0389  *
0390  * This form can be used only if the request will cause
0391  * a reply to be generated. Any returned error will be
0392  * placed in the event queue.
0393  */
0394 xcb_xevie_send_cookie_t
0395 xcb_xevie_send_unchecked (xcb_connection_t  *c,
0396                           xcb_xevie_event_t  event,
0397                           uint32_t           data_type);
0398
0399 /**
0400  * Return the reply
0401  * @param c      The connection
0402  * @param cookie The cookie
0403  * @param e      The xcb_generic_error_t supplied
0404  *
0405  * Returns the reply of the request asked by
0406  *
0407  * The parameter @p e supplied to this function must be NULL if
0408  * xcb_xevie_send_unchecked(). is used.
0409  * Otherwise, it stores the error if any.
0410  *
0411  * The returned value must be freed by the caller using free().
0412  */
0413 xcb_xevie_send_reply_t *
0414 xcb_xevie_send_reply (xcb_connection_t         *c,
0415                       xcb_xevie_send_cookie_t   cookie  /**< */,
0416                       xcb_generic_error_t     **e);
0417
0418 /**
0419  *
0420  * @param c The connection
0421  * @return A cookie
0422  *
0423  * Delivers a request to the X server.
0424  *
0425  */
0426 xcb_xevie_select_input_cookie_t
0427 xcb_xevie_select_input (xcb_connection_t *c,
0428                         uint32_t          event_mask);
0429
0430 /**
0431  *
0432  * @param c The connection
0433  * @return A cookie
0434  *
0435  * Delivers a request to the X server.
0436  *
0437  * This form can be used only if the request will cause
0438  * a reply to be generated. Any returned error will be
0439  * placed in the event queue.
0440  */
0441 xcb_xevie_select_input_cookie_t
0442 xcb_xevie_select_input_unchecked (xcb_connection_t *c,
0443                                   uint32_t          event_mask);
0444
0445 /**
0446  * Return the reply
0447  * @param c      The connection
0448  * @param cookie The cookie
0449  * @param e      The xcb_generic_error_t supplied
0450  *
0451  * Returns the reply of the request asked by
0452  *
0453  * The parameter @p e supplied to this function must be NULL if
0454  * xcb_xevie_select_input_unchecked(). is used.
0455  * Otherwise, it stores the error if any.
0456  *
0457  * The returned value must be freed by the caller using free().
0458  */
0459 xcb_xevie_select_input_reply_t *
0460 xcb_xevie_select_input_reply (xcb_connection_t                 *c,
0461                               xcb_xevie_select_input_cookie_t   cookie  /**< */,
0462                               xcb_generic_error_t             **e);
0463
0464
0465 #ifdef __cplusplus
0466 }
0467 #endif
0468
0469 #endif
0470
0471 /**
0472  * @}
0473  */