Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / man / man3 / Tk_CanvasPsFont.3
CommitLineData
920dae64
AT
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'\" RCS: @(#) $Id: CanvPsY.3,v 1.5 2000/07/25 21:14:34 jenglish Exp $
8'\"
9'\" The definitions below are for supplemental macros used in Tcl/Tk
10'\" 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
54'\" Start of list of standard options for a Tk widget. The
55'\" options follow on successive lines, in four columns separated
56'\" 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'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
71'\"
72'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
73.if t .wh -1.3i ^B
74.nr ^l \n(.l
75.ad b
76'\" # Start an argument description
77.de AP
78.ie !"\\$4"" .TP \\$4
79.el \{\
80. ie !"\\$2"" .TP \\n()Cu
81. el .TP 15
82.\}
83.ta \\n()Au \\n()Bu
84.ie !"\\$3"" \{\
85\&\\$1 \\fI\\$2\\fP (\\$3)
86.\".b
87.\}
88.el \{\
89.br
90.ie !"\\$2"" \{\
91\&\\$1 \\fI\\$2\\fP
92.\}
93.el \{\
94\&\\fI\\$1\\fP
95.\}
96.\}
97..
98'\" # define tabbing values for .AP
99.de AS
100.nr )A 10n
101.if !"\\$1"" .nr )A \\w'\\$1'u+3n
102.nr )B \\n()Au+15n
103.\"
104.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
105.nr )C \\n()Bu+\\w'(in/out)'u+2n
106..
107.AS Tcl_Interp Tcl_CreateInterp in/out
108'\" # BS - start boxed text
109'\" # ^y = starting y location
110'\" # ^b = 1
111.de BS
112.br
113.mk ^y
114.nr ^b 1u
115.if n .nf
116.if n .ti 0
117.if n \l'\\n(.lu\(ul'
118.if n .fi
119..
120'\" # BE - end boxed text (draw box now)
121.de BE
122.nf
123.ti 0
124.mk ^t
125.ie n \l'\\n(^lu\(ul'
126.el \{\
127.\" Draw four-sided box normally, but don't draw top of
128.\" box if the box started on an earlier page.
129.ie !\\n(^b-1 \{\
130\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
131.\}
132.el \}\
133\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134.\}
135.\}
136.fi
137.br
138.nr ^b 0
139..
140'\" # VS - start vertical sidebar
141'\" # ^Y = starting y location
142'\" # ^v = 1 (for troff; for nroff this doesn't matter)
143.de VS
144.if !"\\$2"" .br
145.mk ^Y
146.ie n 'mc \s12\(br\s0
147.el .nr ^v 1u
148..
149'\" # VE - end of vertical sidebar
150.de VE
151.ie n 'mc
152.el \{\
153.ev 2
154.nf
155.ti 0
156.mk ^t
157\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
158.sp -1
159.fi
160.ev
161.\}
162.nr ^v 0
163..
164'\" # Special macro to handle page bottom: finish off current
165'\" # box/sidebar if in box/sidebar mode, then invoked standard
166'\" # page bottom macro.
167.de ^B
168.ev 2
169'ti 0
170'nf
171.mk ^t
172.if \\n(^b \{\
173.\" Draw three-sided box if this is the box's first page,
174.\" draw two sides but no top otherwise.
175.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
176.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177.\}
178.if \\n(^v \{\
179.nr ^x \\n(^tu+1v-\\n(^Yu
180\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
181.\}
182.bp
183'fi
184.ev
185.if \\n(^b \{\
186.mk ^y
187.nr ^b 2
188.\}
189.if \\n(^v \{\
190.mk ^Y
191.\}
192..
193'\" # DS - begin display
194.de DS
195.RS
196.nf
197.sp
198..
199'\" # DE - end display
200.de DE
201.fi
202.RE
203.sp
204..
205'\" # SO - start of list of standard options
206.de SO
207.SH "STANDARD OPTIONS"
208.LP
209.nf
210.ta 5.5c 11c
211.ft B
212..
213'\" # SE - end of list of standard options
214.de SE
215.fi
216.ft R
217.LP
218See the \\fBoptions\\fR manual entry for details on the standard options.
219..
220'\" # OP - start of full description for a single option
221.de OP
222.LP
223.nf
224.ta 4c
225Command-Line Name: \\fB\\$1\\fR
226Database Name: \\fB\\$2\\fR
227Database Class: \\fB\\$3\\fR
228.fi
229.IP
230..
231'\" # CS - begin code excerpt
232.de CS
233.RS
234.nf
235.ta .25i .5i .75i 1i
236..
237'\" # CE - end code excerpt
238.de CE
239.fi
240.RE
241..
242.de UL
243\\$1\l'|0\(ul'\\$2
244..
245.TH Tk_CanvasPs 3 4.0 Tk "Tk Library Procedures"
246.BS
247.SH NAME
248Tk_CanvasPsY, Tk_CanvasPsBitmap, Tk_CanvasPsColor, Tk_CanvasPsFont, Tk_CanvasPsPath, Tk_CanvasPsStipple \- utility procedures for generating Postscript for canvases
249.SH SYNOPSIS
250.nf
251\fB#include <tk.h>\fR
252.sp
253double
254\fBTk_CanvasPsY\fR(\fIcanvas, canvasY\fR)
255.sp
256int
257\fBTk_CanvasPsBitmap\fR(\fIinterp, canvas, bitmap, x, y, width, height\fR)
258.sp
259int
260\fBTk_CanvasPsColor\fR(\fIinterp, canvas, colorPtr\fR)
261.sp
262int
263\fBTk_CanvasPsFont\fR(\fIinterp, canvas, tkFont\fR)
264.sp
265\fBTk_CanvasPsPath\fR(\fIinterp, canvas, coordPtr, numPoints\fR)
266.sp
267int
268\fBTk_CanvasPsStipple\fR(\fIinterp, canvas, bitmap\fR)
269.SH ARGUMENTS
270.AS "unsigned int" "numPoints"
271.AP Tk_Canvas canvas in
272A token that identifies a canvas widget for which Postscript is
273being generated.
274.AP double canvasY in
275Y-coordinate in the space of the canvas.
276.AP Tcl_Interp *interp in/out
277A Tcl interpreter; Postscript is appended to its result, or the
278result may be replaced with an error message.
279.AP Pixmap bitmap in
280Bitmap to use for generating Postscript.
281.AP int x in
282X-coordinate within \fIbitmap\fR of left edge of region to output.
283.AP int y in
284Y-coordinate within \fIbitmap\fR of top edge of region to output.
285.AP "int" width in
286Width of region of bitmap to output, in pixels.
287.AP "int" height in
288Height of region of bitmap to output, in pixels.
289.AP XColor *colorPtr in
290Information about color value to set in Postscript.
291.AP Tk_Font tkFont in
292Font for which Postscript is to be generated.
293.AP double *coordPtr in
294Pointer to an array of coordinates for one or more
295points specified in canvas coordinates.
296The order of values in \fIcoordPtr\fR is x1, y1, x2, y2, x3, y3,
297and so on.
298.AP int numPoints in
299Number of points at \fIcoordPtr\fR.
300.BE
301
302.SH DESCRIPTION
303.PP
304These procedures are called by canvas type managers to carry out
305common functions related to generating Postscript.
306Most of the procedures take a \fIcanvas\fR argument, which
307refers to a canvas widget for which Postscript is being
308generated.
309.PP
310\fBTk_CanvasPsY\fR takes as argument a y-coordinate in the space of
311a canvas and returns the value that should be used for that point
312in the Postscript currently being generated for \fIcanvas\fR.
313Y coordinates require transformation because Postscript uses an
314origin at the lower-left corner whereas X uses an origin at the
315upper-left corner.
316Canvas x coordinates can be used directly in Postscript without
317transformation.
318.PP
319\fBTk_CanvasPsBitmap\fR generates Postscript to describe a region
320of a bitmap.
321The Postscript is generated in proper image data format for Postscript,
322i.e., as data between angle brackets, one bit per pixel.
323The Postscript is appended to \fIinterp->result\fR and TCL_OK is returned
324unless an error occurs, in which case TCL_ERROR is returned and
325\fIinterp->result\fR is overwritten with an error message.
326.PP
327\fBTk_CanvasPsColor\fR generates Postscript to set the current color
328to correspond to its \fIcolorPtr\fR argument, taking into account any
329color map specified in the \fBpostscript\fR command.
330It appends the Postscript to \fIinterp->result\fR and returns
331TCL_OK unless an error occurs, in which case TCL_ERROR is returned and
332\fIinterp->result\fR is overwritten with an error message.
333.PP
334\fBTk_CanvasPsFont\fR generates Postscript that sets the current font
335to match \fItkFont\fR as closely as possible.
336\fBTk_CanvasPsFont\fR takes into account any font map specified
337in the \fBpostscript\fR command, and it does
338the best it can at mapping X fonts to Postscript fonts.
339It appends the Postscript to \fIinterp->result\fR and returns TCL_OK
340unless an error occurs, in which case TCL_ERROR is returned and
341\fIinterp->result\fR is overwritten with an error message.
342.PP
343\fBTk_CanvasPsPath\fR generates Postscript to set the current path
344to the set of points given by \fIcoordPtr\fR and \fInumPoints\fR.
345It appends the resulting Postscript to \fIinterp->result\fR.
346.PP
347\fBTk_CanvasPsStipple\fR generates Postscript that will fill the
348current path in stippled fashion.
349It uses \fIbitmap\fR as the stipple pattern and the current Postscript
350color; ones in the stipple bitmap are drawn in the current color, and
351zeroes are not drawn at all.
352The Postscript is appended to \fIinterp->result\fR and TCL_OK is
353returned, unless an error occurs, in which case TCL_ERROR is returned and
354\fIinterp->result\fR is overwritten with an error message.
355
356.SH KEYWORDS
357bitmap, canvas, color, font, path, Postscript, stipple