1XRaiseWindow(3) XLIB FUNCTIONS XRaiseWindow(3)
2
6 XRaiseWindow, XLowerWindow, XCirculateSubwindows, XCirculateSubwindow‐
7 sUp, XCirculateSubwindowsDown, XRestackWindows - change window stacking
8 order
9
11 int XRaiseWindow(Display *display, Window w);
12 int XLowerWindow(Display *display, Window w);
14 int XCirculateSubwindows(Display *display, Window w, int direction);
16 int XCirculateSubwindowsUp(Display *display, Window w);
18 int XCirculateSubwindowsDown(Display *display, Window w);
20 int XRestackWindows(Display *display, Window windows[], int nwindows);
22
24 direction Specifies the direction (up or down) that you want to circu‐
25 late the window. You can pass RaiseLowest or LowerHighest.
26 display Specifies the connection to the X server.
28 nwindows Specifies the number of windows to be restacked.
30 w Specifies the window.
32 windows Specifies an array containing the windows to be restacked.
34
36 The XRaiseWindow function raises the specified window to the top of the
37 stack so that no sibling window obscures it. If the windows are re‐
38 garded as overlapping sheets of paper stacked on a desk, then raising a
39 window is analogous to moving the sheet to the top of the stack but
40 leaving its x and y location on the desk constant. Raising a mapped
41 window may generate Expose events for the window and any mapped subwin‐
42 dows that were formerly obscured.
43 If the override-redirect attribute of the window is False and some
45 other client has selected SubstructureRedirectMask on the parent, the X
46 server generates a ConfigureRequest event, and no processing is per‐
47 formed. Otherwise, the window is raised.
48 XRaiseWindow can generate a BadWindow error.
50 The XLowerWindow function lowers the specified window to the bottom of
52 the stack so that it does not obscure any sibling windows. If the win‐
53 dows are regarded as overlapping sheets of paper stacked on a desk,
54 then lowering a window is analogous to moving the sheet to the bottom
55 of the stack but leaving its x and y location on the desk constant.
56 Lowering a mapped window will generate Expose events on any windows it
57 formerly obscured.
58 If the override-redirect attribute of the window is False and some
60 other client has selected SubstructureRedirectMask on the parent, the X
61 server generates a ConfigureRequest event, and no processing is per‐
62 formed. Otherwise, the window is lowered to the bottom of the stack.
63 XLowerWindow can generate a BadWindow error.
65 The XCirculateSubwindows function circulates children of the specified
67 window in the specified direction. If you specify RaiseLowest, XCircu‐
68 lateSubwindows raises the lowest mapped child (if any) that is occluded
69 by another child to the top of the stack. If you specify LowerHighest,
70 XCirculateSubwindows lowers the highest mapped child (if any) that oc‐
71 cludes another child to the bottom of the stack. Exposure processing
72 is then performed on formerly obscured windows. If some other client
73 has selected SubstructureRedirectMask on the window, the X server gen‐
74 erates a CirculateRequest event, and no further processing is per‐
75 formed. If a child is actually restacked, the X server generates a
76 CirculateNotify event.
77 XCirculateSubwindows can generate BadValue and BadWindow errors.
79 The XCirculateSubwindowsUp function raises the lowest mapped child of
81 the specified window that is partially or completely occluded by an‐
82 other child. Completely unobscured children are not affected. This is
83 a convenience function equivalent to XCirculateSubwindows with
84 RaiseLowest specified.
85 XCirculateSubwindowsUp can generate a BadWindow error.
87 The XCirculateSubwindowsDown function lowers the highest mapped child
89 of the specified window that partially or completely occludes another
90 child. Completely unobscured children are not affected. This is a
91 convenience function equivalent to XCirculateSubwindows with LowerHigh‐
92 est specified.
93 XCirculateSubwindowsDown can generate a BadWindow error.
95 The XRestackWindows function restacks the windows in the order speci‐
97 fied, from top to bottom. The stacking order of the first window in
98 the windows array is unaffected, but the other windows in the array are
99 stacked underneath the first window, in the order of the array. The
100 stacking order of the other windows is not affected. For each window
101 in the window array that is not a sibling of the first window, a Bad‐
102 Match error results.
103 If the override-redirect attribute of a window is False and some other
105 client has selected SubstructureRedirectMask on the parent, the X
106 server generates ConfigureRequest events for each window whose over‐
107 ride-redirect flag is not set, and no further processing is performed.
108 Otherwise, the windows will be restacked in top-to-bottom order.
109 XRestackWindows can generate BadWindow error.
111
113 BadValue Some numeric value falls outside the range of values accepted
114 by the request. Unless a specific range is specified for an
115 argument, the full range defined by the argument's type is
116 accepted. Any argument defined as a set of alternatives can
117 generate this error.
118 BadWindow A value for a Window argument does not name a defined Window.
120
122 XChangeWindowAttributes(3), XConfigureWindow(3), XCreateWindow(3), XDe‐
123 stroyWindow(3), XMapWindow(3), XUnmapWindow(3)
124 Xlib - C Language X Interface
125X Version 11 libX11 1.7.2 XRaiseWindow(3)