man/XRecolorCursor.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XRecolorCursor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XRecolorCursor, XFreeCursor, XQueryBestCursor \- manipulate cursors
 145 .SH SYNTAX
 146 .HP
 147 int XRecolorCursor\^(\^Display *\fIdisplay\fP\^, Cursor \fIcursor\fP\^, XColor
 148 *\fIforeground_color\fP\^, XColor *\fIbackground_color\fP\^);
 149 .HP
 150 int XFreeCursor\^(\^Display *\fIdisplay\fP\^, Cursor \fIcursor\fP\^);
 151 .HP
 152 Status XQueryBestCursor\^(\^Display *\fIdisplay\fP\^, Drawable \fId\fP\^,
 153 unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int
 154 *\fIwidth_return\fP\^, unsigned int *\fIheight_return\fP\^);
 155 .SH ARGUMENTS
 156 .IP \fIbackground_color\fP 1i
 157 Specifies the RGB values for the background of the source.
 158 .IP \fIcursor\fP 1i
 159 Specifies the cursor.
 160 .ds Dr , which indicates the screen
 161 .IP \fId\fP 1i
 162 Specifies the drawable\*(Dr.
 163 .IP \fIdisplay\fP 1i
 164 Specifies the connection to the X server.
 165 .IP \fIforeground_color\fP 1i
 166 Specifies the RGB values for the foreground of the source.
 167 .ds Wh  of the cursor that you want the size information for
 168 .IP \fIwidth\fP 1i
 169 .br
 170 .ns
 171 .IP \fIheight\fP 1i
 172 Specify the width and height\*(Wh.
 173 .IP \fIwidth_return\fP 1i
 174 .br
 175 .ns
 176 .IP \fIheight_return\fP 1i
 177 Return the best width and height that is closest to the specified width
 178 and height.
 179 .SH DESCRIPTION
 180 The
 181 .ZN XRecolorCursor
 182 function changes the color of the specified cursor, and
 183 if the cursor is being displayed on a screen,
 184 the change is visible immediately.
 185 The pixel members of the
 186 .ZN XColor
 187 structures are ignored; only the RGB values are used.
 188 .LP
 189 .ZN XRecolorCursor
 190 can generate a
 191 .ZN BadCursor
 192 error.
 193 .LP
 194 The
 195 .ZN XFreeCursor
 196 function deletes the association between the cursor resource ID
 197 and the specified cursor.
 198 The cursor storage is freed when no other resource references it.
 199 The specified cursor ID should not be referred to again.
 200 .LP
 201 .ZN XFreeCursor
 202 can generate a
 203 .ZN BadCursor
 204 error.
 205 .LP
 206 Some displays allow larger cursors than other displays.
 207 The
 208 .ZN XQueryBestCursor
 209 function provides a way to find out what size cursors are actually
 210 possible on the display.
 211 .IN "Cursor" "limitations"
 212 It returns the largest size that can be displayed.
 213 Applications should be prepared to use smaller cursors on displays that
 214 cannot support large ones.
 215 .LP
 216 .ZN XQueryBestCursor
 217 can generate a
 218 .ZN BadDrawable
 219 error.
 220 .SH DIAGNOSTICS
 221 .TP 1i
 222 .ZN BadCursor
 223 A value for a Cursor argument does not name a defined Cursor.
 224 .TP 1i
 225 .ZN BadDrawable
 226 A value for a Drawable argument does not name a defined Window or Pixmap.
 227 .SH "SEE ALSO"
 228 XCreateColormap(__libmansuffix__),
 229 XCreateFontCursor(__libmansuffix__),
 230 XDefineCursor(__libmansuffix__)
 231 .br
 232 \fI\*(xL\fP