XRaiseWindow(3X)                                 XRaiseWindow(3X)



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

SYNOPSIS
     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;

DESCRIPTION
     The XRaiseWindow function raises the specified window to the
     top of the stack so that it is not obscured by any sibling
     windows.  If the windows are regarded as overlapping sheets
     of paper stacked on a desk, 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 win-
     dow 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 X server gen-
     erates a ConfigureRequest event, and no processing is per-
     formed.  Otherwise, the window is raised.

     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, lowering a window is analogous



November, 1990                                                  1

XRaiseWindow(3X)                                 XRaiseWindow(3X)



     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 generates
     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 X server gen-
     erates a ConfigureRequest event, and no processing is per-
     formed. Otherwise, the window is lowered to the bottom of
     the stack.

     The XCirculateSubwindows function circulates the specified
     subwindow in the specified direction.  If you specify
     LowerHighest, XCirculateSubwindows lowers the highest mapped
     child (if any) that occludes another child to the bottom of
     the stack.  Exposure processing is then performed on former-
     ly obscured windows.  If some other client has selected Sub-
     structureRedirectMask on the window, the X server generates
     a CirculateRequest event, and no further processing is per-
     formed.  If a child is actually restacked, the X server gen-
     erates a CirculateNotify event.

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

     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 that
     is equivalent to XCirculateSubwindows with RaiseHighest
     specified.

     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 beneath the first
     window in the order of the array.  The stacking order of the
     other windows is not affected.  For each window in the win-
     dow 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 X server gen-
     erates ConfigureRequest events for each window whose
     override-redirect flag is not set, and no further processing
     is performed.  Otherwise, the windows are restacked in top



2                                                  November, 1990

XRaiseWindow(3X)                                 XRaiseWindow(3X)



     to bottom order.

   Arguments
     These functions accept the following arguments:

     direction
             Specifies the direction (up or down) in which you
             want to circulate the window.  You can pass one of
             the following constants:  RaiseLowest or
             LowerHighest.

     display Specifies the connection to the X server.

     nwindows
             Specifies the number of windows to be restacked.

     w       Specifies the window ID.

     windows Specifies an array of the windows to be restacked.
             All the windows must have the same parent.

ERRORS
     BadValue
             A numeric value falls outside the range of values
             accepted by the request.  Unless a range is speci-
             fied 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 de-
             fined window.

     The XRaiseWindow, XLowerWindow,
     XCirculateSubwindowsUp,
     XCirculateSubwindowsDown, and XRestackWindows functions can
     generate a BadWindow error.

     The XCirculateSubwindows function can generate
     BadValue and BadWindow errors.

SEE ALSO
     XChangeWindowAttributes(3X),
     XConfigureWindow(3X), XCreateWindow(3X),
     XDestroyWindow(3X), XMapWindow(3X),
     XUnmapWindow(3X)

     Xlib - C Language Interface








November, 1990                                                  3