1XInstallColormap(3)             XLIB FUNCTIONS             XInstallColormap(3)
2
3
4

NAME

6       XInstallColormap, XUninstallColormap, XListInstalledColormaps - control
7       colormaps
8

SYNTAX

10       int XInstallColormap(Display *display, Colormap colormap);
11
12       int XUninstallColormap(Display *display, Colormap colormap);
13
14       Colormap  *XListInstalledColormaps(Display  *display,  Window  w,   int
15              *num_return);
16

ARGUMENTS

18       colormap  Specifies the colormap.
19
20       display   Specifies the connection to the X server.
21
22       num_return
23                 Returns the number of currently installed colormaps.
24
25       w         Specifies the window that determines the screen.
26

DESCRIPTION

28       The  XInstallColormap  function installs the specified colormap for its
29       associated screen.  All windows associated with this  colormap  immedi‐
30       ately  display  with true colors.  You associated the windows with this
31       colormap when you created them by  calling  XCreateWindow,  XCreateSim‐
32       pleWindow, XChangeWindowAttributes, or XSetWindowColormap.
33
34       If  the  specified colormap is not already an installed colormap, the X
35       server generates a ColormapNotify event on each window  that  has  that
36       colormap.  In addition, for every other colormap that is installed as a
37       result of a call to XInstallColormap, the X  server  generates  a  Col‐
38       ormapNotify event on each window that has that colormap.
39
40       XInstallColormap can generate a BadColor error.
41
42       The XUninstallColormap function removes the specified colormap from the
43       required list for its screen.  As  a  result,  the  specified  colormap
44       might  be  uninstalled,  and  the  X server might implicitly install or
45       uninstall additional colormaps.  Which colormaps get installed or unin‐
46       stalled  is  server dependent except that the required list must remain
47       installed.
48
49       If the specified colormap becomes uninstalled, the X server generates a
50       ColormapNotify  event  on each window that has that colormap.  In addi‐
51       tion, for every other colormap that is installed or  uninstalled  as  a
52       result  of  a call to XUninstallColormap, the X server generates a Col‐
53       ormapNotify event on each window that has that colormap.
54
55       XUninstallColormap can generate a BadColor error.
56
57       The XListInstalledColormaps function returns a list  of  the  currently
58       installed  colormaps for the screen of the specified window.  The order
59       of the colormaps in the list is not significant and is no explicit  in‐
60       dication  of  the  required list.  When the allocated list is no longer
61       needed, free it by using XFree.
62
63       XListInstalledColormaps can generate a BadWindow error.
64

DIAGNOSTICS

66       BadColor  A value for a Colormap argument does not name a defined  Col‐
67                 ormap.
68
69       BadWindow A value for a Window argument does not name a defined Window.
70

SEE ALSO

72       XChangeWindowAttributes(3),    XCreateColormap(3),    XCreateWindow(3),
73       XFree(3)
74       Xlib - C Language X Interface
75
76
77
78X Version 11                    libX11 1.7.3.1             XInstallColormap(3)
Impressum