xcb_circulate_window_checked(3)

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

NAME

6       xcb_circulate_window - Change window stacking order
7

SYNOPSIS

9       #include <xcb/xproto.h>
10
11   Request function
12       xcb_void_cookie_t xcb_circulate_window(xcb_connection_t *conn,
13              uint8_t direction, xcb_window_t window);
14

REQUEST ARGUMENTS

16       conn      The XCB connection to X11.
17
18       direction One of the following values:
19
20                 XCB_CIRCULATE_RAISE_LOWEST
21                           TODO: NOT YET DOCUMENTED.
22
23                 XCB_CIRCULATE_LOWER_HIGHEST
24                           TODO: NOT YET DOCUMENTED.
25
26
27
28       window    The window to raise/lower (depending on direction).
29

DESCRIPTION

31       If direction is XCB_CIRCULATE_RAISE_LOWEST, the lowest mapped child (if
32       any) will be raised to the top of the stack.
33
34       If direction is XCB_CIRCULATE_LOWER_HIGHEST, the highest mapped child
35       will be lowered to the bottom of the stack.
36

RETURN VALUE

38       Returns an xcb_void_cookie_t. Errors (if any) have to be handled in the
39       event loop.
40
41       If you want to handle errors directly with xcb_request_check instead,
42       use xcb_circulate_window_checked. See xcb-requests(3) for details.
43

ERRORS

45       xcb_value_error_t
46                 The specified direction is invalid.
47
48       xcb_window_error_t
49                 The specified window does not exist.
50

AUTHOR

55       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
56       rections and improvements.
57
58
59
60X Version 11                      libxcb 1.13          xcb_circulate_window(3)