head	1.12;
access;
symbols
	core-8-5-9:1.11
	core-8-5-8:1.11
	macosx-cocoa-merge:1.12
	macosx-cocoa-premerge:1.12
	macosx-carbon-freeze:1.12
	core-8-5-7:1.11
	core-8-5-6:1.11
	core-8-6-b1:1.12
	core-8-6-a3:1.12
	core-8-5-5:1.11
	core-8-6-a2:1.12
	core-8-5-4:1.11
	core-8-5-3:1.11
	core-8-6-a1:1.11
	core-8-4-19:1.3
	core-8-5-branch:1.11.0.2
	core-8-5-2:1.11
	core-8-4-18:1.3
	core-8-5-1:1.11
	core-8-4-17:1.3
	core-8-5-0:1.10
	core-8-5-b3:1.9
	core-8-5-b2:1.8
	core-8-4-16:1.3
	core-8-5-b1:1.6
	core-stablilizer-merge:1.6
	core-stabilizer-branch:1.6.0.2
	core-stabilizer-merge:1.11
	core-8-4-15:1.3
	core-8-5-a6:1.6
	core-8-5-a5:1.6
	core-8-4-14:1.3
	core-8-5-a4:1.6
	core-8-4-13:1.3
	core-8-4-12:1.3
	core-8-4-11:1.3
	core-8-5-a3:1.6
	core-8-4-10:1.3
	core-8-4-9-branch:1.3.0.12
	core-8-5-a2:1.4
	core-8-4-9:1.3
	core-8-4-8:1.3
	core-8-4-7:1.3
	core-8-5-a1:1.3
	core-8-4-6:1.3
	core-8-4-5:1.3
	mistachkin-dev-branch:1.3.0.10
	core-8-4-4:1.3
	core-8-4-3:1.3
	core-8-4-branch:1.3.0.8
	core-8-4-2:1.3
	core-8-4-1:1.3
	core-8-3-5:1.2.18.1
	core-8-4-0:1.3
	macosx-8-4-merge-2002-08-31-trunk:1.3
	macosx-8-4-premerge-2002-08-31-branch:1.3
	macosx-8-4-premerge-2002-08-31-trunk:1.3
	macosx-8-4-merge-2002-08-30-branch:1.3
	macosx-8-4-merge-2002-08-30-trunk:1.3
	macosx-8-4-merge-2002-08-20-branch:1.3
	macosx-8-4-merge-2002-08-20-trunk:1.3
	core-8-4-b2:1.3
	core-8-4-b1:1.3
	macosx-premerge-6-9-02:1.3
	core-8-4-a4:1.3
	core-8-3-4:1.2.18.1
	macosx-8-4-branch:1.3.0.6
	macosx-8-4-branchpoint:1.3
	core-8-4-a3:1.3
	core-8-3-3:1.2.18.1
	dgp-privates-into-namespace:1.3.0.4
	tclpro-1-5-0:1.2
	core-8-4-win-speedup:1.3.0.2
	core-8-4-a2:1.3
	tclpro-1-4-1:1.2
	tclpro-1-4-0:1.2
	core-8-3-2:1.2
	ajuba-ajuba2-2-1-base:1.2
	ajuba-ajuba2-2-0:1.2
	core-8-4-a1:1.2
	core-8-3-1-branch:1.2.0.18
	core-8-3-1:1.2
	scriptics-sc-2-0-b5:1.2
	scriptics-sc-2-0-fixed:1.2
	scriptics-sc-2-0-b2:1.2
	scriptics-sc-2-0-b1:1.2
	core-8-3-0:1.2
	core-8-3-b2:1.2
	core-8-3-b1:1.2
	scriptics-sc-1-1:1.2
	scriptics-sc-1-1-b1:1.2
	core-8-2-3:1.2
	scriptics-sc-1-1-branch:1.2.0.16
	scriptics-sc-1-1-base:1.2
	scriptics-sc-1-0:1.2
	scriptics-sc-1-0-branch:1.2.0.14
	scriptics-sc-1-0-base:1.2
	core-8-2-2:1.2
	core-8-2-1:1.2
	scriptics-bc-1-0-b1:1.2
	core-8-2-1-branch:1.2.0.12
	scriptics-tclpro-1-3-0:1.2
	core-8-2-0:1.2
	core-8-2-b3-branch:1.2.0.10
	core-8-2-b3-base:1.2
	scriptics-tclpro-1-3-b4:1.2
	core-8-2-b2:1.2
	scriptics-tclpro-1-3-b3:1.2
	core-8-2-b1:1.2
	scriptics-tclpro-1-3-b2:1.2
	merge-to-mainline-5/21/99:1.2
	scriptics-tclpro-1-3-b2-branch:1.2.0.8
	core-8-1-1:1.2
	scriptics-tclpro-1-3-b1:1.2
	core-8-1-1-base:1.2
	core-8-1-0:1.2
	merge-to-mainline-4-29-99:1.2
	merge-to-mainline-4-23-99:1.2
	core-8-1-branch-old:1.1.0.4
	core-8-0-6-branch:1.2.0.6
	core-8-0-6-base:1.2
	core-8-0-5:1.2
	core-8-1-b3:1.1.4.1
	core-8-1-b2:1.1.4.1
	dev-8-1-stubs-branch:1.1.4.1.0.2
	dev-stubs-branch:1.2.0.4
	scriptics-tclpro-1-2:1.2
	scriptics-tclpro-1-2-b2:1.2
	core-8-1-merge-2/10/99:1.2
	core-8-0-5-branch:1.2.0.2
	core-8-0-5-base:1.2
	scriptics-tclpro-1-2-b1:1.2
	scriptics-tclpro-1-2-a1:1.2
	core-8-1-b1:1.1.4.1
	core-8-0-4:1.2
	core-8-1-a2:1.1
	core-8-0-2:1.1
	core-8-0-3:1.2;
