1xcb_change_window_attributes(3) XCB Requests xcb_change_window_attributes(3)
2
6 xcb_change_window_attributes - change window attributes
7
9 #include <xcb/xproto.h>
10 Request function
12 xcb_void_cookie_t xcb_change_window_attributes(xcb_connection_t *conn,
13 xcb_window_t window, uint32_t value_mask, const
14 void *value_list);
15
17 conn The XCB connection to X11.
18 window The window to change.
20 value_mask
22 One of the following values:
23 XCB_CW_BACK_PIXMAP
25 Overrides the default background-pixmap. The back‐
26 ground pixmap and window must have the same root
27 and same depth. Any size pixmap can be used, al‐
28 though some sizes may be faster than others.
29 If XCB_BACK_PIXMAP_NONE is specified, the window
31 has no defined background. The server may fill the
32 contents with the previous screen contents or with
33 contents of its own choosing.
34 If XCB_BACK_PIXMAP_PARENT_RELATIVE is specified,
36 the parent's background is used, but the window
37 must have the same depth as the parent (or a Match
38 error results). The parent's background is
39 tracked, and the current version is used each time
40 the window background is required.
41 XCB_CW_BACK_PIXEL
43 Overrides BackPixmap. A pixmap of undefined size
44 filled with the specified background pixel is used
45 for the background. Range-checking is not per‐
46 formed, the background pixel is truncated to the
47 appropriate number of bits.
48 XCB_CW_BORDER_PIXMAP
50 Overrides the default border-pixmap. The border
51 pixmap and window must have the same root and the
52 same depth. Any size pixmap can be used, although
53 some sizes may be faster than others.
54 The special value XCB_COPY_FROM_PARENT means the
56 parent's border pixmap is copied (subsequent
57 changes to the parent's border attribute do not af‐
58 fect the child), but the window must have the same
59 depth as the parent.
60 XCB_CW_BORDER_PIXEL
62 Overrides BorderPixmap. A pixmap of undefined size
63 filled with the specified border pixel is used for
64 the border. Range checking is not performed on the
65 border-pixel value, it is truncated to the appro‐
66 priate number of bits.
67 XCB_CW_BIT_GRAVITY
69 Defines which region of the window should be re‐
70 tained if the window is resized.
71 XCB_CW_WIN_GRAVITY
73 Defines how the window should be repositioned if
74 the parent is resized (see ConfigureWindow).
75 XCB_CW_BACKING_STORE
77 A backing-store of WhenMapped advises the server
78 that maintaining contents of obscured regions when
79 the window is mapped would be beneficial. A back‐
80 ing-store of Always advises the server that main‐
81 taining contents even when the window is unmapped
82 would be beneficial. In this case, the server may
83 generate an exposure event when the window is cre‐
84 ated. A value of NotUseful advises the server that
85 maintaining contents is unnecessary, although a
86 server may still choose to maintain contents while
87 the window is mapped. Note that if the server main‐
88 tains contents, then the server should maintain
89 complete contents not just the region within the
90 parent boundaries, even if the window is larger
91 than its parent. While the server maintains con‐
92 tents, exposure events will not normally be gener‐
93 ated, but the server may stop maintaining contents
94 at any time.
95 XCB_CW_BACKING_PLANES
97 The backing-planes indicates (with bits set to 1)
98 which bit planes of the window hold dynamic data
99 that must be preserved in backing-stores and during
100 save-unders.
101 XCB_CW_BACKING_PIXEL
103 The backing-pixel specifies what value to use in
104 planes not covered by backing-planes. The server is
105 free to save only the specified bit planes in the
106 backing-store or save-under and regenerate the re‐
107 maining planes with the specified pixel value. Any
108 bits beyond the specified depth of the window in
109 these values are simply ignored.
110 XCB_CW_OVERRIDE_REDIRECT
112 The override-redirect specifies whether map and
113 configure requests on this window should override a
114 SubstructureRedirect on the parent, typically to
115 inform a window manager not to tamper with the win‐
116 dow.
117 XCB_CW_SAVE_UNDER
119 If 1, the server is advised that when this window
120 is mapped, saving the contents of windows it ob‐
121 scures would be beneficial.
122 XCB_CW_EVENT_MASK
124 The event-mask defines which events the client is
125 interested in for this window (or for some event
126 types, inferiors of the window).
127 XCB_CW_DONT_PROPAGATE
129 The do-not-propagate-mask defines which events
130 should not be propagated to ancestor windows when
131 no client has the event type selected in this win‐
132 dow.
133 XCB_CW_COLORMAP
135 The colormap specifies the colormap that best re‐
136 flects the true colors of the window. Servers capa‐
137 ble of supporting multiple hardware colormaps may
138 use this information, and window man- agers may use
139 it for InstallColormap requests. The colormap must
140 have the same visual type and root as the window
141 (or a Match error results). If CopyFromParent is
142 specified, the parent's colormap is copied (subse‐
143 quent changes to the parent's colormap attribute do
144 not affect the child). However, the window must
145 have the same visual type as the parent (or a Match
146 error results), and the parent must not have a col‐
147 ormap of None (or a Match error results). For an
148 explanation of None, see FreeColormap request. The
149 colormap is copied by sharing the colormap object
150 between the child and the parent, not by making a
151 complete copy of the colormap contents.
152 XCB_CW_CURSOR
154 If a cursor is specified, it will be used whenever
155 the pointer is in the window. If None is speci-
156 fied, the parent's cursor will be used when the
157 pointer is in the window, and any change in the
158 parent's cursor will cause an immediate change in
159 the displayed cursor.
160 value_list
164 Values for each of the attributes specified in the bitmask
165 value_mask. The order has to correspond to the order of pos‐
166 sible value_mask bits. See the example.
167
169 Changes the attributes specified by value_mask for the specified win‐
170 dow.
171
173 Returns an xcb_void_cookie_t. Errors (if any) have to be handled in the
174 event loop.
175 If you want to handle errors directly with xcb_request_check instead,
177 use xcb_change_window_attributes_checked. See xcb-requests(3) for de‐
178 tails.
179
181 xcb_access_error_t
182 TODO: reasons?
183 xcb_colormap_error_t
185 TODO: reasons?
186 xcb_cursor_error_t
188 TODO: reasons?
189 xcb_match_error_t
191 TODO: reasons?
192 xcb_pixmap_error_t
194 TODO: reasons?
195 xcb_value_error_t
197 TODO: reasons?
198 xcb_window_error_t
200 The specified window does not exist.
201
203 xcb-requests(3)
204
206 Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
207 rections and improvements.
208X Version 11 libxcb 1.13 xcb_change_window_attributes(3)