head	1.7;
access;
symbols
	core-8-5-9:1.7
	core-8-5-8:1.7
	macosx-cocoa-merge:1.7
	macosx-cocoa-premerge:1.7
	macosx-carbon-freeze:1.7
	core-8-5-7:1.7
	core-8-5-6:1.7
	core-8-6-b1:1.7
	core-8-6-a3:1.7
	core-8-5-5:1.7
	core-8-6-a2:1.7
	core-8-5-4:1.7
	core-8-5-3:1.7
	core-8-6-a1:1.7
	core-8-4-19:1.3
	core-8-5-branch:1.7.0.2
	core-8-5-2:1.7
	core-8-4-18:1.3
	core-8-5-1:1.6
	core-8-4-17:1.3
	core-8-5-0:1.6
	core-8-5-b3:1.5
	core-8-5-b2:1.4
	core-8-4-16:1.3
	core-8-5-b1:1.4
	core-stablilizer-merge:1.4
	core-stabilizer-branch:1.4.0.2
	core-stabilizer-merge:1.7
	core-8-4-15:1.3
	core-8-5-a6:1.4
	core-8-5-a5:1.3
	core-8-4-14:1.3
	core-8-5-a4:1.3
	core-8-4-13:1.3
	core-8-4-12:1.3
	core-8-4-11:1.3
	core-8-5-a3:1.3
	core-8-4-10:1.3
	core-8-4-9-branch:1.3.0.6
	core-8-5-a2:1.3
	core-8-4-9:1.3
	core-8-4-8:1.3
	core-8-4-7:1.3
	core-8-5-a1:1.3
	core-8-4-6:1.3
	core-8-4-5:1.3
	mistachkin-dev-branch:1.3.0.4
	core-8-4-4:1.3
	core-8-4-3:1.3
	core-8-4-branch:1.3.0.2
	core-8-4-2:1.3
	core-8-4-1:1.3
	core-8-3-5:1.2
	core-8-4-0:1.3
	macosx-8-4-merge-2002-08-31-trunk:1.3
	macosx-8-4-premerge-2002-08-31-branch:1.2.24.1
	macosx-8-4-premerge-2002-08-31-trunk:1.3
	macosx-8-4-merge-2002-08-30-branch:1.2.24.1
	macosx-8-4-merge-2002-08-30-trunk:1.3
	macosx-8-4-merge-2002-08-20-branch:1.2.24.1
	macosx-8-4-merge-2002-08-20-trunk:1.3
	core-8-4-b2:1.3
	core-8-4-b1:1.2
	macosx-premerge-6-9-02:1.2
	core-8-4-a4:1.2
	core-8-3-4:1.2
	macosx-8-4-branch:1.2.0.24
	macosx-8-4-branchpoint:1.2
	core-8-4-a3:1.2
	core-8-3-3:1.2
	dgp-privates-into-namespace:1.2.0.22
	tclpro-1-5-0:1.2
	core-8-4-win-speedup:1.2.0.20
	core-8-4-a2:1.2
	tclpro-1-4-1:1.2
	tclpro-1-4-0:1.2
	core-8-3-2:1.2
	ajuba-ajuba2-2-1-base:1.2
	ajuba-ajuba2-2-0:1.2
	core-8-4-a1:1.2
	core-8-3-1-branch:1.2.0.18
	core-8-3-1:1.2
	scriptics-sc-2-0-b5:1.2
	scriptics-sc-2-0-fixed:1.2
	scriptics-sc-2-0-b2:1.2
	scriptics-sc-2-0-b1:1.2
	core-8-3-0:1.2
	core-8-3-b2:1.2
	core-8-3-b1:1.2
	scriptics-sc-1-1:1.2
	scriptics-sc-1-1-b1:1.2
	core-8-2-3:1.2
	scriptics-sc-1-1-branch:1.2.0.16
	scriptics-sc-1-1-base:1.2
	scriptics-sc-1-0:1.2
	scriptics-sc-1-0-branch:1.2.0.14
	scriptics-sc-1-0-base:1.2
	core-8-2-2:1.2
	core-8-2-1:1.2
	scriptics-bc-1-0-b1:1.2
	core-8-2-1-branch:1.2.0.12
	scriptics-tclpro-1-3-0:1.2
	core-8-2-0:1.2
	core-8-2-b3-branch:1.2.0.10
	core-8-2-b3-base:1.2
	scriptics-tclpro-1-3-b4:1.2
	core-8-2-b2:1.2
	scriptics-tclpro-1-3-b3:1.2
	core-8-2-b1:1.2
	scriptics-tclpro-1-3-b2:1.2
	merge-to-mainline-5/21/99:1.2
	scriptics-tclpro-1-3-b2-branch:1.2.0.8
	core-8-1-1:1.2
	scriptics-tclpro-1-3-b1:1.2
	core-8-1-1-base:1.2
	core-8-1-0:1.2
	merge-to-mainline-4-29-99:1.2
	merge-to-mainline-4-23-99:1.2
	core-8-1-branch-old:1.1.0.4
	core-8-0-6-branch:1.2.0.6
	core-8-0-6-base:1.2
	core-8-0-5:1.2
	core-8-1-b3:1.1.4.1
	core-8-1-b2:1.1.4.1
	dev-8-1-stubs-branch:1.1.4.1.0.2
	dev-stubs-branch:1.2.0.4
	scriptics-tclpro-1-2:1.2
	scriptics-tclpro-1-2-b2:1.2
	core-8-1-merge-2/10/99:1.2
	core-8-0-5-branch:1.2.0.2
	core-8-0-5-base:1.2
	scriptics-tclpro-1-2-b1:1.2
	scriptics-tclpro-1-2-a1:1.2
	core-8-1-b1:1.1.4.1
	core-8-0-4:1.2
	core-8-1-a2:1.1
	core-8-0-2:1.1
	core-8-0-3:1.2;
