Tk_GetColormap (3)
allocate and free colormaps
SYNOPSIS
#include <tk.h>
Colormap
Tk_GetColormap(interp, tkwin, string)
Tk_FreeColormap(display, colormap)
ARGUMENTS
"Colormap" colormap
Tcl_Interp *interp in
Interpreter to use for error reporting.
Tk_Window tkwin in
Token for window in which colormap will be used.
char *string in
Selects a colormap: either new or the name of a window
with the same screen and visual as tkwin.
Display *display in
Display for which colormap was allocated.
Colormap colormap in
Colormap to free; must have been returned by a previous
call to Tk_GetColormap or Tk_GetVisual.
DESCRIPTION
These procedures are used to manage colormaps.
Tk_GetColormap returns a colormap suitable for use in tkwin.
If its string argument is new then a new colormap is
created; otherwise string must be the name of another window
with the same screen and visual as tkwin, and the colormap from that
window is returned.
If string doesn't make sense, or if it refers to a window on
a different screen from tkwin or with
a different visual than tkwin, then Tk_GetColormap returns
None and leaves an error message in interp->result.
Tk_FreeColormap should be called when a colormap returned by
Tk_GetColormap is no longer needed.
Tk maintains a reference count for each colormap returned by
Tk_GetColormap, so there should eventually be one call to
Tk_FreeColormap for each call to Tk_GetColormap.
When a colormap's reference count becomes zero, Tk releases the
X colormap.
Tk_GetVisual and Tk_GetColormap work together, in that
a new colormap created by Tk_GetVisual may later be returned
by Tk_GetColormap.
The reference counting mechanism for colormaps includes both procedures,
so callers of Tk_GetVisual must also call Tk_FreeColormap
to release the colormap.
If Tk_GetColormap is called with a string value of
new then the resulting colormap will never
be returned by Tk_GetVisual; however, it can be used in other
windows by calling Tk_GetColormap with the original window's
name as string.
KEYWORDS
colormap
'\"
'\" Copyright (c) 1990 The Regents of the University of California.
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" RCS: @(#) $Id: GetCursor.3,v 1.2 1998/09/14 18:22:49 stanton Exp $
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.2 1998/09/14 18:39:54 stanton Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|
