summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsurles <surles@noemail.net>1999-04-16 18:26:12 (GMT)
committersurles <surles@noemail.net>1999-04-16 18:26:12 (GMT)
commit2e7654c6e2a8799462edb564b855bcab6b714e98 (patch)
tree1eed715df97153c26e20195045497c6938248c34
parent58364783d6f176ecb8520dade8d1cb1a346c0950 (diff)
downloadtk-2e7654c6e2a8799462edb564b855bcab6b714e98.zip
tk-2e7654c6e2a8799462edb564b855bcab6b714e98.tar.gz
tk-2e7654c6e2a8799462edb564b855bcab6b714e98.tar.bz2
fixed Tk doc bugs
FossilOrigin-Name: de71f02a0f833a7fdfca5fc7631261e09fc48e11
-rw-r--r--doc/CanvPsY.34
-rw-r--r--doc/ConfigWidg.38
-rw-r--r--doc/CrtItemType.34
-rw-r--r--doc/CrtWindow.34
-rw-r--r--doc/EventHndlr.34
-rw-r--r--doc/FreeXId.34
-rw-r--r--doc/GetImage.34
-rw-r--r--doc/HandleEvent.38
-rw-r--r--doc/MapWindow.312
-rw-r--r--doc/TextLayout.34
-rw-r--r--doc/WindowId.34
11 files changed, 30 insertions, 30 deletions
diff --git a/doc/CanvPsY.3 b/doc/CanvPsY.3
index 17e4a05..e665402 100644
--- a/doc/CanvPsY.3
+++ b/doc/CanvPsY.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: CanvPsY.3,v 1.2 1998/09/14 18:22:45 stanton Exp $
+'\" RCS: @(#) $Id: CanvPsY.3,v 1.3 1999/04/16 18:26:12 surles Exp $
'\"
.so man.macros
.TH Tk_CanvasPsY 3 4.0 Tk "Tk Library Procedures"
@@ -72,7 +72,7 @@ Most of the procedures take a \fIcanvas\fR argument, which
refers to a canvas widget for which Postscript is being
generated.
.PP
-\fBTk_CanvasY\fR takes as argument a y-coordinate in the space of
+\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
diff --git a/doc/ConfigWidg.3 b/doc/ConfigWidg.3
index 0b8b91b..f82245a 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.3 1999/04/16 01:51:07 stanton Exp $
+'\" RCS: @(#) $Id: ConfigWidg.3,v 1.4 1999/04/16 18:26:12 surles Exp $
'\"
.so man.macros
.TH Tk_ConfigureWidget 3 4.1 Tk "Tk Library Procedures"
@@ -258,13 +258,13 @@ will never match any arguments.
.TP
\fBTK_CONFIG_FONT\fR
The value must be an ASCII string identifying a font in a form
-suitable for passing to \fBTk_GetFontStruct\fR. The value is converted
-to an (\fBXFontStruct *\fR) by calling \fBTk_GetFontStruct\fR and the result
+suitable for passing to \fBTk_GetFont\fR. The value is converted
+to an (\fBXFontStruct *\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.
If the previous value of the target
-wasn't NULL, then it is freed by passing it to \fBTk_FreeFontStruct\fR.
+wasn't NULL, then it is freed by passing it to \fBTk_FreeFont\fR.
.TP
\fBTK_CONFIG_INT\fR
The value must be an ASCII integer string
diff --git a/doc/CrtItemType.3 b/doc/CrtItemType.3
index 3c11ceb..3eec9a1 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.2 1998/09/14 18:22:47 stanton Exp $
+'\" RCS: @(#) $Id: CrtItemType.3,v 1.3 1999/04/16 18:26:12 surles Exp $
'\"
.so man.macros
.TH Tk_CreateItemType 3 4.0 Tk "Tk Library Procedures"
@@ -442,7 +442,7 @@ In order to generate Postscript that complies with the Adobe Document
Structuring Conventions, Tk actually generates Postscript in two passes.
It calls each item's \fIpostscriptProc\fR in each pass.
The only purpose of the first pass is to collect font information
-(which is done by \fBTk_CanvPsFont\fR); the actual Postscript is
+(which is done by \fBTk_CanvasPsFont\fR); the actual Postscript is
discarded.
Tk sets the \fIprepass\fR argument to \fIpostscriptProc\fR to 1
during the first pass; the type manager can use \fIprepass\fR to skip
diff --git a/doc/CrtWindow.3 b/doc/CrtWindow.3
index b5f0e29..5c0caad 100644
--- a/doc/CrtWindow.3
+++ b/doc/CrtWindow.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: CrtWindow.3,v 1.2 1998/09/14 18:22:47 stanton Exp $
+'\" RCS: @(#) $Id: CrtWindow.3,v 1.3 1999/04/16 18:26:12 surles Exp $
'\"
.so man.macros
.TH Tk_CreateWindow 3 4.2 Tk "Tk Library Procedures"
@@ -125,7 +125,7 @@ created with \fBTk_CreateEventHandler\fR. In addition,
\fBTk_DestroyWindow\fR will delete any children of \fItkwin\fR
recursively (where children are defined in the Tk sense, consisting
of all windows that were created with the given window as \fIparent\fR).
-If \fItkwin\fR was created by \fBTk_CreateInternalWindow\fR then event
+If \fItkwin\fR is an internal window, then event
handlers interested in destroy events
are invoked immediately. If \fItkwin\fR is a top-level or main window,
then the event handlers will be invoked later, after X has seen
diff --git a/doc/EventHndlr.3 b/doc/EventHndlr.3
index cbe7c3b..7d12e04 100644
--- a/doc/EventHndlr.3
+++ b/doc/EventHndlr.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: EventHndlr.3,v 1.2 1998/09/14 18:22:47 stanton Exp $
+'\" RCS: @(#) $Id: EventHndlr.3,v 1.3 1999/04/16 18:26:12 surles Exp $
'\"
.so man.macros
.TH Tk_CreateEventHandler 3 "" Tk "Tk Library Procedures"
@@ -63,7 +63,7 @@ specified in the \fImask\fR argument to \fBTk_CreateEventHandler\fR.
previously-created event handler: it deletes the first handler
it finds that is associated with \fItkwin\fR and matches the
\fImask\fR, \fIproc\fR, and \fIclientData\fR arguments. If
-no such handler exists, then \fBTk_EventHandler\fR returns
+no such handler exists, then \fBTk_HandleEvent\fR returns
without doing anything. Although Tk supports it, it's probably
a bad idea to have more than one callback with the same \fImask\fR,
\fIproc\fR, and \fIclientData\fR arguments.
diff --git a/doc/FreeXId.3 b/doc/FreeXId.3
index 5d8024a..8406a3a 100644
--- a/doc/FreeXId.3
+++ b/doc/FreeXId.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: FreeXId.3,v 1.2 1998/09/14 18:22:48 stanton Exp $
+'\" RCS: @(#) $Id: FreeXId.3,v 1.3 1999/04/16 18:26:12 surles Exp $
'\"
.so man.macros
.TH Tk_FreeXId 3 4.0 Tk "Tk Library Procedures"
@@ -37,7 +37,7 @@ allows identifiers to be reused.
In order for this to work, \fBTk_FreeXId\fR must be called to
tell the allocator about resources that have been freed.
Tk automatically calls \fBTk_FreeXId\fR whenever it frees a
-resource, so if you use procedures like \fBTk_GetFontStruct\fR,
+resource, so if you use procedures like \fBTk_GetFont\fR,
\fBTk_GetGC\fR, and \fBTk_GetPixmap\fR then you need not call
\fBTk_FreeXId\fR.
However, if you allocate resources directly from Xlib, for example
diff --git a/doc/GetImage.3 b/doc/GetImage.3
index 53d31d5..190665f 100644
--- a/doc/GetImage.3
+++ b/doc/GetImage.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: GetImage.3,v 1.2 1998/09/14 18:22:49 stanton Exp $
+'\" RCS: @(#) $Id: GetImage.3,v 1.3 1999/04/16 18:26:12 surles Exp $
'\"
.so man.macros
.TH Tk_GetImage 3 4.0 Tk "Tk Library Procedures"
@@ -79,7 +79,7 @@ If the image doesn't exist then \fBTk_GetImage\fR returns NULL
and leaves an error message in \fIinterp->result\fR.
.PP
When a widget wishes to actually display an image it must
-call \fBTk_RedrawWidget\fR, identifying the image (\fIimage\fR),
+call \fBTk_RedrawImage\fR, identifying the image (\fIimage\fR),
a region within the image to redisplay (\fIimageX\fR, \fIimageY\fR,
\fIwidth\fR, and \fIheight\fR), and a place to display the
image (\fIdrawable\fR, \fIdrawableX\fR, and \fIdrawableY\fR).
diff --git a/doc/HandleEvent.3 b/doc/HandleEvent.3
index 6117aef..9a8aa06 100644
--- a/doc/HandleEvent.3
+++ b/doc/HandleEvent.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: HandleEvent.3,v 1.2 1998/09/14 18:22:52 stanton Exp $
+'\" RCS: @(#) $Id: HandleEvent.3,v 1.3 1999/04/16 18:26:12 surles Exp $
'\"
.so man.macros
.TH Tk_HandleEvent 3 "" Tk "Tk Library Procedures"
@@ -26,15 +26,15 @@ Pointer to X event to dispatch to relevant handler(s).
.SH DESCRIPTION
.PP
\fBTk_HandleEvent\fR is a lower-level procedure that deals with window
-events. It is called by \fBTk_ServiceEvent\fR (and indirectly by
+events. It is called by \fBTcl_ServiceEvent\fR (and indirectly by
\fBTk_DoOneEvent\fR), and in a few other cases within Tk.
It makes callbacks to any window event
handlers (created by calls to \fBTk_CreateEventHandler\fR)
that match \fIeventPtr\fR and then returns. In some cases
it may be useful for an application to bypass the Tk event
queue and call \fBTk_HandleEvent\fR directly instead of
-calling \fBTk_QueueEvent\fR followed by
-\fBTk_ServiceEvent\fR.
+calling \fBTcl_QueueEvent\fR followed by
+\fBTcl_ServiceEvent\fR.
.PP
This procedure may be invoked recursively. For example,
it is possible to invoke \fBTk_HandleEvent\fR recursively
diff --git a/doc/MapWindow.3 b/doc/MapWindow.3
index f2cfc4e..ffc08a8 100644
--- a/doc/MapWindow.3
+++ b/doc/MapWindow.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: MapWindow.3,v 1.2 1998/09/14 18:22:52 stanton Exp $
+'\" RCS: @(#) $Id: MapWindow.3,v 1.3 1999/04/16 18:26:12 surles Exp $
'\"
.so man.macros
.TH Tk_MapWindow 3 "" Tk "Tk Library Procedures"
@@ -37,11 +37,11 @@ deferred window creation.
\fBTk_UnmapWindow\fR unmaps \fItkwin\fR's window
from the screen.
.PP
-If \fItkwin\fR is a child window (i.e. \fBTk_CreateChildWindow\fR was
-used to create it), then event handlers interested in map and unmap events
-are invoked immediately. If \fItkwin\fR isn't an internal window,
-then the event handlers will be invoked later, after X has seen
-the request and returned an event for it.
+If \fItkwin\fR is a child window (i.e. \fBTk_CreateWindow\fR was
+used to create a child window), then event handlers interested in map
+and unmap events are invoked immediately. If \fItkwin\fR isn't an
+internal window, then the event handlers will be invoked later, after
+X has seen the request and returned an event for it.
.PP
These procedures should be used in place of the X procedures
\fBXMapWindow\fR and \fBXUnmapWindow\fR, since they update
diff --git a/doc/TextLayout.3 b/doc/TextLayout.3
index 41b17af..c76b682 100644
--- a/doc/TextLayout.3
+++ b/doc/TextLayout.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: TextLayout.3,v 1.3 1999/04/16 01:51:09 stanton Exp $
+'\" RCS: @(#) $Id: TextLayout.3,v 1.4 1999/04/16 18:26:12 surles Exp $
'\"
.so man.macros
.TH Tk_ComputeTextLayout 3 8.1 Tk "Tk Library Procedures"
@@ -192,7 +192,7 @@ to the point. Given a \fIlayout\fR with no characters, the value 0 will
always be returned, referring to a hypothetical zero-width placeholder
character.
.PP
-\fBTk_CharBBox\fR uses the information in \fIlayout\fR to return the
+\fBTk_CharBbox\fR uses the information in \fIlayout\fR to return the
bounding box for the character specified by \fIindex\fR. The width of the
bounding box is the advance width of the character, and does not include any
left or right bearing. Any character that extends partially outside of
diff --git a/doc/WindowId.3 b/doc/WindowId.3
index 41a0ab5..3d48241 100644
--- a/doc/WindowId.3
+++ b/doc/WindowId.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: WindowId.3,v 1.2 1998/09/14 18:22:54 stanton Exp $
+'\" RCS: @(#) $Id: WindowId.3,v 1.3 1999/04/16 18:26:13 surles Exp $
'\"
.so man.macros
.TH Tk_WindowId 3 "" Tk "Tk Library Procedures"
@@ -83,7 +83,7 @@ Token for window.
.SH DESCRIPTION
.PP
-\fBTk_WindowID\fR and the other names listed above are
+\fBTk_WindowId\fR and the other names listed above are
all macros that return fields from Tk's local data structure
for \fItkwin\fR. None of these macros requires any
interaction with the server; it is safe to assume that