locks; strict;
comment	@# @;


1.12
date	2008.06.30.22.57.01;	author dkf;	state Exp;
branches;
next	1.11;

1.11
date	2008.02.04.09.53.23;	author dkf;	state Exp;
branches;
next	1.10;

1.10
date	2007.12.13.15.23.43;	author dgp;	state Exp;
branches;
next	1.9;

1.9
date	2007.10.29.16.04.12;	author dkf;	state Exp;
branches;
next	1.8;

1.8
date	2007.10.26.20.13.22;	author dgp;	state Exp;
branches;
next	1.7;

1.7
date	2007.10.24.14.32.56;	author dkf;	state Exp;
branches;
next	1.6;

1.6
date	2005.04.22.21.32.23;	author georgeps;	state Exp;
branches
	1.6.2.1;
next	1.5;

1.5
date	2005.04.06.21.11.53;	author dkf;	state Exp;
branches;
next	1.4;

1.4
date	2004.08.22.15.43.20;	author dkf;	state Exp;
branches;
next	1.3;

1.3
date	2000.07.25.21.14.34;	author jenglish;	state Exp;
branches;
next	1.2;

1.2
date	98.09.14.18.22.47;	author stanton;	state Exp;
branches
	1.2.18.1;
next	1.1;

1.1
date	98.04.01.09.40.02;	author rjohnson;	state Exp;
branches
	1.1.4.1;
next	;

1.1.4.1
date	98.09.30.02.15.51;	author stanton;	state Exp;
branches;
next	;

1.2.18.1
date	2001.04.04.07.23.48;	author hobbs;	state Exp;
branches;
next	;

1.6.2.1
date	2007.11.01.16.37.12;	author dgp;	state Exp;
branches;
next	1.6.2.2;

1.6.2.2
date	2008.02.04.16.07.36;	author dgp;	state Exp;
branches;
next	;


desc
@@


1.12
log
@Minor doc updates (removing out of date changebars, improving typedef formatting,
 etc.)
