<?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='xmbricman'>
<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium -->
<!--  Copyright \(co 2000  The XFree86 Project, Inc. -->

<!--  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/XmbRIC.man,v 1.4 2003/04/28 22:17:58 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>XmbResetIC</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XmbResetIC</refname>
<refname>XwcResetIC</refname>
<refname>Xutf8ResetIC</refname>
<refpurpose>reset the state of an input context</refpurpose>
</refnamediv>
<!-- body begins here -->

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

<para>char *XmbResetIC&hairsp;(&hairsp;XIC <emphasis remap='I'>ic</emphasis>&hairsp;);</para> 

<para>wchar_t *XwcResetIC&hairsp;(&hairsp;XIC <emphasis remap='I'>ic</emphasis>&hairsp;);</para> 

<para>char *Xutf8ResetIC&hairsp;(&hairsp;XIC <emphasis remap='I'>ic</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>ic</emphasis></term>
  <listitem>
<para>Specifies the input context.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>When
<emphasis remap='I'>&hairsp;XNResetState&hairsp;</emphasis>
is set to
<emphasis remap='I'>&hairsp;XIMInitialState&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;XmbResetIC&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;XwcResetIC&hairsp;</emphasis>
and
<emphasis remap='I'>&hairsp;Xutf8ResetIC&hairsp;</emphasis>
reset an input context to its initial state;
when
<emphasis remap='I'>&hairsp;XNResetState&hairsp;</emphasis>
is set to
<emphasis remap='I'>&hairsp;XIMPreserveState&hairsp;</emphasis>,
the current input context state is preserved.
In both cases, any input pending on that context is deleted.
The input method is required to clear the preedit area, if any,
and update the status accordingly.
Calling 
<emphasis remap='I'>&hairsp;XmbResetIC&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;XwcResetIC&hairsp;</emphasis>
or
<emphasis remap='I'>&hairsp;Xutf8ResetIC&hairsp;</emphasis>
does not change the focus.</para>

<para>The return value of
<emphasis remap='I'>&hairsp;XmbResetIC&hairsp;</emphasis>
is its current preedit string as a multibyte string.
The return value of
<emphasis remap='I'>&hairsp;XwcResetIC&hairsp;</emphasis>
is its current preedit string as a wide character string.
The return value of
<emphasis remap='I'>&hairsp;Xutf8ResetIC&hairsp;</emphasis>
is its current preedit string as an UTF-8 string.
If there is any preedit text drawn or visible to the user,
then these procedures must return a non-NULL string.
If there is no visible preedit text, 
then it is input method implementation-dependent 
whether these procedures return a non-NULL string or NULL.</para>

<para>The client should free the returned string by calling
<emphasis remap='I'>&hairsp;XFree&hairsp;</emphasis>.</para>

<para>The function
<emphasis remap='I'>&hairsp;Xutf8ResetIC&hairsp;</emphasis>
is an XFree86 extension introduced in XFree86 4.0.2. Its presence is
indicated by the macro
<emphasis remap='I'>&hairsp;X_HAVE_UTF8_STRING&hairsp;</emphasis>.</para>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>XCreateIC(3X11),
XOpenIM(3X11),
XSetICFocus(3X11),
XSetICValues(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

