home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tk / GetColor.man < prev    next >
Encoding:
Text File  |  1992-08-24  |  8.8 KB  |  309 lines
  1. '\"
  2. '\" Copyright 1990, 1991 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/wish/man/RCS/GetColor.man,v 1.6 92/01/02 09:09:47 ouster Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .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
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS Tk_GetColor tk
  189. .BS
  190. .SH NAME
  191. Tk_GetColor, Tk_GetColorByValue, Tk_NameOfColor Tk_FreeColor \- maintain database of colors
  192. .SH SYNOPSIS
  193. .nf
  194. \fB#include <tk.h>\fR
  195. .sp
  196. XColor *
  197. \fBTk_GetColor\fR(\fIinterp, tkwin, colorMap, nameId\fB)\fR
  198. .sp
  199. XColor *
  200. \fBTk_GetColorByValue\fR(\fIinterp, tkwin, colorMap, prefPtr\fB)\fR
  201. .sp
  202. char *
  203. \fBTk_NameOfColor(\fIcolorPtr\fB)\fR
  204. .sp
  205. \fBTk_FreeColor(\fIcolorPtr\fB)\fR
  206. .SH ARGUMENTS
  207. .AS "Tcl_Interp" *colorPtr
  208. .AP Tcl_Interp *interp in
  209. Interpreter to use for error reporting.
  210. .AP Tk_Window tkwin in
  211. Token for window in which color will be used.
  212. .AP Colormap colormap in
  213. Colormap from which to allocate color.  If NULL, then the default
  214. colormap for \fItkwin\fR's screen is used.
  215. .AP Tk_Uid nameId in
  216. Textual description of desired color.
  217. .AP XColor *prefPtr in
  218. Indicates red, green, and blue intensities of desired
  219. color.
  220. .AP XColor *colorPtr in
  221. Pointer to X color information.  Must have been allocated by previous
  222. call to \fBTk_GetColor\fR or \fBTk_GetColorByValue\fR, except when passed
  223. to \fBTk_NameOfColor\fR.
  224. .BE
  225.  
  226. .SH DESCRIPTION
  227. .PP
  228. The \fBTk_GetColor\fR and \fBTk_GetColorByValue\fR procedures
  229. locate pixel values that may be used to render particular
  230. colors in the window given by \fItkwin\fR using the colormap
  231. given by \fIcolormap\fR.  In \fBTk_GetColor\fR
  232. the desired color is specified with a Tk_Uid (\fInameId\fR), which
  233. may have any of the following forms:
  234. .TP 20
  235. \fIcolorname\fR
  236. Any of the valid textual names for a color defined in the
  237. server's color database file, such as \fBred\fR or \fBPeachPuff\fR.
  238. .TP 20
  239. \fB#\fIRGB\fR
  240. .TP 20
  241. \fB#\fIRRGGBB\fR
  242. .TP 20
  243. \fB#\fIRRRGGGBBB\fR
  244. .TP 20
  245. \fB#\fIRRRRGGGGBBBB\fR
  246. A numeric specification of the red, green, and blue intensities
  247. to use to display the color.  Each \fIR\fR, \fIG\fR, or \fIB\fR
  248. represents a single hexadecimal digit.  The four forms permit
  249. colors to be specified with 4-bit, 8-bit, 12-bit or 16-bit values.
  250. When fewer than 16 bits are provided for each color, they represent
  251. the most significant bits of the color.  For example, #3a7 is the
  252. same as #3000a0007000.
  253. .LP
  254. In \fBTk_GetColorByValue\fR, the desired color is indicated with
  255. the \fIred\fR, \fIgreen\fR, and \fIblue\fR fields of the structure
  256. pointed to by \fIcolorPtr\fR.
  257. .PP
  258. If \fBTk_GetColor\fR or \fBTk_GetColorByValue\fR is successful
  259. in allocating the desired color, then it returns a pointer to
  260. an XColor structure;  the structure indicates the exact intensities of
  261. the allocated color (which may differ slightly from those requested,
  262. depending on the limitations of the screen) and a pixel value
  263. from \fIcolormap\fR that may be used to draw in the color.
  264. If an error occurs in allocating a color then NULL is returned
  265. and an error message will be stored in \fIinterp->result\fR.
  266. .PP
  267. \fBTk_GetColor\fR and \fBTk_GetColorByValue\fR maintain a database
  268. of all the colors currently in use.
  269. If the same \fInameId\fR is requested multiple times from
  270. \fBTk_GetColor\fR (e.g. by different windows), or if the
  271. same intensities are requested multiple times from
  272. \fBTk_GetColorByValue\fR, then existing pixel values will
  273. be re-used.  Re-using an existing pixel avoids any interaction
  274. with the X server, which makes the allocation much more
  275. efficient.  For this reason, you should generally use
  276. \fBTk_GetColor\fR or \fBTk_GetColorByValue\fR
  277. instead of Xlib procedures like \fBXAllocColor\fR,
  278. \fBXAllocNamedColor\fR, or \fBXParseColor\fR.
  279. .PP
  280. Since different calls to \fBTk_GetColor\fR or \fBTk_GetColorByValue\fR
  281. may return the same shared
  282. pixel value, callers should never change the color of a pixel
  283. returned by the procedures.
  284. If you need to change a color value dynamically, you should use
  285. \fBXAllocColorCells\fR to allocate the pixel value for the color.
  286. .PP
  287. The procedure \fBTk_NameOfColor\fR is roughly the inverse of
  288. \fBTk_GetColor\fR.  If its \fIcolorPtr\fR argument was created
  289. by \fBTk_GetColor\fR, then the return value is the \fInameId\fR
  290. string that was passed to \fBTk_GetColor\fR to create the
  291. color.  If \fIcolorPtr\fR was created by a call to \fBTk_GetColorByValue\fR,
  292. or by any other mechanism, then the return value is a string
  293. that could be passed to \fBTk_GetColor\fR to return the same
  294. color.  Note:  the string returned by \fBTk_NameOfColor\fR is
  295. only guaranteed to persist until the next call to \fBTk_NameOfColor\fR.
  296. .PP
  297. When a pixel value returned by \fBTk_GetColor\fR or
  298. \fBTk_GetColorByValue\fR is no longer
  299. needed, \fBTk_FreeColor\fR should be called to release the color.
  300. There should be exactly one call to \fBTk_FreeColor\fR for
  301. each call to \fBTk_GetColor\fR or \fBTk_GetColorByValue\fR.
  302. When a pixel value is no longer in
  303. use anywhere (i.e. it has been freed as many times as it has been gotten)
  304. \fBTk_FreeColor\fR will release it to the X server and delete it from
  305. the database.
  306.  
  307. .SH KEYWORDS
  308. color, intensity, pixel value
  309.