@
text
@'\"
'\" Copyright (c) 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: FontId.3,v 1.11 2008/02/04 09:53:23 dkf Exp $
'\" 
.so man.macros
.TH Tk_FontId 3 8.0 Tk "Tk Library Procedures"
.BS
.SH NAME
Tk_FontId, Tk_GetFontMetrics, Tk_PostscriptFontName \- accessor functions for 
fonts
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
.sp
Font
\fBTk_FontId(\fItkfont\fB)\fR
.sp
\fBTk_GetFontMetrics(\fItkfont, fmPtr\fB)\fR
.sp
int
\fBTk_PostscriptFontName(\fItkfont, dsPtr\fB)\fR
.SH ARGUMENTS
.AS Tk_FontMetrics *dsPtr
.AP Tk_Font tkfont in
Opaque font token being queried.  Must have been returned by a previous
call to \fBTk_GetFont\fR.
.AP Tk_FontMetrics *fmPtr out
Pointer to structure in which the font metrics for \fItkfont\fR will
be stored. See \fBDATA STRUCTURES\fR below for details.
.AP Tcl_DString *dsPtr out
Pointer to an initialized \fBTcl_DString\fR to which the name of the
Postscript font that corresponds to \fItkfont\fR will be appended.
.BE
.SH DESCRIPTION
.PP
Given a \fItkfont\fR, \fBTk_FontId\fR returns the token that should be
selected into an XGCValues structure in order to construct a graphics
context that can be used to draw text in the specified font.  
.PP
\fBTk_GetFontMetrics\fR computes the ascent, descent, and linespace of the
\fItkfont\fR in pixels and stores those values in the structure pointer to by
\fIfmPtr\fR.  These values can be used in computations such as to space
multiple lines of text, to align the baselines of text in different
fonts, and to vertically align text in a given region.  See the
documentation for the \fBfont\fR command for definitions of the terms
ascent, descent, and linespace, used in font metrics.  
.PP
\fBTk_PostscriptFontName\fR maps a \fItkfont\fR to the corresponding
Postscript font name that should be used when printing.  The return value
is the size in points of the \fItkfont\fR and the Postscript font name is
appended to \fIdsPtr\fR.  \fIDsPtr\fR must refer to an initialized
\fBTcl_DString\fR.  Given a
.QW reasonable
Postscript printer, the
following screen font families should print correctly:
.IP
\fBAvant Garde\fR, \fBArial\fR, \fBBookman\fR, \fBCourier\fR, 
\fBCourier New\fR, \fBGeneva\fR, \fBHelvetica\fR, \fBMonaco\fR,
\fBNew Century Schoolbook\fR, \fBNew York\fR, \fBPalatino\fR, \fBSymbol\fR,
\fBTimes\fR, \fBTimes New Roman\fR, \fBZapf Chancery\fR, and 
\fBZapf Dingbats\fR.
.PP
Any other font families may not print correctly because the computed
Postscript font name may be incorrect or not exist on the printer.
.SH "DATA STRUCTURES"
.PP
The \fBTk_FontMetrics\fR data structure is used by \fBTk_GetFontMetrics\fR to
return information about a font and is defined as follows:
.CS
typedef struct Tk_FontMetrics {
    int \fIascent\fR;
    int \fIdescent\fR;
    int \fIlinespace\fR;
} \fBTk_FontMetrics\fR;
.CE
.PP
The \fIascent\fR field is the amount in pixels that the tallest
letter sticks up above the baseline, plus any extra blank space added
by the designer of the font.
.PP
The \fIdescent\fR is the largest amount in pixels that any letter
sticks below the baseline, plus any extra blank space added by the
designer of the font.
.PP
The \fIlinespace\fR is the sum of the ascent and descent.  How far
apart two lines of text in the same font should be placed so that none
of the characters in one line overlap any of the characters in the
other line.
.SH "SEE ALSO"
font(n), MeasureChar(3)
.SH KEYWORDS
font, measurement, Postscript
@


1.11
log
@Minor documentation improvements
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.10 2007/12/13 15:23:43 dgp Exp $
d70 1
d78 1
a78 1
} Tk_FontMetrics;
@


1.10
log
@merge stable branch onto HEAD
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.6.2.1 2007/11/01 16:37:12 dgp Exp $
a21 1
void
a25 1

