


XRaiseWindow(3X11)	  XLIB FUNCTIONS       XRaiseWindow(3X11)


NAME
       XRaiseWindow, XLowerWindow, XCirculateSubwindows, XCircu
       lateSubwindowsUp, XCirculateSubwindowsDown, XRestackWin
       dows - change window stacking order

SYNTAX
       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);

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 X 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 analo
       gous to moving the sheet to the top of the stack but leav
       ing its x 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 SubstructureRedirect_
       Mask on the parent, the X server generates a Configur_
       eRequest event, and no processing is performed.	Other
       wise, the window 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



XFree86			  Version 4.8.0				1





XRaiseWindow(3X11)	  XLIB FUNCTIONS       XRaiseWindow(3X11)


       sibling windows.	 If the windows are regarded as overlap
       ping 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 Expose
       events on any windows it formerly obscured.

       If the override-redirect attribute of the window is False
       and some other client has selected SubstructureRedirect_
       Mask on the parent, the X server generates a Configur_
       eRequest event, and no processing is performed.	Other
       wise, 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 low
       est mapped child (if any) that is occluded by another
       child to the top of the stack.  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 per
       formed on formerly obscured windows.  If some other client
       has selected SubstructureRedirectMask on the window, the X
       server generates a CirculateRequest event, and no further
       processing is performed.	 If a child is actually
       restacked, the X 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
       completely occluded by another child.  Completely unob
       scured children are not affected.  This is a convenience
       function equivalent to XCirculateSubwindows with RaiseLow_
       est specified.

       XCirculateSubwindowsUp can generate a BadWindow error.

       The 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 XCirculateSubwindows with LowerHighest spec
       ified.

       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



XFree86			  Version 4.8.0				2





XRaiseWindow(3X11)	  XLIB FUNCTIONS       XRaiseWindow(3X11)


       the first window, in the order of the array.  The stacking
       order of the other windows is not affected.  For each win
       dow in the window array that is not a child of the speci
       fied window, a BadMatch error results.

       If the override-redirect attribute of a window is False
       and some other client has selected SubstructureRedirect_
       Mask on the parent, the X server generates Configur_
       eRequest 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 spe
		 cific 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
		 defined Window.

SEE ALSO
       XChangeWindowAttributes(3X11), XConfigureWindow(3X11),
       XCreateWindow(3X11), XDestroyWindow(3X11), XMapWin
       dow(3X11), XUnmapWindow(3X11)
       Xlib - C Language X Interface


























XFree86			  Version 4.8.0				3


