xcb_get_window_attributes_reply(3)

1xcb_get_window_attributes(3)     XCB Requests     xcb_get_window_attributes(3)
2
3
4

NAME

6       xcb_get_window_attributes - Gets window attributes
7

SYNOPSIS

9       #include <xcb/xproto.h>
10
11   Request function
12       xcb_get_window_attributes_cookie_t
13              xcb_get_window_attributes(xcb_connection_t *conn,
14              xcb_window_t window);
15
16   Reply datastructure
17       typedef struct xcb_get_window_attributes_reply_t {
18           uint8_t        response_type;
19           uint8_t        backing_store;
20           uint16_t       sequence;
21           uint32_t       length;
22           xcb_visualid_t visual;
23           uint16_t       _class;
24           uint8_t        bit_gravity;
25           uint8_t        win_gravity;
26           uint32_t       backing_planes;
27           uint32_t       backing_pixel;
28           uint8_t        save_under;
29           uint8_t        map_is_installed;
30           uint8_t        map_state;
31           uint8_t        override_redirect;
32           xcb_colormap_t colormap;
33           uint32_t       all_event_masks;
34           uint32_t       your_event_mask;
35           uint16_t       do_not_propagate_mask;
36           uint8_t        pad0[2];
37       } xcb_get_window_attributes_reply_t;
38
39   Reply function
40       xcb_get_window_attributes_reply_t
41              *xcb_get_window_attributes_reply(xcb_connection_t *conn,
42              xcb_get_window_attributes_cookie_t cookie,
43              xcb_generic_error_t **e);
44

REQUEST ARGUMENTS

46       conn      The XCB connection to X11.
47
48       window    The window to get the attributes from.
49

REPLY FIELDS

51       response_type
52                 The type of this reply, in this case XCB_GET_WINDOW_AT‐
53                 TRIBUTES. This field is also present in the xcb_generic_re‐
54                 ply_t and can be used to tell replies apart from each other.
55
56       sequence  The sequence number of the last request processed by the X11
57                 server.
58
59       length    The length of the reply, in words (a word is 4 bytes).
60
61       backing_store
62                 One of the following values:
63
64                 XCB_BACKING_STORE_NOT_USEFUL
65                           TODO: NOT YET DOCUMENTED.
66
67                 XCB_BACKING_STORE_WHEN_MAPPED
68                           TODO: NOT YET DOCUMENTED.
69
70                 XCB_BACKING_STORE_ALWAYS
71                           TODO: NOT YET DOCUMENTED.
72
73
74
75       visual    The associated visual structure of window.
76
77       _class    One of the following values:
78
79                 XCB_WINDOW_CLASS_COPY_FROM_PARENT
80                           TODO: NOT YET DOCUMENTED.
81
82                 XCB_WINDOW_CLASS_INPUT_OUTPUT
83                           TODO: NOT YET DOCUMENTED.
84
85                 XCB_WINDOW_CLASS_INPUT_ONLY
86                           TODO: NOT YET DOCUMENTED.
87
88
89
90       bit_gravity
91                 One of the following values:
92
93                 XCB_GRAVITY_BIT_FORGET
94                           TODO: NOT YET DOCUMENTED.
95
96                 XCB_GRAVITY_WIN_UNMAP
97                           TODO: NOT YET DOCUMENTED.
98
99                 XCB_GRAVITY_NORTH_WEST
100                           TODO: NOT YET DOCUMENTED.
101
102                 XCB_GRAVITY_NORTH
103                           TODO: NOT YET DOCUMENTED.
104
105                 XCB_GRAVITY_NORTH_EAST
106                           TODO: NOT YET DOCUMENTED.
107
108                 XCB_GRAVITY_WEST
109                           TODO: NOT YET DOCUMENTED.
110
111                 XCB_GRAVITY_CENTER
112                           TODO: NOT YET DOCUMENTED.
113
114                 XCB_GRAVITY_EAST
115                           TODO: NOT YET DOCUMENTED.
116
117                 XCB_GRAVITY_SOUTH_WEST
118                           TODO: NOT YET DOCUMENTED.
119
120                 XCB_GRAVITY_SOUTH
121                           TODO: NOT YET DOCUMENTED.
122
123                 XCB_GRAVITY_SOUTH_EAST
124                           TODO: NOT YET DOCUMENTED.
125
126                 XCB_GRAVITY_STATIC
127                           TODO: NOT YET DOCUMENTED.
128
129
130
131       win_gravity
132                 One of the following values:
133
134                 XCB_GRAVITY_BIT_FORGET
135                           TODO: NOT YET DOCUMENTED.
136
137                 XCB_GRAVITY_WIN_UNMAP
138                           TODO: NOT YET DOCUMENTED.
139
140                 XCB_GRAVITY_NORTH_WEST
141                           TODO: NOT YET DOCUMENTED.
142
143                 XCB_GRAVITY_NORTH
144                           TODO: NOT YET DOCUMENTED.
145
146                 XCB_GRAVITY_NORTH_EAST
147                           TODO: NOT YET DOCUMENTED.
148
149                 XCB_GRAVITY_WEST
150                           TODO: NOT YET DOCUMENTED.
151
152                 XCB_GRAVITY_CENTER
153                           TODO: NOT YET DOCUMENTED.
154
155                 XCB_GRAVITY_EAST
156                           TODO: NOT YET DOCUMENTED.
157
158                 XCB_GRAVITY_SOUTH_WEST
159                           TODO: NOT YET DOCUMENTED.
160
161                 XCB_GRAVITY_SOUTH
162                           TODO: NOT YET DOCUMENTED.
163
164                 XCB_GRAVITY_SOUTH_EAST
165                           TODO: NOT YET DOCUMENTED.
166
167                 XCB_GRAVITY_STATIC
168                           TODO: NOT YET DOCUMENTED.
169
170
171
172       backing_planes
173                 Planes to be preserved if possible.
174
175       backing_pixel
176                 Value to be used when restoring planes.
177
178       save_under
179                 Boolean, should bits under be saved?
180
181       map_is_installed
182                 TODO: NOT YET DOCUMENTED.
183
184       map_state One of the following values:
185
186                 XCB_MAP_STATE_UNMAPPED
187                           TODO: NOT YET DOCUMENTED.
188
189                 XCB_MAP_STATE_UNVIEWABLE
190                           TODO: NOT YET DOCUMENTED.
191
192                 XCB_MAP_STATE_VIEWABLE
193                           TODO: NOT YET DOCUMENTED.
194
195
196
197       override_redirect
198                 Window managers should ignore this window if override_redi‐
199                 rect is 1.
200
201       colormap  Color map to be associated with window.
202
203       all_event_masks
204                 Set of events all people have interest in.
205
206       your_event_mask
207                 My event mask.
208
209       do_not_propagate_mask
210                 Set of events that should not propagate.
211

DESCRIPTION

213       Gets the current attributes for the specified window.
214

RETURN VALUE

216       Returns an xcb_get_window_attributes_cookie_t. Errors have to be han‐
217       dled when calling the reply function xcb_get_window_attributes_reply.
218
219       If you want to handle errors in the event loop instead, use
220       xcb_get_window_attributes_unchecked. See xcb-requests(3) for details.
221

ERRORS

223       xcb_drawable_error_t
224                 TODO: reasons?
225
226       xcb_window_error_t
227                 The specified window does not exist.
228

AUTHOR

233       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
234       rections and improvements.
235
236
237
238X Version 11                      libxcb 1.13     xcb_get_window_attributes(3)