<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='xraisewinman'>
<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium -->

<!--  Permission is hereby granted, free of charge, to any person obtaining -->
<!--  a copy of this software and associated documentation files (the -->
<!--  "Software"), to deal in the Software without restriction, including -->
<!--  without limitation the rights to use, copy, modify, merge, publish, -->
<!--  distribute, sublicense, and/or sell copies of the Software, and to -->
<!--  permit persons to whom the Software is furnished to do so, subject to -->
<!--  the following conditions: -->

<!--  The above copyright notice and this permission notice shall be included -->
<!--  in all copies or substantial portions of the Software. -->

<!--  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -->
<!--  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -->
<!--  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -->
<!--  IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR -->
<!--  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -->
<!--  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -->
<!--  OTHER DEALINGS IN THE SOFTWARE. -->

<!--  Except as contained in this notice, the name of the X Consortium shall -->
<!--  not be used in advertising or otherwise to promote the sale, use or -->
<!--  other dealings in this Software without prior written authorization -->
<!--  from the X Consortium. -->

<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by -->
<!--  Digital Equipment Corporation -->

<!--  Portions Copyright \(co 1990, 1991 by -->
<!--  Tektronix, Inc. -->

<!--  Permission to use, copy, modify and distribute this documentation for -->
<!--  any purpose and without fee is hereby granted, provided that the above -->
<!--  copyright notice appears in all copies and that both that copyright notice -->
<!--  and this permission notice appear in all copies, and that the names of -->
<!--  Digital and Tektronix not be used in in advertising or publicity pertaining -->
<!--  to this documentation without specific, written prior permission. -->
<!--  Digital and Tektronix makes no representations about the suitability -->
<!--  of this documentation for any purpose. -->
<!--  It is provided ``as is'' without express or implied warranty. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/XRaiseWin.man,v 1.3 2003/04/28 22:17:56 herrb Exp $ -->

<!-- .na -->
<!-- Ds listing suppressed (not used) -->
<!-- De listing suppressed (not used) -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- IN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- Pn listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XRaiseWindow</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XRaiseWindow</refname>
<refname>XLowerWindow</refname>
<refname>XCirculateSubwindows</refname>
<refname>XCirculateSubwindowsUp</refname>
<refname>XCirculateSubwindowsDown</refname>
<refname>XRestackWindows</refname>
<refpurpose>change window stacking order</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>int XRaiseWindow&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window <emphasis remap='I'>w</emphasis>&hairsp;);</para> 

<para>int XLowerWindow&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window <emphasis remap='I'>w</emphasis>&hairsp;);</para> 

<para>int XCirculateSubwindows&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window <emphasis remap='I'>w</emphasis>&hairsp;, int
<emphasis remap='I'>direction</emphasis>&hairsp;);</para> 

<para>int XCirculateSubwindowsUp&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window <emphasis remap='I'>w</emphasis>&hairsp;);</para> 

<para>int XCirculateSubwindowsDown&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window <emphasis remap='I'>w</emphasis>&hairsp;);</para> 

<para>int XRestackWindows&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window <emphasis remap='I'>windows</emphasis>&hairsp;[], int
<emphasis remap='I'>nwindows</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>direction</emphasis></term>
  <listitem>
<para>Specifies the direction (up or down) that you want to circulate
the window. 
You can pass 
<emphasis remap='I'>&hairsp;RaiseLowest&hairsp;</emphasis>
or
<emphasis remap='I'>&hairsp;LowerHighest&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>Specifies the connection to the X server.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>nwindows</emphasis></term>
  <listitem>
<para>Specifies the number of windows to be restacked.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>w</emphasis></term>
  <listitem>
<para>Specifies the window.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>windows</emphasis></term>
  <listitem>
<para>Specifies an array containing the windows to be restacked.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XRaiseWindow&hairsp;</emphasis>
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 and y location on the desk constant.
Raising a mapped window may generate 
<emphasis remap='I'>&hairsp;Expose&hairsp;</emphasis>
events for the window and any mapped subwindows that were formerly obscured.</para>  

