2 '\" Copyright (c) 1994 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 .TH Tk_GetColormap 3 4.0 Tk "Tk Library Procedures"
9 .\" The -*- nroff -*- definitions below are for supplemental macros used
10 .\" in Tcl/Tk manual entries.
12 .\" .AP type name in/out ?indent?
13 .\" Start paragraph describing an argument to a library procedure.
14 .\" type is type of argument (int, etc.), in/out is either "in", "out",
15 .\" or "in/out" to describe whether procedure reads or modifies arg,
16 .\" and indent is equivalent to second arg of .IP (shouldn't ever be
17 .\" needed; use .AS below instead)
20 .\" Give maximum sizes of arguments for setting tab stops. Type and
21 .\" name are examples of largest possible arguments that will be passed
22 .\" to .AP later. If args are omitted, default tab stops are used.
25 .\" Start box enclosure. From here until next .BE, everything will be
26 .\" enclosed in one large box.
29 .\" End of box enclosure.
32 .\" Begin code excerpt.
37 .\" .VS ?version? ?br?
38 .\" Begin vertical sidebar, for use in marking newly-changed parts
39 .\" of man pages. The first argument is ignored and used for recording
40 .\" the version when the .VS was added, so that the sidebars can be
41 .\" found and removed when they reach a certain age. If another argument
42 .\" is present, then a line break is forced before starting the sidebar.
45 .\" End of vertical sidebar.
48 .\" Begin an indented unfilled display.
51 .\" End of indented unfilled display.
54 .\" Start of list of standard options for a Tk widget. The manpage
55 .\" argument defines where to look up the standard options; if
56 .\" omitted, defaults to "options". The options follow on successive
57 .\" lines, in three columns separated by tabs.
60 .\" End of list of standard options for a Tk widget.
62 .\" .OP cmdName dbName dbClass
63 .\" Start of description of a specific option. cmdName gives the
64 .\" option's name as specified in the class command, dbName gives
65 .\" the option's name in the option database, and dbClass gives
66 .\" the option's class in the option database.
69 .\" Print arg1 underlined, then print arg2 normally.
72 .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation).
75 .\" Print an open parenthesis, arg1 in quotes, then arg2 normally
76 .\" (for trailing punctuation) and then a closing parenthesis.
78 .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
82 .\" # Start an argument description
86 . ie !"\\$2"" .TP \\n()Cu
91 \&\\$1 \\fI\\$2\\fP (\\$3)
104 .\" # define tabbing values for .AP
107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
113 .AS Tcl_Interp Tcl_CreateInterp in/out
114 .\" # BS - start boxed text
115 .\" # ^y = starting y location
123 .if n \l'\\n(.lu\(ul'
126 .\" # BE - end boxed text (draw box now)
131 .ie n \l'\\n(^lu\(ul'
133 .\" Draw four-sided box normally, but don't draw top of
134 .\" box if the box started on an earlier page.
136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
146 .\" # VS - start vertical sidebar
147 .\" # ^Y = starting y location
148 .\" # ^v = 1 (for troff; for nroff this doesn't matter)
152 .ie n 'mc \s12\(br\s0
155 .\" # VE - end of vertical sidebar
163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
170 .\" # Special macro to handle page bottom: finish off current
171 .\" # box/sidebar if in box/sidebar mode, then invoked standard
172 .\" # page bottom macro.
179 .\" Draw three-sided box if this is the box's first page,
180 .\" draw two sides but no top otherwise.
181 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
185 .nr ^x \\n(^tu+1v-\\n(^Yu
186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
199 .\" # DS - begin display
205 .\" # DE - end display
211 .\" # SO - start of list of standard options
213 'ie '\\$1'' .ds So \\fBoptions\\fR
214 'el .ds So \\fB\\$1\\fR
215 .SH "STANDARD OPTIONS"
221 .\" # SE - end of list of standard options
226 See the \\*(So manual entry for details on the standard options.
228 .\" # OP - start of full description for a single option
233 Command-Line Name: \\fB\\$1\\fR
234 Database Name: \\fB\\$2\\fR
235 Database Class: \\fB\\$3\\fR
239 .\" # CS - begin code excerpt
245 .\" # CE - end code excerpt
250 .\" # UL - underline word
254 .\" # QW - apply quotation marks to word
256 .ie '\\*(lq'"' ``\\$1''\\$2
257 .\"" fix emacs highlighting
258 .el \\*(lq\\$1\\*(rq\\$2
260 .\" # PQ - apply parens and quotation marks to word
262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
263 .\"" fix emacs highlighting
264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
266 .\" # QR - quoted range
268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
269 .\"" fix emacs highlighting
270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
272 .\" # MT - "empty" string
278 Tk_GetColormap, Tk_PreserveColormap, Tk_FreeColormap \- allocate and free colormaps
281 \fB#include <tk.h>\fR
284 \fBTk_GetColormap(\fIinterp, tkwin, string\fB)\fR
286 \fBTk_PreserveColormap(\fIdisplay, colormap\fB)\fR
288 \fBTk_FreeColormap(\fIdisplay, colormap\fB)\fR
290 .AS "Colormap" colormap
291 .AP Tcl_Interp *interp in
292 Interpreter to use for error reporting.
293 .AP Tk_Window tkwin in
294 Token for window in which colormap will be used.
295 .AP "const char" *string in
296 Selects a colormap: either \fBnew\fR or the name of a window
297 with the same screen and visual as \fItkwin\fR.
298 .AP Display *display in
299 Display for which \fIcolormap\fR was allocated.
300 .AP Colormap colormap in
301 Colormap to free or preserve; must have been returned by a previous
302 call to \fBTk_GetColormap\fR or \fBTk_GetVisual\fR.
306 These procedures are used to manage colormaps.
307 \fBTk_GetColormap\fR returns a colormap suitable for use in \fItkwin\fR.
308 If its \fIstring\fR argument is \fBnew\fR then a new colormap is
309 created; otherwise \fIstring\fR must be the name of another window
310 with the same screen and visual as \fItkwin\fR, and the colormap from that
312 If \fIstring\fR does not make sense, or if it refers to a window on
313 a different screen from \fItkwin\fR or with
314 a different visual than \fItkwin\fR, then \fBTk_GetColormap\fR returns
315 \fBNone\fR and leaves an error message in \fIinterp\fR's result.
317 \fBTk_PreserveColormap\fR increases the internal reference count for a
318 colormap previously returned by \fBTk_GetColormap\fR, which allows the
319 colormap to be stored in several locations without knowing which order
320 they will be released.
322 \fBTk_FreeColormap\fR should be called when a colormap returned by
323 \fBTk_GetColormap\fR is no longer needed.
324 Tk maintains a reference count for each colormap returned by
325 \fBTk_GetColormap\fR, so there should eventually be one call to
326 \fBTk_FreeColormap\fR for each call to \fBTk_GetColormap\fR and each
327 call to \fBTk_PreserveColormap\fR.
328 When a colormap's reference count becomes zero, Tk releases the
331 \fBTk_GetVisual\fR and \fBTk_GetColormap\fR work together, in that
332 a new colormap created by \fBTk_GetVisual\fR may later be returned
333 by \fBTk_GetColormap\fR.
334 The reference counting mechanism for colormaps includes both procedures,
335 so callers of \fBTk_GetVisual\fR must also call \fBTk_FreeColormap\fR
336 to release the colormap.
337 If \fBTk_GetColormap\fR is called with a \fIstring\fR value of
338 \fBnew\fR then the resulting colormap will never
339 be returned by \fBTk_GetVisual\fR; however, it can be used in other
340 windows by calling \fBTk_GetColormap\fR with the original window's
341 name as \fIstring\fR.