locks; strict;
comment	@# @;


1.7
date	2008.03.19.15.34.41;	author dkf;	state Exp;
branches;
next	1.6;

1.6
date	2007.12.13.15.23.43;	author dgp;	state Exp;
branches;
next	1.5;

1.5
date	2007.10.29.16.04.12;	author dkf;	state Exp;
branches;
next	1.4;

1.4
date	2007.01.05.00.00.49;	author nijtmans;	state Exp;
branches
	1.4.2.1;
next	1.3;

1.3
date	2002.08.05.04.30.38;	author dgp;	state Exp;
branches;
next	1.2;

1.2
date	98.09.14.18.22.48;	author stanton;	state Exp;
branches
	1.2.24.1;
next	1.1;

1.1
date	98.04.01.09.40.04;	author rjohnson;	state Exp;
branches
	1.1.4.1;
next	;

1.1.4.1
date	98.09.30.02.15.53;	author stanton;	state Exp;
branches;
next	;

1.2.24.1
date	2002.08.20.20.27.00;	author das;	state Exp;
branches;
next	;

1.4.2.1
date	2007.11.01.16.37.12;	author dgp;	state Exp;
branches;
next	1.4.2.2;

1.4.2.2
date	2008.03.26.20.09.30;	author dgp;	state Exp;
branches;
next	;


desc
@@


1.7
log
@Documented Tk_PreserveColormap. [Bug 220809]
@
text
@'\"
'\" Copyright (c) 1994 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: GetClrmap.3,v 1.6 2007/12/13 15:23:43 dgp Exp $
'\" 
.so man.macros
.TH Tk_GetColormap 3 4.0 Tk "Tk Library Procedures"
.BS
.SH NAME
Tk_GetColormap, Tk_PreserveColormap, Tk_FreeColormap \- allocate and free colormaps
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
.sp
Colormap
\fBTk_GetColormap(\fIinterp, tkwin, string\fB)\fR
.sp
\fBTk_PreserveColormap(\fIdisplay, colormap\fB)\fR
.sp
\fBTk_FreeColormap(\fIdisplay, colormap\fB)\fR
.SH ARGUMENTS
.AS "Colormap" colormap
.AP Tcl_Interp *interp in
Interpreter to use for error reporting.
.AP Tk_Window tkwin in
Token for window in which colormap will be used.
.AP "const char" *string in
Selects a colormap:  either \fBnew\fR or the name of a window
with the same screen and visual as \fItkwin\fR.
.AP Display *display in
Display for which \fIcolormap\fR was allocated.
.AP Colormap colormap in
Colormap to free or preserve;  must have been returned by a previous
call to \fBTk_GetColormap\fR or \fBTk_GetVisual\fR.
.BE
.SH DESCRIPTION
.PP
These procedures are used to manage colormaps.
\fBTk_GetColormap\fR returns a colormap suitable for use in \fItkwin\fR.
If its \fIstring\fR argument is \fBnew\fR then a new colormap is
created;  otherwise \fIstring\fR must be the name of another window
with the same screen and visual as \fItkwin\fR, and the colormap from that
window is returned.
If \fIstring\fR does not make sense, or if it refers to a window on
a different screen from \fItkwin\fR or with
a different visual than \fItkwin\fR, then \fBTk_GetColormap\fR returns
\fBNone\fR and leaves an error message in \fIinterp\fR's result.
.PP
\fBTk_PreserveColormap\fR increases the internal reference count for a
colormap previously returned by \fBTk_GetColormap\fR, which allows the
colormap to be stored in several locations without knowing which order
they will be released.
.PP
\fBTk_FreeColormap\fR should be called when a colormap returned by
\fBTk_GetColormap\fR is no longer needed.
Tk maintains a reference count for each colormap returned by
\fBTk_GetColormap\fR, so there should eventually be one call to
\fBTk_FreeColormap\fR for each call to \fBTk_GetColormap\fR and each
call to \fBTk_PreserveColormap\fR.
When a colormap's reference count becomes zero, Tk releases the
X colormap.
.PP
\fBTk_GetVisual\fR and \fBTk_GetColormap\fR work together, in that
a new colormap created by \fBTk_GetVisual\fR may later be returned
by \fBTk_GetColormap\fR.
The reference counting mechanism for colormaps includes both procedures,
so callers of \fBTk_GetVisual\fR must also call \fBTk_FreeColormap\fR
to release the colormap.
If \fBTk_GetColormap\fR is called with a \fIstring\fR value of
\fBnew\fR then the resulting colormap will never
be returned by \fBTk_GetVisual\fR;  however, it can be used in other
windows by calling \fBTk_GetColormap\fR with the original window's
name as \fIstring\fR.
.SH KEYWORDS
colormap, visual
@


