summaryrefslogtreecommitdiffstats
path: root/generic/tkMacWinMenu.c
Commit message (Expand)AuthorAgeFilesLines
* Purge RCS Keywordsdgp2011-06-081-2/+0
|\
| * Purge RCS Keywords.dgp2011-06-081-2/+0
| |\
| | * Purge RCS Keywords.dgp2011-06-081-2/+0
* | | SMALL FIX: Remove useless explicit casts now that we require C89 or later.dkf2010-01-021-5/+5
|/ /
* | merge stable branch onto HEADdgp2007-12-131-1/+1
* | header cleanupdgp2007-09-071-1/+2
* | ANSIfydkf2005-11-141-68/+72
|/
* * Merged 8.1 branch into the main trunkstanton1999-04-161-7/+16
* Replaced SCCS strings, fixed binary filesstanton1998-09-141-1/+1
* Initial revisionrjohnson1998-04-011-0/+134
100
-rw-r--r--doc/CrtCmHdlr.311
-rw-r--r--doc/CrtErrHdlr.39
-rw-r--r--doc/CrtGenHdlr.3167
-rw-r--r--doc/CrtImgType.385
-rw-r--r--doc/CrtItemType.3176
-rw-r--r--doc/CrtPhImgFmt.3114
-rw-r--r--doc/CrtSelHdlr.313
-rw-r--r--doc/CrtWindow.33
-rw-r--r--doc/DeleteImg.34
-rw-r--r--doc/DrawFocHlt.378
-rw-r--r--doc/EventHndlr.3156
-rw-r--r--doc/FindPhoto.324
-rw-r--r--doc/FontId.35
-rw-r--r--doc/GeomReq.3192
-rw-r--r--doc/GetBitmap.36
-rw-r--r--doc/GetCapStyl.34
-rw-r--r--doc/GetColor.33
-rw-r--r--doc/GetCursor.36
-rw-r--r--doc/GetDash.34
-rw-r--r--doc/GetFont.34
-rw-r--r--doc/GetGC.3146
-rw-r--r--doc/GetHINSTANCE.34
-rw-r--r--doc/GetHWND.379
-rw-r--r--doc/GetImage.321
-rw-r--r--doc/GetJoinStl.34
-rw-r--r--doc/GetJustify.33
-rw-r--r--doc/GetOption.34
-rw-r--r--doc/GetPixels.34
-rw-r--r--doc/GetPixmap.3110
-rw-r--r--doc/GetScroll.34
-rw-r--r--doc/GetSelect.314
-rw-r--r--doc/GetUid.34
-rw-r--r--doc/GetVRoot.34
-rw-r--r--doc/Grab.3125
-rw-r--r--doc/HWNDToWindow.358
-rw-r--r--doc/HandleEvent.396
-rw-r--r--doc/IdToWindow.370
-rw-r--r--doc/ImgChanged.3135
-rw-r--r--doc/Inactive.34
-rw-r--r--doc/InternAtom.34
-rw-r--r--doc/MainLoop.362
-rw-r--r--doc/MainWin.389
-rw-r--r--doc/MaintGeom.33
-rw-r--r--doc/ManageGeom.317
-rw-r--r--doc/MapWindow.34
-rw-r--r--doc/MoveToplev.34
-rw-r--r--doc/Name.34
-rw-r--r--doc/NameOfImg.34
-rw-r--r--doc/OwnSelect.3103
-rw-r--r--doc/ParseArgv.36
-rw-r--r--doc/QWinEvent.3104
-rw-r--r--doc/Restack.396
-rw-r--r--doc/RestrictEv.39
-rw-r--r--doc/SetAppName.34
-rw-r--r--doc/SetCaret.378
-rw-r--r--doc/SetClass.3120
-rw-r--r--doc/SetClassProcs.3180
-rw-r--r--doc/SetGrid.3132
-rw-r--r--doc/SetOptions.360
-rw-r--r--doc/SetVisual.34
-rw-r--r--doc/StrictMotif.34
-rw-r--r--doc/TextLayout.35
-rw-r--r--doc/TkInitStubs.33
-rw-r--r--doc/Tk_Init.34
-rw-r--r--doc/Tk_Main.37
-rw-r--r--doc/WindowId.34
-rw-r--r--doc/bell.n69
-rw-r--r--doc/bind.n13
-rw-r--r--doc/bindtags.n7
-rw-r--r--doc/bitmap.n225
-rw-r--r--doc/button.n8
-rw-r--r--doc/canvas.n9
-rw-r--r--doc/checkbutton.n22
-rw-r--r--doc/chooseColor.n6
-rw-r--r--doc/chooseDirectory.n5
-rw-r--r--doc/clipboard.n7
-rw-r--r--doc/colors.n3
-rw-r--r--doc/console.n4
-rw-r--r--doc/cursors.n3
-rw-r--r--doc/destroy.n5
-rw-r--r--doc/dialog.n7
-rw-r--r--doc/entry.n3
-rw-r--r--doc/event.n8
-rw-r--r--doc/focus.n6
-rw-r--r--doc/focusNext.n5
-rw-r--r--doc/font.n11
-rw-r--r--doc/frame.n3
-rw-r--r--doc/getOpenFile.n4
-rw-r--r--doc/grab.n7
-rw-r--r--doc/grid.n44
-rw-r--r--doc/image.n6
-rw-r--r--doc/keysyms.n1858
-rw-r--r--doc/label.n4
-rw-r--r--doc/labelframe.n4
-rw-r--r--doc/listbox.n5
-rw-r--r--doc/loadTk.n6
-rw-r--r--doc/lower.n74
-rw-r--r--doc/menu.n5
-rw-r--r--doc/menubar.n78
-rw-r--r--doc/menubutton.n3
-rw-r--r--doc/message.n3
-rw-r--r--doc/messageBox.n12
-rw-r--r--doc/option.n6
-rw-r--r--doc/optionMenu.n4
-rw-r--r--doc/options.n7
-rw-r--r--doc/pack-old.n5
-rw-r--r--doc/pack.n7
-rw-r--r--doc/palette.n5
-rw-r--r--doc/panedwindow.n12
-rw-r--r--doc/photo.n7
-rw-r--r--doc/place.n15
-rw-r--r--doc/popup.n99
-rw-r--r--doc/radiobutton.n17
-rw-r--r--doc/raise.n7
-rw-r--r--doc/scale.n5
-rw-r--r--doc/scrollbar.n5
-rw-r--r--doc/selection.n5
-rw-r--r--doc/send.n8
-rw-r--r--doc/spinbox.n5
-rw-r--r--doc/text.n3081
-rw-r--r--doc/tk.n4
-rw-r--r--doc/tkerror.n75
-rw-r--r--doc/tkvars.n5
-rw-r--r--doc/tkwait.n101
-rw-r--r--doc/toplevel.n8
-rw-r--r--doc/ttk_Geometry.345
-rw-r--r--doc/ttk_Theme.34
-rw-r--r--doc/ttk_button.n4
-rw-r--r--doc/ttk_checkbutton.n5
-rw-r--r--doc/ttk_combobox.n5
-rw-r--r--doc/ttk_entry.n10
-rw-r--r--doc/ttk_frame.n6
-rw-r--r--doc/ttk_image.n7
-rw-r--r--doc/ttk_intro.n9
-rw-r--r--doc/ttk_label.n5
-rw-r--r--doc/ttk_labelframe.n5
-rw-r--r--doc/ttk_menubutton.n5
-rw-r--r--doc/ttk_notebook.n10
-rw-r--r--doc/ttk_panedwindow.n6
-rw-r--r--doc/ttk_progressbar.n5
-rw-r--r--doc/ttk_radiobutton.n6
-rw-r--r--doc/ttk_scale.n5
-rw-r--r--doc/ttk_scrollbar.n9
-rw-r--r--doc/ttk_separator.n5
-rw-r--r--doc/ttk_sizegrip.n7
-rw-r--r--doc/ttk_style.n7
-rw-r--r--doc/ttk_treeview.n9
-rw-r--r--doc/ttk_vsapi.n6
-rw-r--r--doc/ttk_widget.n10
-rw-r--r--doc/winfo.n6
-rw-r--r--doc/wish.14
-rw-r--r--doc/wm.n75
162 files changed, 4854 insertions, 5178 deletions
diff --git a/doc/3DBorder.3 b/doc/3DBorder.3
index cc8cb8b..204f908 100644
--- a/doc/3DBorder.3
+++ b/doc/3DBorder.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: 3DBorder.3,v 1.11 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: 3DBorder.3,v 1.12 2008/06/30 22:57:00 dkf Exp $
'\"
.so man.macros
.TH Tk_Alloc3DBorderFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -136,7 +136,6 @@ it forms the bottom side.
Specifies which of the border's graphics contexts is desired.
Must be \fBTK_3D_FLAT_GC\fR, \fBTK_3D_LIGHT_GC\fR, or \fBTK_3D_DARK_GC\fR.
.BE
-
.SH DESCRIPTION
.PP
These procedures provide facilities for drawing window borders in a
@@ -292,6 +291,5 @@ with the Tk_3DBorder token for the border.
There should be exactly one call to \fBTk_Free3DBorderFromObj\fR or
\fBTk_Free3DBorder\fR for each call to \fBTk_Alloc3DBorderFromObj\fR
or \fBTk_Get3DBorder\fR.
-
.SH KEYWORDS
3D, background, border, color, depressed, illumination, object, polygon, raised, shadow, three-dimensional effect
diff --git a/doc/AddOption.3 b/doc/AddOption.3
index 4359c20..882d23b 100644
--- a/doc/AddOption.3
+++ b/doc/AddOption.3
@@ -2,7 +2,7 @@
'\" Copyright (c) 1998-2000 by Scriptics Corporation.
'\" All rights reserved.
'\"
-'\" RCS: @(#) $Id: AddOption.3,v 1.6 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: AddOption.3,v 1.7 2008/06/30 22:57:00 dkf Exp $
'\"
'\"
.so man.macros
@@ -26,7 +26,6 @@ Value of option.
.AP int priority in
Overall priority level to use for option.
.BE
-
.SH DESCRIPTION
.PP
This procedure is invoked to add an option to the database
@@ -50,6 +49,5 @@ user-specific startup files.
.IP 80
Used for options specified interactively after the application starts
running.
-
.SH KEYWORDS
class, name, option, add
diff --git a/doc/BindTable.3 b/doc/BindTable.3
index 688fa7f..32d6184 100644
--- a/doc/BindTable.3
+++ b/doc/BindTable.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: BindTable.3,v 1.5 2007/01/05 00:00:49 nijtmans Exp $
+'\" RCS: @(#) $Id: BindTable.3,v 1.6 2008/06/30 22:57:00 dkf Exp $
'\"
.so man.macros
.TH Tk_CreateBindingTable 3 4.0 Tk "Tk Library Procedures"
@@ -63,7 +63,6 @@ Number of object identifiers pointed to by \fIobjectPtr\fR.
Points to an array of object identifiers: bindings will be considered
for each of these objects in order from first to last.
.BE
-
.SH DESCRIPTION
.PP
These procedures provide a general-purpose mechanism for creating
@@ -152,6 +151,5 @@ the object is skipped.
\fBTk_BindEvent\fR continues through all of the objects, handling
exceptions such as errors, \fBbreak\fR, and \fBcontinue\fR as
described in the documentation for \fBbind\fR.
-
.SH KEYWORDS
binding, event, object, script
diff --git a/doc/CanvPsY.3 b/doc/CanvPsY.3
index 36e3264..05b214e 100644
--- a/doc/CanvPsY.3
+++ b/doc/CanvPsY.3
@@ -1,122 +1,120 @@
-'\"
-'\" 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.6 2004/09/19 16:05:36 dkf Exp $
-'\"
-.so man.macros
-.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 \fBTCL_OK\fR is returned
-unless an error occurs, in which case \fBTCL_ERROR\fR 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
-\fBTCL_OK\fR unless an error occurs, in which case \fBTCL_ERROR\fR 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 \fBTCL_OK\fR
-unless an error occurs, in which case \fBTCL_ERROR\fR 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 \fBTCL_OK\fR is
-returned, unless an error occurs, in which case \fBTCL_ERROR\fR is returned and
-\fIinterp->result\fR is overwritten with an error message.
-
-.SH KEYWORDS
-bitmap, canvas, color, font, path, Postscript, stipple
+'\"
+'\" 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.7 2008/06/30 22:57:00 dkf Exp $
+'\"
+.so man.macros
+.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 \fBTCL_OK\fR is returned
+unless an error occurs, in which case \fBTCL_ERROR\fR 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
+\fBTCL_OK\fR unless an error occurs, in which case \fBTCL_ERROR\fR 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 \fBTCL_OK\fR
+unless an error occurs, in which case \fBTCL_ERROR\fR 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 \fBTCL_OK\fR is
+returned, unless an error occurs, in which case \fBTCL_ERROR\fR is returned and
+\fIinterp->result\fR is overwritten with an error message.
+.SH KEYWORDS
+bitmap, canvas, color, font, path, Postscript, stipple
diff --git a/doc/CanvTkwin.3 b/doc/CanvTkwin.3
index 3283f37..0f1c7c4 100644
--- a/doc/CanvTkwin.3
+++ b/doc/CanvTkwin.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: CanvTkwin.3,v 1.7 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: CanvTkwin.3,v 1.8 2008/06/30 22:57:00 dkf Exp $
'\"
.so man.macros
.TH Tk_CanvasTkwin 3 4.1 Tk "Tk Library Procedures"
@@ -73,7 +73,6 @@ the left of this coordinate need to be redisplayed.
Bottom edge of the region that needs redisplay. Only pixels above
this coordinate need to be redisplayed.
.BE
-
.SH DESCRIPTION
.PP
These procedures are called by canvas type managers to perform various
@@ -156,6 +155,5 @@ static Tk_ConfigSpec configSpecs[] = {
...
};
.CE
-
.SH KEYWORDS
canvas, focus, item type, redisplay, selection, type manager
diff --git a/doc/CanvTxtInfo.3 b/doc/CanvTxtInfo.3
index c3eb487..81080dd 100644
--- a/doc/CanvTxtInfo.3
+++ b/doc/CanvTxtInfo.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: CanvTxtInfo.3,v 1.5 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: CanvTxtInfo.3,v 1.6 2008/06/30 22:57:00 dkf Exp $
'\"
.so man.macros
.TH Tk_CanvasTextInfo 3 4.0 Tk "Tk Library Procedures"
@@ -22,7 +22,6 @@ Tk_CanvasTextInfo *
.AP Tk_Canvas canvas in
A token that identifies a particular canvas widget.
.BE
-
.SH DESCRIPTION
.PP
Textual canvas items are somewhat more complicated to manage than
@@ -49,7 +48,7 @@ typedef struct Tk_CanvasTextInfo {
Tk_Item *\fIfocusItemPtr\fR;
int \fIgotFocus\fR;
int \fIcursorOn\fR;
-} Tk_CanvasTextInfo;
+} \fBTk_CanvasTextInfo\fR;
.CE
The \fBselBorder\fR field identifies a Tk_3DBorder that should be
used for drawing the background under selected text.
@@ -99,6 +98,5 @@ anchor, as determined by \fIselItemPtr\fR or \fIanchorItemPtr\fR).
If all of the selected text in the item is deleted, the item should
set \fIselItemPtr\fR to NULL to indicate that there is no longer a
selection.
-
.SH KEYWORDS
canvas, focus, insertion cursor, selection, selection anchor, text
diff --git a/doc/Clipboard.3 b/doc/Clipboard.3
index 4cf58d8..d0646ea 100644
--- a/doc/Clipboard.3
+++ b/doc/Clipboard.3
@@ -1,80 +1,78 @@
-'\"
-'\" Copyright (c) 1994 The Regents of the University of California.
-'\" 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: Clipboard.3,v 1.3 2004/09/19 16:05:36 dkf Exp $
-'\"
-.so man.macros
-.TH Tk_ClipboardClear 3 4.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_ClipboardClear, Tk_ClipboardAppend \- Manage the clipboard
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-int
-\fBTk_ClipboardClear\fR(\fIinterp, tkwin\fR)
-.sp
-int
-\fBTk_ClipboardAppend\fR(\fIinterp, tkwin, target, format, buffer\fR)
-.SH ARGUMENTS
-.AS Tk_ClipboardClear tkwin
-.AP Tcl_Interp *interp in
-Interpreter to use for reporting errors.
-.AP Tk_Window tkwin in
-Window that determines which display's clipboard to manipulate.
-.AP Atom target in
-Conversion type for this clipboard item; has same meaning as
-\fItarget\fR argument to \fBTk_CreateSelHandler\fR.
-.AP Atom format in
-Representation to use when data is retrieved; has same meaning as
-\fIformat\fR argument to \fBTk_CreateSelHandler\fR.
-.AP char *buffer in
-Null terminated string containing the data to be appended to the clipboard.
-.BE
-
-.SH DESCRIPTION
-.PP
-These two procedures manage the clipboard for Tk.
-The clipboard is typically managed by calling \fBTk_ClipboardClear\fR
-once, then calling \fBTk_ClipboardAppend\fR to add data for any
-number of targets.
-.PP
-\fBTk_ClipboardClear\fR claims the CLIPBOARD selection and frees any
-data items previously stored on the clipboard in this application.
-It normally returns \fBTCL_OK\fR, but if an error occurs it returns
-\fBTCL_ERROR\fR and leaves an error message in \fIinterp->result\fR.
-\fBTk_ClipboardClear\fR must be called before a sequence of
-\fBTk_ClipboardAppend\fR calls can be issued.
-.PP
-\fBTk_ClipboardAppend\fR appends a buffer of data to the clipboard.
-The first buffer for a given \fItarget\fR determines the \fIformat\fR
-for that \fItarget\fR.
-Any successive appends for that \fItarget\fR must have
-the same format or an error will be returned.
-\fBTk_ClipboardAppend\fR returns \fBTCL_OK\fR if the buffer is
-successfully copied onto the clipboard. If the clipboard is not
-currently owned by the application, either
-because \fBTk_ClipboardClear\fR has not been called or because
-ownership of the clipboard has changed since the last call to
-\fBTk_ClipboardClear\fR,
-\fBTk_ClipboardAppend\fR returns \fBTCL_ERROR\fR and leaves an error message in
-\fIinterp->result\fR.
-.PP
-In order to guarantee atomicity, no event handling should occur
-between \fBTk_ClipboardClear\fR and the following
-\fBTk_ClipboardAppend\fR calls (otherwise someone could retrieve
-a partially completed clipboard or claim ownership away from
-this application).
-.PP
-\fBTk_ClipboardClear\fR may invoke callbacks, including arbitrary
-Tcl scripts, as a result of losing the CLIPBOARD selection, so
-any calling function should take care to be reentrant at the point
-\fBTk_ClipboardClear\fR is invoked.
-
-.SH KEYWORDS
-append, clipboard, clear, format, type
+'\"
+'\" Copyright (c) 1994 The Regents of the University of California.
+'\" 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: Clipboard.3,v 1.4 2008/06/30 22:57:00 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_ClipboardClear 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_ClipboardClear, Tk_ClipboardAppend \- Manage the clipboard
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+int
+\fBTk_ClipboardClear\fR(\fIinterp, tkwin\fR)
+.sp
+int
+\fBTk_ClipboardAppend\fR(\fIinterp, tkwin, target, format, buffer\fR)
+.SH ARGUMENTS
+.AS Tk_ClipboardClear tkwin
+.AP Tcl_Interp *interp in
+Interpreter to use for reporting errors.
+.AP Tk_Window tkwin in
+Window that determines which display's clipboard to manipulate.
+.AP Atom target in
+Conversion type for this clipboard item; has same meaning as
+\fItarget\fR argument to \fBTk_CreateSelHandler\fR.
+.AP Atom format in
+Representation to use when data is retrieved; has same meaning as
+\fIformat\fR argument to \fBTk_CreateSelHandler\fR.
+.AP char *buffer in
+Null terminated string containing the data to be appended to the clipboard.
+.BE
+.SH DESCRIPTION
+.PP
+These two procedures manage the clipboard for Tk.
+The clipboard is typically managed by calling \fBTk_ClipboardClear\fR
+once, then calling \fBTk_ClipboardAppend\fR to add data for any
+number of targets.
+.PP
+\fBTk_ClipboardClear\fR claims the CLIPBOARD selection and frees any
+data items previously stored on the clipboard in this application.
+It normally returns \fBTCL_OK\fR, but if an error occurs it returns
+\fBTCL_ERROR\fR and leaves an error message in \fIinterp->result\fR.
+\fBTk_ClipboardClear\fR must be called before a sequence of
+\fBTk_ClipboardAppend\fR calls can be issued.
+.PP
+\fBTk_ClipboardAppend\fR appends a buffer of data to the clipboard.
+The first buffer for a given \fItarget\fR determines the \fIformat\fR
+for that \fItarget\fR.
+Any successive appends for that \fItarget\fR must have
+the same format or an error will be returned.
+\fBTk_ClipboardAppend\fR returns \fBTCL_OK\fR if the buffer is
+successfully copied onto the clipboard. If the clipboard is not
+currently owned by the application, either
+because \fBTk_ClipboardClear\fR has not been called or because
+ownership of the clipboard has changed since the last call to
+\fBTk_ClipboardClear\fR,
+\fBTk_ClipboardAppend\fR returns \fBTCL_ERROR\fR and leaves an error message in
+\fIinterp->result\fR.
+.PP
+In order to guarantee atomicity, no event handling should occur
+between \fBTk_ClipboardClear\fR and the following
+\fBTk_ClipboardAppend\fR calls (otherwise someone could retrieve
+a partially completed clipboard or claim ownership away from
+this application).
+.PP
+\fBTk_ClipboardClear\fR may invoke callbacks, including arbitrary
+Tcl scripts, as a result of losing the CLIPBOARD selection, so
+any calling function should take care to be reentrant at the point
+\fBTk_ClipboardClear\fR is invoked.
+.SH KEYWORDS
+append, clipboard, clear, format, type
diff --git a/doc/ClrSelect.3 b/doc/ClrSelect.3
index 1736848..d00d51b 100644
--- a/doc/ClrSelect.3
+++ b/doc/ClrSelect.3
@@ -1,42 +1,40 @@
-'\"
-'\" Copyright (c) 1992-1994 The Regents of the University of California.
-'\" 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: ClrSelect.3,v 1.2 1998/09/14 18:22:46 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_ClearSelection 3 4.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_ClearSelection \- Deselect a selection
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_ClearSelection\fR(\fItkwin, selection\fR)
-.SH ARGUMENTS
-.AS Tk_Window tkwin
-.AP Tk_Window tkwin in
-The selection will be cleared from the display containing this
-window.
-.AP Atom selection in
-The name of selection to be cleared.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_ClearSelection\fR cancels the selection specified by the atom
-\fIselection\fR for the display containing \fItkwin\fR.
-The selection need not be in \fItkwin\fR itself or even in
-\fItkwin\fR's application.
-If there is a window anywhere on \fItkwin\fR's display that
-owns \fIselection\fR, the window will be notified and the
-selection will be cleared.
-If there is no owner for \fIselection\fR on the display, then the
-procedure has no effect.
-
-.SH KEYWORDS
-clear, selection
+'\"
+'\" Copyright (c) 1992-1994 The Regents of the University of California.
+'\" 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: ClrSelect.3,v 1.3 2008/06/30 22:57:00 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_ClearSelection 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_ClearSelection \- Deselect a selection
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_ClearSelection\fR(\fItkwin, selection\fR)
+.SH ARGUMENTS
+.AS Tk_Window tkwin
+.AP Tk_Window tkwin in
+The selection will be cleared from the display containing this
+window.
+.AP Atom selection in
+The name of selection to be cleared.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_ClearSelection\fR cancels the selection specified by the atom
+\fIselection\fR for the display containing \fItkwin\fR.
+The selection need not be in \fItkwin\fR itself or even in
+\fItkwin\fR's application.
+If there is a window anywhere on \fItkwin\fR's display that
+owns \fIselection\fR, the window will be notified and the
+selection will be cleared.
+If there is no owner for \fIselection\fR on the display, then the
+procedure has no effect.
+.SH KEYWORDS
+clear, selection
diff --git a/doc/ConfigWidg.3 b/doc/ConfigWidg.3
index 1fd230e..d26878a 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.20 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: ConfigWidg.3,v 1.21 2008/06/30 22:57:00 dkf Exp $
'\"
.so man.macros
.TH Tk_ConfigureWidget 3 4.1 Tk "Tk Library Procedures"
@@ -63,7 +63,7 @@ Display containing widget whose record is being freed; needed in
order to free up resources.
.BE
.SH DESCRIPTION
-.PP
+.PP
Note: \fBTk_ConfigureWidget\fR should be replaced with the new
\fBTcl_Obj\fR based API \fBTk_SetOptions\fR. The old interface is
retained for backward compatibility.
@@ -112,7 +112,7 @@ typedef struct {
int \fIoffset\fR;
int \fIspecFlags\fR;
Tk_CustomOption *\fIcustomPtr\fR;
-} Tk_ConfigSpec;
+} \fBTk_ConfigSpec\fR;
.CE
The \fItype\fR field indicates what type of configuration option this is
(e.g. \fBTK_CONFIG_COLOR\fR for a color value, or \fBTK_CONFIG_INT\fR for
@@ -358,7 +358,6 @@ is an empty string then the target will be set to NULL.
\fBTK_CONFIG_WINDOW\fR
The value must be a window path name. It is translated to a
\fBTk_Window\fR token and the token is stored in the target.
-
.SH "GROUPED ENTRIES"
.PP
In some cases it is useful to generate multiple resources from
@@ -376,7 +375,6 @@ Each of the entries after the first must have a NULL value in its
\fIargvName\fR field; this indicates that the entry is to be grouped
with the entry that precedes it. Only the \fItype\fR and \fIoffset\fR
fields are used from these follow-on entries.
-
.SH "FLAGS"
.PP
The \fIflags\fR argument passed to \fBTk_ConfigureWidget\fR is used
@@ -436,13 +434,11 @@ once, save the value, and provide it before calling
.TP
\fBTK_CONFIG_OPTION_SPECIFIED\fR
This bit is
-.VS 8.5
deprecated. It used to be set and cleared by \fBTk_ConfigureWidget\fR
so that callers could detect what entries were specified in
\fIargv\fR, but it was removed because it was inherently
thread-unsafe. Code that wishes to detect what options were specified
should use \fBTk_SetOptions\fR instead.
-.VE 8.5
.PP
The \fBTK_CONFIG_MONO_ONLY\fR and \fBTK_CONFIG_COLOR_ONLY\fR flags are typically
used to specify different default values for
@@ -475,7 +471,6 @@ for which this entry is valid. When calling \fBTk_ConfigureWidget\fR,
\fIflags\fR will have a single one of these bits set to select the
entries for the desired widget type. For a working example of
this feature, see the code in tkButton.c.
-
.SH TK_OFFSET
.PP
The \fBTk_Offset\fR macro is provided as a safe way of generating
@@ -483,7 +478,6 @@ the \fIoffset\fR values for entries in Tk_ConfigSpec structures.
It takes two arguments: the name of a type of record, and the
name of a field in that record. It returns the byte offset of
the named field in records of the given type.
-
.SH TK_CONFIGUREINFO
.PP
The \fBTk_ConfigureInfo\fR procedure may be used to obtain
@@ -519,7 +513,6 @@ if \fIargvName\fR had been NULL.
.PP
The \fIflags\fR argument to \fBTk_ConfigureInfo\fR is used to restrict
the \fIspecs\fR entries to consider, just as for \fBTk_ConfigureWidget\fR.
-
.SH TK_CONFIGUREVALUE
.PP
\fBTk_ConfigureValue\fR takes arguments similar to \fBTk_ConfigureInfo\fR;
@@ -532,7 +525,6 @@ not a valid option name), \fBTCL_ERROR\fR is returned and an error message
is left in \fIinterp->result\fR.
This procedure is typically called to implement \fBcget\fR widget
commands.
-
.SH TK_FREEOPTIONS
.PP
The \fBTk_FreeOptions\fR procedure may be invoked during widget cleanup
@@ -545,7 +537,6 @@ it contains a null pointer) then no resource is freed for that
entry.
After freeing a resource, \fBTk_FreeOptions\fR sets the
corresponding field of the widget record to null.
-
.SH "CUSTOM OPTION TYPES"
.PP
Applications can extend the built-in configuration types with additional
@@ -556,22 +547,22 @@ typedef struct Tk_CustomOption {
Tk_OptionParseProc *\fIparseProc\fR;
Tk_OptionPrintProc *\fIprintProc\fR;
ClientData \fIclientData\fR;
-} Tk_CustomOption;
+} \fBTk_CustomOption\fR;
-typedef int Tk_OptionParseProc(
- ClientData \fIclientData\fR,
- Tcl_Interp *\fIinterp\fR,
- Tk_Window \fItkwin\fR,
- char *\fIvalue\fR,
- char *\fIwidgRec\fR,
- int \fIoffset\fR);
+typedef int \fBTk_OptionParseProc\fR(
+ ClientData \fIclientData\fR,
+ Tcl_Interp *\fIinterp\fR,
+ Tk_Window \fItkwin\fR,
+ char *\fIvalue\fR,
+ char *\fIwidgRec\fR,
+ int \fIoffset\fR);
-typedef char *Tk_OptionPrintProc(
- ClientData \fIclientData\fR,
- Tk_Window \fItkwin\fR,
- char *\fIwidgRec\fR,
- int \fIoffset\fR,
- Tcl_FreeProc **\fIfreeProcPtr\fR);
+typedef char *\fBTk_OptionPrintProc\fR(
+ ClientData \fIclientData\fR,
+ Tk_Window \fItkwin\fR,
+ char *\fIwidgRec\fR,
+ int \fIoffset\fR,
+ Tcl_FreeProc **\fIfreeProcPtr\fR);
.CE
The Tk_CustomOption structure contains three fields, which are pointers
to the two procedures and a \fIclientData\fR value to be passed to those
@@ -624,7 +615,6 @@ Tk_CustomOption structure has been created for them, options of this
new type may be manipulated with Tk_ConfigSpec entries whose \fItype\fR
fields are \fBTK_CONFIG_CUSTOM\fR and whose \fIcustomPtr\fR fields point
to the Tk_CustomOption structure.
-
.SH EXAMPLES
.PP
Although the explanation of \fBTk_ConfigureWidget\fR is fairly
@@ -635,10 +625,8 @@ The library implementation of frames
(tkFrame.c) has a simple configuration table, and the library
implementation of buttons (tkButton.c) has a much more complex
table that uses many of the fancy \fIspecFlags\fR mechanisms.
-
.SH "SEE ALSO"
Tk_SetOptions(3)
-
.SH KEYWORDS
anchor, bitmap, boolean, border, cap style, color, configuration options,
cursor, custom, double, font, integer, join style, justify, millimeters,
diff --git a/doc/CoordToWin.3 b/doc/CoordToWin.3
index 93f81ee..9eb8427 100644
--- a/doc/CoordToWin.3
+++ b/doc/CoordToWin.3
@@ -1,51 +1,49 @@
-'\"
-'\" Copyright (c) 1990-1993 The Regents of the University of California.
-'\" 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: CoordToWin.3,v 1.2 1998/09/14 18:22:46 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_CoordsToWindow 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_CoordsToWindow \- Find window containing a point
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-Tk_Window
-\fBTk_CoordsToWindow\fR(\fIrootX, rootY, tkwin\fR)
-.SH ARGUMENTS
-.AS Tk_Window tkwin
-.AP int rootX in
-X-coordinate (in root window coordinates).
-.AP int rootY in
-Y-coordinate (in root window coordinates).
-.AP Tk_Window tkwin in
-Token for window that identifies application.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_CoordsToWindow\fR locates the window that contains a given point.
-The point is specified in root coordinates with \fIrootX\fR and
-\fIrootY\fR (if a virtual-root window manager is in use then
-\fIrootX\fR and \fIrootY\fR are in the coordinate system of the
-virtual root window).
-The return value from the procedure is a token for the window that
-contains the given point.
-If the point is not in any window, or if the containing window
-is not in the same application as \fItkwin\fR, then NULL is
-returned.
-.PP
-The containing window is decided using the same rules that determine
-which window contains the mouse cursor: if a parent and a child both
-contain the point then the child gets preference, and if two siblings
-both contain the point then the highest one in the stacking order
-(i.e. the one that's visible on the screen) gets preference.
-
-.SH KEYWORDS
-containing, coordinates, root window
+'\"
+'\" Copyright (c) 1990-1993 The Regents of the University of California.
+'\" 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: CoordToWin.3,v 1.3 2008/06/30 22:57:00 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_CoordsToWindow 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_CoordsToWindow \- Find window containing a point
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+Tk_Window
+\fBTk_CoordsToWindow\fR(\fIrootX, rootY, tkwin\fR)
+.SH ARGUMENTS
+.AS Tk_Window tkwin
+.AP int rootX in
+X-coordinate (in root window coordinates).
+.AP int rootY in
+Y-coordinate (in root window coordinates).
+.AP Tk_Window tkwin in
+Token for window that identifies application.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_CoordsToWindow\fR locates the window that contains a given point.
+The point is specified in root coordinates with \fIrootX\fR and
+\fIrootY\fR (if a virtual-root window manager is in use then
+\fIrootX\fR and \fIrootY\fR are in the coordinate system of the
+virtual root window).
+The return value from the procedure is a token for the window that
+contains the given point.
+If the point is not in any window, or if the containing window
+is not in the same application as \fItkwin\fR, then NULL is
+returned.
+.PP
+The containing window is decided using the same rules that determine
+which window contains the mouse cursor: if a parent and a child both
+contain the point then the child gets preference, and if two siblings
+both contain the point then the highest one in the stacking order
+(i.e. the one that's visible on the screen) gets preference.
+.SH KEYWORDS
+containing, coordinates, root window
diff --git a/doc/CrtCmHdlr.3 b/doc/CrtCmHdlr.3
index dd22530..fbe6a95 100644
--- a/doc/CrtCmHdlr.3
+++ b/doc/CrtCmHdlr.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: CrtCmHdlr.3,v 1.4 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: CrtCmHdlr.3,v 1.5 2008/06/30 22:57:00 dkf Exp $
'\"
.so man.macros
.TH Tk_CreateClientMessageHandler 3 "8.4" Tk "Tk Library Procedures"
@@ -22,10 +22,8 @@ Tk_CreateClientMessageHandler, Tk_DeleteClientMessageHandler \- associate proced
.AP Tk_ClientMessageProc *proc in
Procedure to invoke whenever a ClientMessage X event occurs on any display.
.BE
-
.SH DESCRIPTION
.PP
-
\fBTk_CreateClientMessageHandler\fR arranges for \fIproc\fR to be invoked
in the future whenever a ClientMessage X event occurs that is not handled by
\fBWM_PROTOCOL\fR. \fBTk_CreateClientMessageHandler\fR is intended for use
@@ -41,9 +39,9 @@ call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or
\fIProc\fR should have arguments and result that match the
type \fBTk_ClientMessageProc\fR:
.CS
-typedef int Tk_ClientMessageProc(
- Tk_Window \fItkwin\fR,
- XEvent *\fIeventPtr\fR);
+typedef int \fBTk_ClientMessageProc\fR(
+ Tk_Window \fItkwin\fR,
+ XEvent *\fIeventPtr\fR);
.CE
The \fItkwin\fR parameter to \fIproc\fR is the Tk window which is
associated with this event. \fIEventPtr\fR is a pointer to the X event.
@@ -64,6 +62,5 @@ finds that matches the \fIproc\fR argument. If no such handler exists,
then \fBTk_DeleteClientMessageHandler\fR returns without doing anything.
Although Tk supports it, it's probably a bad idea to have more than one
callback with the same \fIproc\fR argument.
-
.SH KEYWORDS
bind, callback, event, handler
diff --git a/doc/CrtErrHdlr.3 b/doc/CrtErrHdlr.3
index a42332e..8f5ff62 100644
--- a/doc/CrtErrHdlr.3
+++ b/doc/CrtErrHdlr.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: CrtErrHdlr.3,v 1.7 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: CrtErrHdlr.3,v 1.8 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_CreateErrorHandler 3 "" Tk "Tk Library Procedures"
@@ -74,9 +74,9 @@ made when the handler was active (see below for more information).
\fIProc\fR should have arguments and result that match the
following type:
.CS
-typedef int Tk_ErrorProc(
- ClientData \fIclientData\fR,
- XErrorEvent *\fIerrEventPtr\fR);
+typedef int \fBTk_ErrorProc\fR(
+ ClientData \fIclientData\fR,
+ XErrorEvent *\fIerrEventPtr\fR);
.CE
The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR
argument given to \fBTcl_CreateErrorHandler\fR when the callback
@@ -138,6 +138,5 @@ handlers deleted before the \fBXSync\fR call.
For the Tk error handling mechanism to work properly, it is essential
that application code never calls \fBXSetErrorHandler\fR directly;
applications should use only \fBTk_CreateErrorHandler\fR.
-
.SH KEYWORDS
callback, error, event, handler
diff --git a/doc/CrtGenHdlr.3 b/doc/CrtGenHdlr.3
index d31f463..095361f 100644
--- a/doc/CrtGenHdlr.3
+++ b/doc/CrtGenHdlr.3
@@ -1,84 +1,83 @@
-'\"
-'\" Copyright (c) 1992-1994 The Regents of the University of California.
-'\" 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: CrtGenHdlr.3,v 1.3 2004/09/19 16:05:36 dkf Exp $
-'\"
-.so man.macros
-.TH Tk_CreateGenericHandler 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_CreateGenericHandler, Tk_DeleteGenericHandler \- associate procedure callback with all X events
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_CreateGenericHandler\fR(\fIproc, clientData\fR)
-.sp
-\fBTk_DeleteGenericHandler\fR(\fIproc, clientData\fR)
-.SH ARGUMENTS
-.AS "Tk_GenericProc" clientData
-.AP Tk_GenericProc *proc in
-Procedure to invoke whenever any X event occurs on any display.
-.AP ClientData clientData in
-Arbitrary one-word value to pass to \fIproc\fR.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_CreateGenericHandler\fR arranges for \fIproc\fR to be
-invoked in the future whenever any X event occurs. This mechanism is
-\fInot\fR intended for dispatching X events on windows managed by Tk
-(you should use \fBTk_CreateEventHandler\fR for this purpose).
-\fBTk_CreateGenericHandler\fR is intended for other purposes, such
-as tracing X events, monitoring events on windows not owned by Tk,
-accessing X-related libraries that were not originally designed for
-use with Tk, and so on.
-.PP
-The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR;
-this mechanism only works in programs that dispatch events
-through \fBTk_HandleEvent\fR (or through other Tk procedures that
-call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or
-\fBTk_MainLoop\fR).
-.PP
-\fIProc\fR should have arguments and result that match the
-type \fBTk_GenericProc\fR:
-.CS
-typedef int Tk_GenericProc(
- ClientData \fIclientData\fR,
- XEvent *\fIeventPtr\fR);
-.CE
-The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR
-argument given to \fBTk_CreateGenericHandler\fR when the callback
-was created. Typically, \fIclientData\fR points to a data
-structure containing application-specific information about
-how to handle events.
-\fIEventPtr\fR is a pointer to the X event.
-.PP
-Whenever an X event is processed by \fBTk_HandleEvent\fR, \fIproc\fR
-is called. The return value from \fIproc\fR is normally 0.
-A non-zero return value indicates that the event is not to be handled
-further; that is, \fIproc\fR has done all processing that is to be
-allowed for the event.
-.PP
-If there are multiple generic event handlers, each one is called
-for each event, in the order in which they were established.
-.PP
-\fBTk_DeleteGenericHandler\fR may be called to delete a
-previously-created generic event handler: it deletes each handler
-it finds that matches the \fIproc\fR and \fIclientData\fR arguments. If
-no such handler exists, then \fBTk_DeleteGenericHandler\fR returns
-without doing anything. Although Tk supports it, it's probably
-a bad idea to have more than one callback with the same
-\fIproc\fR and \fIclientData\fR arguments.
-.PP
-Establishing a generic event handler does nothing to ensure that the
-process will actually receive the X events that the handler wants to
-process.
-For example, it is the caller's responsibility to invoke
-\fBXSelectInput\fR to select the desired events, if that is necessary.
-.SH KEYWORDS
-bind, callback, event, handler
+'\"
+'\" Copyright (c) 1992-1994 The Regents of the University of California.
+'\" 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: CrtGenHdlr.3,v 1.4 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_CreateGenericHandler 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_CreateGenericHandler, Tk_DeleteGenericHandler \- associate procedure callback with all X events
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_CreateGenericHandler\fR(\fIproc, clientData\fR)
+.sp
+\fBTk_DeleteGenericHandler\fR(\fIproc, clientData\fR)
+.SH ARGUMENTS
+.AS "Tk_GenericProc" clientData
+.AP Tk_GenericProc *proc in
+Procedure to invoke whenever any X event occurs on any display.
+.AP ClientData clientData in
+Arbitrary one-word value to pass to \fIproc\fR.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_CreateGenericHandler\fR arranges for \fIproc\fR to be
+invoked in the future whenever any X event occurs. This mechanism is
+\fInot\fR intended for dispatching X events on windows managed by Tk
+(you should use \fBTk_CreateEventHandler\fR for this purpose).
+\fBTk_CreateGenericHandler\fR is intended for other purposes, such
+as tracing X events, monitoring events on windows not owned by Tk,
+accessing X-related libraries that were not originally designed for
+use with Tk, and so on.
+.PP
+The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR;
+this mechanism only works in programs that dispatch events
+through \fBTk_HandleEvent\fR (or through other Tk procedures that
+call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or
+\fBTk_MainLoop\fR).
+.PP
+\fIProc\fR should have arguments and result that match the
+type \fBTk_GenericProc\fR:
+.CS
+typedef int \fBTk_GenericProc\fR(
+ ClientData \fIclientData\fR,
+ XEvent *\fIeventPtr\fR);
+.CE
+The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR
+argument given to \fBTk_CreateGenericHandler\fR when the callback
+was created. Typically, \fIclientData\fR points to a data
+structure containing application-specific information about
+how to handle events.
+\fIEventPtr\fR is a pointer to the X event.
+.PP
+Whenever an X event is processed by \fBTk_HandleEvent\fR, \fIproc\fR
+is called. The return value from \fIproc\fR is normally 0.
+A non-zero return value indicates that the event is not to be handled
+further; that is, \fIproc\fR has done all processing that is to be
+allowed for the event.
+.PP
+If there are multiple generic event handlers, each one is called
+for each event, in the order in which they were established.
+.PP
+\fBTk_DeleteGenericHandler\fR may be called to delete a
+previously-created generic event handler: it deletes each handler
+it finds that matches the \fIproc\fR and \fIclientData\fR arguments. If
+no such handler exists, then \fBTk_DeleteGenericHandler\fR returns
+without doing anything. Although Tk supports it, it's probably
+a bad idea to have more than one callback with the same
+\fIproc\fR and \fIclientData\fR arguments.
+.PP
+Establishing a generic event handler does nothing to ensure that the
+process will actually receive the X events that the handler wants to
+process.
+For example, it is the caller's responsibility to invoke
+\fBXSelectInput\fR to select the desired events, if that is necessary.
+.SH KEYWORDS
+bind, callback, event, handler
diff --git a/doc/CrtImgType.3 b/doc/CrtImgType.3
index 2ff52cd..805eb1c 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.13 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: CrtImgType.3,v 1.14 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_CreateImageType 3 8.5 Tk "Tk Library Procedures"
@@ -40,7 +40,6 @@ Number of arguments
.AP char ***argvPtr in/out
Pointer to argument list
.BE
-
.SH DESCRIPTION
.PP
\fBTk_CreateImageType\fR is invoked to define a new kind of image.
@@ -67,7 +66,7 @@ typedef struct Tk_ImageType {
Tk_ImageDisplayProc *\fIdisplayProc\fR;
Tk_ImageFreeProc *\fIfreeProc\fR;
Tk_ImageDeleteProc *\fIdeleteProc\fR;
-} Tk_ImageType;
+} \fBTk_ImageType\fR;
.CE
The fields of this structure will be described in later subsections
of this entry.
@@ -94,7 +93,6 @@ option specified for a widget or canvas item.
.PP
The following subsections describe the fields of a Tk_ImageType
in more detail.
-
.SS NAME
.PP
\fItypePtr->name\fR provides a name for the image type.
@@ -103,21 +101,21 @@ in \fBimage create\fR commands to create images of the new
type.
If there already existed an image type by this name then
the new image type replaces the old one.
-
.SS CREATEPROC
+.PP
\fItypePtr->createProc\fR provides the address of a procedure for
Tk to call whenever \fBimage create\fR is invoked to create
an image of the new type.
\fItypePtr->createProc\fR must match the following prototype:
.CS
-typedef int Tk_ImageCreateProc(
- Tcl_Interp *\fIinterp\fR,
- char *\fIname\fR,
- int \fIobjc\fR,
- Tcl_Obj *const \fIobjv\fR[],
- Tk_ImageType *\fItypePtr\fR,
- Tk_ImageMaster \fImaster\fR,
- ClientData *\fImasterDataPtr\fR);
+typedef int \fBTk_ImageCreateProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ char *\fIname\fR,
+ int \fIobjc\fR,
+ Tcl_Obj *const \fIobjv\fR[],
+ Tk_ImageType *\fItypePtr\fR,
+ Tk_ImageMaster \fImaster\fR,
+ ClientData *\fImasterDataPtr\fR);
.CE
The \fIinterp\fR argument is the interpreter in which the \fBimage\fR
command was invoked, and \fIname\fR is the name for the new image,
@@ -143,16 +141,15 @@ it should return \fBTCL_OK\fR.
.PP
\fIcreateProc\fR should call \fBTk_ImageChanged\fR in order to set the
size of the image and request an initial redisplay.
-
.SS GETPROC
.PP
\fItypePtr->getProc\fR is invoked by Tk whenever a widget
calls \fBTk_GetImage\fR to use a particular image.
This procedure must match the following prototype:
.CS
-typedef ClientData Tk_ImageGetProc(
- Tk_Window \fItkwin\fR,
- ClientData \fImasterData\fR);
+typedef ClientData \fBTk_ImageGetProc\fR(
+ Tk_Window \fItkwin\fR,
+ ClientData \fImasterData\fR);
.CE
The \fItkwin\fR argument identifies the window in which the
image will be used and \fImasterData\fR is the value
@@ -164,23 +161,22 @@ display the image in the given window.
is typically the address of the instance data structure.
Tk will pass this value back to the image manager when invoking
its \fIdisplayProc\fR and \fIfreeProc\fR procedures.
-
.SS DISPLAYPROC
.PP
\fItypePtr->displayProc\fR is invoked by Tk whenever an image needs
to be displayed (i.e., whenever a widget calls \fBTk_RedrawImage\fR).
\fIdisplayProc\fR must match the following prototype:
.CS
-typedef void Tk_ImageDisplayProc(
- ClientData \fIinstanceData\fR,
- Display *\fIdisplay\fR,
- Drawable \fIdrawable\fR,
- int \fIimageX\fR,
- int \fIimageY\fR,
- int \fIwidth\fR,
- int \fIheight\fR,
- int \fIdrawableX\fR,
- int \fIdrawableY\fR);
+typedef void \fBTk_ImageDisplayProc\fR(
+ ClientData \fIinstanceData\fR,
+ Display *\fIdisplay\fR,
+ Drawable \fIdrawable\fR,
+ int \fIimageX\fR,
+ int \fIimageY\fR,
+ int \fIwidth\fR,
+ int \fIheight\fR,
+ int \fIdrawableX\fR,
+ int \fIdrawableY\fR);
.CE
The \fIinstanceData\fR will be the same as the value returned by
\fIgetProc\fR when the instance was created.
@@ -197,7 +193,6 @@ as specified in the most recent call to \fBTk_ImageChanged\fR.
the image should be displayed; \fIdisplayProc\fR should display
the given region of the image so that point (\fIimageX\fR, \fIimageY\fR)
in the image appears at (\fIdrawableX\fR, \fIdrawableY\fR) in \fIdrawable\fR.
-
.SS FREEPROC
.PP
\fItypePtr->freeProc\fR contains the address of a procedure that
@@ -208,16 +203,15 @@ in a canvas is deleted, or when the image displayed in a widget or
canvas item is changed.
\fIfreeProc\fR must match the following prototype:
.CS
-typedef void Tk_ImageFreeProc(
- ClientData \fIinstanceData\fR,
- Display *\fIdisplay\fR);
+typedef void \fBTk_ImageFreeProc\fR(
+ ClientData \fIinstanceData\fR,
+ Display *\fIdisplay\fR);
.CE
The \fIinstanceData\fR will be the same as the value returned by
\fIgetProc\fR when the instance was created, and \fIdisplay\fR
is the display containing the window for the instance.
\fIfreeProc\fR should release any resources associated with the
image instance, since the instance will never be used again.
-
.SS DELETEPROC
.PP
\fItypePtr->deleteProc\fR is a procedure that Tk invokes when an
@@ -227,15 +221,14 @@ Before invoking \fIdeleteProc\fR Tk will invoke \fIfreeProc\fR for
each of the image's instances.
\fIdeleteProc\fR must match the following prototype:
.CS
-typedef void Tk_ImageDeleteProc(
- ClientData \fImasterData\fR);
+typedef void \fBTk_ImageDeleteProc\fR(
+ ClientData \fImasterData\fR);
.CE
The \fImasterData\fR argument will be the same as the value
stored in \fI*masterDataPtr\fR by \fIcreateProc\fR when the
image was created.
\fIdeleteProc\fR should release any resources associated with
the image.
-
.SH TK_GETIMAGEMASTERDATA
.PP
The procedure \fBTk_GetImageMasterData\fR may be invoked to retrieve
@@ -249,19 +242,19 @@ and the return value is the ClientData value returned by the
\fIcreateProc\fR when the image was created (this is typically a
pointer to the image master data structure). If no such image exists
then NULL is returned and NULL is stored at \fI*typePtrPtr\fR.
-
.SH "LEGACY INTERFACE SUPPORT"
+.PP
In Tk 8.2 and earlier, the definition of \fBTk_ImageCreateProc\fR
was incompatibly different, with the following prototype:
.CS
-typedef int Tk_ImageCreateProc(
- Tcl_Interp *\fIinterp\fR,
- char *\fIname\fR,
- int \fIargc\fR,
- char **\fIargv\fR,
- Tk_ImageType *\fItypePtr\fR,
- Tk_ImageMaster \fImaster\fR,
- ClientData *\fImasterDataPtr\fR);
+typedef int \fBTk_ImageCreateProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ char *\fIname\fR,
+ int \fIargc\fR,
+ char **\fIargv\fR,
+ Tk_ImageType *\fItypePtr\fR,
+ Tk_ImageMaster \fImaster\fR,
+ ClientData *\fImasterDataPtr\fR);
.CE
Legacy programs and libraries dating from those days may still
contain code that defines extended Tk image types using the old
@@ -285,9 +278,7 @@ use Tk 8.4 headers and stub libraries to do so.
.PP
Any new code written today should not make use of the legacy
interfaces. Expect their support to go away in Tk 9.
-
.SH "SEE ALSO"
Tk_ImageChanged, Tk_GetImage, Tk_FreeImage, Tk_RedrawImage, Tk_SizeOfImage
-
.SH KEYWORDS
image manager, image type, instance, master
diff --git a/doc/CrtItemType.3 b/doc/CrtItemType.3
index 08b82e5..057013d 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.12 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: CrtItemType.3,v 1.13 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_CreateItemType 3 4.0 Tk "Tk Library Procedures"
@@ -84,7 +84,7 @@ typedef struct Tk_ItemType {
Tk_ItemInsertProc *\fIinsertProc\fR;
Tk_ItemDCharsProc *\fIdCharsProc\fR;
Tk_ItemType *\fInextPtr\fR;
-} Tk_ItemType;
+} \fBTk_ItemType\fR;
.CE
.PP
The fields of a Tk_ItemType structure are described in more detail
@@ -118,7 +118,7 @@ typedef struct BitmapItem {
XColor *\fIfgColor\fR;
XColor *\fIbgColor\fR;
GC \fIgc\fR;
-} BitmapItem;
+} \fBBitmapItem\fR;
.CE
The \fIheader\fR substructure contains information used by Tk
to manage the item, such as its identifier, its tags, its type,
@@ -163,6 +163,7 @@ type.
If there already existed an item type by this name then
the new item type replaces the old one.
.SS ITEMSIZE
+.PP
\fItypePtr->itemSize\fR gives the size in bytes of item records
of this type, including the Tk_Item header.
Tk uses this size to allocate memory space for items of the type.
@@ -176,12 +177,12 @@ object of variable length and keep a pointer to it in the item record.
Tk to call whenever a new item of this type is created.
\fItypePtr->createProc\fR must match the following prototype:
.CS
-typedef int Tk_ItemCreateProc(
- Tcl_Interp *\fIinterp\fR,
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- int \fIobjc\fR,
- Tcl_Obj* const \fIobjv\fR[]);
+typedef int \fBTk_ItemCreateProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ int \fIobjc\fR,
+ Tcl_Obj* const \fIobjv\fR[]);
.CE
The \fIinterp\fR argument is the interpreter in which the canvas's
\fBcreate\fR widget command was invoked, and \fIcanvas\fR is a
@@ -230,13 +231,13 @@ manager for an example of how to use it in \fIconfigSpecs\fR.
configuration options for a canvas item.
This procedure must match the following prototype:
.CS
-typedef int Tk_ItemConfigureProc(
- Tcl_Interp *\fIinterp\fR,
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- int \fIobjc\fR,
- Tcl_Obj* const \fIobjv\fR[],
- int \fIflags\fR);
+typedef int \fBTk_ItemConfigureProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ int \fIobjc\fR,
+ Tcl_Obj* const \fIobjv\fR[],
+ int \fIflags\fR);
.CE
The \fIinterp\fR objument identifies the interpreter in which the
widget command was invoked, \fIcanvas\fR is a handle for the canvas
@@ -264,12 +265,12 @@ options.
widget command for an item.
It must match the following prototype:
.CS
-typedef int Tk_ItemCoordProc(
- Tcl_Interp *\fIinterp\fR,
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- int \fIobjc\fR,
- Tcl_Obj* const \fIobjv\fR[]);
+typedef int \fBTk_ItemCoordProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ int \fIobjc\fR,
+ Tcl_Obj* const \fIobjv\fR[]);
.CE
The arguments \fIinterp\fR, \fIcanvas\fR, and \fIitemPtr\fR
all have the standard meanings, and \fIobjc\fR and \fIobjv\fR
@@ -293,10 +294,10 @@ If an error occurs, \fIcoordProc\fR must leave an error message in
and free any resources allocated to it.
It must match the following prototype:
.CS
-typedef void Tk_ItemDeleteProc(
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- Display *\fIdisplay\fR);
+typedef void \fBTk_ItemDeleteProc\fR(
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ Display *\fIdisplay\fR);
.CE
The \fIcanvas\fR and \fIitemPtr\fR arguments have the usual
interpretations, and \fIdisplay\fR identifies the X display containing
@@ -311,15 +312,15 @@ be done by Tk when \fIdeleteProc\fR returns.
on the screen.
It must match the following prototype:
.CS
-typedef void Tk_ItemDisplayProc(
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- Display *\fIdisplay\fR,
- Drawable \fIdst\fR,
- int \fIx\fR,
- int \fIy\fR,
- int \fIwidth\fR,
- int \fIheight\fR);
+typedef void \fBTk_ItemDisplayProc\fR(
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ Display *\fIdisplay\fR,
+ Drawable \fIdst\fR,
+ int \fIx\fR,
+ int \fIy\fR,
+ int \fIwidth\fR,
+ int \fIheight\fR);
.CE
The \fIcanvas\fR and \fIitemPtr\fR arguments have the usual meaning.
\fIdisplay\fR identifies the display containing the canvas, and
@@ -356,10 +357,10 @@ Tk uses this procedure for purposes such as locating the item
under the mouse or finding the closest item to a given point.
The procedure must match the following prototype:
.CS
-typedef double Tk_ItemPointProc(
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- double *\fIpointPtr\fR);
+typedef double \fBTk_ItemPointProc\fR(
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ double *\fIpointPtr\fR);
.CE
\fIcanvas\fR and \fIitemPtr\fR have the usual meaning.
\fIpointPtr\fR points to an array of two numbers giving
@@ -373,10 +374,10 @@ the item.
between an item and a rectangular area.
It must match the following prototype:
.CS
-typedef int Tk_ItemAreaProc(
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- double *\fIrectPtr\fR);
+typedef int \fBTk_ItemAreaProc\fR(
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ double *\fIrectPtr\fR);
.CE
\fIcanvas\fR and \fIitemPtr\fR have the usual meaning.
\fIrectPtr\fR points to an array of four real numbers;
@@ -394,11 +395,11 @@ If the type manager is not capable of generating Postscript then
\fItypePtr->postscriptProc\fR should be NULL.
The procedure must match the following prototype:
.CS
-typedef int Tk_ItemPostscriptProc(
- Tcl_Interp *\fIinterp\fR,
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- int \fIprepass\fR);
+typedef int \fBTk_ItemPostscriptProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ int \fIprepass\fR);
.CE
The \fIinterp\fR, \fIcanvas\fR, and \fIitemPtr\fR arguments all have
standard meanings; \fIprepass\fR will be described below.
@@ -437,17 +438,18 @@ all Postscript generation except for calls to \fBTk_CanvasPsFont\fR.
During the second pass \fIprepass\fR will be 0, so the type manager
must generate complete Postscript.
.SS SCALEPROC
+.PP
\fItypePtr->scaleProc\fR is invoked by Tk to rescale a canvas item
during the \fBscale\fR widget command.
The procedure must match the following prototype:
.CS
-typedef void Tk_ItemScaleProc(
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- double \fIoriginX\fR,
- double \fIoriginY\fR,
- double \fIscaleX\fR,
- double \fIscaleY\fR);
+typedef void \fBTk_ItemScaleProc\fR(
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ double \fIoriginX\fR,
+ double \fIoriginY\fR,
+ double \fIscaleX\fR,
+ double \fIscaleY\fR);
.CE
The \fIcanvas\fR and \fIitemPtr\fR arguments have the usual meaning.
\fIoriginX\fR and \fIoriginY\fR specify an origin relative to which
@@ -463,15 +465,16 @@ y\(fm = originY + scaleY*(y-originY)\fR
\fIscaleProc\fR must also update the bounding box in the item's
header.
.SS TRANSLATEPROC
+.PP
\fItypePtr->translateProc\fR is invoked by Tk to translate a canvas item
during the \fBmove\fR widget command.
The procedure must match the following prototype:
.CS
-typedef void Tk_ItemTranslateProc(
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- double \fIdeltaX\fR,
- double \fIdeltaY\fR);
+typedef void \fBTk_ItemTranslateProc\fR(
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ double \fIdeltaX\fR,
+ double \fIdeltaY\fR);
.CE
The \fIcanvas\fR and \fIitemPtr\fR arguments have the usual meaning,
and \fIdeltaX\fR and \fIdeltaY\fR give the amounts that should be
@@ -479,6 +482,7 @@ added to each x and y coordinate within the item.
The type manager should adjust the item's coordinates and
update the bounding box in the item's header.
.SS INDEXPROC
+.PP
\fItypePtr->indexProc\fR is invoked by Tk to translate a string
index specification into a numerical index, for example during the
\fBindex\fR widget command.
@@ -487,12 +491,12 @@ It is only relevant for item types that support indexable text;
item types.
The procedure must match the following prototype:
.CS
-typedef int Tk_ItemIndexProc(
- Tcl_Interp *\fIinterp\fR,
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- char \fIindexString\fR,
- int *\fIindexPtr\fR);
+typedef int \fBTk_ItemIndexProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ char \fIindexString\fR,
+ int *\fIindexPtr\fR);
.CE
The \fIinterp\fR, \fIcanvas\fR, and \fIitemPtr\fR arguments all
have the usual meaning.
@@ -514,10 +518,10 @@ It is only relevant for item types that support an insertion cursor;
that do not support an insertion cursor.
The procedure must match the following prototype:
.CS
-typedef void Tk_ItemCursorProc(
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- int \fIindex\fR);
+typedef void \fBTk_ItemCursorProc\fR(
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ int \fIindex\fR);
.CE
\fIcanvas\fR and \fIitemPtr\fR have the usual meanings, and
\fIindex\fR is an index into the item's text, as returned by a
@@ -536,12 +540,12 @@ It is only relevant for item types that support text;
item types.
The procedure must match the following prototype:
.CS
-typedef int Tk_ItemSelectionProc(
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- int \fIoffset\fR,
- char *\fIbuffer\fR,
- int \fImaxBytes\fR);
+typedef int \fBTk_ItemSelectionProc\fR(
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ int \fIoffset\fR,
+ char *\fIbuffer\fR,
+ int \fImaxBytes\fR);
.CE
\fIcanvas\fR and \fIitemPtr\fR have the usual meanings.
\fIoffset\fR is an offset in bytes into the selection where 0 refers
@@ -565,11 +569,11 @@ It is only relevant for item types that support text;
item types.
The procedure must match the following prototype:
.CS
-typedef void Tk_ItemInsertProc(
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- int \fIindex\fR,
- char *\fIstring\fR);
+typedef void \fBTk_ItemInsertProc\fR(
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ int \fIindex\fR,
+ char *\fIstring\fR);
.CE
\fIcanvas\fR and \fIitemPtr\fR have the usual meanings.
\fIindex\fR is an index into the item's text, as returned by a
@@ -587,11 +591,11 @@ It is only relevant for item types that support text;
item types.
The procedure must match the following prototype:
.CS
-typedef void Tk_ItemDCharsProc(
- Tk_Canvas \fIcanvas\fR,
- Tk_Item *\fIitemPtr\fR,
- int \fIfirst\fR,
- int \fIlast\fR);
+typedef void \fBTk_ItemDCharsProc\fR(
+ Tk_Canvas \fIcanvas\fR,
+ Tk_Item *\fIitemPtr\fR,
+ int \fIfirst\fR,
+ int \fIlast\fR);
.CE
\fIcanvas\fR and \fIitemPtr\fR have the usual meanings.
\fIfirst\fR and \fIlast\fR give the indices of the first and last bytes
diff --git a/doc/CrtPhImgFmt.3 b/doc/CrtPhImgFmt.3
index 04ebf9c..cd2fc85 100644
--- a/doc/CrtPhImgFmt.3
+++ b/doc/CrtPhImgFmt.3
@@ -9,7 +9,7 @@
'\" Department of Computer Science,
'\" Australian National University.
'\"
-'\" RCS: @(#) $Id: CrtPhImgFmt.3,v 1.10 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: CrtPhImgFmt.3,v 1.11 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_CreatePhotoImageFormat 3 8.5 Tk "Tk Library Procedures"
@@ -26,7 +26,6 @@ Tk_CreatePhotoImageFormat \- define new file format for photo images
.AP Tk_PhotoImageFormat *formatPtr in
Structure that defines the new file format.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_CreatePhotoImageFormat\fR is invoked to define a new file format
@@ -55,7 +54,7 @@ typedef struct Tk_PhotoImageFormat {
Tk_ImageStringReadProc *\fIstringReadProc\fR;
Tk_ImageFileWriteProc *\fIfileWriteProc\fR;
Tk_ImageStringWriteProc *\fIstringWriteProc\fR;
-} Tk_PhotoImageFormat;
+} \fBTk_PhotoImageFormat\fR;
.CE
.PP
The handler need not provide implementations of all six procedures.
@@ -67,8 +66,7 @@ structure should be set to NULL. The handler must provide the
\fIfileMatchProc\fR procedure if it provides the \fIfileReadProc\fR
procedure, and the \fIstringMatchProc\fR procedure if it provides the
\fIstringReadProc\fR procedure.
-
-.SH NAME
+.SS NAME
.PP
\fIformatPtr->name\fR provides a name for the image type.
Once \fBTk_CreatePhotoImageFormat\fR returns, this name may be used
@@ -79,20 +77,20 @@ the \fB\-format\fR option. The first character of \fIformatPtr->name\fR
must not be an uppercase character from the ASCII character set
(that is, one of the characters \fBA\fR-\fBZ\fR). Such names are used
only for legacy interface support (see below).
-
-.SH FILEMATCHPROC
+.SS FILEMATCHPROC
+.PP
\fIformatPtr->fileMatchProc\fR provides the address of a procedure for
Tk to call when it is searching for an image file format handler
suitable for reading data in a given file.
\fIformatPtr->fileMatchProc\fR must match the following prototype:
.CS
-typedef int Tk_ImageFileMatchProc(
- Tcl_Channel \fIchan\fR,
- const char *\fIfileName\fR,
- Tcl_Obj *\fIformat\fR,
- int *\fIwidthPtr\fR,
- int *\fIheightPtr\fR,
- Tcl_Interp *\fIinterp\fR);
+typedef int \fBTk_ImageFileMatchProc\fR(
+ Tcl_Channel \fIchan\fR,
+ const char *\fIfileName\fR,
+ Tcl_Obj *\fIformat\fR,
+ int *\fIwidthPtr\fR,
+ int *\fIheightPtr\fR,
+ Tcl_Interp *\fIinterp\fR);
.CE
The \fIfileName\fR argument is the name of the file containing the
image data, which is open for reading as \fIchan\fR. The
@@ -102,19 +100,19 @@ If the data in the file appears to be in the format supported by this
handler, the \fIformatPtr->fileMatchProc\fR procedure should store the
width and height of the image in *\fIwidthPtr\fR and *\fIheightPtr\fR
respectively, and return 1. Otherwise it should return 0.
-
-.SH STRINGMATCHPROC
+.SS STRINGMATCHPROC
+.PP
\fIformatPtr->stringMatchProc\fR provides the address of a procedure for
Tk to call when it is searching for an image file format handler for
suitable for reading data from a given string.
\fIformatPtr->stringMatchProc\fR must match the following prototype:
.CS
-typedef int Tk_ImageStringMatchProc(
- Tcl_Obj *\fIdata\fR,
- Tcl_Obj *\fIformat\fR,
- int *\fIwidthPtr\fR,
- int *\fIheightPtr\fR,
- Tcl_Interp *\fIinterp\fR);
+typedef int \fBTk_ImageStringMatchProc\fR(
+ Tcl_Obj *\fIdata\fR,
+ Tcl_Obj *\fIformat\fR,
+ int *\fIwidthPtr\fR,
+ int *\fIheightPtr\fR,
+ Tcl_Interp *\fIinterp\fR);
.CE
The \fIdata\fR argument points to the object containing the image
data. The \fIformat\fR argument contains the value given for
@@ -124,21 +122,21 @@ this handler, the \fIformatPtr->stringMatchProc\fR procedure should
store the width and height of the image in *\fIwidthPtr\fR and
*\fIheightPtr\fR respectively, and return 1. Otherwise it should
return 0.
-
-.SH FILEREADPROC
+.SS FILEREADPROC
+.PP
\fIformatPtr->fileReadProc\fR provides the address of a procedure for
Tk to call to read data from an image file into a photo image.
\fIformatPtr->fileReadProc\fR must match the following prototype:
.CS
-typedef int Tk_ImageFileReadProc(
- Tcl_Interp *\fIinterp\fR,
- Tcl_Channel \fIchan\fR,
- const char *\fIfileName\fR,
- Tcl_Obj *\fIformat\fR,
- PhotoHandle \fIimageHandle\fR,
- int \fIdestX\fR, int \fIdestY\fR,
- int \fIwidth\fR, int \fIheight\fR,
- int \fIsrcX\fR, int \fIsrcY\fR);
+typedef int \fBTk_ImageFileReadProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ Tcl_Channel \fIchan\fR,
+ const char *\fIfileName\fR,
+ Tcl_Obj *\fIformat\fR,
+ PhotoHandle \fIimageHandle\fR,
+ int \fIdestX\fR, int \fIdestY\fR,
+ int \fIwidth\fR, int \fIheight\fR,
+ int \fIsrcX\fR, int \fIsrcY\fR);
.CE
The \fIinterp\fR argument is the interpreter in which the command was
invoked to read the image; it should be used for reporting errors.
@@ -153,20 +151,20 @@ coordinates (\fIsrcX\fR,\fIsrcY\fR). It is to be stored in the photo
image with its top-left corner at coordinates
(\fIdestX\fR,\fIdestY\fR) using the \fBTk_PhotoPutBlock\fR procedure.
The return value is a standard Tcl return value.
-
-.SH STRINGREADPROC
+.SS STRINGREADPROC
+.PP
\fIformatPtr->stringReadProc\fR provides the address of a procedure for
Tk to call to read data from a string into a photo image.
\fIformatPtr->stringReadProc\fR must match the following prototype:
.CS
-typedef int Tk_ImageStringReadProc(
- Tcl_Interp *\fIinterp\fR,
- Tcl_Obj *\fIdata\fR,
- Tcl_Obj *\fIformat\fR,
- PhotoHandle \fIimageHandle\fR,
- int \fIdestX\fR, int \fIdestY\fR,
- int \fIwidth\fR, int \fIheight\fR,
- int \fIsrcX\fR, int \fIsrcY\fR);
+typedef int \fBTk_ImageStringReadProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ Tcl_Obj *\fIdata\fR,
+ Tcl_Obj *\fIformat\fR,
+ PhotoHandle \fIimageHandle\fR,
+ int \fIdestX\fR, int \fIdestY\fR,
+ int \fIwidth\fR, int \fIheight\fR,
+ int \fIsrcX\fR, int \fIsrcY\fR);
.CE
The \fIinterp\fR argument is the interpreter in which the command was
invoked to read the image; it should be used for reporting errors.
@@ -181,17 +179,17 @@ coordinates (\fIsrcX\fR,\fIsrcY\fR). It is to be stored in the photo
image with its top-left corner at coordinates
(\fIdestX\fR,\fIdestY\fR) using the \fBTk_PhotoPutBlock\fR procedure.
The return value is a standard Tcl return value.
-
-.SH FILEWRITEPROC
+.SS FILEWRITEPROC
+.PP
\fIformatPtr->fileWriteProc\fR provides the address of a procedure for
Tk to call to write data from a photo image to a file.
\fIformatPtr->fileWriteProc\fR must match the following prototype:
.CS
-typedef int Tk_ImageFileWriteProc(
- Tcl_Interp *\fIinterp\fR,
- const char *\fIfileName\fR,
- Tcl_Obj *\fIformat\fR,
- Tk_PhotoImageBlock *\fIblockPtr\fR);
+typedef int \fBTk_ImageFileWriteProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ const char *\fIfileName\fR,
+ Tcl_Obj *\fIformat\fR,
+ Tk_PhotoImageBlock *\fIblockPtr\fR);
.CE
The \fIinterp\fR argument is the interpreter in which the command was
invoked to write the image; it should be used for reporting errors.
@@ -206,16 +204,16 @@ after the name of the format. If appropriate, the
\fIformatPtr->fileWriteProc\fR procedure may interpret these
characters to specify further details about the image file.
The return value is a standard Tcl return value.
-
-.SH STRINGWRITEPROC
+.SS STRINGWRITEPROC
+.PP
\fIformatPtr->stringWriteProc\fR provides the address of a procedure for
Tk to call to translate image data from a photo image into a string.
\fIformatPtr->stringWriteProc\fR must match the following prototype:
.CS
-typedef int Tk_ImageStringWriteProc(
- Tcl_Interp *\fIinterp\fR,
- Tcl_Obj *\fIformat\fR,
- Tk_PhotoImageBlock *\fIblockPtr\fR);
+typedef int \fBTk_ImageStringWriteProc\fR(
+ Tcl_Interp *\fIinterp\fR,
+ Tcl_Obj *\fIformat\fR,
+ Tk_PhotoImageBlock *\fIblockPtr\fR);
.CE
The \fIinterp\fR argument is the interpreter in which the command was
invoked to convert the image; it should be used for reporting errors.
@@ -230,8 +228,8 @@ after the name of the format. If appropriate, the
\fIformatPtr->stringWriteProc\fR procedure may interpret these
characters to specify further details about the image file.
The return value is a standard Tcl return value.
-
.SH "LEGACY INTERFACE SUPPORT"
+.PP
In Tk 8.2 and earlier, the definition of all the function pointer
types stored in fields of a \fBTk_PhotoImageFormat\fR struct were
incompatibly different. Legacy programs and libraries dating from
@@ -268,9 +266,7 @@ use Tk 8.4 headers and stub libraries to do so.
.PP
Any new code written today should not make use of the legacy
interfaces. Expect their support to go away in Tk 9.
-
.SH "SEE ALSO"
Tk_FindPhoto, Tk_PhotoPutBlock
-
.SH KEYWORDS
photo image, image file
diff --git a/doc/CrtSelHdlr.3 b/doc/CrtSelHdlr.3
index 8500bbf..9b0a466 100644
--- a/doc/CrtSelHdlr.3
+++ b/doc/CrtSelHdlr.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: CrtSelHdlr.3,v 1.5 2007/12/13 15:23:42 dgp Exp $
+'\" RCS: @(#) $Id: CrtSelHdlr.3,v 1.6 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_CreateSelHandler 3 4.0 Tk "Tk Library Procedures"
@@ -56,11 +56,11 @@ the selection. The most common form is STRING.
\fIProc\fR should have arguments and result that match the
type \fBTk_SelectionProc\fR:
.CS
-typedef int Tk_SelectionProc(
- ClientData \fIclientData\fR,
- int \fIoffset\fR,
- char *\fIbuffer\fR,
- int \fImaxBytes\fR);
+typedef int \fBTk_SelectionProc\fR(
+ ClientData \fIclientData\fR,
+ int \fIoffset\fR,
+ char *\fIbuffer\fR,
+ int \fImaxBytes\fR);
.CE
The \fIclientData\fR parameter to \fIproc\fR is a copy of the
\fIclientData\fR argument given to \fBTk_CreateSelHandler\fR.
@@ -114,6 +114,5 @@ existing handler is replaced with a new one.
\fBTk_DeleteSelHandler\fR removes the handler given by \fItkwin\fR,
\fIselection\fR, and \fItarget\fR, if such a handler exists.
If there is no such handler then it has no effect.
-
.SH KEYWORDS
format, handler, selection, target
diff --git a/doc/CrtWindow.3 b/doc/CrtWindow.3
index ce5958b..b48696a 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.12 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: CrtWindow.3,v 1.13 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_CreateWindow 3 4.2 Tk "Tk Library Procedures"
@@ -143,7 +143,6 @@ but has not been mapped, so no X window exists, it is
possible to force the creation of the X window by
calling \fBTk_MakeWindowExist\fR. This procedure issues
the X commands to instantiate the window given by \fItkwin\fR.
-
.SH KEYWORDS
create, deferred creation, destroy, display, internal window,
screen, top-level window, window
diff --git a/doc/DeleteImg.3 b/doc/DeleteImg.3
index 2dcf2ed..4e40926 100644
--- a/doc/DeleteImg.3
+++ b/doc/DeleteImg.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: DeleteImg.3,v 1.4 2007/01/05 00:00:49 nijtmans Exp $
+'\" RCS: @(#) $Id: DeleteImg.3,v 1.5 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_DeleteImage 3 4.0 Tk "Tk Library Procedures"
@@ -23,13 +23,11 @@ Interpreter for which the image was created.
.AP "const char" *name in
Name of the image.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_DeleteImage\fR deletes the image given by \fIinterp\fR
and \fIname\fR, if there is one. All instances of that image
will redisplay as empty regions. If the given image does not
exist then the procedure has no effect.
-
.SH KEYWORDS
delete image, image manager
diff --git a/doc/DrawFocHlt.3 b/doc/DrawFocHlt.3
index 9b6f6a0..a66d347 100644
--- a/doc/DrawFocHlt.3
+++ b/doc/DrawFocHlt.3
@@ -1,40 +1,38 @@
-'\"
-'\" Copyright (c) 1995-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: DrawFocHlt.3,v 1.3 2000/03/31 09:23:48 hobbs Exp $
-'\"
-.so man.macros
-.TH Tk_DrawFocusHighlight 3 4.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_DrawFocusHighlight \- draw the traversal highlight ring for a widget
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_DrawFocusHighlight(\fItkwin, gc, width, drawable\fB)\fR
-.SH ARGUMENTS
-.AS "Tcl_Interp" *joinPtr
-.AP Tk_Window tkwin in
-Window for which the highlight is being drawn. Used to retrieve
-the window's dimensions, among other things.
-.AP GC gc in
-Graphics context to use for drawing the highlight.
-.AP int width in
-Width of the highlight ring, in pixels.
-.AP Drawable drawable in
-Drawable in which to draw the highlight; usually an offscreen
-pixmap for double buffering.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_DrawFocusHighlight\fR is a utility procedure that draws the
-traversal highlight ring for a widget.
-It is typically invoked by widgets during redisplay.
-
-.SH KEYWORDS
-focus, traversal highlight
+'\"
+'\" Copyright (c) 1995-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: DrawFocHlt.3,v 1.4 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_DrawFocusHighlight 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_DrawFocusHighlight \- draw the traversal highlight ring for a widget
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_DrawFocusHighlight(\fItkwin, gc, width, drawable\fB)\fR
+.SH ARGUMENTS
+.AS "Tcl_Interp" *joinPtr
+.AP Tk_Window tkwin in
+Window for which the highlight is being drawn. Used to retrieve
+the window's dimensions, among other things.
+.AP GC gc in
+Graphics context to use for drawing the highlight.
+.AP int width in
+Width of the highlight ring, in pixels.
+.AP Drawable drawable in
+Drawable in which to draw the highlight; usually an offscreen
+pixmap for double buffering.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_DrawFocusHighlight\fR is a utility procedure that draws the
+traversal highlight ring for a widget.
+It is typically invoked by widgets during redisplay.
+.SH KEYWORDS
+focus, traversal highlight
diff --git a/doc/EventHndlr.3 b/doc/EventHndlr.3
index a553293..3096c38 100644
--- a/doc/EventHndlr.3
+++ b/doc/EventHndlr.3
@@ -1,79 +1,77 @@
-'\"
-'\" Copyright (c) 1990 The Regents of the University of California.
-'\" 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: EventHndlr.3,v 1.5 2004/09/19 16:05:36 dkf Exp $
-'\"
-.so man.macros
-.TH Tk_CreateEventHandler 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_CreateEventHandler, Tk_DeleteEventHandler \- associate procedure callback with an X event
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_CreateEventHandler\fR(\fItkwin, mask, proc, clientData\fR)
-.sp
-\fBTk_DeleteEventHandler\fR(\fItkwin, mask, proc, clientData\fR)
-.SH ARGUMENTS
-.AS "unsigned long" clientData
-.AP Tk_Window tkwin in
-Token for window in which events may occur.
-.AP "unsigned long" mask in
-Bit-mask of events (such as \fBButtonPressMask\fR)
-for which \fIproc\fR should be called.
-.AP Tk_EventProc *proc in
-Procedure to invoke whenever an event in \fImask\fR occurs
-in the window given by \fItkwin\fR.
-.AP ClientData clientData in
-Arbitrary one-word value to pass to \fIproc\fR.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_CreateEventHandler\fR arranges for \fIproc\fR to be
-invoked in the future whenever one of the event types specified
-by \fImask\fR occurs in the window specified by \fItkwin\fR.
-The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR;
-this mechanism only works in programs that dispatch events
-through \fBTk_HandleEvent\fR (or through other Tk procedures that
-call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or
-\fBTk_MainLoop\fR).
-.PP
-\fIProc\fR should have arguments and result that match the
-type \fBTk_EventProc\fR:
-.CS
-typedef void Tk_EventProc(
- ClientData \fIclientData\fR,
- XEvent *\fIeventPtr\fR);
-.CE
-The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR
-argument given to \fBTk_CreateEventHandler\fR when the callback
-was created. Typically, \fIclientData\fR points to a data
-structure containing application-specific information about
-the window in which the event occurred. \fIEventPtr\fR is
-a pointer to the X event, which will be one of the ones
-specified in the \fImask\fR argument to \fBTk_CreateEventHandler\fR.
-.PP
-\fBTk_DeleteEventHandler\fR may be called to delete a
-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_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.
-When a window is deleted all of its handlers will be deleted
-automatically; in this case there is no need to call
-\fBTk_DeleteEventHandler\fR.
-.PP
-If multiple handlers are declared for the same type of X event
-on the same window, then the handlers will be invoked in the
-order they were created.
-
-.SH KEYWORDS
-bind, callback, event, handler
+'\"
+'\" Copyright (c) 1990 The Regents of the University of California.
+'\" 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: EventHndlr.3,v 1.6 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_CreateEventHandler 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_CreateEventHandler, Tk_DeleteEventHandler \- associate procedure callback with an X event
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_CreateEventHandler\fR(\fItkwin, mask, proc, clientData\fR)
+.sp
+\fBTk_DeleteEventHandler\fR(\fItkwin, mask, proc, clientData\fR)
+.SH ARGUMENTS
+.AS "unsigned long" clientData
+.AP Tk_Window tkwin in
+Token for window in which events may occur.
+.AP "unsigned long" mask in
+Bit-mask of events (such as \fBButtonPressMask\fR)
+for which \fIproc\fR should be called.
+.AP Tk_EventProc *proc in
+Procedure to invoke whenever an event in \fImask\fR occurs
+in the window given by \fItkwin\fR.
+.AP ClientData clientData in
+Arbitrary one-word value to pass to \fIproc\fR.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_CreateEventHandler\fR arranges for \fIproc\fR to be
+invoked in the future whenever one of the event types specified
+by \fImask\fR occurs in the window specified by \fItkwin\fR.
+The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR;
+this mechanism only works in programs that dispatch events
+through \fBTk_HandleEvent\fR (or through other Tk procedures that
+call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or
+\fBTk_MainLoop\fR).
+.PP
+\fIProc\fR should have arguments and result that match the
+type \fBTk_EventProc\fR:
+.CS
+typedef void \fBTk_EventProc\fR(
+ ClientData \fIclientData\fR,
+ XEvent *\fIeventPtr\fR);
+.CE
+The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR
+argument given to \fBTk_CreateEventHandler\fR when the callback
+was created. Typically, \fIclientData\fR points to a data
+structure containing application-specific information about
+the window in which the event occurred. \fIEventPtr\fR is
+a pointer to the X event, which will be one of the ones
+specified in the \fImask\fR argument to \fBTk_CreateEventHandler\fR.
+.PP
+\fBTk_DeleteEventHandler\fR may be called to delete a
+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_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.
+When a window is deleted all of its handlers will be deleted
+automatically; in this case there is no need to call
+\fBTk_DeleteEventHandler\fR.
+.PP
+If multiple handlers are declared for the same type of X event
+on the same window, then the handlers will be invoked in the
+order they were created.
+.SH KEYWORDS
+bind, callback, event, handler
diff --git a/doc/FindPhoto.3 b/doc/FindPhoto.3
index 8e1b683..8d5932f 100644
--- a/doc/FindPhoto.3
+++ b/doc/FindPhoto.3
@@ -9,7 +9,7 @@
'\" Department of Computer Science,
'\" Australian National University.
'\"
-'\" RCS: @(#) $Id: FindPhoto.3,v 1.10 2007/01/05 00:00:48 nijtmans Exp $
+'\" RCS: @(#) $Id: FindPhoto.3,v 1.11 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_FindPhoto 3 8.0 Tk "Tk Library Procedures"
@@ -23,7 +23,6 @@ Tk_FindPhoto, Tk_PhotoPutBlock, Tk_PhotoPutZoomedBlock, Tk_PhotoGetImage, Tk_Pho
Tk_PhotoHandle
\fBTk_FindPhoto\fR(\fIinterp, imageName\fR)
.sp
-.VS 8.5
int
\fBTk_PhotoPutBlock\fR(\fIinterp, handle, blockPtr, x, y, width, height,\
compRule\fR)
@@ -31,7 +30,6 @@ compRule\fR)
int
\fBTk_PhotoPutZoomedBlock\fR(\fIinterp, handle, blockPtr, x, y, width, height,\
zoomX, zoomY, subsampleX, subsampleY, compRule\fR)
-.VE 8.5
.sp
int
\fBTk_PhotoGetImage\fR(\fIhandle, blockPtr\fR)
@@ -39,18 +37,14 @@ int
void
\fBTk_PhotoBlank\fR(\fIhandle\fR)
.sp
-.VS 8.5
int
\fBTk_PhotoExpand\fR(\fIinterp, handle, width, height\fR)
-.VE 8.5
.sp
void
\fBTk_PhotoGetSize\fR(\fIhandle, widthPtr, heightPtr\fR)
.sp
-.VS 8.5
int
\fBTk_PhotoSetSize\fR(\fIinterp. handle, width, height\fR)
-.VE 8.5
.SH ARGUMENTS
.AS Tk_PhotoImageBlock window_path
.AP Tcl_Interp *interp in
@@ -101,7 +95,6 @@ being written to the photo image.
Specifies the zoom factor to be applied in the Y direction to pixels
being written to the photo image.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_FindPhoto\fR returns an opaque handle that is used to identify a
@@ -130,8 +123,8 @@ typedef struct {
int \fIheight\fR;
int \fIpitch\fR;
int \fIpixelSize\fR;
- int \fIoffset[4]\fR;
-} Tk_PhotoImageBlock;
+ int \fIoffset\fR[4];
+} \fBTk_PhotoImageBlock\fR;
.CE
The \fIpixelPtr\fR field points to the first pixel, that is, the
top-left pixel in the block.
@@ -163,12 +156,10 @@ given are replicated (in a tiled fashion) to fill the specified area.
These rules operate independently in the horizontal and vertical
directions.
.PP
-.VS 8.5
\fBTk_PhotoPutBlock\fR normally returns \fBTCL_OK\fR, though if it cannot
allocate sufficient memory to hold the resulting image, \fBTCL_ERROR\fR is
returned instead and, if the \fIinterp\fR argument is non-NULL, an
error message is placed in the interpreter's result.
-.VE 8.5
.PP
\fBTk_PhotoPutZoomedBlock\fR works like \fBTk_PhotoPutBlock\fR except that
the image can be reduced or enlarged for display. The
@@ -209,12 +200,10 @@ are being supplied in many small blocks, it is more efficient to use
allowing the image to expand in many small increments as image blocks
are supplied.
.PP
-.VS 8.5
\fBTk_PhotoExpand\fR normally returns \fBTCL_OK\fR, though if it cannot
allocate sufficient memory to hold the resulting image, \fBTCL_ERROR\fR is
returned instead and, if the \fIinterp\fR argument is non-NULL, an
error message is placed in the interpreter's result.
-.VE 8.5
.PP
\fBTk_PhotoSetSize\fR specifies the size of the image, as if the user
had specified the given \fIwidth\fR and \fIheight\fR values to the
@@ -224,16 +213,13 @@ or height, but allows the width or height to be changed by subsequent
calls to \fBTk_PhotoPutBlock\fR, \fBTk_PhotoPutZoomedBlock\fR or
\fBTk_PhotoExpand\fR.
.PP
-.VS 8.5
\fBTk_PhotoSetSize\fR normally returns \fBTCL_OK\fR, though if it cannot
allocate sufficient memory to hold the resulting image, \fBTCL_ERROR\fR is
returned instead and, if the \fIinterp\fR argument is non-NULL, an
error message is placed in the interpreter's result.
-.VE 8.5
.PP
\fBTk_PhotoGetSize\fR returns the dimensions of the image in
*\fIwidthPtr\fR and *\fIheightPtr\fR.
-
.SH PORTABILITY
.PP
In Tk 8.3 and earlier, \fBTk_PhotoPutBlock\fR and
@@ -243,7 +229,6 @@ your code, compile it with the flag
-DUSE_COMPOSITELESS_PHOTO_PUT_BLOCK. Code linked using Stubs against
older versions of Tk will continue to work.
.PP
-.VS 8.5
In Tk 8.4, \fBTk_PhotoPutBlock\fR, \fBTk_PhotoPutZoomedBlock\fR,
\fBTk_PhotoExpand\fR and \fBTk_PhotoSetSize\fR did not take an
\fIinterp\fR argument or return any result code. If insufficient
@@ -251,12 +236,9 @@ memory was available for an image, Tk would panic. This behaviour is
still supported if you compile your extension with the additional flag
-DUSE_PANIC_ON_PHOTO_ALLOC_FAILURE. Code linked using Stubs against
older versions of Tk will continue to work.
-.VE 8.5
-
.SH CREDITS
.PP
The code for the photo image type was developed by Paul Mackerras,
based on his earlier photo widget code.
-
.SH KEYWORDS
photo, image
diff --git a/doc/FontId.3 b/doc/FontId.3
index c052a7c..8375cb4 100644
--- a/doc/FontId.3
+++ b/doc/FontId.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: FontId.3,v 1.11 2008/02/04 09:53:23 dkf Exp $
+'\" RCS: @(#) $Id: FontId.3,v 1.12 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_FontId 3 8.0 Tk "Tk Library Procedures"
@@ -67,6 +67,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.
.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
@@ -74,7 +75,7 @@ typedef struct Tk_FontMetrics {
int \fIascent\fR;
int \fIdescent\fR;
int \fIlinespace\fR;
-} Tk_FontMetrics;
+} \fBTk_FontMetrics\fR;
.CE
.PP
The \fIascent\fR field is the amount in pixels that the tallest
diff --git a/doc/GeomReq.3 b/doc/GeomReq.3
index 4390d18..72ccc5a 100644
--- a/doc/GeomReq.3
+++ b/doc/GeomReq.3
@@ -1,97 +1,95 @@
-'\"
-'\" Copyright (c) 1990-1994 The Regents of the University of California.
-'\" 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: GeomReq.3,v 1.3 2001/09/26 20:25:17 pspjuth Exp $
-'\"
-.so man.macros
-.TH Tk_GeometryRequest 3 "8.4" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_GeometryRequest, Tk_SetMinimumRequestSize, Tk_SetInternalBorder, Tk_SetInternalBorderEx \- specify desired geometry or internal border for a window
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_GeometryRequest\fR(\fItkwin, reqWidth, reqHeight\fR)
-.sp
-\fBTk_SetMinimumRequestSize\fR(\fItkwin, minWidth, minHeight\fR)
-.sp
-\fBTk_SetInternalBorder\fR(\fItkwin, width\fR)
-.sp
-\fBTk_SetInternalBorderEx\fR(\fItkwin, left, right, top, bottom\fR)
-.SH ARGUMENTS
-.AS baseHeight clientData
-.AP Tk_Window tkwin in
-Window for which geometry is being requested.
-.AP int reqWidth in
-Desired width for \fItkwin\fR, in pixel units.
-.AP int reqHeight in
-Desired height for \fItkwin\fR, in pixel units.
-.AP int minWidth in
-Desired minimum requested width for \fItkwin\fR, in pixel units.
-.AP int minHeight in
-Desired minimum requested height for \fItkwin\fR, in pixel units.
-.AP int width in
-Space to leave for internal border for \fItkwin\fR, in pixel units.
-.AP int left in
-Space to leave for left side of internal border for \fItkwin\fR, in pixel units.
-.AP int right in
-Space to leave for right side of internal border for \fItkwin\fR, in pixel units.
-.AP int top in
-Space to leave for top side of internal border for \fItkwin\fR, in pixel units.
-.AP int bottom in
-Space to leave for bottom side of internal border for \fItkwin\fR, in pixel units.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_GeometryRequest\fR is called by widget code to indicate its
-preference for the dimensions of a particular window. The arguments
-to \fBTk_GeometryRequest\fR are made available to the geometry
-manager for the window, which then decides on the actual geometry
-for the window. Although geometry managers generally try to satisfy
-requests made to \fBTk_GeometryRequest\fR, there is no guarantee that
-this will always be possible. Widget code should not assume that
-a geometry request will be satisfied until it receives a
-\fBConfigureNotify\fR event indicating that the geometry change has
-occurred. Widget code should never call procedures like
-\fBTk_ResizeWindow\fR directly. Instead, it should invoke
-\fBTk_GeometryRequest\fR and leave the final geometry decisions to
-the geometry manager.
-.PP
-If \fItkwin\fR is a top-level window, then the geometry information
-will be passed to the window manager using the standard ICCCM protocol.
-.PP
-\fBTk_SetInternalBorder\fR is called by widget code to indicate that
-the widget has an internal border. This means that the widget draws
-a decorative border inside the window instead of using the standard
-X borders, which are external to the window's area. For example,
-internal borders are used to draw 3-D effects. \fIWidth\fR
-specifies the width of the border in pixels. Geometry managers will
-use this information to avoid placing any children of \fItkwin\fR
-overlapping the outermost \fIwidth\fR pixels of \fItkwin\fR's area.
-.PP
-\fBTk_SetInternalBorderEx\fR works like \fBTk_SetInternalBorder\fR
-but lets you specify different widths for different sides of the window.
-.PP
-\fBTk_SetMinimumRequestSize\fR is called by widget code to indicate
-that a geometry manager should request at least this size for the
-widget. This allows a widget to have some control over its size when
-a propagating geometry manager is used inside it.
-.PP
-The information specified in calls to \fBTk_GeometryRequest\fR,
-\fBTk_SetMinimumRequestSize\fR, \fBTk_SetInternalBorder\fR and
-\fBTk_SetInternalBorderEx\fR can be retrieved using the macros
-\fBTk_ReqWidth\fR, \fBTk_ReqHeight\fR, \fBTk_MinReqWidth\fR,
-\fBTk_MinReqHeight\fR, \fBTk_MinReqWidth\fR, \fBTk_InternalBorderLeft\fR,
-\fBTk_InternalBorderRight\fR, \fBTk_InternalBorderTop\fR and
-\fBTk_InternalBorderBottom\fR.
-See the \fBTk_WindowId\fR manual entry for details.
-
-.SH KEYWORDS
-geometry, request
+'\"
+'\" Copyright (c) 1990-1994 The Regents of the University of California.
+'\" 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: GeomReq.3,v 1.4 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_GeometryRequest 3 "8.4" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_GeometryRequest, Tk_SetMinimumRequestSize, Tk_SetInternalBorder, Tk_SetInternalBorderEx \- specify desired geometry or internal border for a window
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_GeometryRequest\fR(\fItkwin, reqWidth, reqHeight\fR)
+.sp
+\fBTk_SetMinimumRequestSize\fR(\fItkwin, minWidth, minHeight\fR)
+.sp
+\fBTk_SetInternalBorder\fR(\fItkwin, width\fR)
+.sp
+\fBTk_SetInternalBorderEx\fR(\fItkwin, left, right, top, bottom\fR)
+.SH ARGUMENTS
+.AS baseHeight clientData
+.AP Tk_Window tkwin in
+Window for which geometry is being requested.
+.AP int reqWidth in
+Desired width for \fItkwin\fR, in pixel units.
+.AP int reqHeight in
+Desired height for \fItkwin\fR, in pixel units.
+.AP int minWidth in
+Desired minimum requested width for \fItkwin\fR, in pixel units.
+.AP int minHeight in
+Desired minimum requested height for \fItkwin\fR, in pixel units.
+.AP int width in
+Space to leave for internal border for \fItkwin\fR, in pixel units.
+.AP int left in
+Space to leave for left side of internal border for \fItkwin\fR, in pixel units.
+.AP int right in
+Space to leave for right side of internal border for \fItkwin\fR, in pixel units.
+.AP int top in
+Space to leave for top side of internal border for \fItkwin\fR, in pixel units.
+.AP int bottom in
+Space to leave for bottom side of internal border for \fItkwin\fR, in pixel units.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_GeometryRequest\fR is called by widget code to indicate its
+preference for the dimensions of a particular window. The arguments
+to \fBTk_GeometryRequest\fR are made available to the geometry
+manager for the window, which then decides on the actual geometry
+for the window. Although geometry managers generally try to satisfy
+requests made to \fBTk_GeometryRequest\fR, there is no guarantee that
+this will always be possible. Widget code should not assume that
+a geometry request will be satisfied until it receives a
+\fBConfigureNotify\fR event indicating that the geometry change has
+occurred. Widget code should never call procedures like
+\fBTk_ResizeWindow\fR directly. Instead, it should invoke
+\fBTk_GeometryRequest\fR and leave the final geometry decisions to
+the geometry manager.
+.PP
+If \fItkwin\fR is a top-level window, then the geometry information
+will be passed to the window manager using the standard ICCCM protocol.
+.PP
+\fBTk_SetInternalBorder\fR is called by widget code to indicate that
+the widget has an internal border. This means that the widget draws
+a decorative border inside the window instead of using the standard
+X borders, which are external to the window's area. For example,
+internal borders are used to draw 3-D effects. \fIWidth\fR
+specifies the width of the border in pixels. Geometry managers will
+use this information to avoid placing any children of \fItkwin\fR
+overlapping the outermost \fIwidth\fR pixels of \fItkwin\fR's area.
+.PP
+\fBTk_SetInternalBorderEx\fR works like \fBTk_SetInternalBorder\fR
+but lets you specify different widths for different sides of the window.
+.PP
+\fBTk_SetMinimumRequestSize\fR is called by widget code to indicate
+that a geometry manager should request at least this size for the
+widget. This allows a widget to have some control over its size when
+a propagating geometry manager is used inside it.
+.PP
+The information specified in calls to \fBTk_GeometryRequest\fR,
+\fBTk_SetMinimumRequestSize\fR, \fBTk_SetInternalBorder\fR and
+\fBTk_SetInternalBorderEx\fR can be retrieved using the macros
+\fBTk_ReqWidth\fR, \fBTk_ReqHeight\fR, \fBTk_MinReqWidth\fR,
+\fBTk_MinReqHeight\fR, \fBTk_MinReqWidth\fR, \fBTk_InternalBorderLeft\fR,
+\fBTk_InternalBorderRight\fR, \fBTk_InternalBorderTop\fR and
+\fBTk_InternalBorderBottom\fR.
+See the \fBTk_WindowId\fR manual entry for details.
+.SH KEYWORDS
+geometry, request
diff --git a/doc/GetBitmap.3 b/doc/GetBitmap.3
index 542d5ef..9042313 100644
--- a/doc/GetBitmap.3
+++ b/doc/GetBitmap.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: GetBitmap.3,v 1.14 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetBitmap.3,v 1.15 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_AllocBitmapFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -68,7 +68,6 @@ Display for which \fIbitmap\fR was allocated.
Identifier for a bitmap allocated by \fBTk_AllocBitmapFromObj\fR or
\fBTk_GetBitmap\fR.
.BE
-
.SH DESCRIPTION
.PP
These procedures manage a collection of bitmaps (one-plane pixmaps)
@@ -284,8 +283,8 @@ with its Pixmap token.
There should be exactly one call to \fBTk_FreeBitmapFromObj\fR
or \fBTk_FreeBitmap\fR for each call to \fBTk_AllocBitmapFromObj\fR or
\fBTk_GetBitmap\fR.
-
.SH BUGS
+.PP
In determining whether an existing bitmap can be used to satisfy
a new request, \fBTk_AllocBitmapFromObj\fR and \fBTk_GetBitmap\fR
consider only the immediate value of the string description. For
@@ -295,6 +294,5 @@ bitmap created from the same file name: it will not check to
see whether the file itself has changed, or whether the current
directory has changed, thereby causing the name to refer to
a different file.
-
.SH KEYWORDS
bitmap, pixmap
diff --git a/doc/GetCapStyl.3 b/doc/GetCapStyl.3
index 2dd426f..38217c3 100644
--- a/doc/GetCapStyl.3
+++ b/doc/GetCapStyl.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: GetCapStyl.3,v 1.8 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetCapStyl.3,v 1.9 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetCapStyle 3 "" Tk "Tk Library Procedures"
@@ -37,7 +37,6 @@ Pointer to location in which to store X cap style corresponding to
.AP int cap in
Cap style: one of \fBCapButt\fR, \fBCapProjecting\fR, or \fBCapRound\fR.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_GetCapStyle\fR places in \fI*capPtr\fR the X cap style
@@ -62,6 +61,5 @@ statically-allocated string corresponding to \fIcap\fR.
If \fIcap\fR is not a legal cap style, then
.QW "unknown cap style"
is returned.
-
.SH KEYWORDS
butt, cap style, projecting, round
diff --git a/doc/GetColor.3 b/doc/GetColor.3
index ebad886..33c8420 100644
--- a/doc/GetColor.3
+++ b/doc/GetColor.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: GetColor.3,v 1.8 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetColor.3,v 1.9 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_AllocColorFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -60,7 +60,6 @@ call to \fBTk_AllocColorFromObj\fR, \fBTk_GetColor\fR or
Drawable in which the result graphics context will be used. Must have
same screen and depth as the window for which the color was allocated.
.BE
-
.SH DESCRIPTION
.PP
These procedures manage the colors being used by a Tk application.
diff --git a/doc/GetCursor.3 b/doc/GetCursor.3
index 7bf0da7..ae3fb4e 100644
--- a/doc/GetCursor.3
+++ b/doc/GetCursor.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: GetCursor.3,v 1.13 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetCursor.3,v 1.14 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_AllocCursorFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -69,7 +69,6 @@ Opaque Tk identifier for cursor. If passed to \fBTk_FreeCursor\fR, must
have been returned by some previous call to \fBTk_GetCursor\fR or
\fBTk_GetCursorFromData\fR.
.BE
-
.SH DESCRIPTION
.PP
These procedures manage a collection of cursors
@@ -215,8 +214,8 @@ with its Tk_Cursor token.
There should be exactly one call to \fBTk_FreeCursor\fR for
each call to \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR,
or \fBTk_GetCursorFromData\fR.
-
.SH BUGS
+.PP
In determining whether an existing cursor can be used to satisfy
a new request, \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR,
and \fBTk_GetCursorFromData\fR
@@ -230,6 +229,5 @@ a different file. Similarly, \fBTk_GetCursorFromData\fR assumes
that if the same \fIsource\fR pointer is used in two different calls,
then the pointers refer to the same data; it does not check to
see if the actual data values have changed.
-
.SH KEYWORDS
cursor
diff --git a/doc/GetDash.3 b/doc/GetDash.3
index fed5b3f..d93c622 100644
--- a/doc/GetDash.3
+++ b/doc/GetDash.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: GetDash.3,v 1.7 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetDash.3,v 1.8 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetDash 3 8.3 Tk "Tk Library Procedures"
@@ -28,7 +28,6 @@ Textual value to be converted.
Points to place to store the dash pattern
value converted from \fIstring\fR.
.BE
-
.SH DESCRIPTION
.PP
These procedure parses the string and fills in the result in the
@@ -75,6 +74,5 @@ pattern will be displayed as the most close dash pattern that
is available. For example, on Windows only the first 4 of the
above examples are available. The last 2 examples will be
displayed identically as the first one.
-
.SH KEYWORDS
dash, conversion
diff --git a/doc/GetFont.3 b/doc/GetFont.3
index f404686..741ad93 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.11 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetFont.3,v 1.12 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_AllocFontFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -33,7 +33,6 @@ Tk_Font
.sp
void
\fBTk_FreeFont(\fItkfont\fB)\fR
-
.SH ARGUMENTS
.AS "const char" *tkfont
.AP "Tcl_Interp" *interp in
@@ -107,7 +106,6 @@ with the same information used to create it; for
with its Tk_Font token. There should be
exactly one call to \fBTk_FreeFontFromObj\fR or \fBTk_FreeFont\fR
for each call to \fBTk_AllocFontFromObj\fR or \fBTk_GetFont\fR.
-
.SH "SEE ALSO"
Tk_FontId(3)
.SH KEYWORDS
diff --git a/doc/GetGC.3 b/doc/GetGC.3
index 471bdfc..97ac503 100644
--- a/doc/GetGC.3
+++ b/doc/GetGC.3
@@ -1,74 +1,72 @@
-'\"
-'\" Copyright (c) 1990 The Regents of the University of California.
-'\" 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: GetGC.3,v 1.2 1998/09/14 18:22:49 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_GetGC 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_GetGC, Tk_FreeGC \- maintain database of read-only graphics contexts
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-GC
-\fBTk_GetGC\fR(\fItkwin, valueMask, valuePtr\fR)
-.sp
-\fBTk_FreeGC(\fIdisplay, gc\fR)
-.SH ARGUMENTS
-.AS "unsigned long" valueMask
-.AP Tk_Window tkwin in
-Token for window in which the graphics context will be used.
-.AP "unsigned long" valueMask in
-Mask of bits (such as \fBGCForeground\fR or \fBGCStipple\fR)
-indicating which fields of \fI*valuePtr\fR are valid.
-.AP XGCValues *valuePtr in
-Pointer to structure describing the desired values for the
-graphics context.
-.AP Display *display in
-Display for which \fIgc\fR was allocated.
-.AP GC gc in
-X identifier for graphics context that is no longer needed.
-Must have been allocated by \fBTk_GetGC\fR.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_GetGC\fR and \fBTk_FreeGC\fR manage a collection of graphics contexts
-being used by an application. The procedures allow graphics contexts to be
-shared, thereby avoiding the server overhead that would be incurred
-if a separate GC were created for each use. \fBTk_GetGC\fR takes arguments
-describing the desired graphics context and returns an X identifier
-for a GC that fits the description. The graphics context that is returned
-will have default values in all of the fields not specified explicitly
-by \fIvalueMask\fR and \fIvaluePtr\fR.
-.PP
-\fBTk_GetGC\fR maintains a
-database of all the graphics contexts it has created. Whenever possible,
-a call to \fBTk_GetGC\fR will
-return an existing graphics context rather than creating a new one. This
-approach can substantially reduce server overhead, so \fBTk_GetGC\fR
-should generally be used in preference to the Xlib procedure
-\fBXCreateGC\fR, which creates a new graphics context on each call.
-.PP
-Since the return values of \fBTk_GetGC\fR
-are shared, callers should never modify the graphics contexts
-returned by \fBTk_GetGC\fR.
-If a graphics context must be modified dynamically, then it should be
-created by calling \fBXCreateGC\fR instead of \fBTk_GetGC\fR.
-.PP
-When a graphics context
-is no longer needed, \fBTk_FreeGC\fR should be called to release it.
-There should be exactly one call to \fBTk_FreeGC\fR for
-each call to \fBTk_GetGC\fR.
-When a graphics context is no longer in use anywhere (i.e. it has
-been freed as many times as it has been gotten) \fBTk_FreeGC\fR
-will release it to the X server and delete it from the database.
-
-.SH KEYWORDS
-graphics context
+'\"
+'\" Copyright (c) 1990 The Regents of the University of California.
+'\" 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: GetGC.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_GetGC 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_GetGC, Tk_FreeGC \- maintain database of read-only graphics contexts
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+GC
+\fBTk_GetGC\fR(\fItkwin, valueMask, valuePtr\fR)
+.sp
+\fBTk_FreeGC(\fIdisplay, gc\fR)
+.SH ARGUMENTS
+.AS "unsigned long" valueMask
+.AP Tk_Window tkwin in
+Token for window in which the graphics context will be used.
+.AP "unsigned long" valueMask in
+Mask of bits (such as \fBGCForeground\fR or \fBGCStipple\fR)
+indicating which fields of \fI*valuePtr\fR are valid.
+.AP XGCValues *valuePtr in
+Pointer to structure describing the desired values for the
+graphics context.
+.AP Display *display in
+Display for which \fIgc\fR was allocated.
+.AP GC gc in
+X identifier for graphics context that is no longer needed.
+Must have been allocated by \fBTk_GetGC\fR.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_GetGC\fR and \fBTk_FreeGC\fR manage a collection of graphics contexts
+being used by an application. The procedures allow graphics contexts to be
+shared, thereby avoiding the server overhead that would be incurred
+if a separate GC were created for each use. \fBTk_GetGC\fR takes arguments
+describing the desired graphics context and returns an X identifier
+for a GC that fits the description. The graphics context that is returned
+will have default values in all of the fields not specified explicitly
+by \fIvalueMask\fR and \fIvaluePtr\fR.
+.PP
+\fBTk_GetGC\fR maintains a
+database of all the graphics contexts it has created. Whenever possible,
+a call to \fBTk_GetGC\fR will
+return an existing graphics context rather than creating a new one. This
+approach can substantially reduce server overhead, so \fBTk_GetGC\fR
+should generally be used in preference to the Xlib procedure
+\fBXCreateGC\fR, which creates a new graphics context on each call.
+.PP
+Since the return values of \fBTk_GetGC\fR
+are shared, callers should never modify the graphics contexts
+returned by \fBTk_GetGC\fR.
+If a graphics context must be modified dynamically, then it should be
+created by calling \fBXCreateGC\fR instead of \fBTk_GetGC\fR.
+.PP
+When a graphics context
+is no longer needed, \fBTk_FreeGC\fR should be called to release it.
+There should be exactly one call to \fBTk_FreeGC\fR for
+each call to \fBTk_GetGC\fR.
+When a graphics context is no longer in use anywhere (i.e. it has
+been freed as many times as it has been gotten) \fBTk_FreeGC\fR
+will release it to the X server and delete it from the database.
+.SH KEYWORDS
+graphics context
diff --git a/doc/GetHINSTANCE.3 b/doc/GetHINSTANCE.3
index 8942105..2e89475 100644
--- a/doc/GetHINSTANCE.3
+++ b/doc/GetHINSTANCE.3
@@ -2,7 +2,7 @@
'\" Copyright (c) 1998-2000 by Scriptics Corporation.
'\" All rights reserved.
'\"
-'\" RCS: @(#) $Id: GetHINSTANCE.3,v 1.2 2002/11/15 15:35:55 dkf Exp $
+'\" RCS: @(#) $Id: GetHINSTANCE.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetHISTANCE 3 "" Tk "Tk Library Procedures"
@@ -16,11 +16,9 @@ Tk_GetHINSTANCE \- retrieve the global application instance handle
HINSTANCE
\fBTk_GetHINSTANCE\fR()
.BE
-
.SH DESCRIPTION
.PP
\fBTk_GetHINSTANCE\fR returns the Windows application instance handle
for the Tk application. This function is only available on Windows platforms.
-
.SH KEYWORDS
identifier, instance
diff --git a/doc/GetHWND.3 b/doc/GetHWND.3
index 5aa3cab..664277c 100644
--- a/doc/GetHWND.3
+++ b/doc/GetHWND.3
@@ -1,40 +1,39 @@
-'\"
-'\" Copyright (c) 1998-2000 by Scriptics Corporation.
-'\" All rights reserved.
-'\"
-'\" RCS: @(#) $Id: GetHWND.3,v 1.4 2004/08/22 15:43:20 dkf Exp $
-'\"
-'\"
-.so man.macros
-.TH HWND 3 8.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_GetHWND, Tk_AttachHWND \- manage interactions between the Windows handle and an X window
-.SH SYNOPSIS
-.nf
-\fB#include <tkPlatDecls.h>\fR
-.sp
-HWND
-\fBTk_GetHWND\fR(\fIwindow\fR)
-.sp
-Window
-\fBTk_AttachHWND\fR(\fItkwin, hwnd\fR)
-.SH ARGUMENTS
-.AP Window window in
-X token for window.
-.AP Tk_Window tkwin in
-Tk window for window.
-.AP HWND hwnd in
-Windows HWND for window.
-.BE
-.SH DESCRIPTION
-.PP
-\fBTk_GetHWND\fR returns the Windows HWND identifier for X Windows
-window given by \fIwindow\fR.
-.PP
-\fBTk_AttachHWND\fR binds the Windows HWND identifier to the
-specified Tk_Window given by \fItkwin\fR. It returns an X Windows
-window that encapsulates the HWND.
-
-.SH KEYWORDS
-identifier, window
+'\"
+'\" Copyright (c) 1998-2000 by Scriptics Corporation.
+'\" All rights reserved.
+'\"
+'\" RCS: @(#) $Id: GetHWND.3,v 1.5 2008/06/30 22:57:01 dkf Exp $
+'\"
+'\"
+.so man.macros
+.TH HWND 3 8.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_GetHWND, Tk_AttachHWND \- manage interactions between the Windows handle and an X window
+.SH SYNOPSIS
+.nf
+\fB#include <tkPlatDecls.h>\fR
+.sp
+HWND
+\fBTk_GetHWND\fR(\fIwindow\fR)
+.sp
+Window
+\fBTk_AttachHWND\fR(\fItkwin, hwnd\fR)
+.SH ARGUMENTS
+.AP Window window in
+X token for window.
+.AP Tk_Window tkwin in
+Tk window for window.
+.AP HWND hwnd in
+Windows HWND for window.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_GetHWND\fR returns the Windows HWND identifier for X Windows
+window given by \fIwindow\fR.
+.PP
+\fBTk_AttachHWND\fR binds the Windows HWND identifier to the
+specified Tk_Window given by \fItkwin\fR. It returns an X Windows
+window that encapsulates the HWND.
+.SH KEYWORDS
+identifier, window
diff --git a/doc/GetImage.3 b/doc/GetImage.3
index a1f8bb1..6b137f3 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.9 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetImage.3,v 1.10 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetImage 3 4.0 Tk "Tk Library Procedures"
@@ -65,7 +65,6 @@ Store width of \fIimage\fR (in pixels) here.
.AP "int" heightPtr out
Store height of \fIimage\fR (in pixels) here.
.BE
-
.SH DESCRIPTION
.PP
These procedures are invoked by widgets that wish to display images.
@@ -108,14 +107,14 @@ The \fIchangeProc\fR and \fIclientData\fR arguments to
\fIchangeProc\fR will be called by Tk whenever a change occurs
in the image; it must match the following prototype:
.CS
-typedef void Tk_ImageChangedProc(
- ClientData \fIclientData\fR,
- int \fIx\fR,
- int \fIy\fR,
- int \fIwidth\fR,
- int \fIheight\fR,
- int \fIimageWidth\fR,
- int \fIimageHeight\fR);
+typedef void \fBTk_ImageChangedProc\fR(
+ ClientData \fIclientData\fR,
+ int \fIx\fR,
+ int \fIy\fR,
+ int \fIwidth\fR,
+ int \fIheight\fR,
+ int \fIimageWidth\fR,
+ int \fIimageHeight\fR);
.CE
The \fIclientData\fR argument to \fIchangeProc\fR is the same as the
\fIclientData\fR argument to \fBTk_GetImage\fR.
@@ -127,9 +126,7 @@ they are specified in pixels measured from the upper-left
corner of the image.
The arguments \fIimageWidth\fR and \fIimageHeight\fR give
the image's (new) size.
-
.SH "SEE ALSO"
Tk_CreateImageType
-
.SH KEYWORDS
images, redisplay
diff --git a/doc/GetJoinStl.3 b/doc/GetJoinStl.3
index 576e992..980d9e0 100644
--- a/doc/GetJoinStl.3
+++ b/doc/GetJoinStl.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: GetJoinStl.3,v 1.8 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetJoinStl.3,v 1.9 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetJoinStyle 3 "" Tk "Tk Library Procedures"
@@ -37,7 +37,6 @@ Pointer to location in which to store X join style corresponding to
.AP int join in
Join style: one of \fBJoinBevel\fR, \fBJoinMiter\fR, \fBJoinRound\fR.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_GetJoinStyle\fR places in \fI*joinPtr\fR the X join style
@@ -61,6 +60,5 @@ statically-allocated string corresponding to \fIjoin\fR.
If \fIjoin\fR is not a legal join style, then
.QW "unknown join style"
is returned.
-
.SH KEYWORDS
bevel, join style, miter, round
diff --git a/doc/GetJustify.3 b/doc/GetJustify.3
index 9bbcd42..d5b392b 100644
--- a/doc/GetJustify.3
+++ b/doc/GetJustify.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: GetJustify.3,v 1.10 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetJustify.3,v 1.11 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetJustifyFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -84,6 +84,5 @@ corresponding to \fIjustify\fR.
If \fIjustify\fR is not a legal justify value, then
.QW "unknown justification style"
is returned.
-
.SH KEYWORDS
center, fill, justification, string
diff --git a/doc/GetOption.3 b/doc/GetOption.3
index c321680..3ccd8b3 100644
--- a/doc/GetOption.3
+++ b/doc/GetOption.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: GetOption.3,v 1.4 2007/01/05 00:00:48 nijtmans Exp $
+'\" RCS: @(#) $Id: GetOption.3,v 1.5 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetOption 3 "" Tk "Tk Library Procedures"
@@ -28,7 +28,6 @@ Name of desired option.
Class of desired option. Null means there is no class for
this option; do lookup based on name only.
.BE
-
.SH DESCRIPTION
.PP
This procedure is invoked to retrieve an option from the database
@@ -41,6 +40,5 @@ is returned. If no option matches, then NULL is returned.
\fBTk_GetOption\fR caches options related to \fItkwin\fR so that
successive calls for the same \fItkwin\fR will execute much more
quickly than successive calls for different windows.
-
.SH KEYWORDS
class, name, option, retrieve
diff --git a/doc/GetPixels.3 b/doc/GetPixels.3
index bc4774e..a3e7cb0 100644
--- a/doc/GetPixels.3
+++ b/doc/GetPixels.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: GetPixels.3,v 1.8 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetPixels.3,v 1.9 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetPixelsFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -45,7 +45,6 @@ Pointer to location in which to store converted distance in pixels.
.AP double *doublePtr out
Pointer to location in which to store converted distance in millimeters.
.BE
-
.SH DESCRIPTION
.PP
These procedures take as argument a specification of distance on
@@ -94,6 +93,5 @@ return value, so \fBTk_GetAnchor\fR is less efficient than
\fBTk_GetPixelsFromObj\fR and \fBTk_GetPixels\fR (respectively) except
that they convert the screen distance to millimeters and
store a double-precision floating-point result at \fI*doublePtr\fR.
-
.SH KEYWORDS
centimeters, convert, inches, millimeters, pixels, points, screen units
diff --git a/doc/GetPixmap.3 b/doc/GetPixmap.3
index a8cb5e1..d851387 100644
--- a/doc/GetPixmap.3
+++ b/doc/GetPixmap.3
@@ -1,56 +1,54 @@
-'\"
-'\" Copyright (c) 1990 The Regents of the University of California.
-'\" 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: GetPixmap.3,v 1.2 1998/09/14 18:22:50 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_GetPixmap 3 4.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_GetPixmap, Tk_FreePixmap \- allocate and free pixmaps
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-Pixmap
-\fBTk_GetPixmap(\fIdisplay, d, width, height, depth\fB)\fR
-.sp
-\fBTk_FreePixmap(\fIdisplay, pixmap\fB)\fR
-.SH ARGUMENTS
-.AS "Drawable" *pixelPtr
-.AP Display *display in
-X display for the pixmap.
-.AP Drawable d in
-Pixmap or window where the new pixmap will be used for drawing.
-.AP "int" width in
-Width of pixmap.
-.AP "int" height in
-Height of pixmap.
-.AP "int" depth in
-Number of bits per pixel in pixmap.
-.AP Pixmap pixmap in
-Pixmap to destroy.
-.BE
-
-.SH DESCRIPTION
-.PP
-These procedures are identical to the Xlib procedures \fBXCreatePixmap\fR
-and \fBXFreePixmap\fR, except that they have extra code to manage X
-resource identifiers so that identifiers for deleted pixmaps can be
-reused in the future.
-It is important for Tk applications to use these procedures rather
-than \fBXCreatePixmap\fR and \fBXFreePixmap\fR; otherwise long-running
-applications may run out of resource identifiers.
-.PP
-\fBTk_GetPixmap\fR creates a pixmap suitable for drawing in \fId\fR,
-with dimensions given by \fIwidth\fR, \fIheight\fR, and \fIdepth\fR,
-and returns its identifier.
-\fBTk_FreePixmap\fR destroys the pixmap given by \fIpixmap\fR and makes
-its resource identifier available for reuse.
-
-.SH KEYWORDS
-pixmap, resource identifier
+'\"
+'\" Copyright (c) 1990 The Regents of the University of California.
+'\" 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: GetPixmap.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_GetPixmap 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_GetPixmap, Tk_FreePixmap \- allocate and free pixmaps
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+Pixmap
+\fBTk_GetPixmap(\fIdisplay, d, width, height, depth\fB)\fR
+.sp
+\fBTk_FreePixmap(\fIdisplay, pixmap\fB)\fR
+.SH ARGUMENTS
+.AS "Drawable" *pixelPtr
+.AP Display *display in
+X display for the pixmap.
+.AP Drawable d in
+Pixmap or window where the new pixmap will be used for drawing.
+.AP "int" width in
+Width of pixmap.
+.AP "int" height in
+Height of pixmap.
+.AP "int" depth in
+Number of bits per pixel in pixmap.
+.AP Pixmap pixmap in
+Pixmap to destroy.
+.BE
+.SH DESCRIPTION
+.PP
+These procedures are identical to the Xlib procedures \fBXCreatePixmap\fR
+and \fBXFreePixmap\fR, except that they have extra code to manage X
+resource identifiers so that identifiers for deleted pixmaps can be
+reused in the future.
+It is important for Tk applications to use these procedures rather
+than \fBXCreatePixmap\fR and \fBXFreePixmap\fR; otherwise long-running
+applications may run out of resource identifiers.
+.PP
+\fBTk_GetPixmap\fR creates a pixmap suitable for drawing in \fId\fR,
+with dimensions given by \fIwidth\fR, \fIheight\fR, and \fIdepth\fR,
+and returns its identifier.
+\fBTk_FreePixmap\fR destroys the pixmap given by \fIpixmap\fR and makes
+its resource identifier available for reuse.
+.SH KEYWORDS
+pixmap, resource identifier
diff --git a/doc/GetScroll.3 b/doc/GetScroll.3
index f9090ef..dd8b7c6 100644
--- a/doc/GetScroll.3
+++ b/doc/GetScroll.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: GetScroll.3,v 1.6 2007/01/05 00:00:49 nijtmans Exp $
+'\" RCS: @(#) $Id: GetScroll.3,v 1.7 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetScrollInfo 3 8.0 Tk "Tk Library Procedures"
@@ -43,7 +43,6 @@ Filled in with fraction from \fBmoveto\fR option, if any.
Filled in with line or page count from \fBscroll\fR option, if any.
The value may be negative.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_GetScrollInfo\fR parses the arguments expected by widget
@@ -73,6 +72,5 @@ is returned and an error message is left in \fIinterp->result\fR.
\fBTk_GetScrollInfo\fR. However, \fBTk_GetScrollInfoObj\fR accepts
Tcl_Obj style arguments, making it more appropriate for use with new
development.
-
.SH KEYWORDS
parse, scrollbar, scrolling command, xview, yview
diff --git a/doc/GetSelect.3 b/doc/GetSelect.3
index a252ec1..7345cf1 100644
--- a/doc/GetSelect.3
+++ b/doc/GetSelect.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: GetSelect.3,v 1.5 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetSelect.3,v 1.6 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetSelection 3 4.0 Tk "Tk Library Procedures"
@@ -35,7 +35,6 @@ are retrieved.
.AP ClientData clientData in
Arbitrary one-word value to pass to \fIproc\fR.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_GetSelection\fR retrieves the selection specified by the atom
@@ -45,12 +44,12 @@ is retrieved, \fIproc\fR is called to process the piece. \fIProc\fR
should have arguments and result that match the type
\fBTk_GetSelProc\fR:
.CS
-typedef int Tk_GetSelProc(
- ClientData \fIclientData\fR,
- Tcl_Interp *\fIinterp\fR,
- char *\fIportion\fR);
+typedef int \fBTk_GetSelProc\fR(
+ ClientData \fIclientData\fR,
+ Tcl_Interp *\fIinterp\fR,
+ char *\fIportion\fR);
.CE
-The \fIclientData\fR and \fIinterp\fR parameters to \fIproc\fR
+The \fIclientData\fR and \fIinterp\fR parameters to \fIproc\fR
will be copies of the corresponding arguments to
\fBTk_GetSelection\fR. \fIPortion\fR will be a pointer to
a string containing part or all of the selection. For large
@@ -74,6 +73,5 @@ in \fIinterp->result\fR. \fIProc\fR should also return either
\fBTCL_OK\fR or \fBTCL_ERROR\fR. If \fIproc\fR encounters an error in dealing with the
selection, it should leave an error message in \fIinterp->result\fR
and return \fBTCL_ERROR\fR; this will abort the selection retrieval.
-
.SH KEYWORDS
format, get, selection retrieval
diff --git a/doc/GetUid.3 b/doc/GetUid.3
index d3d5eb4..08a6f03 100644
--- a/doc/GetUid.3
+++ b/doc/GetUid.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: GetUid.3,v 1.8 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetUid.3,v 1.9 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetUid 3 "" Tk "Tk Library Procedures"
@@ -23,7 +23,6 @@ Tk_Uid
String for which the corresponding unique identifier is
desired.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_GetUid\fR returns the unique identifier corresponding
@@ -44,6 +43,5 @@ Tk_Uid may be compared directly (x == y) without having to call
\fBstrcmp\fR.
In addition, the return value from \fBTk_GetUid\fR will have the
same string value as its argument (strcmp(Tk_GetUid(a), a) == 0).
-
.SH KEYWORDS
atom, unique identifier
diff --git a/doc/GetVRoot.3 b/doc/GetVRoot.3
index be55fbb..672d949 100644
--- a/doc/GetVRoot.3
+++ b/doc/GetVRoot.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: GetVRoot.3,v 1.7 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: GetVRoot.3,v 1.8 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetVRootGeometry 3 4.0 Tk "Tk Library Procedures"
@@ -30,7 +30,6 @@ Points to word in which to store width of virtual root.
.AP "int" heightPtr out
Points to word in which to store height of virtual root.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_GetVRootGeometry\fR returns geometry information about the virtual
@@ -45,6 +44,5 @@ If \fItkwin\fR is not associated with a virtual root (e.g.
because the window manager does not use virtual roots) then *\fIxPtr\fR and
*\fIyPtr\fR will be set to 0 and *\fIwidthPtr\fR and *\fIheightPtr\fR
will be set to the dimensions of the screen containing \fItkwin\fR.
-
.SH KEYWORDS
geometry, height, location, virtual root, width, window manager
diff --git a/doc/Grab.3 b/doc/Grab.3
index dafb12b..0db62c0 100644
--- a/doc/Grab.3
+++ b/doc/Grab.3
@@ -1,65 +1,60 @@
-'\"
-'\" Copyright (c) 1998-2000 by Scriptics Corporation.
-'\" All rights reserved.
-'\"
-'\" RCS: @(#) $Id: Grab.3,v 1.2 2004/09/19 16:05:36 dkf Exp $
-'\"
-.so man.macros
-.TH Tk_Grab 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_Grab, Tk_Ungrab \- manipulate grab state in an application
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-int
-\fBTk_Grab\fR(\fIinterp, tkwin, grabGlobal\fR)
-.sp
-void
-\fBTk_Ungrab\fR(\fItkwin\fR)
-
-.SH ARGUMENTS
-.AP Tcl_Interp *interp in
-Interpreter to use for error reporting
-.AP Tk_Window tkwin in
-Window on whose behalf the pointer is to be grabbed or released
-.AP int grabGlobal in
-Boolean indicating whether the grab is global or application local
-.BE
-
-.SH DESCRIPTION
-.PP
-These functions are used to set or release a global or
-application local grab. When a grab is set on a particular window
-in a Tk application, mouse and keyboard events can only be received by
-that window and its descendants. Mouse and keyboard events for
-windows outside the tree rooted at \fItkwin\fR will be redirected to
-\fItkwin\fR. If the grab is global, then all mouse and keyboard
-events for windows outside the tree rooted at \fItkwin\fR (even those
-intended for windows in other applications) will be redirected to
-\fItkwin\fR. If the grab is application local, only mouse and
-keyboard events intended for a windows within the same application
-(but outside the tree rooted at \fItkwin\fR) will be redirected.
-
-.PP
-\fBTk_Grab\fR sets a grab on a particular window. \fITkwin\fR
-specifies the window on whose behalf the pointer is to be grabbed.
-\fIGrabGlobal\fR indicates whether the grab should be global or
-application local; if it is non-zero, it means the grab should be
-global. Normally, \fBTk_Grab\fR returns \fBTCL_OK\fR; if an error occurs
-and the grab cannot be set, \fBTCL_ERROR\fR is returned and an error message
-is left if \fIinterp\fR's result. Once this call completes
-successfully, no window outside the tree rooted at \fItkwin\fR will
-receive pointer- or keyboard-related events until the next call to
-Tk_Ungrab. If a previous grab was in effect within the application,
-then it is replaced with a new one.
-
-.PP
-\fBTcl_Ungrab\fR releases a grab on the mouse pointer and keyboard, if
-there is one set on the window given by \fItkwin\fR. Once a grab is
-released, pointer and keyboard events will start being delivered to
-other windows again.
-
-.SH KEYWORDS
-grab, window
+'\"
+'\" Copyright (c) 1998-2000 by Scriptics Corporation.
+'\" All rights reserved.
+'\"
+'\" RCS: @(#) $Id: Grab.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_Grab 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_Grab, Tk_Ungrab \- manipulate grab state in an application
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+int
+\fBTk_Grab\fR(\fIinterp, tkwin, grabGlobal\fR)
+.sp
+void
+\fBTk_Ungrab\fR(\fItkwin\fR)
+.SH ARGUMENTS
+.AP Tcl_Interp *interp in
+Interpreter to use for error reporting
+.AP Tk_Window tkwin in
+Window on whose behalf the pointer is to be grabbed or released
+.AP int grabGlobal in
+Boolean indicating whether the grab is global or application local
+.BE
+.SH DESCRIPTION
+.PP
+These functions are used to set or release a global or
+application local grab. When a grab is set on a particular window
+in a Tk application, mouse and keyboard events can only be received by
+that window and its descendants. Mouse and keyboard events for
+windows outside the tree rooted at \fItkwin\fR will be redirected to
+\fItkwin\fR. If the grab is global, then all mouse and keyboard
+events for windows outside the tree rooted at \fItkwin\fR (even those
+intended for windows in other applications) will be redirected to
+\fItkwin\fR. If the grab is application local, only mouse and
+keyboard events intended for a windows within the same application
+(but outside the tree rooted at \fItkwin\fR) will be redirected.
+.PP
+\fBTk_Grab\fR sets a grab on a particular window. \fITkwin\fR
+specifies the window on whose behalf the pointer is to be grabbed.
+\fIGrabGlobal\fR indicates whether the grab should be global or
+application local; if it is non-zero, it means the grab should be
+global. Normally, \fBTk_Grab\fR returns \fBTCL_OK\fR; if an error occurs
+and the grab cannot be set, \fBTCL_ERROR\fR is returned and an error message
+is left if \fIinterp\fR's result. Once this call completes
+successfully, no window outside the tree rooted at \fItkwin\fR will
+receive pointer- or keyboard-related events until the next call to
+Tk_Ungrab. If a previous grab was in effect within the application,
+then it is replaced with a new one.
+.PP
+\fBTcl_Ungrab\fR releases a grab on the mouse pointer and keyboard, if
+there is one set on the window given by \fItkwin\fR. Once a grab is
+released, pointer and keyboard events will start being delivered to
+other windows again.
+.SH KEYWORDS
+grab, window
diff --git a/doc/HWNDToWindow.3 b/doc/HWNDToWindow.3
index 0aab1ed..9e60bab 100644
--- a/doc/HWNDToWindow.3
+++ b/doc/HWNDToWindow.3
@@ -1,30 +1,28 @@
-'\"
-'\" Copyright (c) 1998-2000 by Scriptics Corporation.
-'\" All rights reserved.
-'\"
-'\" RCS: @(#) $Id: HWNDToWindow.3,v 1.2 2000/09/07 00:28:38 ericm Exp $
-'\"
-.so man.macros
-.TH Tk_HWNDToWindow 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_HWNDToWindow \- Find Tk's window information for a Windows window
-.SH SYNOPSIS
-.nf
-\fB#include <tkPlatDecls.h>\fR
-.sp
-Tk_Window
-\fBTk_HWNDToWindow\fR(\fIhwnd\fR)
-.SH ARGUMENTS
-.AP HWND hwnd in
-Windows handle for the window.
-.BE
-
-.SH DESCRIPTION
-.PP
-Given a Windows HWND window identifier, this procedure returns the
-corresponding Tk_Window handle. If there is no Tk_Window corresponding
-to \fIhwnd\fR then NULL is returned.
-
-.SH KEYWORDS
-Windows window id
+'\"
+'\" Copyright (c) 1998-2000 by Scriptics Corporation.
+'\" All rights reserved.
+'\"
+'\" RCS: @(#) $Id: HWNDToWindow.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_HWNDToWindow 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_HWNDToWindow \- Find Tk's window information for a Windows window
+.SH SYNOPSIS
+.nf
+\fB#include <tkPlatDecls.h>\fR
+.sp
+Tk_Window
+\fBTk_HWNDToWindow\fR(\fIhwnd\fR)
+.SH ARGUMENTS
+.AP HWND hwnd in
+Windows handle for the window.
+.BE
+.SH DESCRIPTION
+.PP
+Given a Windows HWND window identifier, this procedure returns the
+corresponding Tk_Window handle. If there is no Tk_Window corresponding
+to \fIhwnd\fR then NULL is returned.
+.SH KEYWORDS
+Windows window id
diff --git a/doc/HandleEvent.3 b/doc/HandleEvent.3
index ea461d5..69ed289 100644
--- a/doc/HandleEvent.3
+++ b/doc/HandleEvent.3
@@ -1,49 +1,47 @@
-'\"
-'\" Copyright (c) 1990-1992 The Regents of the University of California.
-'\" 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: HandleEvent.3,v 1.4 1999/04/21 21:53:22 rjohnson Exp $
-'\"
-.so man.macros
-.TH Tk_HandleEvent 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_HandleEvent \- invoke event handlers for window system events
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_HandleEvent\fR(\fIeventPtr\fR)
-.SH ARGUMENTS
-.AS XEvent *eventPtr
-.AP XEvent *eventPtr in
-Pointer to X event to dispatch to relevant handler(s).
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_HandleEvent\fR is a lower-level procedure that deals with window
-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 \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
-from a handler called by \fBTk_HandleEvent\fR. This sort
-of operation is useful in some modal situations, such
-as when a
-notifier has been popped up and an application wishes to
-wait for the user to click a button in the notifier before
-doing anything else.
-
-.SH KEYWORDS
-callback, event, handler, window
+'\"
+'\" Copyright (c) 1990-1992 The Regents of the University of California.
+'\" 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: HandleEvent.3,v 1.5 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_HandleEvent 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_HandleEvent \- invoke event handlers for window system events
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_HandleEvent\fR(\fIeventPtr\fR)
+.SH ARGUMENTS
+.AS XEvent *eventPtr
+.AP XEvent *eventPtr in
+Pointer to X event to dispatch to relevant handler(s).
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_HandleEvent\fR is a lower-level procedure that deals with window
+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 \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
+from a handler called by \fBTk_HandleEvent\fR. This sort
+of operation is useful in some modal situations, such
+as when a
+notifier has been popped up and an application wishes to
+wait for the user to click a button in the notifier before
+doing anything else.
+.SH KEYWORDS
+callback, event, handler, window
diff --git a/doc/IdToWindow.3 b/doc/IdToWindow.3
index 61146c8..b1cb5c3 100644
--- a/doc/IdToWindow.3
+++ b/doc/IdToWindow.3
@@ -1,36 +1,34 @@
-'\"
-'\" Copyright (c) 1995-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: IdToWindow.3,v 1.2 1998/09/14 18:22:52 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_IdToWindow 3 4.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_IdToWindow \- Find Tk's window information for an X window
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-Tk_Window
-\fBTk_IdToWindow\fR(\fIdisplay, window\fR)
-.SH ARGUMENTS
-.AS Tk_Window display
-.AP Display *display in
-X display containing the window.
-.AP Window window in
-X id for window.
-.BE
-
-.SH DESCRIPTION
-.PP
-Given an X window identifier and the X display it corresponds to,
-this procedure returns the corresponding Tk_Window handle.
-If there is no Tk_Window corresponding to \fIwindow\fR then
-NULL is returned.
-
-.SH KEYWORDS
-X window id
+'\"
+'\" Copyright (c) 1995-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: IdToWindow.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_IdToWindow 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_IdToWindow \- Find Tk's window information for an X window
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+Tk_Window
+\fBTk_IdToWindow\fR(\fIdisplay, window\fR)
+.SH ARGUMENTS
+.AS Tk_Window display
+.AP Display *display in
+X display containing the window.
+.AP Window window in
+X id for window.
+.BE
+.SH DESCRIPTION
+.PP
+Given an X window identifier and the X display it corresponds to,
+this procedure returns the corresponding Tk_Window handle.
+If there is no Tk_Window corresponding to \fIwindow\fR then
+NULL is returned.
+.SH KEYWORDS
+X window id
diff --git a/doc/ImgChanged.3 b/doc/ImgChanged.3
index bc4f9a4..99f24fd 100644
--- a/doc/ImgChanged.3
+++ b/doc/ImgChanged.3
@@ -1,69 +1,66 @@
-'\"
-'\" Copyright (c) 1994 The Regents of the University of California.
-'\" 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: ImgChanged.3,v 1.2 1998/09/14 18:22:52 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_ImageChanged 3 4.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_ImageChanged \- notify widgets that image needs to be redrawn
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_ImageChanged\fR(\fIimageMaster, x, y, width, height, imageWidth, imageHeight\fR)
-.SH ARGUMENTS
-.AS Tk_ImageMaster imageHeight
-.AP Tk_ImageMaster imageMaster in
-Token for image, which was passed to image's \fIcreateProc\fR when
-the image was created.
-.AP int x in
-X-coordinate of upper-left corner of region that needs redisplay (measured
-from upper-left corner of image).
-.AP int y in
-Y-coordinate of upper-left corner of region that needs redisplay (measured
-from upper-left corner of image).
-.AP "int" width in
-Width of region that needs to be redrawn, in pixels.
-.AP "int" height in
-Height of region that needs to be redrawn, in pixels.
-.AP "int" imageWidth in
-Current width of image, in pixels.
-.AP "int" imageHeight in
-Current height of image, in pixels.
-.BE
-
-.SH DESCRIPTION
-.PP
-An image manager calls \fBTk_ImageChanged\fR for an image
-whenever anything happens that requires the image to be redrawn.
-As a result of calling \fBTk_ImageChanged\fR, any widgets using
-the image are notified so that they can redisplay themselves
-appropriately.
-The \fIimageMaster\fR argument identifies the image, and
-\fIx\fR, \fIy\fR, \fIwidth\fR, and \fIheight\fR
-specify a rectangular region within the image that needs to
-be redrawn.
-\fIimageWidth\fR and \fIimageHeight\fR specify the image's (new) size.
-.PP
-An image manager should call \fBTk_ImageChanged\fR during
-its \fIcreateProc\fR to specify the image's initial size and to
-force redisplay if there are existing instances for the image.
-If any of the pixel values in the image should change later on,
-\fBTk_ImageChanged\fR should be called again with \fIx\fR, \fIy\fR,
-\fIwidth\fR, and \fIheight\fR values that cover all the pixels
-that changed.
-If the size of the image should change, then \fBTk_ImageChanged\fR
-must be called to indicate the new size, even if no pixels
-need to be redisplayed.
-
-.SH "SEE ALSO"
-Tk_CreateImageType
-
-.SH KEYWORDS
-images, redisplay, image size changes
+'\"
+'\" Copyright (c) 1994 The Regents of the University of California.
+'\" 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: ImgChanged.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_ImageChanged 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_ImageChanged \- notify widgets that image needs to be redrawn
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_ImageChanged\fR(\fIimageMaster, x, y, width, height, imageWidth, imageHeight\fR)
+.SH ARGUMENTS
+.AS Tk_ImageMaster imageHeight
+.AP Tk_ImageMaster imageMaster in
+Token for image, which was passed to image's \fIcreateProc\fR when
+the image was created.
+.AP int x in
+X-coordinate of upper-left corner of region that needs redisplay (measured
+from upper-left corner of image).
+.AP int y in
+Y-coordinate of upper-left corner of region that needs redisplay (measured
+from upper-left corner of image).
+.AP "int" width in
+Width of region that needs to be redrawn, in pixels.
+.AP "int" height in
+Height of region that needs to be redrawn, in pixels.
+.AP "int" imageWidth in
+Current width of image, in pixels.
+.AP "int" imageHeight in
+Current height of image, in pixels.
+.BE
+.SH DESCRIPTION
+.PP
+An image manager calls \fBTk_ImageChanged\fR for an image
+whenever anything happens that requires the image to be redrawn.
+As a result of calling \fBTk_ImageChanged\fR, any widgets using
+the image are notified so that they can redisplay themselves
+appropriately.
+The \fIimageMaster\fR argument identifies the image, and
+\fIx\fR, \fIy\fR, \fIwidth\fR, and \fIheight\fR
+specify a rectangular region within the image that needs to
+be redrawn.
+\fIimageWidth\fR and \fIimageHeight\fR specify the image's (new) size.
+.PP
+An image manager should call \fBTk_ImageChanged\fR during
+its \fIcreateProc\fR to specify the image's initial size and to
+force redisplay if there are existing instances for the image.
+If any of the pixel values in the image should change later on,
+\fBTk_ImageChanged\fR should be called again with \fIx\fR, \fIy\fR,
+\fIwidth\fR, and \fIheight\fR values that cover all the pixels
+that changed.
+If the size of the image should change, then \fBTk_ImageChanged\fR
+must be called to indicate the new size, even if no pixels
+need to be redisplayed.
+.SH "SEE ALSO"
+Tk_CreateImageType
+.SH KEYWORDS
+images, redisplay, image size changes
diff --git a/doc/Inactive.3 b/doc/Inactive.3
index f20d3f5..ff92175 100644
--- a/doc/Inactive.3
+++ b/doc/Inactive.3
@@ -2,7 +2,7 @@
'\" Copyright (c) 1998-2000 by Scriptics Corporation.
'\" All rights reserved.
'\"
-'\" RCS: @(#) $Id: Inactive.3,v 1.3 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: Inactive.3,v 1.4 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_GetUserInactiveTime 3 8.5 Tk "Tk Library Procedures"
@@ -23,7 +23,6 @@ long
The display on which the user inactivity timer is to be queried or
reset.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_GetUserInactiveTime\fR returns the number of milliseconds that
@@ -33,6 +32,5 @@ support querying the user inactiviy time, \fB\-1\fR is returned.
\fBTk_GetUserInactiveTime\fR resets the user inactivity timer of the
given display to zero. On windowing systems that do not support
multiple displays \fIdisplay\fR can be passed as \fBNULL\fR.
-
.SH KEYWORDS
idle, inactive
diff --git a/doc/InternAtom.3 b/doc/InternAtom.3
index 5d2ff0b..5800ff0 100644
--- a/doc/InternAtom.3
+++ b/doc/InternAtom.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: InternAtom.3,v 1.9 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: InternAtom.3,v 1.10 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_InternAtom 3 "" Tk "Tk Library Procedures"
@@ -30,7 +30,6 @@ String name for which atom is desired.
.AP Atom atom in
Atom for which corresponding string name is desired.
.BE
-
.SH DESCRIPTION
.PP
These procedures are similar to the Xlib procedures
@@ -54,6 +53,5 @@ for the same information can be serviced from the cache without
contacting the server. Thus \fBTk_InternAtom\fR and \fBTk_GetAtomName\fR
are generally much faster than their Xlib counterparts, and they
should be used in place of the Xlib procedures.
-
.SH KEYWORDS
atom, cache, display
diff --git a/doc/MainLoop.3 b/doc/MainLoop.3
index de6dbe5..0b7f39d 100644
--- a/doc/MainLoop.3
+++ b/doc/MainLoop.3
@@ -1,32 +1,30 @@
-'\"
-'\" Copyright (c) 1990-1992 The Regents of the University of California.
-'\" 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: MainLoop.3,v 1.2 1998/09/14 18:22:52 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_MainLoop 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_MainLoop \- loop for events until all windows are deleted
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_MainLoop\fR()
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_MainLoop\fR is a procedure that loops repeatedly calling
-\fBTcl_DoOneEvent\fR. It returns only when there are no applications
-left in this process (i.e. no main windows exist anymore). Most
-windowing applications will call \fBTk_MainLoop\fR after
-initialization; the main execution of the application will consist
-entirely of callbacks invoked via \fBTcl_DoOneEvent\fR.
-
-.SH KEYWORDS
-application, event, main loop
+'\"
+'\" Copyright (c) 1990-1992 The Regents of the University of California.
+'\" 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: MainLoop.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_MainLoop 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_MainLoop \- loop for events until all windows are deleted
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_MainLoop\fR()
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_MainLoop\fR is a procedure that loops repeatedly calling
+\fBTcl_DoOneEvent\fR. It returns only when there are no applications
+left in this process (i.e. no main windows exist anymore). Most
+windowing applications will call \fBTk_MainLoop\fR after
+initialization; the main execution of the application will consist
+entirely of callbacks invoked via \fBTcl_DoOneEvent\fR.
+.SH KEYWORDS
+application, event, main loop
diff --git a/doc/MainWin.3 b/doc/MainWin.3
index b878cb0..93f0190 100644
--- a/doc/MainWin.3
+++ b/doc/MainWin.3
@@ -1,46 +1,43 @@
-'\"
-'\" Copyright (c) 1990 The Regents of the University of California.
-'\" 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: MainWin.3,v 1.3 2000/04/25 01:42:18 ericm Exp $
-'\"
-.so man.macros
-.TH Tk_MainWindow 3 7.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_MainWindow, Tk_GetNumMainWindows \- functions for querying main
-window information
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-Tk_Window
-\fBTk_MainWindow\fR(\fIinterp\fR)
-.sp
-int
-\fBTk_GetNumMainWindows\fR()
-
-.SH ARGUMENTS
-.AS Tcl_Interp *pathName
-.AP Tcl_Interp *interp in/out
-Interpreter associated with the application.
-.BE
-
-.SH DESCRIPTION
-.PP
-A main window is a special kind of toplevel window used as the
-outermost window in an application.
-.PP
-If \fIinterp\fR is associated with a Tk application then \fBTk_MainWindow\fR
-returns the application's main window. If there is no Tk application
-associated with \fIinterp\fR then \fBTk_MainWindow\fR returns NULL and
-leaves an error message in \fIinterp->result\fR.
-.PP
-\fBTk_GetNumMainWindows\fR returns a count of the number of main
-windows currently open in the process.
-
-.SH KEYWORDS
-application, main window
+'\"
+'\" Copyright (c) 1990 The Regents of the University of California.
+'\" 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: MainWin.3,v 1.4 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_MainWindow 3 7.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_MainWindow, Tk_GetNumMainWindows \- functions for querying main
+window information
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+Tk_Window
+\fBTk_MainWindow\fR(\fIinterp\fR)
+.sp
+int
+\fBTk_GetNumMainWindows\fR()
+.SH ARGUMENTS
+.AS Tcl_Interp *pathName
+.AP Tcl_Interp *interp in/out
+Interpreter associated with the application.
+.BE
+.SH DESCRIPTION
+.PP
+A main window is a special kind of toplevel window used as the
+outermost window in an application.
+.PP
+If \fIinterp\fR is associated with a Tk application then \fBTk_MainWindow\fR
+returns the application's main window. If there is no Tk application
+associated with \fIinterp\fR then \fBTk_MainWindow\fR returns NULL and
+leaves an error message in \fIinterp->result\fR.
+.PP
+\fBTk_GetNumMainWindows\fR returns a count of the number of main
+windows currently open in the process.
+.SH KEYWORDS
+application, main window
diff --git a/doc/MaintGeom.3 b/doc/MaintGeom.3
index d6c32e9..0027064 100644
--- a/doc/MaintGeom.3
+++ b/doc/MaintGeom.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: MaintGeom.3,v 1.5 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: MaintGeom.3,v 1.6 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_MaintainGeometry 3 4.0 Tk "Tk Library Procedures"
@@ -38,7 +38,6 @@ Desired width for \fIslave\fR, in pixels.
.AP int height in
Desired height for \fIslave\fR, in pixels.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_MaintainGeometry\fR and \fBTk_UnmaintainGeometry\fR make it
diff --git a/doc/ManageGeom.3 b/doc/ManageGeom.3
index 55e2333..272a220 100644
--- a/doc/ManageGeom.3
+++ b/doc/ManageGeom.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: ManageGeom.3,v 1.6 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: ManageGeom.3,v 1.7 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_ManageGeometry 3 4.0 Tk "Tk Library Procedures"
@@ -47,7 +47,7 @@ typedef struct {
const char *\fIname\fR;
Tk_GeomRequestProc *\fIrequestProc\fR;
Tk_GeomLostSlaveProc *\fIlostSlaveProc\fR;
-} Tk_GeomMgr;
+} \fBTk_GeomMgr\fR;
.CE
The \fIname\fR field is the textual name for the geometry manager,
such as \fBpack\fR or \fBplace\fR; this value will be returned
@@ -59,9 +59,9 @@ slave to change its desired geometry.
\fIrequestProc\fR should have arguments and results that match the
type \fBTk_GeomRequestProc\fR:
.CS
-typedef void Tk_GeomRequestProc(
- ClientData \fIclientData\fR,
- Tk_Window \fItkwin\fR);
+typedef void \fBTk_GeomRequestProc\fR(
+ ClientData \fIclientData\fR,
+ Tk_Window \fItkwin\fR);
.CE
The parameters to \fIrequestProc\fR will be identical to the
corresponding parameters passed to \fBTk_ManageGeometry\fR.
@@ -82,12 +82,11 @@ is the same as the window's current geometry manager.
\fIlostSlaveProc\fR should have
arguments and results that match the following prototype:
.CS
-typedef void Tk_GeomLostSlaveProc(
- ClientData \fIclientData\fR,
- Tk_Window \fItkwin\fR);
+typedef void \fBTk_GeomLostSlaveProc\fR(
+ ClientData \fIclientData\fR,
+ Tk_Window \fItkwin\fR);
.CE
The parameters to \fIlostSlaveProc\fR will be identical to the
corresponding parameters passed to \fBTk_ManageGeometry\fR.
-
.SH KEYWORDS
callback, geometry, managed, request, unmanaged
diff --git a/doc/MapWindow.3 b/doc/MapWindow.3
index dbebe7c..a0094ae 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.6 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: MapWindow.3,v 1.7 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_MapWindow 3 "" Tk "Tk Library Procedures"
@@ -25,7 +25,6 @@ Tk_Window
.AP Tk_Window tkwin in
Token for window.
.BE
-
.SH DESCRIPTION
.PP
These procedures may be used to map and unmap windows
@@ -48,6 +47,5 @@ These procedures should be used in place of the X procedures
Tk's local data structure for \fItkwin\fR. Applications
using Tk should not invoke \fBXMapWindow\fR and \fBXUnmapWindow\fR
directly.
-
.SH KEYWORDS
map, unmap, window
diff --git a/doc/MoveToplev.3 b/doc/MoveToplev.3
index a7ae554..50d5aa7 100644
--- a/doc/MoveToplev.3
+++ b/doc/MoveToplev.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: MoveToplev.3,v 1.4 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: MoveToplev.3,v 1.5 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_MoveToplevelWindow 3 "" Tk "Tk Library Procedures"
@@ -30,7 +30,6 @@ New y-coordinate for the top-left pixel of \fItkwin\fR's border, or the
top-left pixel of the decorative border supplied for \fItkwin\fR by the
window manager, if there is one.
.BE
-
.SH DESCRIPTION
.PP
In general, a window should never set its own position; this should be
@@ -50,6 +49,5 @@ When \fBTk_MoveToplevelWindow\fR is called it does not immediately
pass on the new desired location to the window manager; it defers
this action until all other outstanding work has been completed,
using the \fBTk_DoWhenIdle\fR mechanism.
-
.SH KEYWORDS
position, top-level window, window manager
diff --git a/doc/Name.3 b/doc/Name.3
index f642b17..16f03a8 100644
--- a/doc/Name.3
+++ b/doc/Name.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: Name.3,v 1.9 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: Name.3,v 1.10 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_Name 3 "" Tk "Tk Library Procedures"
@@ -33,7 +33,6 @@ Interpreter to use for error reporting.
.AP "const char" *pathName in
Character string containing path name of window.
.BE
-
.SH DESCRIPTION
.PP
Each window managed by Tk has two names, a short name that identifies
@@ -85,6 +84,5 @@ two main windows, each will have a separate naming hierarchy and the
same path name might appear in each of the hierarchies. Normally
\fItkwin\fR is the main window of the desired hierarchy, but this
need not be the case: any window in the desired hierarchy may be used.
-
.SH KEYWORDS
name, path name, token, window
diff --git a/doc/NameOfImg.3 b/doc/NameOfImg.3
index 9553318..cc35f68 100644
--- a/doc/NameOfImg.3
+++ b/doc/NameOfImg.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: NameOfImg.3,v 1.4 2007/01/05 00:00:49 nijtmans Exp $
+'\" RCS: @(#) $Id: NameOfImg.3,v 1.5 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_NameOfImage 3 4.0 Tk "Tk Library Procedures"
@@ -23,12 +23,10 @@ const char *
Token for image, which was passed to image manager's \fIcreateProc\fR when
the image was created.
.BE
-
.SH DESCRIPTION
.PP
This procedure is invoked by image managers to find out the name
of an image. Given the token for the image, it returns the
string name for the image.
-
.SH KEYWORDS
image manager, image name
diff --git a/doc/OwnSelect.3 b/doc/OwnSelect.3
index 0cd541c..98d9fb5 100644
--- a/doc/OwnSelect.3
+++ b/doc/OwnSelect.3
@@ -1,52 +1,51 @@
-'\"
-'\" Copyright (c) 1990-1994 The Regents of the University of California.
-'\" 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: OwnSelect.3,v 1.2 1998/09/14 18:22:53 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_OwnSelection 3 4.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_OwnSelection \- make a window the owner of the primary selection
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_OwnSelection\fR(\fItkwin, selection, proc, clientData\fR)
-.SH ARGUMENTS
-.AS Tk_LostSelProc clientData
-.AP Tk_Window tkwin in
-Window that is to become new selection owner.
-.AP Atom selection in
-The name of the selection to be owned, such as XA_PRIMARY.
-.AP Tk_LostSelProc *proc in
-Procedure to invoke when \fItkwin\fR loses selection ownership later.
-.AP ClientData clientData in
-Arbitrary one-word value to pass to \fIproc\fR.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_OwnSelection\fR arranges for \fItkwin\fR to become the
-new owner of the selection specified by the atom
-\fIselection\fR. After this call completes, future requests
-for the selection will be directed to handlers created for
-\fItkwin\fR using \fBTk_CreateSelHandler\fR. When \fItkwin\fR
-eventually loses the selection ownership, \fIproc\fR will be
-invoked so that the window can clean itself up (e.g. by
-unhighlighting the selection). \fIProc\fR should have arguments and
-result that match the type \fBTk_LostSelProc\fR:
-.CS
-typedef void Tk_LostSelProc(ClientData \fIclientData\fR);
-.CE
-The \fIclientData\fR parameter to \fIproc\fR is a copy of the
-\fIclientData\fR argument given to \fBTk_OwnSelection\fR, and is
-usually a pointer to a data structure containing application-specific
-information about \fItkwin\fR.
-
-.SH KEYWORDS
-own, selection owner
+'\"
+'\" Copyright (c) 1990-1994 The Regents of the University of California.
+'\" 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: OwnSelect.3,v 1.3 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_OwnSelection 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_OwnSelection \- make a window the owner of the primary selection
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_OwnSelection\fR(\fItkwin, selection, proc, clientData\fR)
+.SH ARGUMENTS
+.AS Tk_LostSelProc clientData
+.AP Tk_Window tkwin in
+Window that is to become new selection owner.
+.AP Atom selection in
+The name of the selection to be owned, such as XA_PRIMARY.
+.AP Tk_LostSelProc *proc in
+Procedure to invoke when \fItkwin\fR loses selection ownership later.
+.AP ClientData clientData in
+Arbitrary one-word value to pass to \fIproc\fR.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_OwnSelection\fR arranges for \fItkwin\fR to become the
+new owner of the selection specified by the atom
+\fIselection\fR. After this call completes, future requests
+for the selection will be directed to handlers created for
+\fItkwin\fR using \fBTk_CreateSelHandler\fR. When \fItkwin\fR
+eventually loses the selection ownership, \fIproc\fR will be
+invoked so that the window can clean itself up (e.g. by
+unhighlighting the selection). \fIProc\fR should have arguments and
+result that match the type \fBTk_LostSelProc\fR:
+.CS
+typedef void \fBTk_LostSelProc\fR(
+ ClientData \fIclientData\fR);
+.CE
+The \fIclientData\fR parameter to \fIproc\fR is a copy of the
+\fIclientData\fR argument given to \fBTk_OwnSelection\fR, and is
+usually a pointer to a data structure containing application-specific
+information about \fItkwin\fR.
+.SH KEYWORDS
+own, selection owner
diff --git a/doc/ParseArgv.3 b/doc/ParseArgv.3
index 7b81477..b5db646 100644
--- a/doc/ParseArgv.3
+++ b/doc/ParseArgv.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: ParseArgv.3,v 1.10 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: ParseArgv.3,v 1.11 2008/06/30 22:57:01 dkf Exp $
'\"
.so man.macros
.TH Tk_ParseArgv 3 "" Tk "Tk Library Procedures"
@@ -77,7 +77,7 @@ typedef struct {
char *\fIsrc\fR;
char *\fIdst\fR;
char *\fIhelp\fR;
-} Tk_ArgvInfo;
+} \fBTk_ArgvInfo\fR;
.CE
The \fIkey\fR field is a string such as
.QW \-display
@@ -265,7 +265,7 @@ an error then it should leave an error message in \fIinterp->result\fR,
in the usual Tcl fashion, and return \-1; when this happens
\fBTk_ParseArgv\fR will abort its processing and return \fBTCL_ERROR\fR.
.RE
-.SH "FLAGS"
+.SS "FLAGS"
.TP
\fBTK_ARGV_DONT_SKIP_FIRST_ARG\fR
\fBTk_ParseArgv\fR normally treats \fIargv[0]\fR as a program
diff --git a/doc/QWinEvent.3 b/doc/QWinEvent.3
index 15492dc..1117b86 100644
--- a/doc/QWinEvent.3
+++ b/doc/QWinEvent.3
@@ -1,53 +1,51 @@
-'\"
-'\" Copyright (c) 1995-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: QWinEvent.3,v 1.3 2002/06/15 00:21:42 hobbs Exp $
-'\"
-.so man.macros
-.TH Tk_QueueWindowEvent 3 7.5 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_CollapseMotionEvents, Tk_QueueWindowEvent \- Add a window event to the Tcl event queue
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-int
-\fBTk_CollapseMotionEvents\fR(\fIdisplay, collapse\fR)
-.sp
-\fBTk_QueueWindowEvent\fR(\fIeventPtr, position\fR)
-.SH ARGUMENTS
-.AS Tcl_QueuePosition position
-.AP Display *display in
-Display for which to control motion event collapsing.
-.AP int collapse in
-Indicates whether motion events should be collapsed or not.
-.AP XEvent *eventPtr in
-An event to add to the event queue.
-.AP Tcl_QueuePosition position in
-Where to add the new event in the queue: \fBTCL_QUEUE_TAIL\fR,
-\fBTCL_QUEUE_HEAD\fR, or \fBTCL_QUEUE_MARK\fR.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_QueueWindowEvent\fR places a window event on Tcl's internal event
-queue for eventual servicing. It creates a Tcl_Event structure, copies the
-event into that structure, and calls \fBTcl_QueueEvent\fR to add the event
-to the queue. When the event is eventually removed from the queue it is
-processed just like all window events.
-.PP
-When multiple motion events are received for the same window in rapid
-succession, they are collapsed by default. This behavior can be controlled
-with \fBTk_CollapseMotionEvents\fR. \fBTk_CollapseMotionEvents\fR always
-returns the previous value for collapse behavior on the \fIdisplay\fR.
-.PP
-The \fIposition\fR argument to \fBTk_QueueWindowEvent\fR has
-the same significance as for \fBTcl_QueueEvent\fR; see the
-documentation for \fBTcl_QueueEvent\fR for details.
-
-.SH KEYWORDS
-callback, clock, handler, modal timeout, events
+'\"
+'\" Copyright (c) 1995-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: QWinEvent.3,v 1.4 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_QueueWindowEvent 3 7.5 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_CollapseMotionEvents, Tk_QueueWindowEvent \- Add a window event to the Tcl event queue
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+int
+\fBTk_CollapseMotionEvents\fR(\fIdisplay, collapse\fR)
+.sp
+\fBTk_QueueWindowEvent\fR(\fIeventPtr, position\fR)
+.SH ARGUMENTS
+.AS Tcl_QueuePosition position
+.AP Display *display in
+Display for which to control motion event collapsing.
+.AP int collapse in
+Indicates whether motion events should be collapsed or not.
+.AP XEvent *eventPtr in
+An event to add to the event queue.
+.AP Tcl_QueuePosition position in
+Where to add the new event in the queue: \fBTCL_QUEUE_TAIL\fR,
+\fBTCL_QUEUE_HEAD\fR, or \fBTCL_QUEUE_MARK\fR.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_QueueWindowEvent\fR places a window event on Tcl's internal event
+queue for eventual servicing. It creates a Tcl_Event structure, copies the
+event into that structure, and calls \fBTcl_QueueEvent\fR to add the event
+to the queue. When the event is eventually removed from the queue it is
+processed just like all window events.
+.PP
+When multiple motion events are received for the same window in rapid
+succession, they are collapsed by default. This behavior can be controlled
+with \fBTk_CollapseMotionEvents\fR. \fBTk_CollapseMotionEvents\fR always
+returns the previous value for collapse behavior on the \fIdisplay\fR.
+.PP
+The \fIposition\fR argument to \fBTk_QueueWindowEvent\fR has
+the same significance as for \fBTcl_QueueEvent\fR; see the
+documentation for \fBTcl_QueueEvent\fR for details.
+.SH KEYWORDS
+callback, clock, handler, modal timeout, events
diff --git a/doc/Restack.3 b/doc/Restack.3
index 6f8024e..a0a6350 100644
--- a/doc/Restack.3
+++ b/doc/Restack.3
@@ -1,49 +1,47 @@
-'\"
-'\" Copyright (c) 1990 The Regents of the University of California.
-'\" 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: Restack.3,v 1.2 1998/09/14 18:22:53 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_RestackWindow 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_RestackWindow \- Change a window's position in the stacking order
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-int
-\fBTk_RestackWindow\fR(\fItkwin, aboveBelow, other\fR)
-.SH ARGUMENTS
-.AS Tk_Window aboveBelow
-.AP Tk_Window tkwin in
-Token for window to restack.
-.AP int aboveBelow in
-Indicates new position of \fItkwin\fR relative to \fIother\fR;
-must be \fBAbove\fR or \fBBelow\fR.
-.AP Tk_Window other in
-\fITkwin\fR will be repositioned just above or below this window.
-Must be a sibling of \fItkwin\fR or a descendant of a sibling.
-If NULL then \fItkwin\fR is restacked above or below all siblings.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_RestackWindow\fR changes the stacking order of \fIwindow\fR relative
-to its siblings.
-If \fIother\fR is specified as NULL then \fIwindow\fR is repositioned
-at the top or bottom of its stacking order, depending on whether
-\fIaboveBelow\fR is \fBAbove\fR or \fBBelow\fR.
-If \fIother\fR has a non-NULL value then \fIwindow\fR is repositioned
-just above or below \fIother\fR.
-.PP
-The \fIaboveBelow\fR argument must have one of the symbolic values
-\fBAbove\fR or \fBBelow\fR.
-Both of these values are defined by the include file <X11/Xlib.h>.
-
-.SH KEYWORDS
-above, below, obscure, stacking order
+'\"
+'\" Copyright (c) 1990 The Regents of the University of California.
+'\" 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: Restack.3,v 1.3 2008/06/30 22:57:02 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_RestackWindow 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_RestackWindow \- Change a window's position in the stacking order
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+int
+\fBTk_RestackWindow\fR(\fItkwin, aboveBelow, other\fR)
+.SH ARGUMENTS
+.AS Tk_Window aboveBelow
+.AP Tk_Window tkwin in
+Token for window to restack.
+.AP int aboveBelow in
+Indicates new position of \fItkwin\fR relative to \fIother\fR;
+must be \fBAbove\fR or \fBBelow\fR.
+.AP Tk_Window other in
+\fITkwin\fR will be repositioned just above or below this window.
+Must be a sibling of \fItkwin\fR or a descendant of a sibling.
+If NULL then \fItkwin\fR is restacked above or below all siblings.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_RestackWindow\fR changes the stacking order of \fIwindow\fR relative
+to its siblings.
+If \fIother\fR is specified as NULL then \fIwindow\fR is repositioned
+at the top or bottom of its stacking order, depending on whether
+\fIaboveBelow\fR is \fBAbove\fR or \fBBelow\fR.
+If \fIother\fR has a non-NULL value then \fIwindow\fR is repositioned
+just above or below \fIother\fR.
+.PP
+The \fIaboveBelow\fR argument must have one of the symbolic values
+\fBAbove\fR or \fBBelow\fR.
+Both of these values are defined by the include file <X11/Xlib.h>.
+.SH KEYWORDS
+above, below, obscure, stacking order
diff --git a/doc/RestrictEv.3 b/doc/RestrictEv.3
index 6d2abbb..03907a6 100644
--- a/doc/RestrictEv.3
+++ b/doc/RestrictEv.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: RestrictEv.3,v 1.7 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: RestrictEv.3,v 1.8 2008/06/30 22:57:02 dkf Exp $
'\"
.so man.macros
.TH Tk_RestrictEvents 3 "" Tk "Tk Library Procedures"
@@ -28,7 +28,6 @@ Arbitrary argument to pass to \fIproc\fR.
.AP ClientData *prevClientDataPtr out
Pointer to place to save argument to previous restrict procedure.
.BE
-
.SH DESCRIPTION
.PP
This procedure is useful in certain situations where applications
@@ -42,9 +41,9 @@ later time (e.g. when the event restriction is lifted), or discarded.
is a procedure with arguments and result that match
the type \fBTk_RestrictProc\fR:
.CS
-typedef Tk_RestrictAction Tk_RestrictProc(
- ClientData \fIclientData\fR,
- XEvent *\fIeventPtr\fR);
+typedef Tk_RestrictAction \fBTk_RestrictProc\fR(
+ ClientData \fIclientData\fR,
+ XEvent *\fIeventPtr\fR);
.CE
The \fIclientData\fR argument is a copy of the \fIclientData\fR passed
to \fBTk_RestrictEvents\fR; it may be used to provide \fIproc\fR with
diff --git a/doc/SetAppName.3 b/doc/SetAppName.3
index 441a391..4182ed0 100644
--- a/doc/SetAppName.3
+++ b/doc/SetAppName.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: SetAppName.3,v 1.8 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: SetAppName.3,v 1.9 2008/06/30 22:57:02 dkf Exp $
'\"
.so man.macros
.TH Tk_SetAppName 3 4.0 Tk "Tk Library Procedures"
@@ -26,7 +26,6 @@ application.
.AP "const char" *name in
Name under which to register the application.
.BE
-
.SH DESCRIPTION
.PP
\fBTk_SetAppName\fR associates a name with a given application and
@@ -61,6 +60,5 @@ so applications do not normally need to call it explicitly.
.PP
The command \fBtk appname\fR provides Tcl-level access to the
functionality of \fBTk_SetAppName\fR.
-
.SH KEYWORDS
application, name, register, send command
diff --git a/doc/SetCaret.3 b/doc/SetCaret.3
index b5bd901..298387b 100644
--- a/doc/SetCaret.3
+++ b/doc/SetCaret.3
@@ -1,40 +1,38 @@
-'\"
-'\" Copyright (c) 2002 ActiveState Corporation.
-'\"
-'\" See the file "license.terms" for information on usage and redistribution
-'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
-'\"
-'\" RCS: @(#) $Id: SetCaret.3,v 1.1 2002/06/17 20:09:01 hobbs Exp $
-'\"
-.so man.macros
-.TH Tk_SetCaretPos 3 8.4 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_SetCaretPos \- set the display caret location
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-int
-\fBTk_SetCaretPos\fR(\fItkwin, x, y, height\fR)
-.SH ARGUMENTS
-.AP Tk_Window tkwin in
-Token for window.
-.AP int x in
-Window-relative x coordinate.
-.AP int y in
-Window-relative y coordinate.
-.AP int h in
-Height of the caret in the window.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_SetCaretPos\fR sets the caret location for the display of the
-specified Tk_Window \fItkwin\fR. The caret is the per-display cursor
-location used for indicating global focus (e.g. to comply with Microsoft
-Accessibility guidelines), as well as for location of the over-the-spot XIM
-(X Input Methods) or Windows IME windows.
-
-.SH KEYWORDS
-caret, cursor
+'\"
+'\" Copyright (c) 2002 ActiveState Corporation.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" RCS: @(#) $Id: SetCaret.3,v 1.2 2008/06/30 22:57:02 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_SetCaretPos 3 8.4 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_SetCaretPos \- set the display caret location
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+int
+\fBTk_SetCaretPos\fR(\fItkwin, x, y, height\fR)
+.SH ARGUMENTS
+.AP Tk_Window tkwin in
+Token for window.
+.AP int x in
+Window-relative x coordinate.
+.AP int y in
+Window-relative y coordinate.
+.AP int h in
+Height of the caret in the window.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_SetCaretPos\fR sets the caret location for the display of the
+specified Tk_Window \fItkwin\fR. The caret is the per-display cursor
+location used for indicating global focus (e.g. to comply with Microsoft
+Accessibility guidelines), as well as for location of the over-the-spot XIM
+(X Input Methods) or Windows IME windows.
+.SH KEYWORDS
+caret, cursor
diff --git a/doc/SetClass.3 b/doc/SetClass.3
index 68a21a1..ad3d4ce 100644
--- a/doc/SetClass.3
+++ b/doc/SetClass.3
@@ -1,61 +1,59 @@
-'\"
-'\" Copyright (c) 1990 The Regents of the University of California.
-'\" 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: SetClass.3,v 1.2 1998/09/14 18:22:53 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_SetClass 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_SetClass, Tk_Class \- set or retrieve a window's class
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_SetClass\fR(\fItkwin, class\fR)
-.sp
-Tk_Uid
-\fBTk_Class\fR(\fItkwin\fR)
-.SH ARGUMENTS
-.AS Tk_Window parent
-.AP Tk_Window tkwin in
-Token for window.
-.AP char *class in
-New class name for window.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_SetClass\fR is called to associate a class with a particular
-window. The \fIclass\fR string identifies the type of the
-window; all windows with the same general class of behavior
-(button, menu, etc.) should have the same class. By
-convention all class names start with a capital letter, and
-there exists a Tcl command with the same name as
-each class (except all in lower-case) which can be used to
-create and manipulate windows of that class.
-A window's class string is initialized to NULL
-when the window is created.
-.PP
-For main windows, Tk automatically propagates the name and class
-to the WM_CLASS property used by window managers. This happens
-either when a main window is actually created (e.g. in
-\fBTk_MakeWindowExist\fR), or when \fBTk_SetClass\fR
-is called, whichever occurs later. If a main window has not been
-assigned a class then Tk will not set the WM_CLASS property for
-the window.
-.PP
-\fBTk_Class\fR is a macro that returns the
-current value of \fItkwin\fR's class. The value is returned
-as a Tk_Uid, which may be used just like a string pointer but also has
-the properties of a unique identifier (see the manual entry for
-\fBTk_GetUid\fR for details).
-If \fItkwin\fR has not yet been given a class, then
-\fBTk_Class\fR will return NULL.
-
-.SH KEYWORDS
-class, unique identifier, window, window manager
+'\"
+'\" Copyright (c) 1990 The Regents of the University of California.
+'\" 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: SetClass.3,v 1.3 2008/06/30 22:57:02 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_SetClass 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_SetClass, Tk_Class \- set or retrieve a window's class
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_SetClass\fR(\fItkwin, class\fR)
+.sp
+Tk_Uid
+\fBTk_Class\fR(\fItkwin\fR)
+.SH ARGUMENTS
+.AS Tk_Window parent
+.AP Tk_Window tkwin in
+Token for window.
+.AP char *class in
+New class name for window.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_SetClass\fR is called to associate a class with a particular
+window. The \fIclass\fR string identifies the type of the
+window; all windows with the same general class of behavior
+(button, menu, etc.) should have the same class. By
+convention all class names start with a capital letter, and
+there exists a Tcl command with the same name as
+each class (except all in lower-case) which can be used to
+create and manipulate windows of that class.
+A window's class string is initialized to NULL
+when the window is created.
+.PP
+For main windows, Tk automatically propagates the name and class
+to the WM_CLASS property used by window managers. This happens
+either when a main window is actually created (e.g. in
+\fBTk_MakeWindowExist\fR), or when \fBTk_SetClass\fR
+is called, whichever occurs later. If a main window has not been
+assigned a class then Tk will not set the WM_CLASS property for
+the window.
+.PP
+\fBTk_Class\fR is a macro that returns the
+current value of \fItkwin\fR's class. The value is returned
+as a Tk_Uid, which may be used just like a string pointer but also has
+the properties of a unique identifier (see the manual entry for
+\fBTk_GetUid\fR for details).
+If \fItkwin\fR has not yet been given a class, then
+\fBTk_Class\fR will return NULL.
+.SH KEYWORDS
+class, unique identifier, window, window manager
diff --git a/doc/SetClassProcs.3 b/doc/SetClassProcs.3
index a9edef3..85a98d8 100644
--- a/doc/SetClassProcs.3
+++ b/doc/SetClassProcs.3
@@ -1,91 +1,89 @@
-'\"
-'\" Copyright (c) 2000 Ajuba Solutions.
-'\"
-'\" See the file "license.terms" for information on usage and redistribution
-'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
-'\"
-'\" RCS: @(#) $Id: SetClassProcs.3,v 1.3 2004/09/19 16:05:36 dkf Exp $
-'\"
-.so man.macros
-.TH Tk_SetClassProcs 3 8.4 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_SetClassProcs \- register widget specific procedures
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_SetClassProcs\fR(\fItkwin, procs, instanceData\fR)
-.SH ARGUMENTS
-.AS Tk_ClassProc instanceData
-.AP Tk_Window tkwin in
-Token for window to modify.
-.AP Tk_ClassProcs *procs in
-Pointer to data structure containing widget specific procedures.
-The data structure pointed to by \fIprocs\fR must be static:
-Tk keeps a reference to it as long as the window exists.
-.AP ClientData instanceData in
-Arbitrary one-word value to pass to widget callbacks.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_SetClassProcs\fR is called to register a set of procedures that
-are used as callbacks in different places.
-.PP
-The structure pointed to by \fIprocs\fR contains the following:
-.CS
-typedef struct Tk_ClassProcs {
- unsigned int \fIsize\fR;
- Tk_ClassWorldChangedProc *\fIworldChangedProc\fR;
- Tk_ClassCreateProc *\fIcreateProc\fR;
- Tk_ClassModalProc *\fImodalProc\fR;
-} Tk_ClassProcs;
-.CE
-The \fIsize\fR field is used to simplify future expansion of the
-structure. It should always be set to (literally) \fBsizeof(Tk_ClassProcs)\fR.
-.PP
-\fIworldChangedProc\fR is invoked when the system has altered
-in some way that requires some reaction from the widget. For example,
-when a font alias (see the \fBfont\fR manual entry) is reconfigured,
-widgets configured to use that font alias must update their display
-accordingly. \fIworldChangedProc\fR should have arguments and results
-that match the type \fBTk_ClassWorldChangedProc\fR:
-.CS
-typedef void Tk_ClassWorldChangedProc(
- ClientData \fIinstanceData\fR);
-.CE
-The \fIinstanceData\fR parameter passed to the \fIworldChangedProc\fR
-will be identical to the \fIinstanceData\fR parameter passed to
-\fBTk_SetClassProcs\fR.
-.PP
-\fIcreateProc\fR is used to create platform-dependant windows. It is
-invoked by \fBTk_MakeWindowExist\fR. \fIcreateProc\fR should have
-arguments and results that match the type \fBTk_ClassCreateProc\fR:
-.CS
-typedef Window Tk_ClassCreateProc(
- Tk_Window \fItkwin\fR,
- Window \fIparent\fR,
- ClientData \fIinstanceData\fR);
-.CE
-The \fItkwin\fR and \fIinstanceData\fR parameters will be identical to
-the \fItkwin\fR and \fIinstanceData\fR parameters passed to
-\fBTk_SetClassProcs\fR. The \fIparent\fR parameter will be the parent
-of the window to be created. The \fIcreateProc\fR should return the
-created window.
-.PP
-\fImodalProc\fR is invoked after all bindings on a widget have been
-triggered in order to handle a modal loop. \fImodalProc\fR should
-have arguments and results that match the type \fBTk_ClassModalProc\fR:
-.CS
-typedef void Tk_ClassModalProc(
- Tk_Window \fItkwin\fR,
- XEvent *\fIeventPtr\fR);
-.CE
-The \fItkwin\fR parameter to \fImodalProc\fR will be identical to the
-\fItkwin\fR parameter passed to \fBTk_SetClassProcs\fR. The
-\fIeventPtr\fR parameter will be a pointer to an XEvent structure
-describing the event being processed.
-
-.SH KEYWORDS
-callback, class
+'\"
+'\" Copyright (c) 2000 Ajuba Solutions.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" RCS: @(#) $Id: SetClassProcs.3,v 1.4 2008/06/30 22:57:02 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_SetClassProcs 3 8.4 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_SetClassProcs \- register widget specific procedures
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_SetClassProcs\fR(\fItkwin, procs, instanceData\fR)
+.SH ARGUMENTS
+.AS Tk_ClassProc instanceData
+.AP Tk_Window tkwin in
+Token for window to modify.
+.AP Tk_ClassProcs *procs in
+Pointer to data structure containing widget specific procedures.
+The data structure pointed to by \fIprocs\fR must be static:
+Tk keeps a reference to it as long as the window exists.
+.AP ClientData instanceData in
+Arbitrary one-word value to pass to widget callbacks.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_SetClassProcs\fR is called to register a set of procedures that
+are used as callbacks in different places.
+.PP
+The structure pointed to by \fIprocs\fR contains the following:
+.CS
+typedef struct Tk_ClassProcs {
+ unsigned int \fIsize\fR;
+ Tk_ClassWorldChangedProc *\fIworldChangedProc\fR;
+ Tk_ClassCreateProc *\fIcreateProc\fR;
+ Tk_ClassModalProc *\fImodalProc\fR;
+} \fBTk_ClassProcs\fR;
+.CE
+The \fIsize\fR field is used to simplify future expansion of the
+structure. It should always be set to (literally) \fBsizeof(Tk_ClassProcs)\fR.
+.PP
+\fIworldChangedProc\fR is invoked when the system has altered
+in some way that requires some reaction from the widget. For example,
+when a font alias (see the \fBfont\fR manual entry) is reconfigured,
+widgets configured to use that font alias must update their display
+accordingly. \fIworldChangedProc\fR should have arguments and results
+that match the type \fBTk_ClassWorldChangedProc\fR:
+.CS
+typedef void \fBTk_ClassWorldChangedProc\fR(
+ ClientData \fIinstanceData\fR);
+.CE
+The \fIinstanceData\fR parameter passed to the \fIworldChangedProc\fR
+will be identical to the \fIinstanceData\fR parameter passed to
+\fBTk_SetClassProcs\fR.
+.PP
+\fIcreateProc\fR is used to create platform-dependant windows. It is
+invoked by \fBTk_MakeWindowExist\fR. \fIcreateProc\fR should have
+arguments and results that match the type \fBTk_ClassCreateProc\fR:
+.CS
+typedef Window \fBTk_ClassCreateProc\fR(
+ Tk_Window \fItkwin\fR,
+ Window \fIparent\fR,
+ ClientData \fIinstanceData\fR);
+.CE
+The \fItkwin\fR and \fIinstanceData\fR parameters will be identical to
+the \fItkwin\fR and \fIinstanceData\fR parameters passed to
+\fBTk_SetClassProcs\fR. The \fIparent\fR parameter will be the parent
+of the window to be created. The \fIcreateProc\fR should return the
+created window.
+.PP
+\fImodalProc\fR is invoked after all bindings on a widget have been
+triggered in order to handle a modal loop. \fImodalProc\fR should
+have arguments and results that match the type \fBTk_ClassModalProc\fR:
+.CS
+typedef void \fBTk_ClassModalProc\fR(
+ Tk_Window \fItkwin\fR,
+ XEvent *\fIeventPtr\fR);
+.CE
+The \fItkwin\fR parameter to \fImodalProc\fR will be identical to the
+\fItkwin\fR parameter passed to \fBTk_SetClassProcs\fR. The
+\fIeventPtr\fR parameter will be a pointer to an XEvent structure
+describing the event being processed.
+.SH KEYWORDS
+callback, class
diff --git a/doc/SetGrid.3 b/doc/SetGrid.3
index 965864c..ee8a231 100644
--- a/doc/SetGrid.3
+++ b/doc/SetGrid.3
@@ -1,67 +1,65 @@
-'\"
-'\" Copyright (c) 1990-1994 The Regents of the University of California.
-'\" 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: SetGrid.3,v 1.2 1998/09/14 18:22:53 stanton Exp $
-'\"
-.so man.macros
-.TH Tk_SetGrid 3 4.0 Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_SetGrid, Tk_UnsetGrid \- control the grid for interactive resizing
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_SetGrid\fR(\fItkwin, reqWidth, reqHeight, widthInc, heightInc\fR)
-.sp
-\fBTk_UnsetGrid\fR(\fItkwin\fR)
-.SH ARGUMENTS
-.AS Tk_Window heightInc
-.AP Tk_Window tkwin in
-Token for window.
-.AP int reqWidth in
-Width in grid units that corresponds to the pixel dimension \fItkwin\fR
-has requested via \fBTk_GeometryRequest\fR.
-.AP int reqHeight in
-Height in grid units that corresponds to the pixel dimension \fItkwin\fR
-has requested via \fBTk_GeometryRequest\fR.
-.AP int widthInc in
-Width of one grid unit, in pixels.
-.AP int heightInc in
-Height of one grid unit, in pixels.
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_SetGrid\fR turns on gridded geometry management for \fItkwin\fR's
-toplevel window and specifies the geometry of the grid.
-\fBTk_SetGrid\fR is typically invoked by a widget when its \fBsetGrid\fR
-option is true.
-It restricts interactive resizing of \fItkwin\fR's toplevel window so
-that the space allocated to the toplevel is equal to its requested
-size plus or minus even multiples of \fIwidthInc\fR and \fIheightInc\fR.
-Furthermore, the \fIreqWidth\fR and \fIreqHeight\fR values are
-passed to the window manager so that it can report the window's
-size in grid units during interactive resizes.
-If \fItkwin\fR's configuration changes (e.g., the size of a grid unit
-changes) then the widget should invoke \fBTk_SetGrid\fR again with the new
-information.
-.PP
-\fBTk_UnsetGrid\fR cancels gridded geometry management for
-\fItkwin\fR's toplevel window.
-.PP
-For each toplevel window there can be at most one internal window
-with gridding enabled.
-If \fBTk_SetGrid\fR or \fBTk_UnsetGrid\fR is invoked when some
-other window is already controlling gridding for \fItkwin\fR's
-toplevel, the calls for the new window have no effect.
-.PP
-See the \fBwm\fR manual entry for additional information on gridded geometry
-management.
-
-.SH KEYWORDS
-grid, window, window manager
+'\"
+'\" Copyright (c) 1990-1994 The Regents of the University of California.
+'\" 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: SetGrid.3,v 1.3 2008/06/30 22:57:02 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_SetGrid 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_SetGrid, Tk_UnsetGrid \- control the grid for interactive resizing
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_SetGrid\fR(\fItkwin, reqWidth, reqHeight, widthInc, heightInc\fR)
+.sp
+\fBTk_UnsetGrid\fR(\fItkwin\fR)
+.SH ARGUMENTS
+.AS Tk_Window heightInc
+.AP Tk_Window tkwin in
+Token for window.
+.AP int reqWidth in
+Width in grid units that corresponds to the pixel dimension \fItkwin\fR
+has requested via \fBTk_GeometryRequest\fR.
+.AP int reqHeight in
+Height in grid units that corresponds to the pixel dimension \fItkwin\fR
+has requested via \fBTk_GeometryRequest\fR.
+.AP int widthInc in
+Width of one grid unit, in pixels.
+.AP int heightInc in
+Height of one grid unit, in pixels.
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_SetGrid\fR turns on gridded geometry management for \fItkwin\fR's
+toplevel window and specifies the geometry of the grid.
+\fBTk_SetGrid\fR is typically invoked by a widget when its \fBsetGrid\fR
+option is true.
+It restricts interactive resizing of \fItkwin\fR's toplevel window so
+that the space allocated to the toplevel is equal to its requested
+size plus or minus even multiples of \fIwidthInc\fR and \fIheightInc\fR.
+Furthermore, the \fIreqWidth\fR and \fIreqHeight\fR values are
+passed to the window manager so that it can report the window's
+size in grid units during interactive resizes.
+If \fItkwin\fR's configuration changes (e.g., the size of a grid unit
+changes) then the widget should invoke \fBTk_SetGrid\fR again with the new
+information.
+.PP
+\fBTk_UnsetGrid\fR cancels gridded geometry management for
+\fItkwin\fR's toplevel window.
+.PP
+For each toplevel window there can be at most one internal window
+with gridding enabled.
+If \fBTk_SetGrid\fR or \fBTk_UnsetGrid\fR is invoked when some
+other window is already controlling gridding for \fItkwin\fR's
+toplevel, the calls for the new window have no effect.
+.PP
+See the \fBwm\fR manual entry for additional information on gridded geometry
+management.
+.SH KEYWORDS
+grid, window, window manager
diff --git a/doc/SetOptions.3 b/doc/SetOptions.3