man/XInstallColormap.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 XInstallColormap __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XInstallColormap, XUninstallColormap, XListInstalledColormaps \- control colormaps
 145 .SH SYNTAX
 146 .HP
 147 int XInstallColormap\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^);
 148 .HP
 149 int XUninstallColormap\^(\^Display *\fIdisplay\fP\^, Colormap
 150 \fIcolormap\fP\^);
 151 .HP
 152 Colormap *XListInstalledColormaps\^(\^Display *\fIdisplay\fP\^, Window
 153 \fIw\fP\^, int *\fInum_return\fP\^);
 154 .SH ARGUMENTS
 155 .IP \fIcolormap\fP 1i
 156 Specifies the colormap.
 157 .IP \fIdisplay\fP 1i
 158 Specifies the connection to the X server.
 159 .IP \fInum_return\fP 1i
 160 Returns the number of currently installed colormaps.
 161 .ds Wi that determines the screen
 162 .IP \fIw\fP 1i
 163 Specifies the window \*(Wi.
 164 .SH DESCRIPTION
 165 The
 166 .ZN XInstallColormap
 167 function installs the specified colormap for its associated screen.
 168 All windows associated with this colormap immediately display with
 169 true colors.
 170 You associated the windows with this colormap when you created them by calling
 171 .ZN XCreateWindow ,
 172 .ZN XCreateSimpleWindow ,
 173 .ZN XChangeWindowAttributes ,
 174 or
 175 .ZN XSetWindowColormap .
 176 .LP
 177 If the specified colormap is not already an installed colormap,
 178 the X server generates a
 179 .ZN ColormapNotify
 180 event on each window that has that colormap.
 181 In addition, for every other colormap that is installed as
 182 a result of a call to
 183 .ZN XInstallColormap ,
 184 the X server generates a
 185 .ZN ColormapNotify
 186 event on each window that has that colormap.
 187 .LP
 188 .ZN XInstallColormap
 189 can generate a
 190 .ZN BadColor
 191 error.
 192 .LP
 193 The
 194 .ZN XUninstallColormap
 195 function removes the specified colormap from the required
 196 list for its screen.
 197 As a result,
 198 the specified colormap might be uninstalled,
 199 and the X server might implicitly install or uninstall additional colormaps.
 200 Which colormaps get installed or uninstalled is server dependent
 201 except that the required list must remain installed.
 202 .LP
 203 If the specified colormap becomes uninstalled,
 204 the X server generates a
 205 .ZN ColormapNotify
 206 event on each window that has that colormap.
 207 In addition, for every other colormap that is installed or uninstalled as a
 208 result of a call to
 209 .ZN XUninstallColormap ,
 210 the X server generates a
 211 .ZN ColormapNotify
 212 event on each window that has that colormap.
 213 .LP
 214 .ZN XUninstallColormap
 215 can generate a
 216 .ZN BadColor
 217 error.
 218 .LP
 219 The
 220 .ZN XListInstalledColormaps
 221 function returns a list of the currently installed colormaps for the screen
 222 of the specified window.
 223 The order of the colormaps in the list is not significant
 224 and is no explicit indication of the required list.
 225 When the allocated list is no longer needed,
 226 free it by using
 227 .ZN XFree .
 228 .LP
 229 .ZN XListInstalledColormaps
 230 can generate a
 231 .ZN BadWindow
 232 error.
 233 .SH DIAGNOSTICS
 234 .TP 1i
 235 .ZN BadColor
 236 A value for a Colormap argument does not name a defined Colormap.
 237 .TP 1i
 238 .ZN BadWindow
 239 A value for a Window argument does not name a defined Window.
 240 .SH "SEE ALSO"
 241 XChangeWindowAttributes(__libmansuffix__),
 242 XCreateColormap(__libmansuffix__),
 243 XCreateWindow(__libmansuffix__),
 244 XFree(__libmansuffix__)
 245 .br
 246 \fI\*(xL\fP