1.6
log
@merge stable branch onto HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetClrmap.3,v 1.4.2.1 2007/11/01 16:37:12 dgp Exp $
d14 1
a14 1
Tk_GetColormap, Tk_FreeColormap \- allocate and free colormaps
d22 2
d37 1
a37 1
Colormap to free;  must have been returned by a previous
a39 1

d51 6
a56 1
\fBNone\fR and leaves an error message in \fIinterp->result\fR.
d62 2
a63 1
\fBTk_FreeColormap\fR for each call to \fBTk_GetColormap\fR.
a77 1

d79 1
a79 1
colormap
@


1.5
log
@Lots more GOOBE stuff. Now works with 'make html'!
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetClrmap.3,v 1.4 2007/01/05 00:00:49 nijtmans Exp $
@


1.4
log
@various "const" additions, in line with TIP #27
fix bug #1627732
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetClrmap.3,v 1.3 2002/08/05 04:30:38 dgp Exp $
d47 1
a47 1
If \fIstring\fR doesn't make sense, or if it refers to a window on
@


1.4.2.1
log
@merge updates from HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetClrmap.3,v 1.4 2007/01/05 00:00:49 nijtmans Exp $
d47 1
a47 1
If \fIstring\fR does not make sense, or if it refers to a window on
@


1.4.2.2
log
@merge updates from HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetClrmap.3,v 1.4.2.1 2007/11/01 16:37:12 dgp Exp $
d14 1
a14 1
Tk_GetColormap, Tk_PreserveColormap, Tk_FreeColormap \- allocate and free colormaps
a21 2
\fBTk_PreserveColormap(\fIdisplay, colormap\fB)\fR
.sp
d35 1
a35 1
Colormap to free or preserve;  must have been returned by a previous
d38 1
d50 1
a50 6
\fBNone\fR and leaves an error message in \fIinterp\fR's result.
.PP
\fBTk_PreserveColormap\fR increases the internal reference count for a
colormap previously returned by \fBTk_GetColormap\fR, which allows the
colormap to be stored in several locations without knowing which order
they will be released.
d56 1
a56 2
\fBTk_FreeColormap\fR for each call to \fBTk_GetColormap\fR and each
call to \fBTk_PreserveColormap\fR.
d71 1
d73 1
a73 1
colormap, visual
@


1.3
log
@Applied companion patch for Tcl Patch 585105,
updating Tk to use Tcl 8.4's fully CONST-ified
interface, and fully CONSTifying Tk at the
same time.

This patch includes purging Tk of its last
direct access to interp->result.  [Bug 589853]

The substantial changes include copying
event sequence strings into Tcl_DStrings
in tkBind.c, and copying [text] indices into
Tcl_DStrings because parsing them involved
overwriting them.  If this causes performance
trouble, that can be resolved by further
converting them to Tcl_Obj's.

The #defines USE_NON_CONST and USE_COMPAT_CONST
have the same effect for Tk as they do for Tcl.
(They actually change tcl.h)
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetClrmap.3,v 1.2 1998/09/14 18:22:48 stanton Exp $
d29 1
a29 1
.AP "CONST char" *string in
@


1.2
log
@Replaced SCCS strings, fixed binary files
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id$
d29 1
a29 1
.AP char *string in
@


1.2.24.1
log
@merged with trunk at tag macosx-8-4-merge-2002-08-20-trunk
@
text
@d29 1
a29 1
.AP "CONST char" *string in
@


1.1
log
@Initial revision
@
text
@d8 1
a8 1
'\" SCCS: @@(#) GetClrmap.3 1.5 96/03/26 18:09:27
@


1.1.4.1
log
@Merged 8.0.3 changes into 8.1
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetClrmap.3,v 1.2 1998/09/14 18:22:48 stanton Exp $
@


