NAME

XGetStandardColormap — get the standard colormap property. 

SYNOPSIS

Status XGetStandardColormap(display, w, cmap_info_return, property) Display ∗display;  Window w;  XStandardColormap ∗colormap_return;  Atom property;

ARGUMENTS

displaySpecifies a connection to an X server; returned from XOpenDisplay(). 

wSpecifies the ID of the window on which the property is set.  This is normally the root window. 

colormap_return
Returns the filled colormap information structure.

propertySpecifies the atom indicating the type of standard colormap desired. The predefined standard colormap atoms are XA_RGB_BEST_MAP, XA_RGB_RED_MAP, XA_RGB_GREEN_MAP, XA_RGB_BLUE_MAP, XA_RGB_DEFAULT_MAP, and XA_RGB_GRAY_MAP. 

RETURNS

Zero on failure, non-zero on success. 

DESCRIPTION

XGetStandardColormap() is superseded by XGetRGBColormaps() in Release 4.  XGetStandardColormap() gets a property on the root window that describes a standard colormap.  XGetStandardColormap() returns zero if it fails, or non-zero if it succeeds. 

See Volume One, Chapter 7, Color, for a complete description of standard colormaps. 

STRUCTURES

typedef struct {
    Colormap colormap;   /∗ ID of colormap created by XCreateColormap ∗/
    unsigned long red_max;
    unsigned long red_mult;
    unsigned long green_max;
    unsigned long green_mult;
    unsigned long blue_max;
    unsigned long blue_mult;
    unsigned long base_pixel;
    VisualID visualid;
    XID killid; } XStandardColormap;

ERRORS

BadAtom
BadWindow

SEE ALSO

XDefaultColormap(), XDisplayCells(), XCopyColormapAndFree(), XCreateColormap(), XFreeColormap(), XInstallColormap(), XListInstalledColormaps(), XSetStandardColormap(), XSetWindowColormap(), XUninstallColormap(). 

Xlib Reference Manual