util/X86LINUX64/man/man3/Tk_GetColorFromObj.3

   1 '\"
   2 '\" Copyright (c) 1990-1991 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1998 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 .TH Tk_AllocColorFromObj 3 8.1 Tk "Tk Library Procedures"
   9 .\" The -*- nroff -*- definitions below are for supplemental macros used
  10 .\" in Tcl/Tk manual entries.
  11 .\"
  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)
  18 .\"
  19 .\" .AS ?type? ?name?
  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.
  23 .\"
  24 .\" .BS
  25 .\"     Start box enclosure.  From here until next .BE, everything will be
  26 .\"     enclosed in one large box.
  27 .\"
  28 .\" .BE
  29 .\"     End of box enclosure.
  30 .\"
  31 .\" .CS
  32 .\"     Begin code excerpt.
  33 .\"
  34 .\" .CE
  35 .\"     End code excerpt.
  36 .\"
  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.
  43 .\"
  44 .\" .VE
  45 .\"     End of vertical sidebar.
  46 .\"
  47 .\" .DS
  48 .\"     Begin an indented unfilled display.
  49 .\"
  50 .\" .DE
  51 .\"     End of indented unfilled display.
  52 .\"
  53 .\" .SO ?manpage?
  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.
  58 .\"
  59 .\" .SE
  60 .\"     End of list of standard options for a Tk widget.
  61 .\"
  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.
  67 .\"
  68 .\" .UL arg1 arg2
  69 .\"     Print arg1 underlined, then print arg2 normally.
  70 .\"
  71 .\" .QW arg1 ?arg2?
  72 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  73 .\"
  74 .\" .PQ arg1 ?arg2?
  75 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  76 .\"     (for trailing punctuation) and then a closing parenthesis.
  77 .\"
  78 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  79 .if t .wh -1.3i ^B
  80 .nr ^l \n(.l
  81 .ad b
  82 .\"     # Start an argument description
  83 .de AP
  84 .ie !"\\$4"" .TP \\$4
  85 .el \{\
  86 .   ie !"\\$2"" .TP \\n()Cu
  87 .   el          .TP 15
  88 .\}
  89 .ta \\n()Au \\n()Bu
  90 .ie !"\\$3"" \{\
  91 \&\\$1 \\fI\\$2\\fP (\\$3)
  92 .\".b
  93 .\}
  94 .el \{\
  95 .br
  96 .ie !"\\$2"" \{\
  97 \&\\$1  \\fI\\$2\\fP
  98 .\}
  99 .el \{\
 100 \&\\fI\\$1\\fP
 101 .\}
 102 .\}
 103 ..
 104 .\"     # define tabbing values for .AP
 105 .de AS
 106 .nr )A 10n
 107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 108 .nr )B \\n()Au+15n
 109 .\"
 110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 112 ..
 113 .AS Tcl_Interp Tcl_CreateInterp in/out
 114 .\"     # BS - start boxed text
 115 .\"     # ^y = starting y location
 116 .\"     # ^b = 1
 117 .de BS
 118 .br
 119 .mk ^y
 120 .nr ^b 1u
 121 .if n .nf
 122 .if n .ti 0
 123 .if n \l'\\n(.lu\(ul'
 124 .if n .fi
 125 ..
 126 .\"     # BE - end boxed text (draw box now)
 127 .de BE
 128 .nf
 129 .ti 0
 130 .mk ^t
 131 .ie n \l'\\n(^lu\(ul'
 132 .el \{\
 133 .\"     Draw four-sided box normally, but don't draw top of
 134 .\"     box if the box started on an earlier page.
 135 .ie !\\n(^b-1 \{\
 136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 137 .\}
 138 .el \}\
 139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 140 .\}
 141 .\}
 142 .fi
 143 .br
 144 .nr ^b 0
 145 ..
 146 .\"     # VS - start vertical sidebar
 147 .\"     # ^Y = starting y location
 148 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 149 .de VS
 150 .if !"\\$2"" .br
 151 .mk ^Y
 152 .ie n 'mc \s12\(br\s0
 153 .el .nr ^v 1u
 154 ..
 155 .\"     # VE - end of vertical sidebar
 156 .de VE
 157 .ie n 'mc
 158 .el \{\
 159 .ev 2
 160 .nf
 161 .ti 0
 162 .mk ^t
 163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 164 .sp -1
 165 .fi
 166 .ev
 167 .\}
 168 .nr ^v 0
 169 ..
 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.
 173 .de ^B
 174 .ev 2
 175 'ti 0
 176 'nf
 177 .mk ^t
 178 .if \\n(^b \{\
 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
 183 .\}
 184 .if \\n(^v \{\
 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
 187 .\}
 188 .bp
 189 'fi
 190 .ev
 191 .if \\n(^b \{\
 192 .mk ^y
 193 .nr ^b 2
 194 .\}
 195 .if \\n(^v \{\
 196 .mk ^Y
 197 .\}
 198 ..
 199 .\"     # DS - begin display
 200 .de DS
 201 .RS
 202 .nf
 203 .sp
 204 ..
 205 .\"     # DE - end display
 206 .de DE
 207 .fi
 208 .RE
 209 .sp
 210 ..
 211 .\"     # SO - start of list of standard options
 212 .de SO
 213 'ie '\\$1'' .ds So \\fBoptions\\fR
 214 'el .ds So \\fB\\$1\\fR
 215 .SH "STANDARD OPTIONS"
 216 .LP
 217 .nf
 218 .ta 5.5c 11c
 219 .ft B
 220 ..
 221 .\"     # SE - end of list of standard options
 222 .de SE
 223 .fi
 224 .ft R
 225 .LP
 226 See the \\*(So manual entry for details on the standard options.
 227 ..
 228 .\"     # OP - start of full description for a single option
 229 .de OP
 230 .LP
 231 .nf
 232 .ta 4c
 233 Command-Line Name:      \\fB\\$1\\fR
 234 Database Name:  \\fB\\$2\\fR
 235 Database Class: \\fB\\$3\\fR
 236 .fi
 237 .IP
 238 ..
 239 .\"     # CS - begin code excerpt
 240 .de CS
 241 .RS
 242 .nf
 243 .ta .25i .5i .75i 1i
 244 ..
 245 .\"     # CE - end code excerpt
 246 .de CE
 247 .fi
 248 .RE
 249 ..
 250 .\"     # UL - underline word
 251 .de UL
 252 \\$1\l'|0\(ul'\\$2
 253 ..
 254 .\"     # QW - apply quotation marks to word
 255 .de QW
 256 .ie '\\*(lq'"' ``\\$1''\\$2
 257 .\"" fix emacs highlighting
 258 .el \\*(lq\\$1\\*(rq\\$2
 259 ..
 260 .\"     # PQ - apply parens and quotation marks to word
 261 .de PQ
 262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 263 .\"" fix emacs highlighting
 264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 265 ..
 266 .\"     # QR - quoted range
 267 .de QR
 268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 269 .\"" fix emacs highlighting
 270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 271 ..
 272 .\"     # MT - "empty" string
 273 .de MT
 274 .QW ""
 275 ..
 276 .BS
 277 .SH NAME
 278 Tk_AllocColorFromObj, Tk_GetColor, Tk_GetColorFromObj, Tk_GetColorByValue, Tk_NameOfColor, Tk_FreeColorFromObj, Tk_FreeColor \- maintain database of colors
 279 .SH SYNOPSIS
 280 .nf
 281 \fB#include <tk.h>\fR
 282 .sp
 283 XColor *
 284 \fBTk_AllocColorFromObj(\fIinterp, tkwin, objPtr\fB)\fR
 285 .sp
 286 XColor *
 287 \fBTk_GetColor(\fIinterp, tkwin, name\fB)\fR
 288 .sp
 289 XColor *
 290 \fBTk_GetColorFromObj(\fItkwin, objPtr\fB)\fR
 291 .sp
 292 XColor *
 293 \fBTk_GetColorByValue(\fItkwin, prefPtr\fB)\fR
 294 .sp
 295 const char *
 296 \fBTk_NameOfColor(\fIcolorPtr\fB)\fR
 297 .sp
 298 GC
 299 \fBTk_GCForColor(\fIcolorPtr, drawable\fB)\fR
 300 .sp
 301 \fBTk_FreeColorFromObj(\fItkwin, objPtr\fB)\fR
 302 .sp
 303 \fBTk_FreeColor(\fIcolorPtr\fB)\fR
 304 .SH ARGUMENTS
 305 .AS "Tcl_Interp" *colorPtr
 306 .AP Tcl_Interp *interp in
 307 Interpreter to use for error reporting.
 308 .AP Tk_Window tkwin in
 309 Token for window in which color will be used.
 310 .AP Tcl_Obj *objPtr in/out
 311 String value describes desired color; internal rep will be
 312 modified to cache pointer to corresponding (XColor *).
 313 .AP char *name in
 314 Same as \fIobjPtr\fR except description of color is passed as a string and
 315 resulting (XColor *) is not cached.
 316 .AP XColor *prefPtr in
 317 Indicates red, green, and blue intensities of desired
 318 color.
 319 .AP XColor *colorPtr in
 320 Pointer to X color information.  Must have been allocated by previous
 321 call to \fBTk_AllocColorFromObj\fR, \fBTk_GetColor\fR or
 322 \fBTk_GetColorByValue\fR, except when passed to \fBTk_NameOfColor\fR.
 323 .AP Drawable drawable in
 324 Drawable in which the result graphics context will be used.  Must have
 325 same screen and depth as the window for which the color was allocated.
 326 .BE
 327 .SH DESCRIPTION
 328 .PP
 329 These procedures manage the colors being used by a Tk application.
 330 They allow colors to be shared whenever possible, so that colormap
 331 space is preserved, and they pick closest available colors when
 332 colormap space is exhausted.
 333 .PP
 334 Given a textual description of a color, \fBTk_AllocColorFromObj\fR
 335 locates a pixel value that may be used to render the color
 336 in a particular window.  The desired color is specified with a
 337 value whose string value must have one of the following forms:
 338 .TP 20
 339 \fIcolorname\fR
 340 Any of the valid textual names for a color defined in the
 341 server's color database file, such as \fBred\fR or \fBPeachPuff\fR.
 342 .TP 20
 343 \fB#\fIRGB\fR
 344 .TP 20
 345 \fB#\fIRRGGBB\fR
 346 .TP 20
 347 \fB#\fIRRRGGGBBB\fR
 348 .TP 20
 349 \fB#\fIRRRRGGGGBBBB\fR
 350 A numeric specification of the red, green, and blue intensities
 351 to use to display the color.  Each \fIR\fR, \fIG\fR, or \fIB\fR
 352 represents a single hexadecimal digit.  The four forms permit
 353 colors to be specified with 4-bit, 8-bit, 12-bit or 16-bit values.
 354 When fewer than 16 bits are provided for each color, they represent
 355 the most significant bits of the color, while the lower unfilled
 356 bits will be repeatedly replicated from the available higher bits.
 357 For example, #3a7 is the same as #3333aaaa7777.
 358 .PP
 359 \fBTk_AllocColorFromObj\fR returns a pointer to
 360 an XColor structure;  the structure indicates the exact intensities of
 361 the allocated color (which may differ slightly from those requested,
 362 depending on the limitations of the screen) and a pixel value
 363 that may be used to draw with the color in \fItkwin\fR.
 364 If an error occurs in \fBTk_AllocColorFromObj\fR (such as an unknown
 365 color name) then NULL is returned and an error message is stored in
 366 \fIinterp\fR's result if \fIinterp\fR is not NULL.
 367 If the colormap for \fItkwin\fR is full, \fBTk_AllocColorFromObj\fR
 368 will use the closest existing color in the colormap.
 369 \fBTk_AllocColorFromObj\fR caches information about
 370 the return value in \fIobjPtr\fR, which speeds up future calls to procedures
 371 such as \fBTk_AllocColorFromObj\fR and \fBTk_GetColorFromObj\fR.
 372 .PP
 373 \fBTk_GetColor\fR is identical to \fBTk_AllocColorFromObj\fR except
 374 that the description of the color is specified with a string instead
 375 of a value.  This prevents \fBTk_GetColor\fR from caching the
 376 return value, so \fBTk_GetColor\fR is less efficient than
 377 \fBTk_AllocColorFromObj\fR.
 378 .PP
 379 \fBTk_GetColorFromObj\fR returns the token for an existing color, given
 380 the window and description used to create the color.
 381 \fBTk_GetColorFromObj\fR does not actually create the color; the color
 382 must already have been created with a previous call to
 383 \fBTk_AllocColorFromObj\fR or \fBTk_GetColor\fR.  The return
 384 value is cached in \fIobjPtr\fR, which speeds up
 385 future calls to \fBTk_GetColorFromObj\fR with the same \fIobjPtr\fR
 386 and \fItkwin\fR.
 387 .PP
 388 \fBTk_GetColorByValue\fR is similar to \fBTk_GetColor\fR except that
 389 the desired color is indicated with the \fIred\fR, \fIgreen\fR, and
 390 \fIblue\fR fields of the structure pointed to by \fIcolorPtr\fR.
 391 .PP
 392 This package maintains a database
 393 of all the colors currently in use.
 394 If the same color is requested multiple times from
 395 \fBTk_GetColor\fR or \fBTk_AllocColorFromObj\fR (e.g. by different
 396 windows), or if the
 397 same intensities are requested multiple times from
 398 \fBTk_GetColorByValue\fR, then existing pixel values will
 399 be re-used.  Re-using an existing pixel avoids any interaction
 400 with the window server, which makes the allocation much more
 401 efficient.  These procedures also provide a portable interface that
 402 works across all platforms.  For this reason, you should generally use
 403 \fBTk_AllocColorFromObj\fR, \fBTk_GetColor\fR, or \fBTk_GetColorByValue\fR
 404 instead of lower level procedures like \fBXAllocColor\fR.
 405 .PP
 406 Since different calls to this package
 407 may return the same shared
 408 pixel value, callers should never change the color of a pixel
 409 returned by the procedures.
 410 If you need to change a color value dynamically, you should use
 411 \fBXAllocColorCells\fR to allocate the pixel value for the color.
 412 .PP
 413 The procedure \fBTk_NameOfColor\fR is roughly the inverse of
 414 \fBTk_GetColor\fR.  If its \fIcolorPtr\fR argument was created
 415 by \fBTk_AllocColorFromObj\fR or \fBTk_GetColor\fR then the return value
 416 is the string that was used to create the
 417 color.  If \fIcolorPtr\fR was created by a call to \fBTk_GetColorByValue\fR,
 418 or by any other mechanism, then the return value is a string
 419 that could be passed to \fBTk_GetColor\fR to return the same
 420 color.  Note:  the string returned by \fBTk_NameOfColor\fR is
 421 only guaranteed to persist until the next call to
 422 \fBTk_NameOfColor\fR.
 423 .PP
 424 \fBTk_GCForColor\fR returns a graphics context whose \fBforeground\fR
 425 field is the pixel allocated for \fIcolorPtr\fR and whose other fields
 426 all have default values.
 427 This provides an easy way to do basic drawing with a color.
 428 The graphics context is cached with the color and will exist only as
 429 long as \fIcolorPtr\fR exists;  it is freed when the last reference
 430 to \fIcolorPtr\fR is freed by calling \fBTk_FreeColor\fR.
 431 .PP
 432 When a color is no longer needed \fBTk_FreeColorFromObj\fR or
 433 \fBTk_FreeColor\fR should be called to release it.
 434 For \fBTk_FreeColorFromObj\fR the color to release is specified
 435 with the same information used to create it; for
 436 \fBTk_FreeColor\fR the color to release is specified
 437 with a pointer to its XColor structure.
 438 There should be exactly one call to \fBTk_FreeColorFromObj\fR
 439 or \fBTk_FreeColor\fR for each call to \fBTk_AllocColorFromObj\fR,
 440 \fBTk_GetColor\fR, or \fBTk_GetColorByValue\fR.
 441 .SH KEYWORDS
 442 color, intensity, value, pixel value