NAME

XCirculateSubwindows − circulate the stacking order of children up or down. 

Synopsis

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

Arguments

displaySpecifies a connection to an X server; returned from XOpenDisplay(). 

wSpecifies the window ID of the parent of the subwindows to be circulated. 

directionSpecifies the direction (up or down) that you want to circulate the children.  Pass either RaiseLowest or LowerHighest. 

Description

XCirculateSubwindows() circulates the children of the specified window in the specified direction, either RaiseLowest or LowerHighest.  If some other client has selected SubstructureRedirectMask on the specified window, then a CirculateRequest event is generated, and no further processing is performed.  If you specify RaiseLowest, this function raises the lowest mapped child (if any) that is occluded by another child to the top of the stack.  If you specify LowerHighest, this function lowers the highest mapped child (if any) that occludes another child to the bottom of the stack.  Exposure processing is performed on formerly obscured windows.  If a child is actually restacked, the X server generates a CirculateNotify event.  For more information, see Volume One, Chapter 14, Window Management. 

Errors

BadValue
BadWindow

See Also

XCirculateSubwindowsDown(), XCirculateSubwindowsUp(), XConfigureWindow(), XLowerWindow(), XMoveResizeWindow(), XMoveWindow(), XQueryTree(), XRaiseWindow(), XReparentWindow(), XResizeWindow(), XRestackWindows(). 

Copyright O’Reilly & Assoc.  —