<para>If the override-redirect attribute of the window is 
<emphasis remap='I'>&hairsp;False&hairsp;</emphasis>
and some
other client has selected 
<emphasis remap='I'>&hairsp;SubstructureRedirectMask&hairsp;</emphasis>
on the parent, the X server generates a
<emphasis remap='I'>&hairsp;ConfigureRequest&hairsp;</emphasis>
event, and no processing is performed.
Otherwise, the window is raised.</para>

<para><emphasis remap='I'>&hairsp;XRaiseWindow&hairsp;</emphasis>
can generate a
<emphasis remap='I'>&hairsp;BadWindow&hairsp;</emphasis>
error.</para>

<para>The
<emphasis remap='I'>&hairsp;XLowerWindow&hairsp;</emphasis>
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 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 
<emphasis remap='I'>&hairsp;Expose&hairsp;</emphasis>
events on any windows it formerly obscured.</para>

<para>If the override-redirect attribute of the window is 
<emphasis remap='I'>&hairsp;False&hairsp;</emphasis>
and some
other client has selected 
<emphasis remap='I'>&hairsp;SubstructureRedirectMask&hairsp;</emphasis>
on the parent, the X server generates a
<emphasis remap='I'>&hairsp;ConfigureRequest&hairsp;</emphasis>
event, and no processing is performed.  
Otherwise, the window is lowered to the bottom of the
stack.</para>

<para><emphasis remap='I'>&hairsp;XLowerWindow&hairsp;</emphasis>
can generate a
<emphasis remap='I'>&hairsp;BadWindow&hairsp;</emphasis>
error.</para>

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

<para><emphasis remap='I'>&hairsp;XCirculateSubwindows&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
and
<emphasis remap='I'>&hairsp;BadWindow&hairsp;</emphasis>
errors.</para>

<para>The
<emphasis remap='I'>&hairsp;XCirculateSubwindowsUp&hairsp;</emphasis>
function raises the lowest mapped child of the specified window that
is partially
or completely
occluded by another child.
Completely unobscured children are not affected.
This is a convenience function equivalent to
<emphasis remap='I'>&hairsp;XCirculateSubwindows&hairsp;</emphasis>
with
<emphasis remap='I'>&hairsp;RaiseLowest&hairsp;</emphasis>
specified.</para>

<para><emphasis remap='I'>&hairsp;XCirculateSubwindowsUp&hairsp;</emphasis>
can generate a
<emphasis remap='I'>&hairsp;BadWindow&hairsp;</emphasis>
error.</para>

<para>The
<emphasis remap='I'>&hairsp;XCirculateSubwindowsDown&hairsp;</emphasis>
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
<emphasis remap='I'>&hairsp;XCirculateSubwindows&hairsp;</emphasis>
with
<emphasis remap='I'>&hairsp;LowerHighest&hairsp;</emphasis>
specified.</para>

<para><emphasis remap='I'>&hairsp;XCirculateSubwindowsDown&hairsp;</emphasis>
can generate a
<emphasis remap='I'>&hairsp;BadWindow&hairsp;</emphasis>
error.</para>

<para>The
<emphasis remap='I'>&hairsp;XRestackWindows&hairsp;</emphasis>
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
<emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis>
error results.</para>

<para>If the override-redirect attribute of a window is 
<emphasis remap='I'>&hairsp;False&hairsp;</emphasis>
and some
other client has selected 
<emphasis remap='I'>&hairsp;SubstructureRedirectMask&hairsp;</emphasis>
on the parent, the X server generates 
<emphasis remap='I'>&hairsp;ConfigureRequest&hairsp;</emphasis>
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.</para>

<para><emphasis remap='I'>&hairsp;XRestackWindows&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadWindow&hairsp;</emphasis>
error.</para>
</refsect1>

<refsect1 id='diagnostics'><title>DIAGNOSTICS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis></term>
  <listitem>
<para>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.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadWindow&hairsp;</emphasis></term>
  <listitem>
<para>A value for a Window argument does not name a defined Window.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>XChangeWindowAttributes(3X11),
XConfigureWindow(3X11),
XCreateWindow(3X11),
XDestroyWindow(3X11),
XMapWindow(3X11),
XUnmapWindow(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

