util/X86LINUX64/man/man3/Tk_CanvasPsPath.3

   1 '\"
   2 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 .TH Tk_CanvasPs 3 4.0 Tk "Tk Library Procedures"
   8 .\" The -*- nroff -*- definitions below are for supplemental macros used
   9 .\" in Tcl/Tk manual entries.
  10 .\"
  11 .\" .AP type name in/out ?indent?
  12 .\"     Start paragraph describing an argument to a library procedure.
  13 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  14 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  15 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  16 .\"     needed;  use .AS below instead)
  17 .\"
  18 .\" .AS ?type? ?name?
  19 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  20 .\"     name are examples of largest possible arguments that will be passed
  21 .\"     to .AP later.  If args are omitted, default tab stops are used.
  22 .\"
  23 .\" .BS
  24 .\"     Start box enclosure.  From here until next .BE, everything will be
  25 .\"     enclosed in one large box.
  26 .\"
  27 .\" .BE
  28 .\"     End of box enclosure.
  29 .\"
  30 .\" .CS
  31 .\"     Begin code excerpt.
  32 .\"
  33 .\" .CE
  34 .\"     End code excerpt.
  35 .\"
  36 .\" .VS ?version? ?br?
  37 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  38 .\"     of man pages.  The first argument is ignored and used for recording
  39 .\"     the version when the .VS was added, so that the sidebars can be
  40 .\"     found and removed when they reach a certain age.  If another argument
  41 .\"     is present, then a line break is forced before starting the sidebar.
  42 .\"
  43 .\" .VE
  44 .\"     End of vertical sidebar.
  45 .\"
  46 .\" .DS
  47 .\"     Begin an indented unfilled display.
  48 .\"
  49 .\" .DE
  50 .\"     End of indented unfilled display.
  51 .\"
  52 .\" .SO ?manpage?
  53 .\"     Start of list of standard options for a Tk widget. The manpage
  54 .\"     argument defines where to look up the standard options; if
  55 .\"     omitted, defaults to "options". The options follow on successive
  56 .\"     lines, in three columns separated by tabs.
  57 .\"
  58 .\" .SE
  59 .\"     End of list of standard options for a Tk widget.
  60 .\"
  61 .\" .OP cmdName dbName dbClass
  62 .\"     Start of description of a specific option.  cmdName gives the
  63 .\"     option's name as specified in the class command, dbName gives
  64 .\"     the option's name in the option database, and dbClass gives
  65 .\"     the option's class in the option database.
  66 .\"
  67 .\" .UL arg1 arg2
  68 .\"     Print arg1 underlined, then print arg2 normally.
  69 .\"
  70 .\" .QW arg1 ?arg2?
  71 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  72 .\"
  73 .\" .PQ arg1 ?arg2?
  74 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  75 .\"     (for trailing punctuation) and then a closing parenthesis.
  76 .\"
  77 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  78 .if t .wh -1.3i ^B
  79 .nr ^l \n(.l
  80 .ad b
  81 .\"     # Start an argument description
  82 .de AP
  83 .ie !"\\$4"" .TP \\$4
  84 .el \{\
  85 .   ie !"\\$2"" .TP \\n()Cu
  86 .   el          .TP 15
  87 .\}
  88 .ta \\n()Au \\n()Bu
  89 .ie !"\\$3"" \{\
  90 \&\\$1 \\fI\\$2\\fP (\\$3)
  91 .\".b
  92 .\}
  93 .el \{\
  94 .br
  95 .ie !"\\$2"" \{\
  96 \&\\$1  \\fI\\$2\\fP
  97 .\}
  98 .el \{\
  99 \&\\fI\\$1\\fP
 100 .\}
 101 .\}
 102 ..
 103 .\"     # define tabbing values for .AP
 104 .de AS
 105 .nr )A 10n
 106 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 107 .nr )B \\n()Au+15n
 108 .\"
 109 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 110 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 111 ..
 112 .AS Tcl_Interp Tcl_CreateInterp in/out
 113 .\"     # BS - start boxed text
 114 .\"     # ^y = starting y location
 115 .\"     # ^b = 1
 116 .de BS
 117 .br
 118 .mk ^y
 119 .nr ^b 1u
 120 .if n .nf
 121 .if n .ti 0
 122 .if n \l'\\n(.lu\(ul'
 123 .if n .fi
 124 ..
 125 .\"     # BE - end boxed text (draw box now)
 126 .de BE
 127 .nf
 128 .ti 0
 129 .mk ^t
 130 .ie n \l'\\n(^lu\(ul'
 131 .el \{\
 132 .\"     Draw four-sided box normally, but don't draw top of
 133 .\"     box if the box started on an earlier page.
 134 .ie !\\n(^b-1 \{\
 135 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 136 .\}
 137 .el \}\
 138 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 139 .\}
 140 .\}
 141 .fi
 142 .br
 143 .nr ^b 0
 144 ..
 145 .\"     # VS - start vertical sidebar
 146 .\"     # ^Y = starting y location
 147 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 148 .de VS
 149 .if !"\\$2"" .br
 150 .mk ^Y
 151 .ie n 'mc \s12\(br\s0
 152 .el .nr ^v 1u
 153 ..
 154 .\"     # VE - end of vertical sidebar
 155 .de VE
 156 .ie n 'mc
 157 .el \{\
 158 .ev 2
 159 .nf
 160 .ti 0
 161 .mk ^t
 162 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 163 .sp -1
 164 .fi
 165 .ev
 166 .\}
 167 .nr ^v 0
 168 ..
 169 .\"     # Special macro to handle page bottom:  finish off current
 170 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 171 .\"     # page bottom macro.
 172 .de ^B
 173 .ev 2
 174 'ti 0
 175 'nf
 176 .mk ^t
 177 .if \\n(^b \{\
 178 .\"     Draw three-sided box if this is the box's first page,
 179 .\"     draw two sides but no top otherwise.
 180 .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
 181 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 182 .\}
 183 .if \\n(^v \{\
 184 .nr ^x \\n(^tu+1v-\\n(^Yu
 185 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 186 .\}
 187 .bp
 188 'fi
 189 .ev
 190 .if \\n(^b \{\
 191 .mk ^y
 192 .nr ^b 2
 193 .\}
 194 .if \\n(^v \{\
 195 .mk ^Y
 196 .\}
 197 ..
 198 .\"     # DS - begin display
 199 .de DS
 200 .RS
 201 .nf
 202 .sp
 203 ..
 204 .\"     # DE - end display
 205 .de DE
 206 .fi
 207 .RE
 208 .sp
 209 ..
 210 .\"     # SO - start of list of standard options
 211 .de SO
 212 'ie '\\$1'' .ds So \\fBoptions\\fR
 213 'el .ds So \\fB\\$1\\fR
 214 .SH "STANDARD OPTIONS"
 215 .LP
 216 .nf
 217 .ta 5.5c 11c
 218 .ft B
 219 ..
 220 .\"     # SE - end of list of standard options
 221 .de SE
 222 .fi
 223 .ft R
 224 .LP
 225 See the \\*(So manual entry for details on the standard options.
 226 ..
 227 .\"     # OP - start of full description for a single option
 228 .de OP
 229 .LP
 230 .nf
 231 .ta 4c
 232 Command-Line Name:      \\fB\\$1\\fR
 233 Database Name:  \\fB\\$2\\fR
 234 Database Class: \\fB\\$3\\fR
 235 .fi
 236 .IP
 237 ..
 238 .\"     # CS - begin code excerpt
 239 .de CS
 240 .RS
 241 .nf
 242 .ta .25i .5i .75i 1i
 243 ..
 244 .\"     # CE - end code excerpt
 245 .de CE
 246 .fi
 247 .RE
 248 ..
 249 .\"     # UL - underline word
 250 .de UL
 251 \\$1\l'|0\(ul'\\$2
 252 ..
 253 .\"     # QW - apply quotation marks to word
 254 .de QW
 255 .ie '\\*(lq'"' ``\\$1''\\$2
 256 .\"" fix emacs highlighting
 257 .el \\*(lq\\$1\\*(rq\\$2
 258 ..
 259 .\"     # PQ - apply parens and quotation marks to word
 260 .de PQ
 261 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 262 .\"" fix emacs highlighting
 263 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 264 ..
 265 .\"     # QR - quoted range
 266 .de QR
 267 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 268 .\"" fix emacs highlighting
 269 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 270 ..
 271 .\"     # MT - "empty" string
 272 .de MT
 273 .QW ""
 274 ..
 275 .BS
 276 .SH NAME
 277 Tk_CanvasPsY, Tk_CanvasPsBitmap, Tk_CanvasPsColor, Tk_CanvasPsFont, Tk_CanvasPsPath, Tk_CanvasPsStipple \- utility procedures for generating Postscript for canvases
 278 .SH SYNOPSIS
 279 .nf
 280 \fB#include <tk.h>\fR
 281 .sp
 282 double
 283 \fBTk_CanvasPsY\fR(\fIcanvas, canvasY\fR)
 284 .sp
 285 int
 286 \fBTk_CanvasPsBitmap\fR(\fIinterp, canvas, bitmap, x, y, width, height\fR)
 287 .sp
 288 int
 289 \fBTk_CanvasPsColor\fR(\fIinterp, canvas, colorPtr\fR)
 290 .sp
 291 int
 292 \fBTk_CanvasPsFont\fR(\fIinterp, canvas, tkFont\fR)
 293 .sp
 294 \fBTk_CanvasPsPath\fR(\fIinterp, canvas, coordPtr, numPoints\fR)
 295 .sp
 296 int
 297 \fBTk_CanvasPsStipple\fR(\fIinterp, canvas, bitmap\fR)
 298 .SH ARGUMENTS
 299 .AS "unsigned int" "numPoints"
 300 .AP Tk_Canvas canvas in
 301 A token that identifies a canvas widget for which Postscript is
 302 being generated.
 303 .AP double canvasY in
 304 Y-coordinate in the space of the canvas.
 305 .AP Tcl_Interp *interp in/out
 306 A Tcl interpreter;  Postscript is appended to its result, or the
 307 result may be replaced with an error message.
 308 .AP Pixmap bitmap in
 309 Bitmap to use for generating Postscript.
 310 .AP int x in
 311 X-coordinate within \fIbitmap\fR of left edge of region to output.
 312 .AP int y in
 313 Y-coordinate within \fIbitmap\fR of top edge of region to output.
 314 .AP "int" width in
 315 Width of region of bitmap to output, in pixels.
 316 .AP "int" height in
 317 Height of region of bitmap to output, in pixels.
 318 .AP XColor *colorPtr in
 319 Information about color value to set in Postscript.
 320 .AP Tk_Font tkFont in
 321 Font for which Postscript is to be generated.
 322 .AP double *coordPtr in
 323 Pointer to an array of coordinates for one or more
 324 points specified in canvas coordinates.
 325 The order of values in \fIcoordPtr\fR is x1, y1, x2, y2, x3, y3,
 326 and so on.
 327 .AP int numPoints in
 328 Number of points at \fIcoordPtr\fR.
 329 .BE
 330 .SH DESCRIPTION
 331 .PP
 332 These procedures are called by canvas type managers to carry out
 333 common functions related to generating Postscript.
 334 Most of the procedures take a \fIcanvas\fR argument, which
 335 refers to a canvas widget for which Postscript is being
 336 generated.
 337 .PP
 338 \fBTk_CanvasPsY\fR takes as argument a y-coordinate in the space of
 339 a canvas and returns the value that should be used for that point
 340 in the Postscript currently being generated for \fIcanvas\fR.
 341 Y coordinates require transformation because Postscript uses an
 342 origin at the lower-left corner whereas X uses an origin at the
 343 upper-left corner.
 344 Canvas x coordinates can be used directly in Postscript without
 345 transformation.
 346 .PP
 347 \fBTk_CanvasPsBitmap\fR generates Postscript to describe a region
 348 of a bitmap.
 349 The Postscript is generated in proper image data format for Postscript,
 350 i.e., as data between angle brackets, one bit per pixel.
 351 The Postscript is appended to the result of interpreter \fIinterp\fR
 352 and \fBTCL_OK\fR is returned unless an error occurs, in which case
 353 \fBTCL_ERROR\fR is returned and the interpreter result is overwritten
 354 with an error message.
 355 .PP
 356 \fBTk_CanvasPsColor\fR generates Postscript to set the current color
 357 to correspond to its \fIcolorPtr\fR argument, taking into account any
 358 color map specified in the \fBpostscript\fR command.
 359 It appends the Postscript to the interpreter \fIinterp\fR's result and returns
 360 \fBTCL_OK\fR unless an error occurs, in which case \fBTCL_ERROR\fR is
 361 returned and the interpreter's result is overwritten with an error message.
 362 .PP
 363 \fBTk_CanvasPsFont\fR generates Postscript that sets the current font
 364 to match \fItkFont\fR as closely as possible.
 365 \fBTk_CanvasPsFont\fR takes into account any font map specified
 366 in the \fBpostscript\fR command, and it does
 367 the best it can at mapping X fonts to Postscript fonts.
 368 It appends the Postscript to interpreter \fIinterp\fR's result and
 369 returns \fBTCL_OK\fR unless an error occurs, in which case
 370 \fBTCL_ERROR\fR is returned and the interpreter's result is
 371 overwritten with an error message.
 372 .PP
 373 \fBTk_CanvasPsPath\fR generates Postscript to set the current path
 374 to the set of points given by \fIcoordPtr\fR and \fInumPoints\fR.
 375 It appends the resulting Postscript to the result of interpreter \fIinterp\fR.
 376 .PP
 377 \fBTk_CanvasPsStipple\fR generates Postscript that will fill the
 378 current path in stippled fashion.
 379 It uses \fIbitmap\fR as the stipple pattern and the current Postscript
 380 color;  ones in the stipple bitmap are drawn in the current color, and
 381 zeroes are not drawn at all.
 382 The Postscript is appended to interpreter \fIinterp\fR's result and
 383 \fBTCL_OK\fR is returned, unless an error occurs, in which case
 384 \fBTCL_ERROR\fR is returned and the interpreter's result is
 385 overwritten with an error message.
 386 .SH KEYWORDS
 387 bitmap, canvas, color, font, path, Postscript, stipple