include/xcb/xinerama.h

0001 /*
0002  * This file generated automatically from xinerama.xml by c_client.py.
0003  * Edit at your peril.
0004  */
0005
0006 /**
0007  * @defgroup XCB_Xinerama_API XCB Xinerama API
0008  * @brief Xinerama XCB Protocol Implementation.
0009  * @{
0010  **/
0011
0012 #ifndef __XINERAMA_H
0013 #define __XINERAMA_H
0014
0015 #include "xcb.h"
0016 #include "xproto.h"
0017
0018 #ifdef __cplusplus
0019 extern "C" {
0020 #endif
0021
0022 #define XCB_XINERAMA_MAJOR_VERSION 1
0023 #define XCB_XINERAMA_MINOR_VERSION 1
0024
0025 extern xcb_extension_t xcb_xinerama_id;
0026
0027 /**
0028  * @brief xcb_xinerama_screen_info_t
0029  **/
0030 typedef struct xcb_xinerama_screen_info_t {
0031     int16_t  x_org;
0032     int16_t  y_org;
0033     uint16_t width;
0034     uint16_t height;
0035 } xcb_xinerama_screen_info_t;
0036
0037 /**
0038  * @brief xcb_xinerama_screen_info_iterator_t
0039  **/
0040 typedef struct xcb_xinerama_screen_info_iterator_t {
0041     xcb_xinerama_screen_info_t *data;
0042     int                         rem;
0043     int                         index;
0044 } xcb_xinerama_screen_info_iterator_t;
0045
0046 /**
0047  * @brief xcb_xinerama_query_version_cookie_t
0048  **/
0049 typedef struct xcb_xinerama_query_version_cookie_t {
0050     unsigned int sequence;
0051 } xcb_xinerama_query_version_cookie_t;
0052
0053 /** Opcode for xcb_xinerama_query_version. */
0054 #define XCB_XINERAMA_QUERY_VERSION 0
0055
0056 /**
0057  * @brief xcb_xinerama_query_version_request_t
0058  **/
0059 typedef struct xcb_xinerama_query_version_request_t {
0060     uint8_t  major_opcode;
0061     uint8_t  minor_opcode;
0062     uint16_t length;
0063     uint8_t  major;
0064     uint8_t  minor;
0065 } xcb_xinerama_query_version_request_t;
0066
0067 /**
0068  * @brief xcb_xinerama_query_version_reply_t
0069  **/
0070 typedef struct xcb_xinerama_query_version_reply_t {
0071     uint8_t  response_type;
0072     uint8_t  pad0;
0073     uint16_t sequence;
0074     uint32_t length;
0075     uint16_t major;
0076     uint16_t minor;
0077 } xcb_xinerama_query_version_reply_t;
0078
0079 /**
0080  * @brief xcb_xinerama_get_state_cookie_t
0081  **/
0082 typedef struct xcb_xinerama_get_state_cookie_t {
0083     unsigned int sequence;
0084 } xcb_xinerama_get_state_cookie_t;
0085
0086 /** Opcode for xcb_xinerama_get_state. */
0087 #define XCB_XINERAMA_GET_STATE 1
0088
0089 /**
0090  * @brief xcb_xinerama_get_state_request_t
0091  **/
0092 typedef struct xcb_xinerama_get_state_request_t {
0093     uint8_t      major_opcode;
0094     uint8_t      minor_opcode;
0095     uint16_t     length;
0096     xcb_window_t window;
0097 } xcb_xinerama_get_state_request_t;
0098
0099 /**
0100  * @brief xcb_xinerama_get_state_reply_t
0101  **/
0102 typedef struct xcb_xinerama_get_state_reply_t {
0103     uint8_t      response_type;
0104     uint8_t      state;
0105     uint16_t     sequence;
0106     uint32_t     length;
0107     xcb_window_t window;
0108 } xcb_xinerama_get_state_reply_t;
0109
0110 /**
0111  * @brief xcb_xinerama_get_screen_count_cookie_t
0112  **/
0113 typedef struct xcb_xinerama_get_screen_count_cookie_t {
0114     unsigned int sequence;
0115 } xcb_xinerama_get_screen_count_cookie_t;
0116
0117 /** Opcode for xcb_xinerama_get_screen_count. */
0118 #define XCB_XINERAMA_GET_SCREEN_COUNT 2
0119
0120 /**
0121  * @brief xcb_xinerama_get_screen_count_request_t
0122  **/
0123 typedef struct xcb_xinerama_get_screen_count_request_t {
0124     uint8_t      major_opcode;
0125     uint8_t      minor_opcode;
0126     uint16_t     length;
0127     xcb_window_t window;
0128 } xcb_xinerama_get_screen_count_request_t;
0129
0130 /**
0131  * @brief xcb_xinerama_get_screen_count_reply_t
0132  **/
0133 typedef struct xcb_xinerama_get_screen_count_reply_t {
0134     uint8_t      response_type;
0135     uint8_t      screen_count;
0136     uint16_t     sequence;
0137     uint32_t     length;
0138     xcb_window_t window;
0139 } xcb_xinerama_get_screen_count_reply_t;
0140
0141 /**
0142  * @brief xcb_xinerama_get_screen_size_cookie_t
0143  **/
0144 typedef struct xcb_xinerama_get_screen_size_cookie_t {
0145     unsigned int sequence;
0146 } xcb_xinerama_get_screen_size_cookie_t;
0147
0148 /** Opcode for xcb_xinerama_get_screen_size. */
0149 #define XCB_XINERAMA_GET_SCREEN_SIZE 3
0150
0151 /**
0152  * @brief xcb_xinerama_get_screen_size_request_t
0153  **/
0154 typedef struct xcb_xinerama_get_screen_size_request_t {
0155     uint8_t      major_opcode;
0156     uint8_t      minor_opcode;
0157     uint16_t     length;
0158     xcb_window_t window;
0159     uint32_t     screen;
0160 } xcb_xinerama_get_screen_size_request_t;
0161
0162 /**
0163  * @brief xcb_xinerama_get_screen_size_reply_t
0164  **/
0165 typedef struct xcb_xinerama_get_screen_size_reply_t {
0166     uint8_t      response_type;
0167     uint8_t      pad0;
0168     uint16_t     sequence;
0169     uint32_t     length;
0170     uint32_t     width;
0171     uint32_t     height;
0172     xcb_window_t window;
0173     uint32_t     screen;
0174 } xcb_xinerama_get_screen_size_reply_t;
0175
0176 /**
0177  * @brief xcb_xinerama_is_active_cookie_t
0178  **/
0179 typedef struct xcb_xinerama_is_active_cookie_t {
0180     unsigned int sequence;
0181 } xcb_xinerama_is_active_cookie_t;
0182
0183 /** Opcode for xcb_xinerama_is_active. */
0184 #define XCB_XINERAMA_IS_ACTIVE 4
0185
0186 /**
0187  * @brief xcb_xinerama_is_active_request_t
0188  **/
0189 typedef struct xcb_xinerama_is_active_request_t {
0190     uint8_t  major_opcode;
0191     uint8_t  minor_opcode;
0192     uint16_t length;
0193 } xcb_xinerama_is_active_request_t;
0194
0195 /**
0196  * @brief xcb_xinerama_is_active_reply_t
0197  **/
0198 typedef struct xcb_xinerama_is_active_reply_t {
0199     uint8_t  response_type;
0200     uint8_t  pad0;
0201     uint16_t sequence;
0202     uint32_t length;
0203     uint32_t state;
0204 } xcb_xinerama_is_active_reply_t;
0205
0206 /**
0207  * @brief xcb_xinerama_query_screens_cookie_t
0208  **/
0209 typedef struct xcb_xinerama_query_screens_cookie_t {
0210     unsigned int sequence;
0211 } xcb_xinerama_query_screens_cookie_t;
0212
0213 /** Opcode for xcb_xinerama_query_screens. */
0214 #define XCB_XINERAMA_QUERY_SCREENS 5
0215
0216 /**
0217  * @brief xcb_xinerama_query_screens_request_t
0218  **/
0219 typedef struct xcb_xinerama_query_screens_request_t {
0220     uint8_t  major_opcode;
0221     uint8_t  minor_opcode;
0222     uint16_t length;
0223 } xcb_xinerama_query_screens_request_t;
0224
0225 /**
0226  * @brief xcb_xinerama_query_screens_reply_t
0227  **/
0228 typedef struct xcb_xinerama_query_screens_reply_t {
0229     uint8_t  response_type;
0230     uint8_t  pad0;
0231     uint16_t sequence;
0232     uint32_t length;
0233     uint32_t number;
0234     uint8_t  pad1[20];
0235 } xcb_xinerama_query_screens_reply_t;
0236
0237 /**
0238  * Get the next element of the iterator
0239  * @param i Pointer to a xcb_xinerama_screen_info_iterator_t
0240  *
0241  * Get the next element in the iterator. The member rem is
0242  * decreased by one. The member data points to the next
0243  * element. The member index is increased by sizeof(xcb_xinerama_screen_info_t)
0244  */
0245 void
0246 xcb_xinerama_screen_info_next (xcb_xinerama_screen_info_iterator_t *i);
0247
0248 /**
0249  * Return the iterator pointing to the last element
0250  * @param i An xcb_xinerama_screen_info_iterator_t
0251  * @return  The iterator pointing to the last element
0252  *
0253  * Set the current element in the iterator to the last element.
0254  * The member rem is set to 0. The member data points to the
0255  * last element.
0256  */
0257 xcb_generic_iterator_t
0258 xcb_xinerama_screen_info_end (xcb_xinerama_screen_info_iterator_t i);
0259
0260 /**
0261  *
0262  * @param c The connection
0263  * @return A cookie
0264  *
0265  * Delivers a request to the X server.
0266  *
0267  */
0268 xcb_xinerama_query_version_cookie_t
0269 xcb_xinerama_query_version (xcb_connection_t *c,
0270                             uint8_t           major,
0271                             uint8_t           minor);
0272
0273 /**
0274  *
0275  * @param c The connection
0276  * @return A cookie
0277  *
0278  * Delivers a request to the X server.
0279  *
0280  * This form can be used only if the request will cause
0281  * a reply to be generated. Any returned error will be
0282  * placed in the event queue.
0283  */
0284 xcb_xinerama_query_version_cookie_t
0285 xcb_xinerama_query_version_unchecked (xcb_connection_t *c,
0286                                       uint8_t           major,
0287                                       uint8_t           minor);
0288
0289 /**
0290  * Return the reply
0291  * @param c      The connection
0292  * @param cookie The cookie
0293  * @param e      The xcb_generic_error_t supplied
0294  *
0295  * Returns the reply of the request asked by
0296  *
0297  * The parameter @p e supplied to this function must be NULL if
0298  * xcb_xinerama_query_version_unchecked(). is used.
0299  * Otherwise, it stores the error if any.
0300  *
0301  * The returned value must be freed by the caller using free().
0302  */
0303 xcb_xinerama_query_version_reply_t *
0304 xcb_xinerama_query_version_reply (xcb_connection_t                     *c,
0305                                   xcb_xinerama_query_version_cookie_t   cookie  /**< */,
0306                                   xcb_generic_error_t                 **e);
0307
0308 /**
0309  *
0310  * @param c The connection
0311  * @return A cookie
0312  *
0313  * Delivers a request to the X server.
0314  *
0315  */
0316 xcb_xinerama_get_state_cookie_t
0317 xcb_xinerama_get_state (xcb_connection_t *c,
0318                         xcb_window_t      window);
0319
0320 /**
0321  *
0322  * @param c The connection
0323  * @return A cookie
0324  *
0325  * Delivers a request to the X server.
0326  *
0327  * This form can be used only if the request will cause
0328  * a reply to be generated. Any returned error will be
0329  * placed in the event queue.
0330  */
0331 xcb_xinerama_get_state_cookie_t
0332 xcb_xinerama_get_state_unchecked (xcb_connection_t *c,
0333                                   xcb_window_t      window);
0334
0335 /**
0336  * Return the reply
0337  * @param c      The connection
0338  * @param cookie The cookie
0339  * @param e      The xcb_generic_error_t supplied
0340  *
0341  * Returns the reply of the request asked by
0342  *
0343  * The parameter @p e supplied to this function must be NULL if
0344  * xcb_xinerama_get_state_unchecked(). is used.
0345  * Otherwise, it stores the error if any.
0346  *
0347  * The returned value must be freed by the caller using free().
0348  */
0349 xcb_xinerama_get_state_reply_t *
0350 xcb_xinerama_get_state_reply (xcb_connection_t                 *c,
0351                               xcb_xinerama_get_state_cookie_t   cookie  /**< */,
0352                               xcb_generic_error_t             **e);
0353
0354 /**
0355  *
0356  * @param c The connection
0357  * @return A cookie
0358  *
0359  * Delivers a request to the X server.
0360  *
0361  */
0362 xcb_xinerama_get_screen_count_cookie_t
0363 xcb_xinerama_get_screen_count (xcb_connection_t *c,
0364                                xcb_window_t      window);
0365
0366 /**
0367  *
0368  * @param c The connection
0369  * @return A cookie
0370  *
0371  * Delivers a request to the X server.
0372  *
0373  * This form can be used only if the request will cause
0374  * a reply to be generated. Any returned error will be
0375  * placed in the event queue.
0376  */
0377 xcb_xinerama_get_screen_count_cookie_t
0378 xcb_xinerama_get_screen_count_unchecked (xcb_connection_t *c,
0379                                          xcb_window_t      window);
0380
0381 /**
0382  * Return the reply
0383  * @param c      The connection
0384  * @param cookie The cookie
0385  * @param e      The xcb_generic_error_t supplied
0386  *
0387  * Returns the reply of the request asked by
0388  *
0389  * The parameter @p e supplied to this function must be NULL if
0390  * xcb_xinerama_get_screen_count_unchecked(). is used.
0391  * Otherwise, it stores the error if any.
0392  *
0393  * The returned value must be freed by the caller using free().
0394  */
0395 xcb_xinerama_get_screen_count_reply_t *
0396 xcb_xinerama_get_screen_count_reply (xcb_connection_t                        *c,
0397                                      xcb_xinerama_get_screen_count_cookie_t   cookie  /**< */,
0398                                      xcb_generic_error_t                    **e);
0399
0400 /**
0401  *
0402  * @param c The connection
0403  * @return A cookie
0404  *
0405  * Delivers a request to the X server.
0406  *
0407  */
0408 xcb_xinerama_get_screen_size_cookie_t
0409 xcb_xinerama_get_screen_size (xcb_connection_t *c,
0410                               xcb_window_t      window,
0411                               uint32_t          screen);
0412
0413 /**
0414  *
0415  * @param c The connection
0416  * @return A cookie
0417  *
0418  * Delivers a request to the X server.
0419  *
0420  * This form can be used only if the request will cause
0421  * a reply to be generated. Any returned error will be
0422  * placed in the event queue.
0423  */
0424 xcb_xinerama_get_screen_size_cookie_t
0425 xcb_xinerama_get_screen_size_unchecked (xcb_connection_t *c,
0426                                         xcb_window_t      window,
0427                                         uint32_t          screen);
0428
0429 /**
0430  * Return the reply
0431  * @param c      The connection
0432  * @param cookie The cookie
0433  * @param e      The xcb_generic_error_t supplied
0434  *
0435  * Returns the reply of the request asked by
0436  *
0437  * The parameter @p e supplied to this function must be NULL if
0438  * xcb_xinerama_get_screen_size_unchecked(). is used.
0439  * Otherwise, it stores the error if any.
0440  *
0441  * The returned value must be freed by the caller using free().
0442  */
0443 xcb_xinerama_get_screen_size_reply_t *
0444 xcb_xinerama_get_screen_size_reply (xcb_connection_t                       *c,
0445                                     xcb_xinerama_get_screen_size_cookie_t   cookie  /**< */,
0446                                     xcb_generic_error_t                   **e);
0447
0448 /**
0449  *
0450  * @param c The connection
0451  * @return A cookie
0452  *
0453  * Delivers a request to the X server.
0454  *
0455  */
0456 xcb_xinerama_is_active_cookie_t
0457 xcb_xinerama_is_active (xcb_connection_t *c);
0458
0459 /**
0460  *
0461  * @param c The connection
0462  * @return A cookie
0463  *
0464  * Delivers a request to the X server.
0465  *
0466  * This form can be used only if the request will cause
0467  * a reply to be generated. Any returned error will be
0468  * placed in the event queue.
0469  */
0470 xcb_xinerama_is_active_cookie_t
0471 xcb_xinerama_is_active_unchecked (xcb_connection_t *c);
0472
0473 /**
0474  * Return the reply
0475  * @param c      The connection
0476  * @param cookie The cookie
0477  * @param e      The xcb_generic_error_t supplied
0478  *
0479  * Returns the reply of the request asked by
0480  *
0481  * The parameter @p e supplied to this function must be NULL if
0482  * xcb_xinerama_is_active_unchecked(). is used.
0483  * Otherwise, it stores the error if any.
0484  *
0485  * The returned value must be freed by the caller using free().
0486  */
0487 xcb_xinerama_is_active_reply_t *
0488 xcb_xinerama_is_active_reply (xcb_connection_t                 *c,
0489                               xcb_xinerama_is_active_cookie_t   cookie  /**< */,
0490                               xcb_generic_error_t             **e);
0491
0492 int
0493 xcb_xinerama_query_screens_sizeof (const void  *_buffer);
0494
0495 /**
0496  *
0497  * @param c The connection
0498  * @return A cookie
0499  *
0500  * Delivers a request to the X server.
0501  *
0502  */
0503 xcb_xinerama_query_screens_cookie_t
0504 xcb_xinerama_query_screens (xcb_connection_t *c);
0505
0506 /**
0507  *
0508  * @param c The connection
0509  * @return A cookie
0510  *
0511  * Delivers a request to the X server.
0512  *
0513  * This form can be used only if the request will cause
0514  * a reply to be generated. Any returned error will be
0515  * placed in the event queue.
0516  */
0517 xcb_xinerama_query_screens_cookie_t
0518 xcb_xinerama_query_screens_unchecked (xcb_connection_t *c);
0519
0520 xcb_xinerama_screen_info_t *
0521 xcb_xinerama_query_screens_screen_info (const xcb_xinerama_query_screens_reply_t *R);
0522
0523 int
0524 xcb_xinerama_query_screens_screen_info_length (const xcb_xinerama_query_screens_reply_t *R);
0525
0526 xcb_xinerama_screen_info_iterator_t
0527 xcb_xinerama_query_screens_screen_info_iterator (const xcb_xinerama_query_screens_reply_t *R);
0528
0529 /**
0530  * Return the reply
0531  * @param c      The connection
0532  * @param cookie The cookie
0533  * @param e      The xcb_generic_error_t supplied
0534  *
0535  * Returns the reply of the request asked by
0536  *
0537  * The parameter @p e supplied to this function must be NULL if
0538  * xcb_xinerama_query_screens_unchecked(). is used.
0539  * Otherwise, it stores the error if any.
0540  *
0541  * The returned value must be freed by the caller using free().
0542  */
0543 xcb_xinerama_query_screens_reply_t *
0544 xcb_xinerama_query_screens_reply (xcb_connection_t                     *c,
0545                                   xcb_xinerama_query_screens_cookie_t   cookie  /**< */,
0546                                   xcb_generic_error_t                 **e);
0547
0548
0549 #ifdef __cplusplus
0550 }
0551 #endif
0552
0553 #endif
0554
0555 /**
0556  * @}
0557  */