From af0c6996b5dd46e602fa5da6542a4ccb4e45656c Mon Sep 17 00:00:00 2001 From: dkf Date: Wed, 6 Apr 2005 21:11:49 +0000 Subject: Purge old and inaccurate .VS/.VE macros. --- ChangeLog | 12 ++++++++++++ doc/3DBorder.3 | 12 +----------- doc/ConfigWidg.3 | 4 +--- doc/CrtImgType.3 | 7 +------ doc/CrtWindow.3 | 4 +--- doc/FontId.3 | 4 +--- doc/GetAnchor.3 | 8 +------- doc/GetBitmap.3 | 22 +--------------------- doc/GetColor.3 | 14 +------------- doc/GetCursor.3 | 14 +------------- doc/GetFont.3 | 13 +------------ doc/GetJustify.3 | 9 +-------- doc/GetPixels.3 | 14 +------------- doc/GetRelief.3 | 8 +------- doc/MeasureChar.3 | 8 +------- doc/TextLayout.3 | 6 +----- doc/bind.n | 14 +------------- doc/button.n | 8 +------- doc/canvas.n | 4 +--- doc/checkbutton.n | 10 +--------- doc/clipboard.n | 4 +--- doc/entry.n | 18 +----------------- doc/event.n | 4 +--- doc/font.n | 6 +----- doc/getOpenFile.n | 4 +--- doc/listbox.n | 16 +--------------- doc/menu.n | 32 +------------------------------- doc/options.n | 4 +--- doc/photo.n | 10 +--------- doc/radiobutton.n | 12 +----------- doc/selection.n | 4 +--- doc/send.n | 6 +----- doc/tk.n | 8 +------- doc/winfo.n | 4 +--- doc/wm.n | 9 +++------ 35 files changed, 48 insertions(+), 288 deletions(-) diff --git a/ChangeLog b/ChangeLog index cae2af2..ba2e4ba 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2005-04-06 Donal K. Fellows + + * doc/wm.n, doc/winfo.n, doc/tk.n, doc/send.n, doc/selection.n: + * doc/radiobutton.n, doc/photo.n, doc/options.n, doc/menu.n: + * doc/listbox.n, doc/getOpenFile.n, doc/font.n, doc/event.n: + * doc/entry.n, doc/clipboard.n, doc/checkbutton.n, doc/canvas.n: + * doc/button.n, doc/bind.n, doc/TextLayout.3, doc/MeasureChar.3: + * doc/GetRelief.3, doc/GetPixels.3, doc/GetJustify.3, doc/GetFont.3: + * doc/GetCursor.3, doc/GetColor.3, doc/GetBitmap.3, doc/GetAnchor.3: + * doc/FontId.3, doc/CrtWindow.3, doc/CrtImgType.3, doc/ConfigWidg.3: + * doc/3DBorder.3: Purge old .VS/.VE macro instances. + 2005-04-04 Don Porter * library/comdlg.tcl: Added Macintosh file type validation to diff --git a/doc/3DBorder.3 b/doc/3DBorder.3 index 999dae4..b122e3b 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.5 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: 3DBorder.3,v 1.6 2005/04/06 21:11:53 dkf Exp $ '\" .so man.macros .TH Tk_Alloc3DBorderFromObj 3 8.1 Tk "Tk Library Procedures" @@ -16,7 +16,6 @@ Tk_Alloc3DBorderFromObj, Tk_Get3DBorder, Tk_Get3DBorderFromObj, Tk_Draw3DRectang .nf \fB#include \fR .sp -.VS 8.1 Tk_3DBorder \fBTk_Alloc3DBorderFromObj(\fIinterp, tkwin, objPtr\fB)\fR .sp @@ -25,7 +24,6 @@ Tk_3DBorder .sp Tk_3DBorder \fBTk_Get3DBorderFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp void \fBTk_Draw3DRectangle(\fItkwin, drawable, border, x, y, width, height, borderWidth, relief\fB)\fR @@ -57,9 +55,7 @@ XColor * GC * \fBTk_3DBorderGC(\fItkwin, border, which\fB)\fR .sp -.VS 8.1 \fBTk_Free3DBorderFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp \fBTk_Free3DBorder(\fIborder\fB)\fR .SH ARGUMENTS @@ -70,14 +66,12 @@ Interpreter to use for error reporting. Token for window (for all procedures except \fBTk_Get3DBorder\fR, must be the window for which the border was allocated). .AP Tcl_Obj *objPtr in -.VS 8.1 Pointer to object whose value describes color corresponding to background (flat areas). Illuminated edges will be brighter than this and shadowed edges will be darker than this. .AP char *colorName in Same as \fIobjPtr\fR except value is supplied as a string rather than an object. -.VE .AP Drawable drawable in X token for window or pixmap; indicates where graphics are to be drawn. Must either be the X window for \fItkwin\fR or a pixmap with the @@ -147,7 +141,6 @@ Must be \fBTK_3D_FLAT_GC\fR, \fBTK_3D_LIGHT_GC\fR, or \fBTK_3D_DARK_GC\fR. .PP These procedures provide facilities for drawing window borders in a way that produces a three-dimensional appearance. -.VS 8.1 \fBTk_Alloc3DBorderFromObj\fR allocates colors and Pixmaps needed to draw a border in the window given by the \fItkwin\fR argument. The value of \fIobjPtr\fR @@ -181,7 +174,6 @@ already have been created with a previous call to value is cached in \fIobjPtr\fR, which speeds up future calls to \fBTk_Get3DBorderFromObj\fR with the same \fIobjPtr\fR and \fItkwin\fR. -.VE .PP Once a border structure has been created, \fBTk_Draw3DRectangle\fR may be invoked to draw the border. @@ -288,7 +280,6 @@ The argument \fIwhich\fR selects which one of the three possible GC's: \fBTK_3D_LIGHT_GC\fR returns the context for light shadows, and \fBTK_3D_DARK_GC\fR returns the context for dark shadows. .PP -.VS 8.1 When a border is no longer needed, \fBTk_Free3DBorderFromObj\fR or \fBTk_Free3DBorder\fR should be called to release the resources associated with it. @@ -299,7 +290,6 @@ 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. -.VE .SH KEYWORDS 3D, background, border, color, depressed, illumination, object, polygon, raised, shadow, three-dimensional effect diff --git a/doc/ConfigWidg.3 b/doc/ConfigWidg.3 index 69810a2..0aa0ff7 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.12 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: ConfigWidg.3,v 1.13 2005/04/06 21:11:53 dkf Exp $ '\" .so man.macros .TH Tk_ConfigureWidget 3 4.1 Tk "Tk Library Procedures" @@ -63,12 +63,10 @@ Display containing widget whose record is being freed; needed in order to free up resources. .BE .SH DESCRIPTION -.VS 8.1 .PP Note: \fBTk_ConfigureWidget\fP should be replaced with the new \fBTcl_Obj\fP based API \fBTk_SetOptions\fP. The old interface is retained for backward compatibility. -.VE .PP \fBTk_ConfigureWidget\fR is called to configure various aspects of a widget, such as colors, fonts, border width, etc. diff --git a/doc/CrtImgType.3 b/doc/CrtImgType.3 index 5f87b98..ed03d54 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.8 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: CrtImgType.3,v 1.9 2005/04/06 21:11:53 dkf Exp $ '\" .so man.macros .TH Tk_CreateImageType 3 8.3 Tk "Tk Library Procedures" @@ -18,7 +18,6 @@ Tk_CreateImageType, Tk_GetImageMasterData, Tk_InitImageArgs \- define new kind o .sp \fBTk_CreateImageType\fR(\fItypePtr\fR) .sp -.VS ClientData \fBTk_GetImageMasterData\fR(\fIinterp, name, typePtrPtr\fR) .sp @@ -40,7 +39,6 @@ the given image, if it exists. Number of arguments .AP char ***argvPtr in/out Pointer to argument list -.VE .BE .SH DESCRIPTION @@ -249,7 +247,6 @@ image was created. the image. .SH TK_GETIMAGEMASTERDATA -.VS .PP The procedure \fBTk_GetImageMasterData\fR may be invoked to retrieve information about an image. For example, an image manager can use this @@ -262,10 +259,8 @@ 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. -.VE .SH TK_INITIMAGEARGS -.VS .PP The function \fBTk_InitImageArgs\fR converts the arguments of the \fBcreateProc\fR from objects to strings when necessary. When diff --git a/doc/CrtWindow.3 b/doc/CrtWindow.3 index e09fdef..a7bf3d4 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.6 2002/08/05 04:30:38 dgp Exp $ +'\" RCS: @(#) $Id: CrtWindow.3,v 1.7 2005/04/06 21:11:53 dkf Exp $ '\" .so man.macros .TH Tk_CreateWindow 3 4.2 Tk "Tk Library Procedures" @@ -55,7 +55,6 @@ Name of new window, specified as path name within application .SH DESCRIPTION .PP The procedures \fBTk_CreateWindow\fR, -.VS \fBTk_CreateAnonymousWindow\fR, and \fBTk_CreateWindowFromPath\fR are used to create new windows for use in Tk-based applications. Each of the procedures returns a token @@ -66,7 +65,6 @@ message. .PP Tk supports two different kinds of windows: internal windows and top-level windows. -.VE An internal window is an interior window of a Tk application, such as a scrollbar or menu bar or button. A top-level window is one that is created as a child of a screen's root window, rather than as an diff --git a/doc/FontId.3 b/doc/FontId.3 index d206fa1..208666e 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.4 2004/08/22 15:43:20 dkf Exp $ +'\" RCS: @(#) $Id: FontId.3,v 1.5 2005/04/06 21:11:53 dkf Exp $ '\" .so man.macros .TH Tk_FontId 3 8.0 Tk "Tk Library Procedures" @@ -67,7 +67,6 @@ following screen font families should print correctly: .PP Any other font families may not print correctly because the computed Postscript font name may be incorrect or not exist on the printer. -.VS 8.0 br .SH "DATA STRUCTURES" The Tk_FontMetrics data structure is used by Tk_GetFontMetrics to return information about a font and is defined as follows: @@ -90,6 +89,5 @@ The \fIlinespace\fR is the sum of the ascent and descent. How far apart two lines of text in the same font should be placed so that none of the characters in one line overlap any of the characters in the other line. -.VE .SH KEYWORDS font diff --git a/doc/GetAnchor.3 b/doc/GetAnchor.3 index a992980..6fe0692 100644 --- a/doc/GetAnchor.3 +++ b/doc/GetAnchor.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: GetAnchor.3,v 1.4 2002/08/05 04:30:38 dgp Exp $ +'\" RCS: @(#) $Id: GetAnchor.3,v 1.5 2005/04/06 21:11:53 dkf Exp $ '\" .so man.macros .TH Tk_GetAnchorFromObj 3 8.1 Tk "Tk Library Procedures" @@ -16,10 +16,8 @@ Tk_GetAnchorFromObj, Tk_GetAnchor, Tk_NameOfAnchor \- translate between strings .nf \fB#include \fR .sp -.VS 8.1 int \fBTk_GetAnchorFromObj(\fIinterp, objPtr, anchorPtr\fB)\fR -.VE .sp int \fBTk_GetAnchor(\fIinterp, string, anchorPtr\fB)\fR @@ -30,7 +28,6 @@ CONST char * .AS "Tk_Anchor" *anchorPtr .AP Tcl_Interp *interp in Interpreter to use for error reporting, or NULL. -.VS 8.1 br .AP Tcl_Obj *objPtr in/out String value contains name of anchor point: \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR, \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR; @@ -38,7 +35,6 @@ internal rep will be modified to cache corresponding Tk_Anchor. .AP "CONST char" *string in Same as \fIobjPtr\fR except description of anchor point is passed as a string. -.VE .AP int *anchorPtr out Pointer to location in which to store anchor position corresponding to \fIobjPtr\fR or \fIstring\fR. @@ -48,7 +44,6 @@ Anchor position, e.g. \fBTCL_ANCHOR_CENTER\fR. .SH DESCRIPTION .PP -.VS 8.1 \fBTk_GetAnchorFromObj\fR places in \fI*anchorPtr\fR an anchor position (enumerated type \fBTk_Anchor\fR) corresponding to \fIobjPtr\fR's value. The result will be one of @@ -74,7 +69,6 @@ that the description of the anchor is specified with a string instead of an object. This prevents \fBTk_GetAnchor\fR from caching the return value, so \fBTk_GetAnchor\fR is less efficient than \fBTk_GetAnchorFromObj\fR. -.VE .PP \fBTk_NameOfAnchor\fR is the logical inverse of \fBTk_GetAnchor\fR. Given an anchor position such as \fBTK_ANCHOR_N\fR it returns a diff --git a/doc/GetBitmap.3 b/doc/GetBitmap.3 index f092b7a..3007d93 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.7 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: GetBitmap.3,v 1.8 2005/04/06 21:11:53 dkf Exp $ '\" .so man.macros .TH Tk_AllocBitmapFromObj 3 8.1 Tk "Tk Library Procedures" @@ -16,7 +16,6 @@ Tk_AllocBitmapFromObj, Tk_GetBitmap, Tk_GetBitmapFromObj, Tk_DefineBitmap, Tk_Na .nf \fB#include \fR .sp -.VS 8.1 Pixmap \fBTk_GetBitmapFromObj(\fIinterp, tkwin, objPtr\fB)\fR .sp @@ -25,7 +24,6 @@ Pixmap .sp Pixmap \fBTk_GetBitmapFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp int \fBTk_DefineBitmap(\fIinterp, name, source, width, height\fB)\fR @@ -35,9 +33,7 @@ CONST char * .sp \fBTk_SizeOfBitmap(\fIdisplay, bitmap, widthPtr, heightPtr\fB)\fR .sp -.VS 8.1 \fBTk_FreeBitmapFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp \fBTk_FreeBitmap(\fIdisplay, bitmap\fB)\fR .SH ARGUMENTS @@ -47,14 +43,12 @@ Interpreter to use for error reporting; if NULL then no error message is left after errors. .AP Tk_Window tkwin in Token for window in which the bitmap will be used. -.VS 8.1 br .AP Tcl_Obj *objPtr in/out String value describes desired bitmap; internal rep will be modified to cache pointer to corresponding Pixmap. .AP "CONST char" *info in Same as \fIobjPtr\fR except description of bitmap is passed as a string and resulting Pixmap isn't cached. -.VE .AP "CONST char" *name in Name for new bitmap to be defined. .AP "CONST char" *source in @@ -82,13 +76,11 @@ being used by an application. The procedures allow bitmaps to be re-used efficiently, thereby avoiding server overhead, and also allow bitmaps to be named with character strings. .PP -.VS 8.1 \fBTk_AllocBitmapFromObj\fR returns a Pixmap identifier for a bitmap that matches the description in \fIobjPtr\fR and is suitable for use in \fItkwin\fR. It re-uses an existing bitmap, if possible, and creates a new one otherwise. \fIObjPtr\fR's value must have one of the following forms: -.VE .TP 20 \fB@\fIfileName\fR \fIFileName\fR must be the name of a file containing a bitmap @@ -103,19 +95,15 @@ by Tk: \fBerror\fR The international "don't" symbol: a circle with a diagonal line across it. -.VS "" br .TP 12 \fBgray75\fR 75% gray: a checkerboard pattern where three out of four bits are on. -.VE .TP 12 \fBgray50\fR 50% gray: a checkerboard pattern where every other bit is on. -.VS "" br .TP 12 \fBgray25\fR 25% gray: a checkerboard pattern where one out of every four bits is on. -.VE .TP 12 \fBgray12\fR 12.5% gray: a pattern where one-eighth of the bits are on, consisting of @@ -188,7 +176,6 @@ A face with balloon words. A triangle with an exclamation point. .RE .LP -.VS 8.1 Under normal conditions, \fBTk_AllocBitmapFromObj\fR returns an identifier for the requested bitmap. If an error occurs in creating the bitmap, such as when \fIobjPtr\fR refers @@ -212,7 +199,6 @@ must already have been created with a previous call to value is cached in \fIobjPtr\fR, which speeds up future calls to \fBTk_GetBitmapFromObj\fR with the same \fIobjPtr\fR and \fItkwin\fR. -.VE .PP \fBTk_DefineBitmap\fR associates a name with in-memory bitmap data so that the name can be used in later @@ -239,7 +225,6 @@ which was created by the \fBbitmap\fR program and contains a stipple pattern. The following code uses \fBTk_DefineBitmap\fR to define a new bitmap named \fBfoo\fR: -.VS .CS Pixmap bitmap; #include "stip.bitmap" @@ -248,17 +233,14 @@ Tk_DefineBitmap(interp, "foo", stip_bits, \&... bitmap = Tk_GetBitmap(interp, tkwin, "foo"); .CE -.VE This code causes the bitmap file to be read at compile-time and incorporates the bitmap information into the program's executable image. The same bitmap file could be read at run-time using \fBTk_GetBitmap\fR: -.VS .CS Pixmap bitmap; bitmap = Tk_GetBitmap(interp, tkwin, "@stip.bitmap"); .CE -.VE The second form is a bit more flexible (the file could be modified after the program has been compiled, or a different string could be provided to read a different file), but it is a little slower and @@ -291,7 +273,6 @@ argument in the words pointed to by the \fIwidthPtr\fR and \fIbitmap\fR must have been created by \fBTk_AllocBitmapFromObj\fR or \fBTk_GetBitmap\fR. .PP -.VS 8.1 When a bitmap is no longer needed, \fBTk_FreeBitmapFromObj\fR or \fBTk_FreeBitmap\fR should be called to release it. For \fBTk_FreeBitmapFromObj\fR the bitmap to release is specified @@ -301,7 +282,6 @@ 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. -.VE .SH BUGS In determining whether an existing bitmap can be used to satisfy diff --git a/doc/GetColor.3 b/doc/GetColor.3 index 8b122ca..786dad7 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.4 2002/08/05 04:30:38 dgp Exp $ +'\" RCS: @(#) $Id: GetColor.3,v 1.5 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH Tk_AllocColorFromObj 3 8.1 Tk "Tk Library Procedures" @@ -15,7 +15,6 @@ Tk_AllocColorFromObj, Tk_GetColor, Tk_GetColorFromObj, Tk_GetColorByValue, Tk_Na .SH SYNOPSIS .nf \fB#include \fR -.VS 8.1 .sp XColor * \fBTk_AllocColorFromObj(\fIinterp, tkwin, objPtr\fB)\fR @@ -25,7 +24,6 @@ XColor * .sp XColor * \fBTk_GetColorFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp XColor * \fBTk_GetColorByValue(\fItkwin, prefPtr\fB)\fR @@ -36,9 +34,7 @@ CONST char * GC \fBTk_GCForColor(\fIcolorPtr, drawable\fB)\fR .sp -.VS 8.1 \fBTk_FreeColorFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp \fBTk_FreeColor(\fIcolorPtr\fB)\fR .SH ARGUMENTS @@ -47,14 +43,12 @@ GC Interpreter to use for error reporting. .AP Tk_Window tkwin in Token for window in which color will be used. -.VS 8.1 br .AP Tcl_Obj *objPtr in/out String value describes desired color; internal rep will be modified to cache pointer to corresponding (XColor *). .AP char *name in Same as \fIobjPtr\fR except description of color is passed as a string and resulting (XColor *) isn't cached. -.VE .AP XColor *prefPtr in Indicates red, green, and blue intensities of desired color. @@ -68,7 +62,6 @@ same screen and depth as the window for which the color was allocated. .BE .SH DESCRIPTION -.VS 8.1 .PP These procedures manage the colors being used by a Tk application. They allow colors to be shared whenever possible, so that colormap @@ -79,7 +72,6 @@ Given a textual description of a color, \fBTk_AllocColorFromObj\fR locates a pixel value that may be used to render the color in a particular window. The desired color is specified with an object whose string value must have one of the following forms: -.VE .TP 20 \fIcolorname\fR Any of the valid textual names for a color defined in the @@ -100,7 +92,6 @@ When fewer than 16 bits are provided for each color, they represent the most significant bits of the color. For example, #3a7 is the same as #3000a0007000. .PP -.VS 8.1 \fBTk_AllocColorFromObj\fR returns a pointer to an XColor structure; the structure indicates the exact intensities of the allocated color (which may differ slightly from those requested, @@ -129,7 +120,6 @@ must already have been created with a previous call to value is cached in \fIobjPtr\fR, which speeds up future calls to \fBTk_GetColorFromObj\fR with the same \fIobjPtr\fR and \fItkwin\fR. -.VE .PP \fBTk_GetColorByValue\fR is similar to \fBTk_GetColor\fR except that the desired color is indicated with the \fIred\fR, \fIgreen\fR, and @@ -175,7 +165,6 @@ The graphics context is cached with the color and will exist only as long as \fIcolorPtr\fR exists; it is freed when the last reference to \fIcolorPtr\fR is freed by calling \fBTk_FreeColor\fR. .PP -.VS 8.1 When a color is no longer needed \fBTk_FreeColorFromObj\fR or \fBTk_FreeColor\fR should be called to release it. For \fBTk_FreeColorFromObj\fR the color to release is specified @@ -185,6 +174,5 @@ with a pointer to its XColor structure. There should be exactly one call to \fBTk_FreeColorFromObj\fR or \fBTk_FreeColor\fR for each call to \fBTk_AllocColorFromObj\fR, \fBTk_GetColor\fR, or \fBTk_GetColorByValue\fR. -.VE .SH KEYWORDS color, intensity, object, pixel value diff --git a/doc/GetCursor.3 b/doc/GetCursor.3 index cc00ed4..6d3d28d 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.7 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: GetCursor.3,v 1.8 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH Tk_AllocCursorFromObj 3 8.1 Tk "Tk Library Procedures" @@ -16,7 +16,6 @@ Tk_AllocCursorFromObj, Tk_GetCursor, Tk_GetCursorFromObj, Tk_GetCursorFromData, .nf \fB#include \fR .sp -.VS 8.1 Tk_Cursor \fBTk_AllocCursorFromObj(\fIinterp, tkwin, objPtr\fB)\fR .sp @@ -25,7 +24,6 @@ Tk_Cursor .sp Tk_Cursor \fBTk_GetCursorFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp Tk_Cursor \fBTk_GetCursorFromData(\fIinterp, tkwin, source, mask, width, height, xHot, yHot, fg, bg\fB)\fR @@ -33,9 +31,7 @@ Tk_Cursor CONST char * \fBTk_NameOfCursor(\fIdisplay, cursor\fB)\fR .sp -.VS 8.1 \fBTk_FreeCursorFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp \fBTk_FreeCursor(\fIdisplay, cursor\fB)\fR .SH ARGUMENTS @@ -44,14 +40,12 @@ CONST char * Interpreter to use for error reporting. .AP Tk_Window tkwin in Token for window in which the cursor will be used. -.VS 8.1 br .AP Tcl_Obj *objPtr in/out Description of cursor; see below for possible values. Internal rep will be modified to cache pointer to corresponding Tk_Cursor. .AP char *name in Same as \fIobjPtr\fR except description of cursor is passed as a string and resulting Tk_Cursor isn't cached. -.VE .AP "CONST char" *source in Data for cursor cursor, in standard cursor format. .AP "CONST char" *mask in @@ -83,7 +77,6 @@ being used by an application. The procedures allow cursors to be re-used efficiently, thereby avoiding server overhead, and also allow cursors to be named with character strings. .PP -.VS 8.1 \fBTk_AllocCursorFromObj\fR takes as argument an object describing a cursor, and returns an opaque Tk identifier for a cursor corresponding to the description. It re-uses an existing cursor if possible and @@ -95,7 +88,6 @@ such as when \fIobjPtr\fR refers to a non-existent file, then \fBNone\fR is returned and an error message will be stored in \fIinterp\fR's result if \fIinterp\fR isn't NULL. \fIObjPtr\fR must contain a standard Tcl list with one of the following forms: -.VE .TP \fIname\fR\0[\fIfgColor\fR\0[\fIbgColor\fR]] \fIName\fR is the name of a cursor in the standard X cursor cursor, @@ -144,7 +136,6 @@ This form only works on Windows, and will load a Windows system cursor (\fB.ani\fR or \fB.cur\fR) from the file specified in \fIsourceName\fR. .PP -.VS 8.1 \fBTk_GetCursor\fR is identical to \fBTk_AllocCursorFromObj\fR except that the description of the cursor is specified with a string instead of an object. This prevents \fBTk_GetCursor\fR from caching the @@ -159,7 +150,6 @@ must already have been created with a previous call to value is cached in \fIobjPtr\fR, which speeds up future calls to \fBTk_GetCursorFromObj\fR with the same \fIobjPtr\fR and \fItkwin\fR. -.VE .PP \fBTk_GetCursorFromData\fR allows cursors to be created from in-memory descriptions of their source and mask cursors. \fISource\fR @@ -213,7 +203,6 @@ only guaranteed to persist until the next call to \fBTk_NameOfCursor\fR. Also, this call is not portable except for cursors returned by \fBTk_GetCursor\fR. .PP -.VS 8.1 When a cursor returned by \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR, or \fBTk_GetCursorFromData\fR is no longer needed, \fBTk_FreeCursorFromObj\fR or @@ -225,7 +214,6 @@ 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. -.VE .SH BUGS In determining whether an existing cursor can be used to satisfy diff --git a/doc/GetFont.3 b/doc/GetFont.3 index 8e40eb4..102dcd4 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.5 2002/08/05 04:30:38 dgp Exp $ +'\" RCS: @(#) $Id: GetFont.3,v 1.6 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH Tk_AllocFontFromObj 3 8.1 Tk "Tk Library Procedures" @@ -16,7 +16,6 @@ Tk_AllocFontFromObj, Tk_GetFont, Tk_GetFontFromObj, Tk_NameOfFont, Tk_FreeFontFr .nf \fB#include \fR .sp -.VS 8.1 Tk_Font \fBTk_AllocFontFromObj(\fIinterp, tkwin, objPtr\fB)\fR .sp @@ -25,15 +24,12 @@ Tk_Font .sp Tk_Font \fBTk_GetFontFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp CONST char * \fBTk_NameOfFont(\fItkfont\fB)\fR .sp -.VS 8.1 Tk_Font \fBTk_FreeFontFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp void \fBTk_FreeFont(\fItkfont\fB)\fR @@ -45,7 +41,6 @@ Interpreter to use for error reporting. If NULL, then no error messages are left after errors. .AP Tk_Window tkwin in Token for window in which font will be used. -.VS 8.1 br .AP Tcl_Obj *objPtr in/out Gives name or description of font. See documentation for the \fBfont\fR command for details on acceptable formats. @@ -53,13 +48,11 @@ Internal rep will be modified to cache corresponding Tk_Font. .AP "const char" *string in Same as \fIobjPtr\fR except description of font is passed as a string and resulting Tk_Font isn't cached. -.VE .AP Tk_Font tkfont in Opaque font token. .BE .SH DESCRIPTION .PP -.VS 8.1 \fBTk_AllocFontFromObj\fR finds the font indicated by \fIobjPtr\fR and returns a token that represents the font. The return value can be used in subsequent calls to procedures such as \fBTk_GetFontMetrics\fR, @@ -90,7 +83,6 @@ must already have been created with a previous call to value is cached in \fIobjPtr\fR, which speeds up future calls to \fBTk_GetFontFromObj\fR with the same \fIobjPtr\fR and \fItkwin\fR. -.VE .PP \fBTk_AllocFontFromObj\fR and \fBTk_GetFont\fR maintain a database of all fonts they have allocated. If @@ -107,7 +99,6 @@ passed to \fBTk_GetFont\fR to create the font. The string returned by \fBTk_NameOfFont\fR is only guaranteed to persist until the \fItkfont\fR is deleted. The caller must not modify this string. .PP -.VS 8.1 When a font is no longer needed, \fBTk_FreeFontFromObj\fR or \fBTk_FreeFont\fR should be called to release it. For \fBTk_FreeFontFromObj\fR the font to release is specified @@ -116,10 +107,8 @@ 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. -.VE .SH "SEE ALSO" Tk_FontId(3) - .SH KEYWORDS font diff --git a/doc/GetJustify.3 b/doc/GetJustify.3 index 384ce5d..f4d74af 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.4 2002/08/05 04:30:38 dgp Exp $ +'\" RCS: @(#) $Id: GetJustify.3,v 1.5 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH Tk_GetJustifyFromObj 3 8.1 Tk "Tk Library Procedures" @@ -16,7 +16,6 @@ Tk_GetJustifyFromObj, Tk_GetJustify, Tk_NameOfJustify \- translate between strin .nf \fB#include \fR .sp -.VS 8.1 int \fBTk_GetJustifyFromObj(\fIinterp, objPtr, justifyPtr\fB)\fR .sp @@ -29,7 +28,6 @@ CONST char * .AS "Tk_Justify" *justifyPtr .AP Tcl_Interp *interp in Interpreter to use for error reporting, or NULL. -.VS 8.1 br .AP Tcl_Obj *objPtr in/out String value contains name of justification style (\fBleft\fR, \fBright\fR, or \fBcenter\fR). The @@ -37,7 +35,6 @@ internal rep will be modified to cache corresponding justify value. .AP "CONST char" *string in Same as \fIobjPtr\fR except description of justification style is passed as a string. -.VE .AP int *justifyPtr out Pointer to location in which to store justify value corresponding to \fIobjPtr\fR or \fIstring\fR. @@ -47,10 +44,8 @@ Justification style (one of the values listed below). .SH DESCRIPTION .PP -.VS 8.1 \fBTk_GetJustifyFromObj\fR places in \fI*justifyPtr\fR the justify value corresponding to \fIobjPtr\fR's value. -.VE This value will be one of the following: .TP \fBTK_JUSTIFY_LEFT\fR @@ -65,7 +60,6 @@ the line; as a result, the left edges of lines may be ragged. Means that the text on each line should be centered; as a result, both the left and right edges of lines may be ragged. .PP -.VS 8.1 Under normal circumstances the return value is \fBTCL_OK\fR and \fIinterp\fR is unused. If \fIobjPtr\fR doesn't contain a valid justification style @@ -81,7 +75,6 @@ that the description of the justification is specified with a string instead of an object. This prevents \fBTk_GetJustify\fR from caching the return value, so \fBTk_GetJustify\fR is less efficient than \fBTk_GetJustifyFromObj\fR. -.VE .PP \fBTk_NameOfJustify\fR is the logical inverse of \fBTk_GetJustify\fR. Given a justify value it returns a statically-allocated string diff --git a/doc/GetPixels.3 b/doc/GetPixels.3 index 7330018..99b8a73 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.4 2002/01/25 21:09:36 dgp Exp $ +'\" RCS: @(#) $Id: GetPixels.3,v 1.5 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH Tk_GetPixelsFromObj 3 8.1 Tk "Tk Library Procedures" @@ -16,18 +16,14 @@ Tk_GetPixelsFromObj, Tk_GetPixels, Tk_GetMMFromObj, Tk_GetScreenMM \- translate .nf \fB#include \fR .sp -.VS 8.1 int \fBTk_GetPixelsFromObj(\fIinterp, tkwin, objPtr, intPtr\fB)\fR -.VE .sp int \fBTk_GetPixels(\fIinterp, tkwin, string, intPtr\fB)\fR .sp -.VS 8.1 int \fBTk_GetMMFromObj(\fIinterp, tkwin, objPtr, doublePtr\fB)\fR -.VE .sp int \fBTk_GetScreenMM(\fIinterp, tkwin, string, doublePtr\fB)\fR @@ -38,14 +34,12 @@ Interpreter to use for error reporting. .AP Tk_Window tkwin in Window whose screen geometry determines the conversion between absolute units and pixels. -.VS 8.1 br .AP Tcl_Obj *objPtr in/out String value specifies a distance on the screen; internal rep will be modified to cache converted distance. .AP "CONST char" *string in Same as \fIobjPtr\fR except specification of distance is passed as a string. -.VE .AP int *intPtr out Pointer to location in which to store converted distance in pixels. .AP double *doublePtr out @@ -55,14 +49,10 @@ Pointer to location in which to store converted distance in millimeters. .SH DESCRIPTION .PP These procedures take as argument a specification of distance on -.VS 8.1 the screen (\fIobjPtr\fR or \fIstring\fR) and compute the -.VE corresponding distance either in integer pixels or floating-point millimeters. In either case, -.VS 8.1 \fIobjPtr\fR or \fIstring\fR -.VE specifies a screen distance as a floating-point number followed by one of the following characters that indicates units: @@ -83,7 +73,6 @@ The number specifies a distance in millimeters on the screen. The number specifies a distance in printer's points (1/72 inch) on the screen. .PP -.VS 8.1 \fBTk_GetPixelsFromObj\fR converts the value of \fIobjPtr\fR to the nearest even number of pixels and stores that value at \fI*intPtr\fR. It returns \fBTCL_OK\fR under normal circumstances. @@ -105,7 +94,6 @@ 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. -.VE .SH KEYWORDS centimeters, convert, inches, millimeters, pixels, points, screen units diff --git a/doc/GetRelief.3 b/doc/GetRelief.3 index 0b7b2cb..94971c5 100644 --- a/doc/GetRelief.3 +++ b/doc/GetRelief.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: GetRelief.3,v 1.5 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: GetRelief.3,v 1.6 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH Tk_GetReliefFromObj 3 8.1 Tk "Tk Library Procedures" @@ -16,10 +16,8 @@ Tk_GetReliefFromObj, Tk_GetRelief, Tk_NameOfRelief \- translate between strings .nf \fB#include \fR .sp -.VS 8.1 int \fBTk_GetReliefFromObj(\fIinterp, objPtr, reliefPtr\fB)\fR -.VE .sp int \fBTk_GetRelief(\fIinterp, name, reliefPtr\fB)\fR @@ -30,7 +28,6 @@ CONST char * .AS "Tcl_Interp" *reliefPtr .AP Tcl_Interp *interp in Interpreter to use for error reporting. -.VS 8.1 br .AP Tcl_Obj *objPtr in/out String value contains name of relief (one of \fBflat\fR, \fBgroove\fR, \fBraised\fR, \fBridge\fR, \fBsolid\fR, or \fBsunken\fR); @@ -38,7 +35,6 @@ internal rep will be modified to cache corresponding relief value. .AP char *string in Same as \fIobjPtr\fR except description of relief is passed as a string. -.VE .AP int *reliefPtr out Pointer to location in which to store relief value corresponding to \fIobjPtr\fR or \fIname\fR. @@ -52,7 +48,6 @@ or \fBTK_RELIEF_RIDGE\fR). .SH DESCRIPTION .PP -.VS 8.1 \fBTk_GetReliefFromObj\fR places in \fI*reliefPtr\fR the relief value corresponding to the value of \fIobjPtr\fR. This value will be one of \fBTK_RELIEF_FLAT\fR, \fBTK_RELIEF_RAISED\fR, \fBTK_RELIEF_SUNKEN\fR, @@ -72,7 +67,6 @@ that the description of the relief is specified with a string instead of an object. This prevents \fBTk_GetRelief\fR from caching the return value, so \fBTk_GetRelief\fR is less efficient than \fBTk_GetReliefFromObj\fR. -.VE .PP \fBTk_NameOfRelief\fR is the logical inverse of \fBTk_GetRelief\fR. Given a relief value it returns the corresponding string (\fBflat\fR, diff --git a/doc/MeasureChar.3 b/doc/MeasureChar.3 index 324e623..79e4cbc 100644 --- a/doc/MeasureChar.3 +++ b/doc/MeasureChar.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: MeasureChar.3,v 1.6 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: MeasureChar.3,v 1.7 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH Tk_MeasureChars 3 8.1 Tk "Tk Library Procedures" @@ -37,11 +37,9 @@ Text to be measured or displayed. Need not be null terminated. Any non-printing meta-characters in the string (such as tabs, newlines, and other control characters) will be measured or displayed in a platform-dependent manner. -.VS 8.1 .AP int numBytes in The maximum number of bytes to consider when measuring or drawing \fIstring\fR. Must be greater than or equal to 0. -.VE 8.1 .AP int maxPixels in If \fImaxPixels\fR is >= 0, it specifies the longest permissible line length in pixels. Characters from \fIstring\fR are processed only @@ -71,7 +69,6 @@ must be the same as the \fItkfont\fR. .AP int "x, y" in Coordinates at which to place the left edge of the baseline when displaying \fIstring\fR. -.VS 8.1 .AP int firstByte in The index of the first byte of the first character to underline in the \fIstring\fR. Underlining begins at the left edge of this character. @@ -79,7 +76,6 @@ The index of the first byte of the first character to underline in the The index of the first byte of the last character up to which the underline will be drawn. The character specified by \fIlastByte\fR will not itself be underlined. -.VE 8.1 .BE .SH DESCRIPTION @@ -90,12 +86,10 @@ justified text, refer to the documentation for \fBTk_ComputeTextLayout\fR. There is no programming interface in the core of Tk that supports multi-font, multi-line text; support for that behavior must be built on top of simpler layers. -.VS 8.1 Note that the interfaces described here are byte-oriented not character-oriented, so index values coming from Tcl scripts need to be converted to byte offsets using the \fBTcl_UtfAtIndex\fR and related routines. -.VE 8.1 .PP A glyph is the displayable picture of a letter, number, or some other symbol. Not all character codes in a given font have a glyph. diff --git a/doc/TextLayout.3 b/doc/TextLayout.3 index 6ad51d0..287906f 100644 --- a/doc/TextLayout.3 +++ b/doc/TextLayout.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: TextLayout.3,v 1.6 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: TextLayout.3,v 1.7 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH Tk_ComputeTextLayout 3 8.1 Tk "Tk Library Procedures" @@ -55,10 +55,8 @@ lifetime of the text layout. .AP int numChars in The number of characters to consider from \fIstring\fR. If \fInumChars\fR is less than 0, then assumes \fIstring\fR is null -.VS 8.1 terminated and uses \fBTcl_NumUtfChars\fR to determine the length of \fIstring\fR. -.VE .AP int wrapLength in Longest permissible line length, in pixels. Lines in \fIstring\fR will automatically be broken at word boundaries and wrapped when they reach @@ -139,13 +137,11 @@ strings, refer to the documentation for \fBTk_MeasureChars\fR. There is no programming interface in the core of Tk that supports multi-font, multi-line text; support for that behavior must be built on top of simpler layers. -.VS 8.1 Note that unlike the lower level text display routines, the functions described here all operate on character-oriented lengths and indices rather than byte-oriented values. See the description of \fBTcl_UtfAtIndex\fR for more details on converting between character and byte offsets. -.VE 8.1 .PP The routines described here are built on top of the programming interface described in the \fBTk_MeasureChars\fR documentation. Tab characters and diff --git a/doc/bind.n b/doc/bind.n index 67191fc..598937f 100644 --- a/doc/bind.n +++ b/doc/bind.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: bind.n,v 1.18 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: bind.n,v 1.19 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH bind n 8.0 Tk "Tk Built-In Commands" @@ -66,10 +66,8 @@ the binding applies to all windows in the application. .PP The \fIsequence\fR argument specifies a sequence of one or more event patterns, with optional white space between the patterns. Each -.VS event pattern may take one of three forms. In the simplest case it is a single -.VE printing ASCII character, such as \fBa\fR or \fB[\fR. The character may not be a space character or the character \fB<\fR. This form of pattern matches a \fBKeyPress\fR event for the particular @@ -115,9 +113,7 @@ Modifiers consist of any of the following values: \fBButton4, B4\fR \fBDouble\fR \fBButton5, B5\fR \fBTriple\fR \fBMod1, M1\fR \fBQuadruple\fR -.VS \fBExtended\fR -.VE .DE Where more than one value is listed, separated by commas, the values are equivalent. @@ -461,12 +457,10 @@ for \fBEnter\fR and \fBLeave\fR events. \fB1\fP if the receiving window is the focus window or a descendant of the focus window, \fB0\fP otherwise. .IP \fB%h\fR 5 -.VS The \fIheight\fR field from the event. Valid for the \fBConfigure\fR, \fBConfigureRequest\fR, \fBCreate\fR, \fBResizeRequest\fR, and \fBExpose\fR events. Indicates the new or requested height of the window. -.VE .IP \fB%i\fR 5 The \fIwindow\fR field from the event, represented as a hexadecimal integer. Valid for all event types. @@ -476,10 +470,8 @@ and \fBKeyRelease\fR events. .IP \fB%m\fR 5 The \fImode\fR field from the event. The substituted string is one of \fBNotifyNormal\fR, \fBNotifyGrab\fR, \fBNotifyUngrab\fR, or -.VS \fBNotifyWhileGrabbed\fR. Valid only for \fBEnter\fR, \fBFocusIn\fR, \fBFocusOut\fR, and \fBLeave\fR events. -.VE .IP \fB%o\fR 5 The \fIoverride_redirect\fR field from the event. Valid only for \fBMap\fR, \fBReparent\fR, and \fBConfigure\fR events. @@ -507,10 +499,8 @@ Valid for most events. The \fIwidth\fR field from the event. Indicates the new or requested width of the window. Valid only for -.VS \fBConfigure\fR, \fBConfigureRequest\fR, \fBCreate\fR, \fBResizeRequest\fR, and \fBExpose\fR events. -.VE .IP "\fB%x\fR, \fB%y\fR" 5 The \fIx\fR and \fIy\fR fields from the event. For \fBButtonPress\fP, \fBButtonRelease\fP, \fBMotion\fP, @@ -532,14 +522,12 @@ Valid only for \fBKeyPress\fR and \fBKeyRelease\fR events. The \fIborder_width\fR field from the event. Valid only for \fBConfigure\fR, \fBConfigureRequest\fR, and \fBCreate\fR events. .IP \fB%D\fR 5 -.VS This reports the \fIdelta\fR value of a \fBMouseWheel\fR event. The \fIdelta\fR value represents the rotation units the mouse wheel has been moved. On Windows 95 & 98 systems the smallest value for the delta is 120. Future systems may support higher resolution values for the delta. The sign of the value represents the direction the mouse wheel was scrolled. -.VE .IP \fB%E\fR 5 The \fIsend_event\fR field from the event. Valid for all event types. \fB0\fP indicates that this is a ``normal'' event, \fB1\fP indicates diff --git a/doc/button.n b/doc/button.n index 68aaf7d..dcb85f5 100644 --- a/doc/button.n +++ b/doc/button.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: button.n,v 1.9 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: button.n,v 1.10 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH button n 4.4 Tk "Tk Built-In Commands" @@ -32,7 +32,6 @@ Specifies a Tcl command to associate with the button. This command is typically invoked when mouse button 1 is released over the button window. .OP \-default default Default -.VS Specifies one of three states for the default ring: \fBnormal\fR, \fBactive\fR, or \fBdisabled\fR. In active state, the button is drawn with the platform specific appearance for a default button. In normal @@ -43,7 +42,6 @@ the same size. In disabled state, the button is drawn with the non-default button appearance without leaving space for the default appearance. The disabled state may result in a smaller button than the active state. -.VE .OP \-height height Height Specifies a desired height for the button. If an image or bitmap is being displayed in the button then the value is in @@ -51,7 +49,6 @@ screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR); for text it is in lines of text. If this option isn't specified, the button's desired height is computed from the size of the image or bitmap or text being displayed in it. -.VS 8.4 .OP \-overrelief overRelief OverRelief Specifies an alternative relief for the button, to be used when the mouse cursor is over the widget. This option can be used to make @@ -59,7 +56,6 @@ toolbar buttons, by configuring \fB\-relief flat \-overrelief raised\fR. If the value of this option is the empty string, then no alternative relief is used when the mouse cursor is over the button. The empty string is the default value. -.VE 8.4 .OP \-state state State Specifies one of three states for the button: \fBnormal\fR, \fBactive\fR, or \fBdisabled\fR. In normal state the button is displayed using the @@ -161,10 +157,8 @@ default behavior: .IP [1] A button activates whenever the mouse passes over it and deactivates whenever the mouse leaves the button. -.VS Under Windows, this binding is only active when mouse button 1 has been pressed over the button. -.VE .IP [2] A button's relief is changed to sunken whenever mouse button 1 is pressed over the button, and the relief is restored to its original diff --git a/doc/canvas.n b/doc/canvas.n index 53c525f..9a0bbde 100644 --- a/doc/canvas.n +++ b/doc/canvas.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: canvas.n,v 1.18 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: canvas.n,v 1.19 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH canvas n 8.3 Tk "Tk Built-In Commands" @@ -195,11 +195,9 @@ the screen; if it is \fBc\fR then the distance is in centimeters; \fBi\fR means inches, and \fBp\fR means printers points (1/72 inch). Larger y-coordinates refer to points lower on the screen; larger x-coordinates refer to points farther to the right. -.VS Coordinates can be specified either as an even number of parameters, or as a single list parameter containing an even number of x and y coordinate values. -.VE .SS TRANSFORMATIONS .PP Normally the origin of the canvas coordinate system is at the diff --git a/doc/checkbutton.n b/doc/checkbutton.n index d36d54b..f8a2540 100644 --- a/doc/checkbutton.n +++ b/doc/checkbutton.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: checkbutton.n,v 1.9 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: checkbutton.n,v 1.10 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH checkbutton n 4.4 Tk "Tk Built-In Commands" @@ -43,7 +43,6 @@ Specifies whether or not the indicator should be drawn. Must be a proper boolean value. If false, the \fBrelief\fR option is ignored and the widget's relief is always sunken if the widget is selected and raised otherwise. -.VS 8.4 .OP \-offrelief offRelief OffRelief Specifies the relief for the checkbutton when the indicator is not drawn and the checkbutton is off. The default value is "raised". By setting this option @@ -53,14 +52,12 @@ of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. -.VE 8.4 .OP \-offvalue offValue Value Specifies value to store in the button's associated variable whenever this button is deselected. Defaults to ``0''. .OP \-onvalue onValue Value Specifies value to store in the button's associated variable whenever this button is selected. Defaults to ``1''. -.VS 8.4 .OP \-overrelief overRelief OverRelief Specifies an alternative relief for the checkbutton, to be used when the mouse cursor is over the widget. This option can be used to make @@ -68,7 +65,6 @@ toolbar buttons, by configuring \fB\-relief flat \-overrelief raised\fR. If the value of this option is the empty string, then no alternative relief is used when the mouse cursor is over the checkbutton. The empty string is the default value. -.VE 8.4 .OP \-selectcolor selectColor Background Specifies a background color to use when the button is selected. If \fBindicatorOn\fR is true then the color applies to the indicator. @@ -245,7 +241,6 @@ modifying its associated variable to reflect the new state. .PP Tk automatically creates class bindings for checkbuttons that give them the following default behavior: -.VS .IP [1] On Unix systems, a checkbutton activates whenever the mouse passes over it and deactivates whenever the mouse leaves the checkbutton. On @@ -253,17 +248,14 @@ Mac and Windows systems, when mouse button 1 is pressed over a checkbutton, the button activates whenever the mouse pointer is inside the button, and deactivates whenever the mouse pointer leaves the button. -.VE .IP [2] When mouse button 1 is pressed over a checkbutton, it is invoked (its selection state toggles and the command associated with the button is invoked, if there is one). -.VS .IP [3] When a checkbutton has the input focus, the space key causes the checkbutton to be invoked. Under Windows, there are additional key bindings; plus (+) and equal (=) select the button, and minus (-) deselects the button. -.VE .PP If the checkbutton's state is \fBdisabled\fR then none of the above actions occur: the checkbutton is completely non-responsive. diff --git a/doc/clipboard.n b/doc/clipboard.n index d8f04a2..f12d48f 100644 --- a/doc/clipboard.n +++ b/doc/clipboard.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: clipboard.n,v 1.9 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: clipboard.n,v 1.10 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH clipboard n 8.4 Tk "Tk Built-In Commands" @@ -79,13 +79,11 @@ with a \fB\-\fR. .RE .TP \fBclipboard get\fR ?\fB\-displayof\fR \fIwindow\fR? ?\fB\-type\fR \fItype\fR? -.VS 8.4 Retrieve data from the clipboard on \fIwindow\fR's display. \fIwindow\fR defaults to ".". \fIType\fR specifies the form in which the data is to be returned and should be an atom name such as STRING or FILE_NAME. \fIType\fR defaults to STRING. This command is equivalent to \fBselection get -selection CLIPBOARD\fR. -.VE 8.4 .SH EXAMPLES Get the current contents of the clipboard. .CS diff --git a/doc/entry.n b/doc/entry.n index 67a4232..aaf5b09 100644 --- a/doc/entry.n +++ b/doc/entry.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: entry.n,v 1.14 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: entry.n,v 1.15 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH entry n 8.3 Tk "Tk Built-In Commands" @@ -27,26 +27,20 @@ entry \- Create and manipulate entry widgets \-highlightcolor \-relief .SE .SH "WIDGET-SPECIFIC OPTIONS" -.VS 8.4 .OP \-disabledbackground disabledBackground DisabledBackground Specifies the background color to use when the entry is disabled. If this option is the empty string, the normal background color is used. .OP \-disabledforeground disabledForeground DisabledForeground Specifies the foreground color to use when the entry is disabled. If this option is the empty string, the normal foreground color is used. -.VE 8.4 -.VS 8.3 .OP "\-invalidcommand or \-invcmd" invalidCommand InvalidCommand Specifies a script to eval when \fBvalidateCommand\fR returns 0. Setting it to {} disables this feature (the default). The best use of this option is to set it to \fIbell\fR. See \fBValidation\fR below for more information. -.VE -.VS 8.4 .OP \-readonlybackground readonlyBackground ReadonlyBackground Specifies the background color to use when the entry is readonly. If this option is the empty string, the normal background color is used. -.VE .OP \-show show Show If this option is specified, then the true contents of the entry are not displayed in the window. @@ -57,7 +51,6 @@ a password. If characters in the entry are selected and copied elsewhere, the information copied will be what is displayed, not the true contents of the entry. -.VS 8.4 .OP \-state state State Specifies one of three states for the entry: \fBnormal\fR, \fBdisabled\fR, or \fBreadonly\fR. If the entry is readonly, then the @@ -68,8 +61,6 @@ disabled, the value may not be changed, no insertion cursor will be displayed, the contents will not be selectable, and the entry may be displayed in a different color, depending on the values of the \fB-disabledforeground\fR and \fB-disabledbackground\fR options. -.VE 8.4 -.VS 8.3 .OP \-validate validate Validate Specifies the mode in which validation should operate: \fBnone\fR, \fBfocus\fR, \fBfocusin\fR, \fBfocusout\fR, \fBkey\fR, or \fBall\fR. @@ -83,7 +74,6 @@ the valid Tcl boolean equivalent) then it means you reject the new edition and it will not occur and the \fBinvalidCommand\fR will be evaluated if it is set. If it returns 1, then the new edition occurs. See \fBValidation\fR below for more information. -.VE .OP \-width width Width Specifies an integer value indicating the desired width of the entry window, in average-size characters of the widget's font. @@ -124,7 +114,6 @@ the standard \fBxScrollCommand\fR mechanism for interacting with scrollbars (see the description of the \fBxScrollCommand\fR option for details). They also support scanning, as described below. .SH VALIDATION -.VS 8.3 .PP Validation works by setting the \fBvalidateCommand\fR option to a script which will be evaluated according to the \fBvalidate\fR @@ -196,7 +185,6 @@ in the \fBvalidateCommand\fR or \fBinvalidCommand\fR (whichever one you were editing the entry widget from). It is also recommended to not set an associated \fBtextVariable\fR during validation, as that can cause the entry widget to become out of sync with the \fBtextVariable\fR. -.VE .SH "WIDGET COMMAND" .PP The \fBentry\fR command creates a new Tcl command whose @@ -375,14 +363,12 @@ If the selection isn't in this widget then a new selection is created using the most recent anchor point specified for the widget. Returns an empty string. .RE -.VS 8.3 .TP \fIpathName \fBvalidate\fR This command is used to force an evaluation of the \fBvalidateCommand\fR independent of the conditions specified by the \fBvalidate\fR option. This is done by temporarily setting the \fBvalidate\fR option to \fBall\fR. It returns 0 or 1. -.VE .TP \fIpathName \fBxview \fIargs\fR This command is used to query and change the horizontal position of the @@ -533,11 +519,9 @@ If the entry is disabled using the \fB\-state\fR option, then the entry's view can still be adjusted and text in the entry can still be selected, but no insertion cursor will be displayed and no text modifications will take place -.VS except if the entry is linked to a variable using the \fB\-textvariable\fR option, in which case any changes to the variable are reflected by the entry whatever the value of its \fB\-state\fR option. -.VE .PP The behavior of entries can be changed by defining new bindings for individual widgets or by redefining the class bindings. diff --git a/doc/event.n b/doc/event.n index 0facdb9..5849b85 100644 --- a/doc/event.n +++ b/doc/event.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: event.n,v 1.11 2005/01/12 11:03:33 dkf Exp $ +'\" RCS: @(#) $Id: event.n,v 1.12 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH event n 8.3 Tk "Tk Built-In Commands" @@ -51,10 +51,8 @@ trigger anymore. Generates a window event and arranges for it to be processed just as if it had come from the window system. \fIWindow\fR gives the path name of the window for which the event -.VS 8.3 will be generated; it may also be an identifier (such as returned by \fBwinfo id\fR) as long as it is for a window in the current application. -.VE \fIEvent\fR provides a basic description of the event, such as \fB\fR or \fB<>\fR. If \fIWindow\fR is empty the whole screen is meant, and coordinates diff --git a/doc/font.n b/doc/font.n index d888e2e..8e844d0 100644 --- a/doc/font.n +++ b/doc/font.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: font.n,v 1.7 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: font.n,v 1.8 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH font n 8.0 Tk "Tk Built-In Commands" @@ -114,7 +114,6 @@ The platform-specific name of a font, interpreted by the graphics server. This also includes, under X, an XLFD (see [4]) for which a single ``\fB*\fR'' character was used to elide more than one field in the middle of the name. See PLATFORM-SPECIFIC issues for a list of the system fonts. -.VS 8.0 br .TP [3] \fIfamily \fR?\fIsize\fR? ?\fIstyle\fR? ?\fIstyle ...\fR? . @@ -146,7 +145,6 @@ pixel size (not point size); although this interpretation is not strictly correct, all existing applications using XLFDs assumed that one ``point'' was in fact one pixel and would display incorrectly (generally larger) if the correct size font were actually used. -.VE .TP [5] \fIoption value \fR?\fIoption value ...\fR? . @@ -213,7 +211,6 @@ The \fIname\fR may also be the name of a native, platform-specific font family; in that case it will work as desired on one platform but may not display correctly on other platforms. If the family is unspecified or unrecognized, a platform-specific default font will be chosen. -.VS .TP \fB\-size \fIsize\fR . @@ -233,7 +230,6 @@ to a fixed-size bitmap. The mapping between points and pixels is set when the application starts, based on properties of the installed monitor, but it can be overridden by calling the \fBtk scaling\fR command. .RE -.VE .TP \fB\-weight \fIweight\fR . diff --git a/doc/getOpenFile.n b/doc/getOpenFile.n index 65fb110..017babe 100644 --- a/doc/getOpenFile.n +++ b/doc/getOpenFile.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: getOpenFile.n,v 1.13 2004/09/19 16:05:37 dkf Exp $ +'\" RCS: @(#) $Id: getOpenFile.n,v 1.14 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH tk_getOpenFile n 4.2 Tk "Tk Built-In Commands" @@ -43,10 +43,8 @@ enters a filename without an extension. The default value is the empty string, which means no extension will be appended to the filename in any case. This option is ignored on the Macintosh platform, which does not require extensions to filenames, -.VS 8.4 and the UNIX implementation guesses reasonable values for this from the \fB\-filetypes\fR option when this is not supplied. -.VE 8.4 .TP \fB\-filetypes\fR \fIfilePatternList\fR If a \fBFile types\fR listbox exists in the file dialog on the particular diff --git a/doc/listbox.n b/doc/listbox.n index 1a36230..4c76839 100644 --- a/doc/listbox.n +++ b/doc/listbox.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: listbox.n,v 1.11 2004/08/17 22:37:24 dkf Exp $ +'\" RCS: @(#) $Id: listbox.n,v 1.12 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH listbox n 8.4 Tk "Tk Built-In Commands" @@ -26,14 +26,12 @@ listbox \- Create and manipulate listbox widgets \-foreground .SE .SH "WIDGET-SPECIFIC OPTIONS" -.VS 8.4 .OP \-activestyle activeStyle ActiveStyle Specifies the style in which to draw the active element. This must be one of \fBdotbox\fR (show a focus ring around the active element), \fBnone\fR (no special indication of active element) or \fBunderline\fR (underline the active element). The default is \fBunderline\fR. -.VS 8.4 .OP \-height height Height Specifies the desired height for the window, in lines. If zero or less, then the desired height for the window is made just @@ -119,11 +117,9 @@ Indicates the anchor point for the selection, which is set with the .TP 12 \fBend\fR Indicates the end of the listbox. -.VS 8.0 For most commands this refers to the last element in the listbox, but for a few commands such as \fBindex\fR and \fBinsert\fR it refers to the element just after the last one. -.VE .TP 12 \fB@\fIx\fB,\fIy\fR Indicates the element that covers the point in the listbox window @@ -150,10 +146,8 @@ commands are possible for listbox widgets: .TP \fIpathName \fBactivate\fR \fIindex\fR Sets the active element to the one indicated by \fIindex\fR. -.VS 8.0 If \fIindex\fR is outside the range of elements in the listbox then the closest element is activated. -.VE The active element is drawn as specified by \fB\-activestyle\fR when the widget has the input focus, and its index may be retrieved with the index \fBactive\fR. @@ -167,9 +161,7 @@ of the upper-left corner of the screen area covered by the text elements give the width and height of the area, in pixels. If no part of the element given by \fIindex\fR is visible on the screen, -.VS 8.0 or if \fIindex\fR refers to a non-existent element, -.VE then the result is an empty string; if the element is partially visible, the result gives the full area of the element, including any parts that are not visible. @@ -209,9 +201,7 @@ to delete. If \fIlast\fR isn't specified it defaults to \fIpathName \fBget \fIfirst\fR ?\fIlast\fR? If \fIlast\fR is omitted, returns the contents of the listbox element indicated by \fIfirst\fR, -.VS 8.0 or an empty string if \fIfirst\fR refers to a non-existent element. -.VE If \fIlast\fR is specified, the command returns a list whose elements are all of the listbox elements between \fIfirst\fR and \fIlast\fR, inclusive. @@ -220,10 +210,8 @@ forms for indices. .TP \fIpathName \fBindex \fIindex\fR Returns the integer index value that corresponds to \fIindex\fR. -.VS 8.0 If \fIindex\fR is \fBend\fR the return value is a count of the number of elements in the listbox (not the index of the last element). -.VE .TP \fIpathName \fBinsert \fIindex \fR?\fIelement element ...\fR? Inserts zero or more new elements in the list just before the @@ -310,10 +298,8 @@ has several forms, depending on \fIoption\fR: .TP \fIpathName \fBselection anchor \fIindex\fR Sets the selection anchor to the element given by \fIindex\fR. -.VS 8.0 If \fIindex\fR refers to a non-existent element, then the closest element is used. -.VE The selection anchor is the end of the selection that is fixed while dragging out a selection with the mouse. The index \fBanchor\fR may be used to refer to the anchor diff --git a/doc/menu.n b/doc/menu.n index 422d0c7..96095e9 100644 --- a/doc/menu.n +++ b/doc/menu.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: menu.n,v 1.11 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: menu.n,v 1.12 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH menu n 4.1 Tk "Tk Built-In Commands" @@ -25,7 +25,6 @@ menu, tk_menuSetFocus \- Create and manipulate menu widgets .SE .SH "WIDGET-SPECIFIC OPTIONS" -.VS .OP \-postcommand postCommand Command If this option is specified then it provides a Tcl command to execute each time the menu is posted. The command is invoked by the \fBpost\fR @@ -33,7 +32,6 @@ widget command before posting the menu. Note that in Tk 8.0 on Macintosh and Windows, all post-commands in a system of menus are executed before any of those menus are posted. This is due to the limitations in the individual platforms' menu managers. -.VE .OP \-selectcolor selectColor Background For menu entries that are check buttons or radio buttons, this option specifies the color to display in the indicator when the check button @@ -54,7 +52,6 @@ the name of the name of the torn off menu window. For example, if the option's is ``\fBa b\fR'' and menu \fB.x.y\fR is torn off to create a new menu \fB.x.tearoff1\fR, then the command ``\fBa b .x.y .x.tearoff1\fR'' will be invoked. -.VS .OP \-title title Title The string will be used to title the window created when this menu is torn off. If the title is NULL, then the window will have the title @@ -67,7 +64,6 @@ returned by the configuration database will change if this option is changed, this does not affect the menu widget's behavior. This is used by the cloning mechanism and is not normally set outside of the Tk library. -.VE .BE .SH INTRODUCTION @@ -83,14 +79,12 @@ The \fBmenu\fR command returns its there must not exist a window named \fIpathName\fR, but \fIpathName\fR's parent must exist. .PP -.VS A menu is a widget that displays a collection of one-line entries arranged in one or more columns. There exist several different types of entries, each with different properties. Entries of different types may be combined in a single menu. Menu entries are not the same as entry widgets. In fact, menu entries are not even distinct widgets; the entire menu is one widget. -.VE .PP Menu entries are displayed with up to three separate fields. The main field is a label in the form of a text string, @@ -119,13 +113,11 @@ The default menu bindings will not allow a disabled entry to be activated or invoked. Disabled entries may be re-enabled, at which point it becomes possible to activate and invoke them again. -.VS .PP Whenever a menu's active entry is changed, a <> virtual event is send to the menu. The active item can then be queried from the menu, and an action can be taken, such as setting context-sensitive help text for the entry. -.VE .SH "COMMAND ENTRIES" .PP @@ -201,7 +193,6 @@ Tcl command of the form where \fImenu\fR is the path name of the associated menu, and \fIx\fR and \fIy\fR are the root-window coordinates of the upper-right corner of the cascade entry. -.VS On Unix, the lower-level menu is unposted by executing a Tcl command with the form .CS @@ -210,13 +201,10 @@ the form where \fImenu\fR is the name of the associated menu. On other platforms, the platform's native code takes care of unposting the menu. -.VE .PP -.VS If a \fB\-command\fR option is specified for a cascade entry then it is evaluated as a Tcl command whenever the entry is invoked. This is not supported on Windows. -.VE .SH "TEAR-OFF ENTRIES" .PP @@ -229,7 +217,6 @@ the top of the menu. Under the default bindings, invoking the tear-off entry causes a torn-off copy to be made of the menu and all of its submenus. -.VS .SH "MENUBARS" .PP Any menu can be set as a menubar for a toplevel window (see @@ -246,9 +233,7 @@ example of this concerns the handling of checkbuttons and radiobuttons within the menu. While it is permitted to put these menu elements on menubars, they may not be drawn with indicators on some platforms, due to system restrictions. -.VE -.VS .SH "SPECIAL MENUS IN MENUBARS" .PP Certain menus in a menubar will be treated specially. On the Macintosh, @@ -289,9 +274,7 @@ system menu. .PP When Tk see a Help menu on X Windows, the menu is moved to be last in the menubar and is right justified. -.VE -.VS .SH "CLONES" .PP When a menu is set as a menubar for a toplevel window, or when a menu @@ -302,7 +285,6 @@ clone. Additionally, any cascades that are pointed to are also cloned so that menu traversal will work right. Clones are destroyed when either the tearoff or menubar goes away, or when the original menu is destroyed. -.VE .SH "WIDGET COMMAND" .PP @@ -426,7 +408,6 @@ menu. \fB\-command \fIvalue\fR Specifies a Tcl command to execute when the menu entry is invoked. Not available for separator or tear-off entries. -.VS 8.4 .TP \fB\-compound \fIvalue\fR Specifies whether the menu entry should display both an image and text, @@ -436,7 +417,6 @@ Valid values for this option are \fBbottom\fR, \fBcenter\fR, is \fBnone\fR, meaning that the button will display either an image or text, depending on the values of the \fB\-image\fR and \fB\-bitmap\fR options. -.VE .TP \fB\-font \fIvalue\fR Specifies the font to use when drawing the label or accelerator @@ -451,14 +431,12 @@ is in the normal state (neither active nor disabled). If this option is specified as an empty string (the default), then the \fBforeground\fR option for the overall menu is used. This option is not available for separator or tear-off entries. -.VS .TP \fB\-hidemargin \fIvalue\fR Specifies whether the standard margins should be drawn for this menu entry. This is useful when creating palette with images in them, i.e., color palettes, pattern palettes, etc. 1 indicates that the margin for the entry is hidden; 0 means that the margin is used. -.VE .TP \fB\-image \fIvalue\fR Specifies an image to display in the menu instead of a text string @@ -556,7 +534,6 @@ Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBmenu\fR command. -.VS .TP \fIpathName\fR \fBclone\fR \fInewPathname ?cloneType?\fR Makes a clone of the current menu named \fInewPathName\fR. This clone @@ -565,7 +542,6 @@ propogated to the original menu and vice versa. \fIcloneType\fR can be \fBnormal\fR, \fBmenubar\fR, or \fBtearoff\fR. Should not normally be called outside of the Tk library. See the \fBCLONES\fR section for more information. -.VE .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? Query or modify the configuration options of the widget. @@ -656,12 +632,10 @@ command when the entry was created, such as \fBcommand\fR or \fBseparator\fR, or \fBtearoff\fR for a tear-off entry. .TP \fIpathName \fBunpost\fR -.VS Unmap the window so that it is no longer displayed. If a lower-level cascaded menu is posted, unpost that menu. Returns an empty string. This subcommand does not work on Windows and the Macintosh, as those platforms have their own way of unposting menus. -.VE .TP \fIpathName \fByposition \fIindex\fR Returns a decimal string giving the y-coordinate within the menu @@ -670,7 +644,6 @@ window of the topmost pixel in the entry specified by \fIindex\fR. .SH "MENU CONFIGURATIONS" .PP The default bindings support four different ways of using menus: -.VS .TP \fBPulldown Menus in Menubar\fR This is the most command case. You create a menu widget that will become the @@ -679,7 +652,6 @@ pull down menus you wish to use in your menu bar. You then create all of the pulldowns. Once you have done this, specify the menu using the \fB\-menu\fR option of the toplevel's widget command. See the \fBtoplevel\fR manual entry for details. -.VE .TP \fBPulldown Menus in Menu Buttons\fR This is the compatable way to do menu bars. You create one menubutton @@ -766,11 +738,9 @@ next menubutton to the right is posted. Disabled menu entries are non-responsive: they don't activate and they ignore mouse button presses and releases. .PP -.VS 8.4 Several of the bindings make use of the command \fBtk_menuSetFocus\fR. It saves the current focus and sets the focus to its \fIpathName\fR argument, which is a menu widget. -.VE .PP The behavior of menus can be changed by defining new bindings for individual widgets or by redefining the class bindings. diff --git a/doc/options.n b/doc/options.n index c71b87e..4522293 100644 --- a/doc/options.n +++ b/doc/options.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: options.n,v 1.10 2005/02/14 20:40:35 hobbs Exp $ +'\" RCS: @(#) $Id: options.n,v 1.11 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH options n 4.4 Tk "Tk Built-In Commands" @@ -45,10 +45,8 @@ will cause some action to occur. If strict Motif compliance has been requested by setting the \fBtk_strictMotif\fR variable, this option will normally be ignored; the normal background color will be used instead. -.VS For some elements on Windows and Macintosh systems, the active color will only be used while mouse button 1 is pressed over the element. -.VE .OP \-activeborderwidth activeBorderWidth BorderWidth Specifies a non-negative value indicating the width of the 3-D border drawn around active elements. See above for diff --git a/doc/photo.n b/doc/photo.n index 95a74d8..09221b6 100644 --- a/doc/photo.n +++ b/doc/photo.n @@ -9,7 +9,7 @@ '\" Department of Computer Science, '\" Australian National University. '\" -'\" RCS: @(#) $Id: photo.n,v 1.18 2004/08/20 14:15:29 dkf Exp $ +'\" RCS: @(#) $Id: photo.n,v 1.19 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH photo n 4.0 Tk "Tk Built-In Commands" @@ -32,10 +32,8 @@ C code through a procedural interface. At present, only GIF and PPM/PGM formats are supported, but an interface exists to allow additional image file formats to be added easily. A photo image is transparent in regions where no image data has been supplied -.VS 8.4 or where it has been set transparent by the \fBtransparency set\fR subcommand. -.VE 8.4 .SH "CREATING PHOTOS" .PP Like all images, photos are created using the \fBimage create\fR @@ -189,7 +187,6 @@ about the Y or X axes, respectively. If \fIy\fR is not given, the default value is the same as \fIx\fR. .TP \fB\-compositingrule \fIrule\fR -.VS 8.4 Specifies how transparent pixels in the source image are combined with the destination image. When a compositing rule of \fIoverlay\fR is set, the old contents of the destination image are visible, as if the @@ -198,7 +195,6 @@ over the top of the destination. When a compositing rule of \fIset\fR is set, the old contents of the destination image are discarded and the source image is used as-is. The default compositing rule is \fIoverlay\fR. -.VE 8.4 .RE .TP \fIimageName \fBdata ?\fIoption value(s) ...\fR? @@ -317,7 +313,6 @@ recalculate the dithered image in each window where the image is displayed. .TP \fIimageName \fBtransparency \fIsubcommand ?arg arg ...?\fR -.VS 8.4 Allows examination and manipulation of the transparency information in the photo image. Several subcommands are available: .RS @@ -330,7 +325,6 @@ transparent. Makes the pixel at (\fIx\fR,\fIy\fR) transparent if \fIboolean\fR is true, and makes that pixel opaque otherwise. .RE -.VE 8.4 .TP \fIimageName \fBwrite \fIfilename\fR ?\fIoption value(s) ...\fR? Writes image data from \fIimageName\fR to a file named \fIfilename\fR. @@ -391,10 +385,8 @@ for the \fB\-format\fR option must begin with the complete name of the requested handler, and may contain additional information following that, which the handler can use, for example, to specify which variant to use of the formats supported by the handler. -.VS 8.4 Note that not all image handlers may support writing transparency data to a file, even where the target image format does. -.VE 8.4 .SH "COLOR ALLOCATION" .PP When a photo image is displayed in a window, the photo image code diff --git a/doc/radiobutton.n b/doc/radiobutton.n index 902d205..549e62c 100644 --- a/doc/radiobutton.n +++ b/doc/radiobutton.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: radiobutton.n,v 1.9 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: radiobutton.n,v 1.10 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH radiobutton n 4.4 Tk "Tk Built-In Commands" @@ -54,7 +54,6 @@ whenever the widget is selected. If specified as an empty string then no special color is used for displaying when the widget is selected. .OP \-offrelief offRelief OffRelief -.VS 8.4 Specifies the relief for the checkbutton when the indicator is not drawn and the checkbutton is off. The default value is "raised". By setting this option to "flat" and setting -indicatoron to false and -overrelief to raised, @@ -63,16 +62,13 @@ of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Align-Left, Align-Right, and Center radiobuttons on the toolbar of a word-processor, for example. -.VE 8.4 .OP \-overrelief overRelief OverRelief -.VS 8.4 Specifies an alternative relief for the radiobutton, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring \fB\-relief flat \-overrelief raised\fR. If the value of this option is the empty string, then no alternative relief is used when the mouse cursor is over the radiobutton. The empty string is the default value. -.VE 8.4 .OP \-selectimage selectImage SelectImage Specifies an image to display (in place of the \fBimage\fR option) when the radiobutton is selected. @@ -131,10 +127,8 @@ text, and initial relief. The \fBradiobutton\fR command returns its there must not exist a window named \fIpathName\fR, but \fIpathName\fR's parent must exist. .PP -.VS A radiobutton is a widget that displays a textual string, bitmap or image and a diamond or circle called an \fIindicator\fR. -.VE If text is displayed, it must all be in a single font, but it can occupy multiple lines on the screen (if it contains newlines or if wrapping occurs because of the \fBwrapLength\fR option) and @@ -149,7 +143,6 @@ check button. .PP In addition, radiobuttons can be \fIselected\fR. If a radiobutton is selected, the indicator is normally -.VS drawn with a selected appearance, and a Tcl variable associated with the radiobutton is set to a particular value (normally 1). @@ -159,7 +152,6 @@ If the radiobutton is not selected, then the indicator is drawn with a deselected appearance, and the associated variable is set to a different value (typically 0). The indicator is drawn without a round mark inside. -.VE Typically, several radiobuttons share a single variable and the value of the variable indicates which radiobutton is to be selected. When a radiobutton is selected it sets the value of the variable to @@ -244,14 +236,12 @@ value corresponding to this widget. Tk automatically creates class bindings for radiobuttons that give them the following default behavior: .IP [1] -.VS On Unix systems, a radiobutton activates whenever the mouse passes over it and deactivates whenever the mouse leaves the radiobutton. On Mac and Windows systems, when mouse button 1 is pressed over a radiobutton, the button activates whenever the mouse pointer is inside the button, and deactivates whenever the mouse pointer leaves the button. -.VE .IP [2] When mouse button 1 is pressed over a radiobutton it is invoked (it becomes selected and the command associated with the button is diff --git a/doc/selection.n b/doc/selection.n index 272f9f5..9a99426 100644 --- a/doc/selection.n +++ b/doc/selection.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: selection.n,v 1.6 2004/10/28 12:25:53 dkf Exp $ +'\" RCS: @(#) $Id: selection.n,v 1.7 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH selection n 8.1 Tk "Tk Built-In Commands" @@ -73,7 +73,6 @@ and \fItype\fR is the requested type, \fIcommand\fR will be executed as a Tcl command with two additional numbers appended to it (with space separators). The two additional numbers -.VS are \fIoffset\fR and \fImaxChars\fR: \fIoffset\fR specifies a starting character position in the selection and \fImaxChars\fR gives the maximum number of characters to retrieve. The command should return a value consisting @@ -87,7 +86,6 @@ include all of the remainder of the selection; if the length of \fIcommand\fR will be invoked again, until it eventually returns a result shorter than \fImaxChars\fR. The value of \fImaxChars\fR will always be relatively large (thousands of characters). -.VE .PP If \fIcommand\fR returns an error then the selection retrieval is rejected just as if the selection didn't exist at all. diff --git a/doc/send.n b/doc/send.n index 5de1b84..fc2fe65 100644 --- a/doc/send.n +++ b/doc/send.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: send.n,v 1.4 2004/06/21 14:06:37 dkf Exp $ +'\" RCS: @(#) $Id: send.n,v 1.5 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH send n 4.0 Tk "Tk Built-In Commands" @@ -87,10 +87,8 @@ list of enabled hosts is empty. This means that applications cannot connect to your server unless they use some other form of authorization such as that provide by \fBxauth\fR. -.VS Under Windows, \fBsend\fR is currently disabled. Most of the functionality is provided by the \fBdde\fR command instead. -.VE .SH EXAMPLE This script fragment can be used to make an application that only runs once on a particular display. @@ -109,6 +107,4 @@ proc RemoteStart args { } .CE .SH KEYWORDS -.VS application, dde, name, remote execution, security, send -.VE diff --git a/doc/tk.n b/doc/tk.n index 049304b..587fbc2 100644 --- a/doc/tk.n +++ b/doc/tk.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tk.n,v 1.8 2004/03/17 18:15:42 das Exp $ +'\" RCS: @(#) $Id: tk.n,v 1.9 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH tk n 8.4 Tk "Tk Built-In Commands" @@ -43,7 +43,6 @@ be able to find some options for the application. If sends have been disabled by deleting the \fBsend\fR command, this command will reenable them and recreate the \fBsend\fR command. -.VS 8.4 .TP \fBtk caret window \fR?\fB\-x \fIx\fR? ?\fB\-y \fIy\fR? ?\fB\-height \fIheight\fR? . @@ -56,7 +55,6 @@ the last values used for setting the caret are return in option-value pair format. \fI\-x\fR and \fI\-y\fR represent window-relative coordinates, and \fI\-height\fR is the height of the current cursor location, or the height of the specified \fIwindow\fR if none is given. -.VE .TP \fBtk scaling \fR?\fB\-displayof \fIwindow\fR? ?\fInumber\fR? . @@ -80,7 +78,6 @@ after the scaling factor is changed will use the new scaling factor, but it is undefined whether existing widgets will resize themselves dynamically to accomodate the new scaling factor. .RE -.VS 8.3 .TP \fBtk useinputmethods \fR?\fB\-displayof \fIwindow\fR? ?\fIboolean\fR? . @@ -91,14 +88,11 @@ feature is only significant on X. If XIM support is not available, this will always return 0. If the \fIwindow\fR argument is omitted, it defaults to the main window. If the \fIboolean\fR argument is omitted, the current state is returned. This is turned on by default for the main display. -.VE -.VS 8.4 .TP \fBtk windowingsystem\fR . Returns the current Tk windowing system, one of \fBx11\fR (X11-based), \fBwin32\fR (MS Windows), or \fBaqua\fR (Mac OS X Aqua). -.VE .SH KEYWORDS application name, send diff --git a/doc/winfo.n b/doc/winfo.n index 76f29c3..43bb69c 100644 --- a/doc/winfo.n +++ b/doc/winfo.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: winfo.n,v 1.7 2004/10/28 12:25:53 dkf Exp $ +'\" RCS: @(#) $Id: winfo.n,v 1.8 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH winfo n 4.3 Tk "Tk Built-In Commands" @@ -110,12 +110,10 @@ or use \fBwinfo reqheight\fR to get the window's requested height instead of its actual height. .TP \fBwinfo id \fIwindow\fR -.VS Returns a hexadecimal string giving a low-level platform-specific identifier for \fIwindow\fR. On Unix platforms, this is the X window identifier. Under Windows, this is the Windows HWND. On the Macintosh the value has no meaning outside Tk. -.VE .TP \fBwinfo interps \fR?\fB\-displayof \fIwindow\fR? Returns a list whose members are the names of all Tcl interpreters diff --git a/doc/wm.n b/doc/wm.n index e98407e..adee805 100644 --- a/doc/wm.n +++ b/doc/wm.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: wm.n,v 1.22 2005/02/17 00:06:08 mdejong Exp $ +'\" RCS: @(#) $Id: wm.n,v 1.23 2005/04/06 21:11:54 dkf Exp $ '\" .so man.macros .TH wm n 8.5 Tk "Tk Built-In Commands" @@ -44,7 +44,6 @@ a Tcl list containing four elements, which are the current values of \fIminNumer\fR, \fIminDenom\fR, \fImaxNumer\fR, and \fImaxDenom\fR (if no aspect restrictions are in effect, then an empty string is returned). -.VS 8.4 .TP \fBwm attributes \fIwindow\fR .TP @@ -63,12 +62,13 @@ disabled state. \fB\-toolwindow\fR gets or sets the style of the window to toolwindow (as defined in the MSDN). \fB\-topmost\fR gets or sets whether this is a topmost window (displays above all other windows). .VS 8.5 +The \fB\-alpha\fR sets the alpha transparency level of the toplevel. It accepts a value from \fB0.0\fR (fully transparent) to \fB1.0\fR (opaque). Values outside that range will be constrained. This is supported on Windows 2000/XP+. Where not supported, the \fB\-alpha\fR value remains at \fB1.0\fR. -.VE 8.5 +The \fB\-fullscreen\fR attribute will place the window in a mode that takes up the entire screen, has no borders, and covers the Start menu and taskbar. @@ -84,7 +84,6 @@ values outside that range will be constrained. .PP On Unix, there are currently no special attribute values. .RE -.VE 8.4 .TP \fBwm client \fIwindow\fR ?\fIname\fR? If \fIname\fR is specified, this command stores \fIname\fR (which @@ -161,14 +160,12 @@ The focus model defaults to \fBpassive\fR, and Tk's \fBfocus\fR command assumes a passive model of focusing. .TP \fBwm frame \fIwindow\fR -.VS If \fIwindow\fR has been reparented by the window manager into a decorative frame, the command returns the platform specific window identifier for the outermost frame that contains \fIwindow\fR (the window whose parent is the root or virtual root). If \fIwindow\fR hasn't been reparented by the window manager then the command returns the platform specific window identifier for \fIwindow\fR. -.VE .TP \fBwm geometry \fIwindow\fR ?\fInewGeometry\fR? If \fInewGeometry\fR is specified, then the geometry of \fIwindow\fR -- cgit v0.12