XRaiseWindow(3X) — X Version 11

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

directionSpecifies the direction (up or down) that you want to circulate the window. You can pass one of these constants: RaiseLowest or LowerHighest.

displaySpecifies the connection to the X server.

nwindowsSpecifies the number of windows to be restacked.

wSpecifies the window ID.

windowsSpecifies an array containing the windows to be restacked. All the windows must have the same parent.

DESCRIPTION

The XRaiseWindow function raises the specified window to the top of the stack so that no sibling window obscures it. .PN 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. .PN XLowerWindow can generate a BadWindow error.

The XCirculateSubwindows function circulates the specified subwindow in the specified direction: RaiseLowest or LowerHighest. .PN 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. .PN 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. .PN 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 will be unaffected, but the other windows in the array will be stacked underneath the first window in the order of the array. The stacking order of the other windows is not affected. .PN 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 defined Window.

Museum