Manual pages › X Window and screen libraries (3X)

XRaiseWin(3X)

change window stacking order

From the original Amiga UNIX 2.1 manual. Some things it mentions may not be in this release.

NAME

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

SYNTAX

XRaiseWindow(display, w)
      Display *display;
      Window w;

XLowerWindow(display, w)
      Display *display;
      Window w;

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

XCirculateSubwindowsUp(display, w)
      Display *display;
      Window w;

XCirculateSubwindowsDown(display, w)
      Display *display;
      Window w;

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

ARGUMENTS

direction Specifies the direction (up or down) that you want
          to circulate the window. You can pass RaiseLowest
          or LowerHighest.

display   Specifies the connection to the XWIN server.

nwindows Specifies the number of windows to be restacked. w Specifies the window.

windows   Specifies an array containing the windows to be
          restacked.

DESCRIPTION

     The 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

XWIN 3.0               Last change: 9/1/88                 .ie t

and y location on the desk constant. Raising a mapped window may generate Expose events for the window and any mapped subwindows that were formerly obscured.

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

XRaiseWindow can generate a BadWindow error.

The 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 analo-
gous 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 Expose events on any windows
it formerly obscured.

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

XLowerWindow can generate a BadWindow error.

     The XCirculateSubwindows function circulates children of the
     specified window in the specified direction.  If you specify
     RaiseLowest, XCirculateSubwindows raises the lowest mapped
     child (if any) that is occluded by another child to the top
     of the stack.  If you specify LowerHighest, XCircula-
     teSubwindows 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 SubstructureRedirectMask
     on the window, the XWIN server generates a CirculateRequest
     event, and no further processing is performed.  If a child
     is actually restacked, the XWIN server generates a
     CirculateNotify event.

     XCirculateSubwindows can generate BadValue and BadWindow
     errors.

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

XWIN 3.0               Last change: 9/1/88                 .ie t

XCirculateSubwindowsUp can generate a BadWindow error.

The XCirculateSubwindowsDown function lowers the highest
mapped child of the specified window that partially or com-
pletely occludes another child.  Completely unobscured chil-
dren are not affected.  This is a convenience function
equivalent to XCirculateSubwindows with LowerHighest speci-
fied.

XCirculateSubwindowsDown can generate a BadWindow error.

The 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 child of the specified window, a
BadMatch error results.

If the override-redirect attribute of a window is False and
some other client has selected SubstructureRedirectMask on
the parent, the XWIN server generates 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.

XRestackWindows can generate BadWindow error.

DIAGNOSTICS

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.

BadWindow A value for a Window argument does not name a