summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjenglish@flightlab.com <jenglish>2000-07-25 21:14:34 (GMT)
committerjenglish@flightlab.com <jenglish>2000-07-25 21:14:34 (GMT)
commitcdd4c4c1dacd96174225dc62905fedd31d8b27df (patch)
treebea05665891f61ab3749ece3ae4fe07945da4664 /doc
parentc6bc600d803dbcb3b90be56c4653c52add4ba9b3 (diff)
downloadtk-cdd4c4c1dacd96174225dc62905fedd31d8b27df.zip
tk-cdd4c4c1dacd96174225dc62905fedd31d8b27df.tar.gz
tk-cdd4c4c1dacd96174225dc62905fedd31d8b27df.tar.bz2
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.
Diffstat (limited to 'doc')
-rw-r--r--doc/CanvPsY.312
-rw-r--r--doc/ConfigWidg.34
-rw-r--r--doc/CrtImgType.36
-rw-r--r--doc/CrtItemType.34
-rw-r--r--doc/FontId.36
-rw-r--r--doc/GetFont.37
-rw-r--r--doc/canvas.n4
-rw-r--r--doc/font.n4
-rw-r--r--doc/getOpenFile.n4
-rw-r--r--doc/options.n7
-rw-r--r--doc/photo.n3
-rw-r--r--doc/text.n12
12 files changed, 38 insertions, 35 deletions
diff --git a/doc/CanvPsY.3 b/doc/CanvPsY.3
index c25f42f..af051ca 100644
--- a/doc/CanvPsY.3
+++ b/doc/CanvPsY.3
@@ -4,10 +4,10 @@
'\" 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.4 1999/04/21 21:53:20 rjohnson Exp $
+'\" RCS: @(#) $Id: CanvPsY.3,v 1.5 2000/07/25 21:14:34 jenglish Exp $
'\"
.so man.macros
-.TH Tk_CanvasPsY 3 4.0 Tk "Tk Library Procedures"
+.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
@@ -25,14 +25,14 @@ int
\fBTk_CanvasPsColor\fR(\fIinterp, canvas, colorPtr\fR)
.sp
int
-\fBTk_CanvasPsFont\fR(\fIinterp, canvas, fontStructPtr\fR)
+\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" *fontStructPtr
+.AS "unsigned int" "numPoints"
.AP Tk_Canvas canvas in
A token that identifies a canvas widget for which Postscript is
being generated.
@@ -53,7 +53,7 @@ Width of region of bitmap to output, in pixels.
Height of region of bitmap to output, in pixels.
.AP XColor *colorPtr in
Information about color value to set in Postscript.
-.AP XFontStruct *fontStructPtr in
+.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
@@ -97,7 +97,7 @@ 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 \fIfontStructPtr\fR as closely as possible.
+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.
diff --git a/doc/ConfigWidg.3 b/doc/ConfigWidg.3
index d20022e..1ac41e2 100644
--- a/doc/ConfigWidg.3
+++ b/doc/ConfigWidg.3
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: ConfigWidg.3,v 1.5 1999/04/21 21:53:20 rjohnson Exp $
+'\" RCS: @(#) $Id: ConfigWidg.3,v 1.6 2000/07/25 21:14:34 jenglish Exp $
'\"
.so man.macros
.TH Tk_ConfigureWidget 3 4.1 Tk "Tk Library Procedures"
@@ -259,7 +259,7 @@ will never match any arguments.
\fBTK_CONFIG_FONT\fR
The value must be an ASCII string identifying a font in a form
suitable for passing to \fBTk_GetFont\fR. The value is converted
-to an (\fBXFontStruct *\fR) by calling \fBTk_GetFont\fR and the result
+to a \fBTk_Font\fR by calling \fBTk_GetFont\fR and the result
is stored in the target.
If TK_CONFIG_NULL_OK is specified in \fIspecFlags\fR then the value
may be an empty string, in which case the target will be set to NULL.
diff --git a/doc/CrtImgType.3 b/doc/CrtImgType.3
index ce97863..1cbfc38 100644
--- a/doc/CrtImgType.3
+++ b/doc/CrtImgType.3
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: CrtImgType.3,v 1.4 2000/02/08 11:31:30 hobbs Exp $
+'\" RCS: @(#) $Id: CrtImgType.3,v 1.5 2000/07/25 21:14:34 jenglish Exp $
'\"
.so man.macros
.TH Tk_CreateImageType 3 8.3 Tk "Tk Library Procedures"
@@ -36,9 +36,9 @@ Name of existing image.
.AP Tk_ImageType **typePtrPtr out
Points to word in which to store a pointer to type information for
the given image, if it exists.
-.AP int argc
+.AP int argc in
Number of arguments
-.AP char ***argvPtr
+.AP char ***argvPtr in/out
Pointer to argument list
.VE
.BE
diff --git a/doc/CrtItemType.3 b/doc/CrtItemType.3
index 442f242..8d5e357 100644
--- a/doc/CrtItemType.3
+++ b/doc/CrtItemType.3
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: CrtItemType.3,v 1.5 2000/03/02 21:53:00 hobbs Exp $
+'\" RCS: @(#) $Id: CrtItemType.3,v 1.6 2000/07/25 21:14:34 jenglish Exp $
'\"
.so man.macros
.TH Tk_CreateItemType 3 4.0 Tk "Tk Library Procedures"
@@ -531,7 +531,7 @@ It is only relevant for item types that support an insertion cursor;
that don't support an insertion cursor.
The procedure must match the following prototype:
.CS
-typedef void Tk_ItemIndexProc(
+typedef void Tk_ItemCursorProc(
Tk_Canvas \fIcanvas\fR,
Tk_Item *\fIitemPtr\fR,
int \fIindex\fR);
diff --git a/doc/FontId.3 b/doc/FontId.3
index 80b0390..a787242 100644
--- a/doc/FontId.3
+++ b/doc/FontId.3
@@ -4,13 +4,13 @@
'\" 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.2 1998/09/14 18:22:47 stanton Exp $
+'\" RCS: @(#) $Id: FontId.3,v 1.3 2000/07/25 21:14:34 jenglish Exp $
'\"
.so man.macros
.TH Tk_FontId 3 8.0 Tk "Tk Library Procedures"
.BS
.SH NAME
-Tk_FontId, Tk_FontMetrics, Tk_PostscriptFontName \- accessor functions for
+Tk_FontId, Tk_GetFontMetrics, Tk_PostscriptFontName \- accessor functions for
fonts
.SH SYNOPSIS
.nf
@@ -68,7 +68,7 @@ following screen font families should print correctly:
Any other font families may not print correctly because the computed
Postscript font name may be incorrect or not exist on the printer.
.VS 8.0 br
-.SH DATA STRUCTURES
+.SH "DATA STRUCTURES"
The Tk_FontMetrics data structure is used by Tk_GetFontMetrics to return
information about a font and is defined as follows:
.CS
diff --git a/doc/GetFont.3 b/doc/GetFont.3
index f052935..eb9692a 100644
--- a/doc/GetFont.3
+++ b/doc/GetFont.3
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: GetFont.3,v 1.3 1999/04/16 01:51:08 stanton Exp $
+'\" RCS: @(#) $Id: GetFont.3,v 1.4 2000/07/25 21:14:34 jenglish Exp $
'\"
.so man.macros
.TH Tk_AllocFontFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -62,7 +62,7 @@ Opaque font token.
.VS 8.1
\fBTk_AllocFontFromObj\fR finds the font indicated by \fIobjPtr\fR and
returns a token that represents the font. The return value can be used
-in subsequent calls to procedures such as \fBTk_FontMetrics\fR,
+in subsequent calls to procedures such as \fBTk_GetFontMetrics\fR,
\fBTk_MeasureChars\fR, and \fBTk_FreeFont\fR. The Tk_Font token
will remain valid until
\fBTk_FreeFontFromObj\fR or \fBTk_FreeFont\fR is called to release it.
@@ -118,5 +118,8 @@ exactly one call to \fBTk_FreeFontFromObj\fR or \fBTk_FreeFont\fR
for each call to \fBTk_AllocFontFromObj\fR or \fBTk_GetFont\fR.
.VE
+.SH "SEE ALSO"
+Tk_FontId(3)
+
.SH KEYWORDS
font
diff --git a/doc/canvas.n b/doc/canvas.n
index 54a27be..b598ac3 100644
--- a/doc/canvas.n
+++ b/doc/canvas.n
@@ -6,7 +6,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: canvas.n,v 1.8 2000/06/05 23:31:34 ericm Exp $
+'\" RCS: @(#) $Id: canvas.n,v 1.9 2000/07/25 21:14:34 jenglish Exp $
'\"
.so man.macros
.TH canvas n 8.3 Tk "Tk Built-In Commands"
@@ -1616,7 +1616,7 @@ This option defaults to \fBcenter\fR.
.TP
\fB\-font \fIfontName\fR
Specifies the font to use for the text item.
-\fIFontName\fR may be any string acceptable to \fBTk_GetFontStruct\fR.
+\fIFontName\fR may be any string acceptable to \fBTk_GetFont\fR.
If this option isn't specified, it defaults to a system-dependent
font.
.TP
diff --git a/doc/font.n b/doc/font.n
index 3677771..dc28acd 100644
--- a/doc/font.n
+++ b/doc/font.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: font.n,v 1.2 1998/09/14 18:22:56 stanton Exp $
+'\" RCS: @(#) $Id: font.n,v 1.3 2000/07/25 21:14:35 jenglish Exp $
'\"
.so man.macros
.TH font n 8.0 Tk "Tk Built-In Commands"
@@ -269,12 +269,14 @@ All valid X font names, including those listed by xlsfonts(1), are available.
.TP
MS Windows:
.DS
+.ta 3c 6c
\fBsystem ansi device
systemfixed ansifixed oemfixed\fR
.DE
.TP
Macintosh:
.DS
+.ta 3c 6c
\fBsystem application\fR
.DE
.RE
diff --git a/doc/getOpenFile.n b/doc/getOpenFile.n
index bd6795f..26625d2 100644
--- a/doc/getOpenFile.n
+++ b/doc/getOpenFile.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: getOpenFile.n,v 1.7 2000/06/23 00:22:28 ericm Exp $
+'\" RCS: @(#) $Id: getOpenFile.n,v 1.8 2000/07/25 21:14:35 jenglish Exp $
'\"
.so man.macros
.TH tk_getOpenFile n 4.2 Tk "Tk Built-In Commands"
@@ -12,8 +12,6 @@
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
tk_getOpenFile, tk_getSaveFile \- pop up a dialog box for the user to select a file to open or save.
-.PP
-.PP
.SH SYNOPSIS
\fBtk_getOpenFile \fR?\fIoption value ...\fR?
.br
diff --git a/doc/options.n b/doc/options.n
index a55b071..1801a42 100644
--- a/doc/options.n
+++ b/doc/options.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: options.n,v 1.5 2000/04/27 18:28:58 ericm Exp $
+'\" RCS: @(#) $Id: options.n,v 1.6 2000/07/25 21:14:35 jenglish Exp $
'\"
.so man.macros
.TH options n 4.4 Tk "Tk Built-In Commands"
@@ -108,6 +108,7 @@ requests when it has a selection. The default is usually for widgets
to export selections.
.OP \-font font Font
Specifies the font to use when drawing text inside the widget.
+The value may have any of the forms accepted by \fBTk_GetFont\fR.
.OP "\-foreground or \-fg" foreground Foreground
Specifies the normal foreground color to use when displaying the widget.
.OP \-highlightbackground highlightBackground HighlightBackground
@@ -325,8 +326,8 @@ scrollbars and is provided by widgets that support vertical scrolling.
See the description of \fBxScrollCommand\fR for details
on how this option is used.
-.SH SEE ALSO
-colors, cursors
+.SH "SEE ALSO"
+colors, cursors, font
.SH KEYWORDS
class, name, standard option, switch
diff --git a/doc/photo.n b/doc/photo.n
index 00c2133..7ca4d3c 100644
--- a/doc/photo.n
+++ b/doc/photo.n
@@ -9,7 +9,7 @@
'\" Department of Computer Science,
'\" Australian National University.
'\"
-'\" RCS: @(#) $Id: photo.n,v 1.5 2000/05/23 00:31:36 hobbs Exp $
+'\" RCS: @(#) $Id: photo.n,v 1.6 2000/07/25 21:14:35 jenglish Exp $
'\"
.so man.macros
.TH photo n 4.0 Tk "Tk Built-In Commands"
@@ -337,7 +337,6 @@ if this option is not given, is the whole image.
If this options is specified, the data will not contain color
information. All pixel data will be transformed into grayscale.
.RE
-.TP
.SH "IMAGE FORMATS"
.PP
The photo image code is structured to allow handlers for additional
diff --git a/doc/text.n b/doc/text.n
index eb88142..a8c03f6 100644
--- a/doc/text.n
+++ b/doc/text.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: text.n,v 1.6 2000/02/01 11:40:58 hobbs Exp $
+'\" RCS: @(#) $Id: text.n,v 1.7 2000/07/25 21:14:35 jenglish Exp $
'\"
.so man.macros
.TH text n 4.0 Tk "Tk Built-In Commands"
@@ -339,7 +339,7 @@ as an empty string, then a solid fill will be used.
.TP
\fB\-font \fIfontName\fR
\fIFontName\fR is the name of a font to use for drawing characters.
-It may have any of the forms accepted by \fBTk_GetFontStruct\fR.
+It may have any of the forms accepted by \fBTk_GetFont\fR.
.TP
\fB\-foreground \fIcolor\fR
\fIColor\fR specifies the color to use when drawing text and other
@@ -524,7 +524,7 @@ motions if a mouse button is down; the update will be deferred
until all mouse buttons have been released).
Neither of these special marks may be deleted.
-.SH EMBEDDED WINDOWS
+.SH "EMBEDDED WINDOWS"
.PP
The third form of annotation in text widgets is an embedded window.
Each embedded window annotation causes a window to be displayed
@@ -595,7 +595,7 @@ stretched.
Specifies the name of a window to display in the annotation.
.VS
-.SH EMBEDDED IMAGES
+.SH "EMBEDDED IMAGES"
.PP
The final form of annotation in text widgets is an embedded image.
Each embedded image annotation causes an image to be displayed
@@ -664,7 +664,7 @@ the top and on the bottom of the embedded image.
It may have any of the usual forms defined for a screen distance.
.VE
-.SH THE SELECTION
+.SH "THE SELECTION"
.PP
Selection support is implemented via tags.
If the \fBexportSelection\fR option for the text widget is true
@@ -690,7 +690,7 @@ the text widget are tied to the \fB\-background\fR,
tag: changes in either will automatically be reflected in the
other.
-.SH THE INSERTION CURSOR
+.SH "THE INSERTION CURSOR"
.PP
The mark named \fBinsert\fR has special significance in text widgets.
It is defined automatically when a text widget is created and it