|
Packit |
5bd3a9 |
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
|
|
Packit |
5bd3a9 |
.\"
|
|
Packit |
5bd3a9 |
.\" Permission is hereby granted, free of charge, to any person obtaining
|
|
Packit |
5bd3a9 |
.\" a copy of this software and associated documentation files (the
|
|
Packit |
5bd3a9 |
.\" "Software"), to deal in the Software without restriction, including
|
|
Packit |
5bd3a9 |
.\" without limitation the rights to use, copy, modify, merge, publish,
|
|
Packit |
5bd3a9 |
.\" distribute, sublicense, and/or sell copies of the Software, and to
|
|
Packit |
5bd3a9 |
.\" permit persons to whom the Software is furnished to do so, subject to
|
|
Packit |
5bd3a9 |
.\" the following conditions:
|
|
Packit |
5bd3a9 |
.\"
|
|
Packit |
5bd3a9 |
.\" The above copyright notice and this permission notice shall be included
|
|
Packit |
5bd3a9 |
.\" in all copies or substantial portions of the Software.
|
|
Packit |
5bd3a9 |
.\"
|
|
Packit |
5bd3a9 |
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
Packit |
5bd3a9 |
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
Packit |
5bd3a9 |
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
Packit |
5bd3a9 |
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
|
Packit |
5bd3a9 |
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
|
Packit |
5bd3a9 |
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
Packit |
5bd3a9 |
.\" OTHER DEALINGS IN THE SOFTWARE.
|
|
Packit |
5bd3a9 |
.\"
|
|
Packit |
5bd3a9 |
.\" Except as contained in this notice, the name of the X Consortium shall
|
|
Packit |
5bd3a9 |
.\" not be used in advertising or otherwise to promote the sale, use or
|
|
Packit |
5bd3a9 |
.\" other dealings in this Software without prior written authorization
|
|
Packit |
5bd3a9 |
.\" from the X Consortium.
|
|
Packit |
5bd3a9 |
.\"
|
|
Packit |
5bd3a9 |
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
|
|
Packit |
5bd3a9 |
.\" Digital Equipment Corporation
|
|
Packit |
5bd3a9 |
.\"
|
|
Packit |
5bd3a9 |
.\" Portions Copyright \(co 1990, 1991 by
|
|
Packit |
5bd3a9 |
.\" Tektronix, Inc.
|
|
Packit |
5bd3a9 |
.\"
|
|
Packit |
5bd3a9 |
.\" Permission to use, copy, modify and distribute this documentation for
|
|
Packit |
5bd3a9 |
.\" any purpose and without fee is hereby granted, provided that the above
|
|
Packit |
5bd3a9 |
.\" copyright notice appears in all copies and that both that copyright notice
|
|
Packit |
5bd3a9 |
.\" and this permission notice appear in all copies, and that the names of
|
|
Packit |
5bd3a9 |
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
|
|
Packit |
5bd3a9 |
.\" to this documentation without specific, written prior permission.
|
|
Packit |
5bd3a9 |
.\" Digital and Tektronix makes no representations about the suitability
|
|
Packit |
5bd3a9 |
.\" of this documentation for any purpose.
|
|
Packit |
5bd3a9 |
.\" It is provided ``as is'' without express or implied warranty.
|
|
Packit |
5bd3a9 |
.\"
|
|
Packit |
5bd3a9 |
.\"
|
|
Packit |
5bd3a9 |
.ds xT X Toolkit Intrinsics \- C Language Interface
|
|
Packit |
5bd3a9 |
.ds xW Athena X Widgets \- C Language X Toolkit Interface
|
|
Packit |
5bd3a9 |
.ds xL Xlib \- C Language X Interface
|
|
Packit |
5bd3a9 |
.ds xC Inter-Client Communication Conventions Manual
|
|
Packit |
5bd3a9 |
.na
|
|
Packit |
5bd3a9 |
.de Ds
|
|
Packit |
5bd3a9 |
.nf
|
|
Packit |
5bd3a9 |
.\\$1D \\$2 \\$1
|
|
Packit |
5bd3a9 |
.ft CW
|
|
Packit |
5bd3a9 |
.\".ps \\n(PS
|
|
Packit |
5bd3a9 |
.\".if \\n(VS>=40 .vs \\n(VSu
|
|
Packit |
5bd3a9 |
.\".if \\n(VS<=39 .vs \\n(VSp
|
|
Packit |
5bd3a9 |
..
|
|
Packit |
5bd3a9 |
.de De
|
|
Packit |
5bd3a9 |
.ce 0
|
|
Packit |
5bd3a9 |
.if \\n(BD .DF
|
|
Packit |
5bd3a9 |
.nr BD 0
|
|
Packit |
5bd3a9 |
.in \\n(OIu
|
|
Packit |
5bd3a9 |
.if \\n(TM .ls 2
|
|
Packit |
5bd3a9 |
.sp \\n(DDu
|
|
Packit |
5bd3a9 |
.fi
|
|
Packit |
5bd3a9 |
..
|
|
Packit |
5bd3a9 |
.de IN \" send an index entry to the stderr
|
|
Packit |
5bd3a9 |
..
|
|
Packit |
5bd3a9 |
.de Pn
|
|
Packit |
5bd3a9 |
.ie t \\$1\fB\^\\$2\^\fR\\$3
|
|
Packit |
5bd3a9 |
.el \\$1\fI\^\\$2\^\fP\\$3
|
|
Packit |
5bd3a9 |
..
|
|
Packit |
5bd3a9 |
.de ZN
|
|
Packit |
5bd3a9 |
.ie t \fB\^\\$1\^\fR\\$2
|
|
Packit |
5bd3a9 |
.el \fI\^\\$1\^\fP\\$2
|
|
Packit |
5bd3a9 |
..
|
|
Packit |
5bd3a9 |
.de hN
|
|
Packit |
5bd3a9 |
.ie t <\fB\\$1\fR>\\$2
|
|
Packit |
5bd3a9 |
.el <\fI\\$1\fP>\\$2
|
|
Packit |
5bd3a9 |
..
|
|
Packit |
5bd3a9 |
.ny0
|
|
Packit |
5bd3a9 |
.TH XRecolorCursor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
|
|
Packit |
5bd3a9 |
.SH NAME
|
|
Packit |
5bd3a9 |
XRecolorCursor, XFreeCursor, XQueryBestCursor \- manipulate cursors
|
|
Packit |
5bd3a9 |
.SH SYNTAX
|
|
Packit |
5bd3a9 |
.HP
|
|
Packit |
5bd3a9 |
int XRecolorCursor\^(\^Display *\fIdisplay\fP\^, Cursor \fIcursor\fP\^, XColor
|
|
Packit |
5bd3a9 |
*\fIforeground_color\fP\^, XColor *\fIbackground_color\fP\^);
|
|
Packit |
5bd3a9 |
.HP
|
|
Packit |
5bd3a9 |
int XFreeCursor\^(\^Display *\fIdisplay\fP\^, Cursor \fIcursor\fP\^);
|
|
Packit |
5bd3a9 |
.HP
|
|
Packit |
5bd3a9 |
Status XQueryBestCursor\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^,
|
|
Packit |
5bd3a9 |
unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int
|
|
Packit |
5bd3a9 |
*\fIwidth_return\fP\^, unsigned int *\fIheight_return\fP\^);
|
|
Packit |
5bd3a9 |
.SH ARGUMENTS
|
|
Packit |
5bd3a9 |
.IP \fIbackground_color\fP 1i
|
|
Packit |
5bd3a9 |
Specifies the RGB values for the background of the source.
|
|
Packit |
5bd3a9 |
.IP \fIcursor\fP 1i
|
|
Packit |
5bd3a9 |
Specifies the cursor.
|
|
Packit |
5bd3a9 |
.ds Dr , which indicates the screen
|
|
Packit |
5bd3a9 |
.IP \fId\fP 1i
|
|
Packit |
5bd3a9 |
Specifies the drawable\*(Dr.
|
|
Packit |
5bd3a9 |
.IP \fIdisplay\fP 1i
|
|
Packit |
5bd3a9 |
Specifies the connection to the X server.
|
|
Packit |
5bd3a9 |
.IP \fIforeground_color\fP 1i
|
|
Packit |
5bd3a9 |
Specifies the RGB values for the foreground of the source.
|
|
Packit |
5bd3a9 |
.ds Wh of the cursor that you want the size information for
|
|
Packit |
5bd3a9 |
.IP \fIwidth\fP 1i
|
|
Packit |
5bd3a9 |
.br
|
|
Packit |
5bd3a9 |
.ns
|
|
Packit |
5bd3a9 |
.IP \fIheight\fP 1i
|
|
Packit |
5bd3a9 |
Specify the width and height\*(Wh.
|
|
Packit |
5bd3a9 |
.IP \fIwidth_return\fP 1i
|
|
Packit |
5bd3a9 |
.br
|
|
Packit |
5bd3a9 |
.ns
|
|
Packit |
5bd3a9 |
.IP \fIheight_return\fP 1i
|
|
Packit |
5bd3a9 |
Return the best width and height that is closest to the specified width
|
|
Packit |
5bd3a9 |
and height.
|
|
Packit |
5bd3a9 |
.SH DESCRIPTION
|
|
Packit |
5bd3a9 |
The
|
|
Packit |
5bd3a9 |
.ZN XRecolorCursor
|
|
Packit |
5bd3a9 |
function changes the color of the specified cursor, and
|
|
Packit |
5bd3a9 |
if the cursor is being displayed on a screen,
|
|
Packit |
5bd3a9 |
the change is visible immediately.
|
|
Packit |
5bd3a9 |
The pixel members of the
|
|
Packit |
5bd3a9 |
.ZN XColor
|
|
Packit |
5bd3a9 |
structures are ignored; only the RGB values are used.
|
|
Packit |
5bd3a9 |
.LP
|
|
Packit |
5bd3a9 |
.ZN XRecolorCursor
|
|
Packit |
5bd3a9 |
can generate a
|
|
Packit |
5bd3a9 |
.ZN BadCursor
|
|
Packit |
5bd3a9 |
error.
|
|
Packit |
5bd3a9 |
.LP
|
|
Packit |
5bd3a9 |
The
|
|
Packit |
5bd3a9 |
.ZN XFreeCursor
|
|
Packit |
5bd3a9 |
function deletes the association between the cursor resource ID
|
|
Packit |
5bd3a9 |
and the specified cursor.
|
|
Packit |
5bd3a9 |
The cursor storage is freed when no other resource references it.
|
|
Packit |
5bd3a9 |
The specified cursor ID should not be referred to again.
|
|
Packit |
5bd3a9 |
.LP
|
|
Packit |
5bd3a9 |
.ZN XFreeCursor
|
|
Packit |
5bd3a9 |
can generate a
|
|
Packit |
5bd3a9 |
.ZN BadCursor
|
|
Packit |
5bd3a9 |
error.
|
|
Packit |
5bd3a9 |
.LP
|
|
Packit |
5bd3a9 |
Some displays allow larger cursors than other displays.
|
|
Packit |
5bd3a9 |
The
|
|
Packit |
5bd3a9 |
.ZN XQueryBestCursor
|
|
Packit |
5bd3a9 |
function provides a way to find out what size cursors are actually
|
|
Packit |
5bd3a9 |
possible on the display.
|
|
Packit |
5bd3a9 |
.IN "Cursor" "limitations"
|
|
Packit |
5bd3a9 |
It returns the largest size that can be displayed.
|
|
Packit |
5bd3a9 |
Applications should be prepared to use smaller cursors on displays that
|
|
Packit |
5bd3a9 |
cannot support large ones.
|
|
Packit |
5bd3a9 |
.LP
|
|
Packit |
5bd3a9 |
.ZN XQueryBestCursor
|
|
Packit |
5bd3a9 |
can generate a
|
|
Packit |
5bd3a9 |
.ZN BadDrawable
|
|
Packit |
5bd3a9 |
error.
|
|
Packit |
5bd3a9 |
.SH DIAGNOSTICS
|
|
Packit |
5bd3a9 |
.TP 1i
|
|
Packit |
5bd3a9 |
.ZN BadCursor
|
|
Packit |
5bd3a9 |
A value for a Cursor argument does not name a defined Cursor.
|
|
Packit |
5bd3a9 |
.TP 1i
|
|
Packit |
5bd3a9 |
.ZN BadDrawable
|
|
Packit |
5bd3a9 |
A value for a Drawable argument does not name a defined Window or Pixmap.
|
|
Packit |
5bd3a9 |
.SH "SEE ALSO"
|
|
Packit |
5bd3a9 |
XCreateColormap(__libmansuffix__),
|
|
Packit |
5bd3a9 |
XCreateFontCursor(__libmansuffix__),
|
|
Packit |
5bd3a9 |
XDefineCursor(__libmansuffix__)
|
|
Packit |
5bd3a9 |
.br
|
|
Packit |
5bd3a9 |
\fI\*(xL\fP
|