d33 1
a33 1
be stored.
a37 1

d70 2
a71 2
The Tk_FontMetrics data structure is used by Tk_GetFontMetrics to return 
information about a font and is defined as follows:
d74 3
a76 3
    int ascent;
    int descent;
    int linespace;
d92 2
d95 1
a95 1
font
@


1.9
log
@Lots more GOOBE stuff. Now works with 'make html'!
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.8 2007/10/26 20:13:22 dgp Exp $
@


1.8
log
@        * doc/*.1:              Revert doc changes that broke
        * doc/*.3:              `make html` so we can get the release
        * doc/*.n:              out the door.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.6 2005/04/22 21:32:23 georgeps Exp $
d59 3
a61 1
\fBTcl_DString\fR.  Given a ``reasonable'' Postscript printer, the
@


1.7
log
@Lots of improvements to look and feel of manual pages
@
text
@d59 2
a60 4
\fBTcl_DString\fR.  Given a
.QW reasonable
Postscript printer, the following screen font families should print
correctly:
@


1.6
log
@fixed a typo
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.5 2005/04/06 21:11:53 dkf Exp $
d59 4
a62 2
\fBTcl_DString\fR.  Given a ``reasonable'' Postscript printer, the
following screen font families should print correctly:
@


1.6.2.1
log
@merge updates from HEAD
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.6 2005/04/22 21:32:23 georgeps Exp $
d59 1
a59 3
\fBTcl_DString\fR.  Given a
.QW reasonable
Postscript printer, the
@


1.6.2.2
log
@merge udpates from HEAD
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.10 2007/12/13 15:23:43 dgp Exp $
d22 1
d27 1
d35 1
a35 1
be stored. See \fBDATA STRUCTURES\fR below for details.
d40 1
d73 2
a74 2
The \fBTk_FontMetrics\fR data structure is used by \fBTk_GetFontMetrics\fR to
return information about a font and is defined as follows:
d77 3
a79 3
    int \fIascent\fR;
    int \fIdescent\fR;
    int \fIlinespace\fR;
a94 2
.SH "SEE ALSO"
font(n), MeasureChar(3)
d96 1
a96 1
font, measurement, Postscript
@


1.5
log
@Purge old and inaccurate .VS/.VE macros.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.4 2004/08/22 15:43:20 dkf Exp $
d80 2
a81 1
The \fIlinespace\fR field is the amount in pixels that the tallest
@


1.4
log
@More doc fixes from Mikhail Kolesnitchenko. [Patch 1013520]
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.3 2000/07/25 21:14:34 jenglish Exp $
a69 1
.VS 8.0 br
a91 1
.VE
@


1.3
log
@CanvPsY.3, ConfigWidg.3, CrtImgType.3, CrtItemType.3,
FontId.3, GetFont.3, canvas.n, font.n, options.n, text.n:
Documentation fix: Replaced references to XFontStruct *
and Tk_FontStruct with Tk_Font.
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.2 1998/09/14 18:22:47 stanton Exp $
d56 1
a56 1
Postcript font name that should be used when printing.  The return value
@


1.2
log
@Replaced SCCS strings, fixed binary files
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id$
d13 1
a13 1
Tk_FontId, Tk_FontMetrics, Tk_PostscriptFontName \- accessor functions for 
d71 1
a71 1
.SH DATA STRUCTURES
@


1.2.18.1
log
@doc cleanup and clarifications from 8.4aCVS backport
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.3 2000/07/25 21:14:34 jenglish Exp $
d13 1
a13 1
Tk_FontId, Tk_GetFontMetrics, Tk_PostscriptFontName \- accessor functions for 
d71 1
a71 1
.SH "DATA STRUCTURES"
@


1.1
log
@Initial revision
@
text
@d7 1
a7 1
'\" SCCS: @@(#) FontId.3 1.4 97/11/04 18:03:07
@


1.1.4.1
log
@Merged 8.0.3 changes into 8.1
@
text
@d7 1
a7 1
'\" RCS: @@(#) $Id: FontId.3,v 1.2 1998/09/14 18:22:47 stanton Exp $
@


