<?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='xreccurman'>
<!--  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/XRecCur.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) -->
<!-- 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>XRecolorCursor</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XRecolorCursor</refname>
<refname>XFreeCursor</refname>
<refname>XQueryBestCursor</refname>
<refpurpose>manipulate cursors</refpurpose>
</refnamediv>
<!-- body begins here -->

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

<para>int XRecolorCursor&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Cursor <emphasis remap='I'>cursor</emphasis>&hairsp;, XColor
*<emphasis remap='I'>foreground_color</emphasis>&hairsp;, XColor *<emphasis remap='I'>background_color</emphasis>&hairsp;);</para> 

<para>int XFreeCursor&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Cursor <emphasis remap='I'>cursor</emphasis>&hairsp;);</para> 

<para>Status XQueryBestCursor&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Drawable <emphasis remap='I'>d</emphasis>&hairsp;,
unsigned int <emphasis remap='I'>width</emphasis>&hairsp;, unsigned int <emphasis remap='I'>height</emphasis>&hairsp;, unsigned int
*<emphasis remap='I'>width_return</emphasis>&hairsp;, unsigned int *<emphasis remap='I'>height_return</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>background_color</emphasis></term>
  <listitem>
<para>Specifies the RGB values for the background of the source.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>cursor</emphasis></term>
  <listitem>
<para>Specifies the cursor.</para> 
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>d</emphasis></term>
  <listitem>
<para>Specifies the drawable, which indicates the screen.</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'>foreground_color</emphasis></term>
  <listitem>
<para>Specifies the RGB values for the foreground of the source.</para> 
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>width</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>height</emphasis></term>
  <listitem>
<para>Specify the width and heightof the cursor that you want the size information for.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>width_return</emphasis></term>
<!-- .br -->
<!-- .ns -->
  <term><emphasis remap='I'>height_return</emphasis></term>
  <listitem>
<para>Return the best width and height that is closest to the specified width 
and height.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XRecolorCursor&hairsp;</emphasis>
function changes the color of the specified cursor, and
if the cursor is being displayed on a screen,
the change is visible immediately.
The pixel members of the
<emphasis remap='I'>&hairsp;XColor&hairsp;</emphasis>
structures are ignored; only the RGB values are used.</para>

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

<para>The
<emphasis remap='I'>&hairsp;XFreeCursor&hairsp;</emphasis>
function deletes the association between the cursor resource ID 
and the specified cursor.
The cursor storage is freed when no other resource references it.
The specified cursor ID should not be referred to again.</para>

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

<para>Some displays allow larger cursors than other displays.
The
<emphasis remap='I'>&hairsp;XQueryBestCursor&hairsp;</emphasis>
function provides a way to find out what size cursors are actually
possible on the display.
It returns the largest size that can be displayed.
Applications should be prepared to use smaller cursors on displays that
cannot support large ones.</para>

<para><emphasis remap='I'>&hairsp;XQueryBestCursor&hairsp;</emphasis>
can generate a
<emphasis remap='I'>&hairsp;BadDrawable&hairsp;</emphasis>
error.</para>
</refsect1>

<refsect1 id='diagnostics'><title>DIAGNOSTICS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadCursor&hairsp;</emphasis></term>
  <listitem>
<para>A value for a Cursor argument does not name a defined Cursor.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadDrawable&hairsp;</emphasis></term>
  <listitem>
<para>A value for a Drawable argument does not name a defined Window or Pixmap.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

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

