<?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='xseinfocman'>
<!--  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/XSeInFoc.man,v 1.3 2003/04/28 22:17:57 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) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XSetInputFocus</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XSetInputFocus</refname>
<refname>XGetInputFocus</refname>
<refpurpose>control input focus</refpurpose>
</refnamediv>
<!-- body begins here -->

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

<para>int XSetInputFocus&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window <emphasis remap='I'>focus</emphasis>&hairsp;, int
<emphasis remap='I'>revert_to</emphasis>&hairsp;, Time <emphasis remap='I'>time</emphasis>&hairsp;);</para> 

<para>int XGetInputFocus&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Window *<emphasis remap='I'>focus_return</emphasis>&hairsp;,
int *<emphasis remap='I'>revert_to_return</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <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'>focus</emphasis></term>
  <listitem>
<para>Specifies the window,
<emphasis remap='I'>&hairsp;PointerRoot&hairsp;</emphasis>,
or
<emphasis remap='I'>&hairsp;None&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>focus_return</emphasis></term>
  <listitem>
<para>Returns the focus window,
<emphasis remap='I'>&hairsp;PointerRoot&hairsp;</emphasis>,
or 
<emphasis remap='I'>&hairsp;None&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>revert_to</emphasis></term>
  <listitem>
<para>Specifies where the input focus reverts to if the window becomes not
viewable.
You can pass 
<emphasis remap='I'>&hairsp;RevertToParent&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;RevertToPointerRoot&hairsp;</emphasis>,
or 
<emphasis remap='I'>&hairsp;RevertToNone&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>revert_to_return</emphasis></term>
  <listitem>
<para>Returns the current focus state
(<emphasis remap='I'>&hairsp;RevertToParent&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;RevertToPointerRoot&hairsp;</emphasis>,
or 
<emphasis remap='I'>&hairsp;RevertToNone&hairsp;</emphasis>).</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>time</emphasis></term>
  <listitem>
<para>Specifies the time.
You can pass either a timestamp or
<emphasis remap='I'>&hairsp;CurrentTime&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XSetInputFocus&hairsp;</emphasis>
function changes the input focus and the last-focus-change time.
It has no effect if the specified time is earlier than the current
last-focus-change time or is later than the current X server time.
Otherwise, the last-focus-change time is set to the specified time
(<emphasis remap='I'>&hairsp;CurrentTime&hairsp;</emphasis>
is replaced by the current X server time).
<emphasis remap='I'>&hairsp;XSetInputFocus&hairsp;</emphasis>
causes the X server to generate
<emphasis remap='I'>&hairsp;FocusIn&hairsp;</emphasis>
and 
<emphasis remap='I'>&hairsp;FocusOut&hairsp;</emphasis>
events.</para>

<para>Depending on the focus argument,
the following occurs:</para> 
<itemizedlist remap='IP+bullet'>
  <listitem override='bullet'>
<para>If focus is
<emphasis remap='I'>&hairsp;None&hairsp;</emphasis>,
all keyboard events are discarded until a new focus window is set,
and the revert_to argument is ignored.</para>
  </listitem>
</itemizedlist>
<itemizedlist remap='IP+bullet'>
  <listitem override='bullet'>
<para>If focus is a window, 
it becomes the keyboard's focus window.
If a generated keyboard event would normally be reported to this window
or one of its inferiors, the event is reported as usual. 
Otherwise, the event is reported relative to the focus window.</para>
  </listitem>
</itemizedlist>
<itemizedlist remap='IP+bullet'>
  <listitem override='bullet'>
<para>If focus is
<emphasis remap='I'>&hairsp;PointerRoot&hairsp;</emphasis>,
the focus window is dynamically taken to be the root window of whatever screen 
the pointer is on at each keyboard event.  
In this case, the revert_to argument is ignored.</para>
  </listitem>
</itemizedlist>

<para>The specified focus window must be viewable at the time 
<emphasis remap='I'>&hairsp;XSetInputFocus&hairsp;</emphasis>
is called,
or a
<emphasis remap='I'>&hairsp;BadMatch&hairsp;</emphasis>
error results.
If the focus window later becomes not viewable, 
the X server
evaluates the revert_to argument to determine the new focus window as follows:</para> 
<itemizedlist remap='IP+bullet'>
  <listitem override='bullet'>
<para>If revert_to is
<emphasis remap='I'>&hairsp;RevertToParent&hairsp;</emphasis>,
the focus reverts to the parent (or the closest viewable ancestor), 
and the new revert_to value is taken to be
<emphasis remap='I'>&hairsp;RevertToNone&hairsp;</emphasis>.</para>
  </listitem>
</itemizedlist>
<itemizedlist remap='IP+bullet'>
  <listitem override='bullet'>
<para>If revert_to is
<emphasis remap='I'>&hairsp;RevertToPointerRoot&hairsp;</emphasis>
or 
<emphasis remap='I'>&hairsp;RevertToNone&hairsp;</emphasis>,
the focus reverts to
<emphasis remap='I'>&hairsp;PointerRoot&hairsp;</emphasis>
or
<emphasis remap='I'>&hairsp;None&hairsp;</emphasis>,
respectively.
When the focus reverts,
the X server generates
<emphasis remap='I'>&hairsp;FocusIn&hairsp;</emphasis>
and
<emphasis remap='I'>&hairsp;FocusOut&hairsp;</emphasis>
events, but the last-focus-change time is not affected.</para>
  </listitem>
</itemizedlist>

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

<para>The
<emphasis remap='I'>&hairsp;XGetInputFocus&hairsp;</emphasis>
function returns the focus window and the current focus state.</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>XWarpPointer(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

