'\" 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: CanvPsY.3,v 1.5 2000/07/25 21:14:34 jenglish Exp $
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\" End of box enclosure.
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\" End of vertical sidebar.
'\" Begin an indented unfilled display.
'\" End of indented unfilled display.
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" End of list of standard options for a Tk widget.
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\" Print arg1 underlined, then print arg2 normally.
'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
'\" # Start an argument description
. ie !"\\$2"" .TP \\n()Cu
\&\\$1 \\fI\\$2\\fP (\\$3)
'\" # define tabbing values for .AP
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
.AS Tcl_Interp Tcl_CreateInterp in/out
'\" # BS - start boxed text
'\" # ^y = starting y location
'\" # BE - end boxed text (draw box now)
.\" Draw four-sided box normally, but don't draw top of
.\" box if the box started on an earlier page.
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
'\" # VS - start vertical sidebar
'\" # ^Y = starting y location
'\" # ^v = 1 (for troff; for nroff this doesn't matter)
'\" # VE - end of vertical sidebar
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
'\" # Special macro to handle page bottom: finish off current
'\" # box/sidebar if in box/sidebar mode, then invoked standard
.\" Draw three-sided box if this is the box's first page,
.\" draw two sides but no top otherwise.
.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
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
'\" # SO - start of list of standard options
'\" # SE - end of list of standard options
See the \\fBoptions\\fR manual entry for details on the standard options.
'\" # OP - start of full description for a single option
Command-Line Name: \\fB\\$1\\fR
Database Name: \\fB\\$2\\fR
Database Class: \\fB\\$3\\fR
'\" # CS - begin code excerpt
'\" # CE - end code excerpt
.TH Tk_CanvasPs 3 4.0 Tk "Tk Library Procedures"
Tk_CanvasPsY, Tk_CanvasPsBitmap, Tk_CanvasPsColor, Tk_CanvasPsFont, Tk_CanvasPsPath, Tk_CanvasPsStipple \- utility procedures for generating Postscript for canvases
\fBTk_CanvasPsY\fR(\fIcanvas, canvasY\fR)
\fBTk_CanvasPsBitmap\fR(\fIinterp, canvas, bitmap, x, y, width, height\fR)
\fBTk_CanvasPsColor\fR(\fIinterp, canvas, colorPtr\fR)
\fBTk_CanvasPsFont\fR(\fIinterp, canvas, tkFont\fR)
\fBTk_CanvasPsPath\fR(\fIinterp, canvas, coordPtr, numPoints\fR)
\fBTk_CanvasPsStipple\fR(\fIinterp, canvas, bitmap\fR)
.AS "unsigned int" "numPoints"
A token that identifies a canvas widget for which Postscript is
Y-coordinate in the space of the canvas.
.AP Tcl_Interp *interp in/out
A Tcl interpreter; Postscript is appended to its result, or the
result may be replaced with an error message.
Bitmap to use for generating Postscript.
X-coordinate within \fIbitmap\fR of left edge of region to output.
Y-coordinate within \fIbitmap\fR of top edge of region to output.
Width of region of bitmap to output, in pixels.
Height of region of bitmap to output, in pixels.
Information about color value to set in Postscript.
Font for which Postscript is to be generated.
Pointer to an array of coordinates for one or more
points specified in canvas coordinates.
The order of values in \fIcoordPtr\fR is x1, y1, x2, y2, x3, y3,
Number of points at \fIcoordPtr\fR.
These procedures are called by canvas type managers to carry out
common functions related to generating Postscript.
Most of the procedures take a \fIcanvas\fR argument, which
refers to a canvas widget for which Postscript is being
\fBTk_CanvasPsY\fR takes as argument a y-coordinate in the space of
a canvas and returns the value that should be used for that point
in the Postscript currently being generated for \fIcanvas\fR.
Y coordinates require transformation because Postscript uses an
origin at the lower-left corner whereas X uses an origin at the
Canvas x coordinates can be used directly in Postscript without
\fBTk_CanvasPsBitmap\fR generates Postscript to describe a region
The Postscript is generated in proper image data format for Postscript,
i.e., as data between angle brackets, one bit per pixel.
The Postscript is appended to \fIinterp->result\fR and TCL_OK is returned
unless an error occurs, in which case TCL_ERROR is returned and
\fIinterp->result\fR is overwritten with an error message.
\fBTk_CanvasPsColor\fR generates Postscript to set the current color
to correspond to its \fIcolorPtr\fR argument, taking into account any
color map specified in the \fBpostscript\fR command.
It appends the Postscript to \fIinterp->result\fR and returns
TCL_OK unless an error occurs, in which case TCL_ERROR is returned and
\fIinterp->result\fR is overwritten with an error message.
\fBTk_CanvasPsFont\fR generates Postscript that sets the current font
to match \fItkFont\fR as closely as possible.
\fBTk_CanvasPsFont\fR takes into account any font map specified
in the \fBpostscript\fR command, and it does
the best it can at mapping X fonts to Postscript fonts.
It appends the Postscript to \fIinterp->result\fR and returns TCL_OK
unless an error occurs, in which case TCL_ERROR is returned and
\fIinterp->result\fR is overwritten with an error message.
\fBTk_CanvasPsPath\fR generates Postscript to set the current path
to the set of points given by \fIcoordPtr\fR and \fInumPoints\fR.
It appends the resulting Postscript to \fIinterp->result\fR.
\fBTk_CanvasPsStipple\fR generates Postscript that will fill the
current path in stippled fashion.
It uses \fIbitmap\fR as the stipple pattern and the current Postscript
color; ones in the stipple bitmap are drawn in the current color, and
zeroes are not drawn at all.
The Postscript is appended to \fIinterp->result\fR and TCL_OK is
returned, unless an error occurs, in which case TCL_ERROR is returned and
\fIinterp->result\fR is overwritten with an error message.
bitmap, canvas, color, font, path, Postscript, stipple