| '\" |
| '\" 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 |
| '\" manual entries. |
| '\" |
| '\" .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) |
| '\" |
| '\" .AS ?type? ?name? |
| '\" 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. |
| '\" |
| '\" .BS |
| '\" Start box enclosure. From here until next .BE, everything will be |
| '\" enclosed in one large box. |
| '\" |
| '\" .BE |
| '\" End of box enclosure. |
| '\" |
| '\" .CS |
| '\" Begin code excerpt. |
| '\" |
| '\" .CE |
| '\" End code excerpt. |
| '\" |
| '\" .VS ?version? ?br? |
| '\" 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. |
| '\" |
| '\" .VE |
| '\" End of vertical sidebar. |
| '\" |
| '\" .DS |
| '\" Begin an indented unfilled display. |
| '\" |
| '\" .DE |
| '\" End of indented unfilled display. |
| '\" |
| '\" .SO |
| '\" Start of list of standard options for a Tk widget. The |
| '\" options follow on successive lines, in four columns separated |
| '\" by tabs. |
| '\" |
| '\" .SE |
| '\" 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. |
| '\" |
| '\" .UL arg1 arg2 |
| '\" 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. |
| .if t .wh -1.3i ^B |
| .nr ^l \n(.l |
| .ad b |
| '\" # Start an argument description |
| .de AP |
| .ie !"\\$4"" .TP \\$4 |
| .el \{\ |
| . ie !"\\$2"" .TP \\n()Cu |
| . el .TP 15 |
| .\} |
| .ta \\n()Au \\n()Bu |
| .ie !"\\$3"" \{\ |
| \&\\$1 \\fI\\$2\\fP (\\$3) |
| .\".b |
| .\} |
| .el \{\ |
| .br |
| .ie !"\\$2"" \{\ |
| \&\\$1 \\fI\\$2\\fP |
| .\} |
| .el \{\ |
| \&\\fI\\$1\\fP |
| .\} |
| .\} |
| .. |
| '\" # define tabbing values for .AP |
| .de AS |
| .nr )A 10n |
| .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| .nr )B \\n()Au+15n |
| .\" |
| .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 |
| '\" # ^b = 1 |
| .de BS |
| .br |
| .mk ^y |
| .nr ^b 1u |
| .if n .nf |
| .if n .ti 0 |
| .if n \l'\\n(.lu\(ul' |
| .if n .fi |
| .. |
| '\" # BE - end boxed text (draw box now) |
| .de BE |
| .nf |
| .ti 0 |
| .mk ^t |
| .ie n \l'\\n(^lu\(ul' |
| .el \{\ |
| .\" Draw four-sided box normally, but don't draw top of |
| .\" box if the box started on an earlier page. |
| .ie !\\n(^b-1 \{\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .el \}\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .\} |
| .fi |
| .br |
| .nr ^b 0 |
| .. |
| '\" # VS - start vertical sidebar |
| '\" # ^Y = starting y location |
| '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| .de VS |
| .if !"\\$2"" .br |
| .mk ^Y |
| .ie n 'mc \s12\(br\s0 |
| .el .nr ^v 1u |
| .. |
| '\" # VE - end of vertical sidebar |
| .de VE |
| .ie n 'mc |
| .el \{\ |
| .ev 2 |
| .nf |
| .ti 0 |
| .mk ^t |
| \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| .sp -1 |
| .fi |
| .ev |
| .\} |
| .nr ^v 0 |
| .. |
| '\" # Special macro to handle page bottom: finish off current |
| '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| '\" # page bottom macro. |
| .de ^B |
| .ev 2 |
| 'ti 0 |
| 'nf |
| .mk ^t |
| .if \\n(^b \{\ |
| .\" 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 |
| .\} |
| .if \\n(^v \{\ |
| .nr ^x \\n(^tu+1v-\\n(^Yu |
| \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| .\} |
| .bp |
| 'fi |
| .ev |
| .if \\n(^b \{\ |
| .mk ^y |
| .nr ^b 2 |
| .\} |
| .if \\n(^v \{\ |
| .mk ^Y |
| .\} |
| .. |
| '\" # DS - begin display |
| .de DS |
| .RS |
| .nf |
| .sp |
| .. |
| '\" # DE - end display |
| .de DE |
| .fi |
| .RE |
| .sp |
| .. |
| '\" # SO - start of list of standard options |
| .de SO |
| .SH "STANDARD OPTIONS" |
| .LP |
| .nf |
| .ta 5.5c 11c |
| .ft B |
| .. |
| '\" # SE - end of list of standard options |
| .de SE |
| .fi |
| .ft R |
| .LP |
| See the \\fBoptions\\fR manual entry for details on the standard options. |
| .. |
| '\" # OP - start of full description for a single option |
| .de OP |
| .LP |
| .nf |
| .ta 4c |
| Command-Line Name: \\fB\\$1\\fR |
| Database Name: \\fB\\$2\\fR |
| Database Class: \\fB\\$3\\fR |
| .fi |
| .IP |
| .. |
| '\" # CS - begin code excerpt |
| .de CS |
| .RS |
| .nf |
| .ta .25i .5i .75i 1i |
| .. |
| '\" # CE - end code excerpt |
| .de CE |
| .fi |
| .RE |
| .. |
| .de UL |
| \\$1\l'|0\(ul'\\$2 |
| .. |
| .TH Tk_CanvasPs 3 4.0 Tk "Tk Library Procedures" |
| .BS |
| .SH NAME |
| Tk_CanvasPsY, Tk_CanvasPsBitmap, Tk_CanvasPsColor, Tk_CanvasPsFont, Tk_CanvasPsPath, Tk_CanvasPsStipple \- utility procedures for generating Postscript for canvases |
| .SH SYNOPSIS |
| .nf |
| \fB#include <tk.h>\fR |
| .sp |
| double |
| \fBTk_CanvasPsY\fR(\fIcanvas, canvasY\fR) |
| .sp |
| int |
| \fBTk_CanvasPsBitmap\fR(\fIinterp, canvas, bitmap, x, y, width, height\fR) |
| .sp |
| int |
| \fBTk_CanvasPsColor\fR(\fIinterp, canvas, colorPtr\fR) |
| .sp |
| int |
| \fBTk_CanvasPsFont\fR(\fIinterp, canvas, tkFont\fR) |
| .sp |
| \fBTk_CanvasPsPath\fR(\fIinterp, canvas, coordPtr, numPoints\fR) |
| .sp |
| int |
| \fBTk_CanvasPsStipple\fR(\fIinterp, canvas, bitmap\fR) |
| .SH ARGUMENTS |
| .AS "unsigned int" "numPoints" |
| .AP Tk_Canvas canvas in |
| A token that identifies a canvas widget for which Postscript is |
| being generated. |
| .AP double canvasY in |
| 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. |
| .AP Pixmap bitmap in |
| Bitmap to use for generating Postscript. |
| .AP int x in |
| X-coordinate within \fIbitmap\fR of left edge of region to output. |
| .AP int y in |
| Y-coordinate within \fIbitmap\fR of top edge of region to output. |
| .AP "int" width in |
| Width of region of bitmap to output, in pixels. |
| .AP "int" height in |
| Height of region of bitmap to output, in pixels. |
| .AP XColor *colorPtr in |
| Information about color value to set in Postscript. |
| .AP Tk_Font tkFont in |
| Font for which Postscript is to be generated. |
| .AP double *coordPtr in |
| 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, |
| and so on. |
| .AP int numPoints in |
| Number of points at \fIcoordPtr\fR. |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| 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 |
| generated. |
| .PP |
| \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 |
| upper-left corner. |
| Canvas x coordinates can be used directly in Postscript without |
| transformation. |
| .PP |
| \fBTk_CanvasPsBitmap\fR generates Postscript to describe a region |
| of a bitmap. |
| 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. |
| .PP |
| \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. |
| .PP |
| \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. |
| .PP |
| \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. |
| .PP |
| \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. |
| |
| .SH KEYWORDS |
| bitmap, canvas, color, font, path, Postscript, stipple |