Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.

Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Digital Equipment Corporation

Portions Copyright \(co 1990, 1991 by
Tektronix, Inc.

Permission to use, copy, modify and distribute this documentation for
any purpose and without fee is hereby granted, provided that the above
copyright notice appears in all copies and that both that copyright notice
and this permission notice appear in all copies, and that the names of
Digital and Tektronix not be used in in advertising or publicity pertaining
to this documentation without specific, written prior permission.
Digital and Tektronix makes no representations about the suitability
of this documentation for any purpose.
It is provided ``as is'' without express or implied warranty.

.\\$1D \\$2 \\$1
.ps \\n(PS
.if \\n(VS>=40 .vs \\n(VSu
.if \\n(VS<=39 .vs \\n(VSp
..
 0
.nr BD 0

.. .. .. .. .. .ny0 XRaiseWindow, XLowerWindow, XCirculateSubwindows, XCirculateSubwindowsUp, XCirculateSubwindowsDown, XRestackWindows - change window stacking order

int XRaiseWindow\^(\^Display *display\^, Window w\^);

int XLowerWindow\^(\^Display *display\^, Window w\^);

int XCirculateSubwindows\^(\^Display *display\^, Window w\^, int direction\^);

int XCirculateSubwindowsUp\^(\^Display *display\^, Window w\^);

int XCirculateSubwindowsDown\^(\^Display *display\^, Window w\^);

int XRestackWindows\^(\^Display *display\^, Window windows\^[], int nwindows\^);

Specifies the direction (up or down) that you want to circulate the window. You can pass .ZN RaiseLowest or .ZN LowerHighest . Specifies the connection to the X server. Specifies the number of windows to be restacked. Specifies the window. Specifies an array containing the windows to be restacked. The .ZN XRaiseWindow function raises the specified window to the top of the stack so that no sibling window obscures it. If the windows are regarded as overlapping sheets of paper stacked on a desk, then raising a window is analogous to moving the sheet to the top of the stack but leaving its x and y location on the desk constant. Raising a mapped window may generate .ZN Expose events for the window and any mapped subwindows that were formerly obscured.

If the override-redirect attribute of the window is .ZN False and some other client has selected .ZN SubstructureRedirectMask on the parent, the X server generates a .ZN ConfigureRequest event, and no processing is performed. Otherwise, the window is raised.

.ZN XRaiseWindow can generate a .ZN BadWindow error.

The .ZN XLowerWindow function lowers the specified window to the bottom of the stack so that it does not obscure any sibling windows. If the windows are regarded as overlapping sheets of paper stacked on a desk, then lowering a window is analogous to moving the sheet to the bottom of the stack but leaving its x and y location on the desk constant. Lowering a mapped window will generate .ZN Expose events on any windows it formerly obscured.

If the override-redirect attribute of the window is .ZN False and some other client has selected .ZN SubstructureRedirectMask on the parent, the X server generates a .ZN ConfigureRequest event, and no processing is performed. Otherwise, the window is lowered to the bottom of the stack.

.ZN XLowerWindow can generate a .ZN BadWindow error.

The .ZN XCirculateSubwindows function circulates children of the specified window in the specified direction. If you specify .ZN RaiseLowest , .ZN XCirculateSubwindows raises the lowest mapped child (if any) that is occluded by another child to the top of the stack. If you specify .ZN LowerHighest , .ZN XCirculateSubwindows lowers the highest mapped child (if any) that occludes another child to the bottom of the stack. Exposure processing is then performed on formerly obscured windows. If some other client has selected .ZN SubstructureRedirectMask on the window, the X server generates a .ZN CirculateRequest event, and no further processing is performed. If a child is actually restacked, the X server generates a .ZN CirculateNotify event.

.ZN XCirculateSubwindows can generate .ZN BadValue and .ZN BadWindow errors.

The .ZN XCirculateSubwindowsUp function raises the lowest mapped child of the specified window that is partially or completely occluded by another child. Completely unobscured children are not affected. This is a convenience function equivalent to .ZN XCirculateSubwindows with .ZN RaiseLowest specified.

.ZN XCirculateSubwindowsUp can generate a .ZN BadWindow error.

The .ZN XCirculateSubwindowsDown function lowers the highest mapped child of the specified window that partially or completely occludes another child. Completely unobscured children are not affected. This is a convenience function equivalent to .ZN XCirculateSubwindows with .ZN LowerHighest specified.

.ZN XCirculateSubwindowsDown can generate a .ZN BadWindow error.

The .ZN XRestackWindows function restacks the windows in the order specified, from top to bottom. The stacking order of the first window in the windows array is unaffected, but the other windows in the array are stacked underneath the first window, in the order of the array. The stacking order of the other windows is not affected. For each window in the window array that is not a sibling of the first window, a .ZN BadMatch error results.

If the override-redirect attribute of a window is .ZN False and some other client has selected .ZN SubstructureRedirectMask on the parent, the X server generates .ZN ConfigureRequest events for each window whose override-redirect flag is not set, and no further processing is performed. Otherwise, the windows will be restacked in top-to-bottom order.

.ZN XRestackWindows can generate .ZN BadWindow error.

1i .ZN BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error.

1i .ZN BadWindow A value for a Window argument does not name a defined Window.

XChangeWindowAttributes(__libmansuffix__), XConfigureWindow(__libmansuffix__), XCreateWindow(__libmansuffix__), XDestroyWindow(__libmansuffix__), XMapWindow(__libmansuffix__), XUnmapWindow(__libmansuffix__)

\*(xL