From 2f4b99c2d164ebbc4b182ae7eb1f0d635aea6b87 Mon Sep 17 00:00:00 2001 From: dkf Date: Thu, 25 Jan 2024 17:50:00 +0000 Subject: Another round of small fixes, especially spelling errors... --- doc/3DBorder.3 | 78 ++++++++--------- doc/AddOption.3 | 1 + doc/BindTable.3 | 17 ++-- doc/CanvPsY.3 | 1 + doc/CanvTkwin.3 | 3 +- doc/CanvTxtInfo.3 | 3 +- doc/Clipboard.3 | 1 + doc/ClrSelect.3 | 1 + doc/ConfigWidg.3 | 49 ++++++++--- doc/ConfigWind.3 | 1 + doc/CoordToWin.3 | 1 + doc/CrtCmHdlr.3 | 1 + doc/CrtConsoleChan.3 | 1 + doc/CrtErrHdlr.3 | 1 + doc/CrtGenHdlr.3 | 1 + doc/CrtImgType.3 | 3 +- doc/CrtItemType.3 | 13 +-- doc/CrtPhImgFmt.3 | 50 +++++------ doc/CrtSelHdlr.3 | 1 + doc/CrtWindow.3 | 1 + doc/DeleteImg.3 | 1 + doc/DrawFocHlt.3 | 3 +- doc/EventHndlr.3 | 1 + doc/FindPhoto.3 | 3 +- doc/FontId.3 | 9 +- doc/GeomReq.3 | 13 ++- doc/GetAnchor.3 | 7 +- doc/GetBitmap.3 | 99 ++++++++------------- doc/GetCapStyl.3 | 5 +- doc/GetClrmap.3 | 7 +- doc/GetColor.3 | 19 ++-- doc/GetCursor.3 | 21 +++-- doc/GetFont.3 | 19 ++-- doc/GetGC.3 | 3 +- doc/GetHINSTANCE.3 | 1 + doc/GetHWND.3 | 1 + doc/GetImage.3 | 1 + doc/GetJoinStl.3 | 5 +- doc/GetJustify.3 | 16 ++-- doc/GetOption.3 | 1 + doc/GetPixels.3 | 26 +++--- doc/GetPixmap.3 | 5 +- doc/GetRelief.3 | 7 +- doc/GetRootCrd.3 | 1 + doc/GetScroll.3 | 5 +- doc/GetSelect.3 | 1 + doc/GetUid.3 | 1 + doc/GetVRoot.3 | 3 +- doc/GetVisual.3 | 8 +- doc/Grab.3 | 2 +- doc/HWNDToWindow.3 | 1 + doc/HandleEvent.3 | 1 + doc/IdToWindow.3 | 1 + doc/ImgChanged.3 | 1 + doc/Inactive.3 | 5 +- doc/InternAtom.3 | 5 +- doc/MainLoop.3 | 1 + doc/MainWin.3 | 5 +- doc/MaintGeom.3 | 1 + doc/ManageGeom.3 | 1 + doc/MapWindow.3 | 1 + doc/MeasureChar.3 | 14 +-- doc/MoveToplev.3 | 3 +- doc/Name.3 | 1 + doc/NameOfImg.3 | 1 + doc/OwnSelect.3 | 1 + doc/ParseArgv.3 | 68 ++++++--------- doc/QWinEvent.3 | 1 + doc/Restack.3 | 1 + doc/RestrictEv.3 | 1 + doc/SetAppName.3 | 1 + doc/SetCaret.3 | 1 + doc/SetClass.3 | 1 + doc/SetClassProcs.3 | 3 +- doc/SetGrid.3 | 1 + doc/SetOptions.3 | 150 ++++++++++++++------------------ doc/SetVisual.3 | 3 +- doc/StrictMotif.3 | 1 + doc/TextLayout.3 | 23 +++-- doc/TkInitStubs.3 | 1 + doc/Tk_Init.3 | 10 +++ doc/WinUtil.3 | 9 +- doc/WindowId.3 | 3 +- doc/bind.n | 9 +- doc/bitmap.n | 6 ++ doc/busy.n | 11 +-- doc/button.n | 10 +-- doc/canvas.n | 233 +++++++++++++++++++++++++++++++++++--------------- doc/checkbutton.n | 10 +-- doc/chooseColor.n | 8 +- doc/chooseDirectory.n | 18 +++- doc/clipboard.n | 8 +- doc/colors.n | 3 +- doc/console.n | 3 +- doc/cursors.n | 2 + doc/dialog.n | 18 ++-- doc/entry.n | 20 ++++- doc/event.n | 29 ++++++- doc/focus.n | 13 +-- doc/focusNext.n | 7 +- doc/font.n | 74 ++++++++-------- doc/fontchooser.n | 40 ++++++--- doc/getOpenFile.n | 15 +++- doc/grab.n | 10 ++- doc/grid.n | 85 +++++++++--------- doc/image.n | 12 +-- doc/label.n | 18 ++-- doc/labelframe.n | 14 +-- doc/listbox.n | 26 +++--- doc/menu.n | 57 ++++++------ doc/messageBox.n | 45 +++++----- doc/nsimage.n | 45 +++++----- doc/option.n | 12 +-- doc/options.n | 2 +- doc/pack.n | 67 ++++++++++----- doc/palette.n | 4 +- doc/panedwindow.n | 31 +++---- doc/photo.n | 93 +++++++++++++------- doc/place.n | 34 ++++++-- doc/popup.n | 6 +- doc/radiobutton.n | 7 +- doc/raise.n | 10 +-- doc/scale.n | 4 +- doc/scrollbar.n | 27 +++--- doc/selection.n | 8 +- doc/send.n | 8 +- doc/spinbox.n | 17 +++- doc/sysnotify.n | 1 + doc/systray.n | 9 +- doc/text.n | 64 +++++++++++++- doc/tk_mac.n | 29 ++++++- doc/tkerror.n | 6 +- doc/tkvars.n | 10 +++ doc/tkwait.n | 4 +- doc/ttk_Geometry.3 | 3 +- doc/ttk_button.n | 2 +- doc/ttk_entry.n | 3 +- doc/ttk_image.n | 26 ++++-- doc/ttk_intro.n | 20 ++--- doc/ttk_notebook.n | 10 ++- doc/ttk_panedwindow.n | 2 + doc/ttk_sizegrip.n | 6 +- doc/ttk_spinbox.n | 6 +- doc/ttk_style.n | 18 +++- doc/ttk_treeview.n | 62 ++++++++------ doc/ttk_vsapi.n | 8 +- doc/ttk_widget.n | 48 +++-------- doc/winfo.n | 50 ++++++++++- doc/wish.1 | 21 ++++- doc/wm.n | 104 +++++++++++----------- 150 files changed, 1518 insertions(+), 1016 deletions(-) diff --git a/doc/3DBorder.3 b/doc/3DBorder.3 index a6deb30..d609d6d 100644 --- a/doc/3DBorder.3 +++ b/doc/3DBorder.3 @@ -13,58 +13,49 @@ Tk_Alloc3DBorderFromObj, Tk_ClipDrawableToRect, Tk_DrawHighlightBorder, Tk_Get3D .SH SYNOPSIS .nf \fB#include \fR -.sp + Tk_3DBorder -\fBTk_Alloc3DBorderFromObj(\fIinterp, tkwin, objPtr\fB)\fR +\fBTk_Alloc3DBorderFromObj\fR(\fIinterp, tkwin, objPtr\fR) .sp -void -\fBTk_ClipDrawableToRect(\fIdisplay, drawable, x, y, width, height\fB)\fR +\fBTk_ClipDrawableToRect\fR(\fIdisplay, drawable, x, y, width, height\fR) .sp -void -\fBTk_DrawHighlightBorder(\fItkwin, fgGC, bgGC, highlightWidth, drawable\fB)\fR +\fBTk_DrawHighlightBorder\fR(\fItkwin, fgGC, bgGC, highlightWidth, drawable\fR) .sp Tk_3DBorder -\fBTk_Get3DBorder(\fIinterp, tkwin, colorName\fB)\fR +\fBTk_Get3DBorder\fR(\fIinterp, tkwin, colorName\fR) .sp -void -\fBTk_Get3DBorderColors(\fIborder, bgColorPtr, darkColorPtr, lightColorPtr\fB)\fR +\fBTk_Get3DBorderColors\fR(\fIborder, bgColorPtr, darkColorPtr, lightColorPtr\fR) .sp Tk_3DBorder -\fBTk_Get3DBorderFromObj(\fItkwin, objPtr\fB)\fR +\fBTk_Get3DBorderFromObj\fR(\fItkwin, objPtr\fR) .sp -void -\fBTk_Draw3DRectangle(\fItkwin, drawable, border, x, y, width, height, borderWidth, relief\fB)\fR +\fBTk_Draw3DRectangle\fR(\fItkwin, drawable, border, x, y, width, height, borderWidth, relief\fR) .sp -void -\fBTk_Fill3DRectangle(\fItkwin, drawable, border, x, y, width, height, borderWidth, relief\fB)\fR +\fBTk_Fill3DRectangle\fR(\fItkwin, drawable, border, x, y, width, height, borderWidth, relief\fR) .sp -void -\fBTk_Draw3DPolygon(\fItkwin, drawable, border, pointPtr, numPoints, polyBorderWidth, leftRelief\fB)\fR +\fBTk_Draw3DPolygon\fR(\fItkwin, drawable, border, pointPtr, numPoints, polyBorderWidth, leftRelief\fR) .sp -void -\fBTk_Fill3DPolygon(\fItkwin, drawable, border, pointPtr, numPoints, polyBorderWidth, leftRelief\fB)\fR +\fBTk_Fill3DPolygon\fR(\fItkwin, drawable, border, pointPtr, numPoints, polyBorderWidth, leftRelief\fR) .sp -void -\fBTk_3DVerticalBevel\fR(\fItkwin, drawable, border, x, y, width, height, leftBevel, relief\fB)\fR +\fBTk_3DVerticalBevel\fR(\fItkwin, drawable, border, x, y, width, height, leftBevel, relief\fR) .sp -void -\fBTk_3DHorizontalBevel\fR(\fItkwin, drawable, border, x, y, width, height, leftIn, rightIn, topBevel, relief\fB)\fR +\fBTk_3DHorizontalBevel\fR(\fItkwin, drawable, border, x, y, width, height, leftIn, rightIn, topBevel, relief\fR) .sp -void -\fBTk_SetBackgroundFromBorder(\fItkwin, border\fB)\fR +\fBTk_SetBackgroundFromBorder\fR(\fItkwin, border\fR) .sp const char * -\fBTk_NameOf3DBorder(\fIborder\fB)\fR +\fBTk_NameOf3DBorder\fR(\fIborder\fR) .sp XColor * -\fBTk_3DBorderColor(\fIborder\fB)\fR +\fBTk_3DBorderColor\fR(\fIborder\fR) .sp GC * -\fBTk_3DBorderGC(\fItkwin, border, which\fB)\fR +\fBTk_3DBorderGC\fR(\fItkwin, border, which\fR) .sp -\fBTk_Free3DBorderFromObj(\fItkwin, objPtr\fB)\fR +\fBTk_Free3DBorderFromObj\fR(\fItkwin, objPtr\fR) .sp -\fBTk_Free3DBorder(\fIborder\fB)\fR +\fBTk_Free3DBorder\fR(\fIborder\fR) +.fi .SH ARGUMENTS .AS "Tk_3DBorder" borderWidth .AP Tcl_Interp *interp in @@ -100,7 +91,8 @@ Width of border in pixels. Positive means border is inside rectangle given by \fIx\fR, \fIy\fR, \fIwidth\fR, \fIheight\fR, negative means border is outside rectangle. .AP int highlightWidth in -Width of ring around the outside of the widget if the widget has received the input focus. +Width of ring around the outside of the widget if the widget has received the +input focus. .AP int relief in Indicates 3-D position of interior of value relative to exterior; should be \fBTK_RELIEF_RAISED\fR, \fBTK_RELIEF_SUNKEN\fR, \fBTK_RELIEF_GROOVE\fR, @@ -147,9 +139,11 @@ Must be \fBTK_3D_FLAT_GC\fR, \fBTK_3D_LIGHT_GC\fR, or \fBTK_3D_DARK_GC\fR. .AP XColor *bgColorPtr out Pointer to location in which to store the background color of the given border. .AP XColor *darkColorPtr out -Pointer to location in which to store the color for darker areas of the given border. +Pointer to location in which to store the color for darker areas of the +given border. .AP XColor *lightColorPtr out -Pointer to location in which to store the color for lighter areas of the given border. +Pointer to location in which to store the color for lighter areas of the +given border. .AP GC fgGC in Foreground X graphics context. .AP GC fgGC in @@ -180,12 +174,15 @@ information about the return value in \fIobjPtr\fR, which speeds up future calls to \fBTk_Alloc3DBorderFromObj\fR with the same \fIobjPtr\fR and \fItkwin\fR. .PP -\fBTk_ClipDrawableToRect\fR will clip all drawing into the drawable d to the given rectangle. If width or height are negative, reset to no clipping. -Subsequent drawing into d is offset and clipped as specified. -The function is only used when \fBTK_NO_DOUBLE_BUFFERING\fR is specified at compile time. +\fBTk_ClipDrawableToRect\fR will clip all drawing into the drawable \fId\fR +to the given rectangle. If \fIwidth\fR or \fIheight\fR are negative, reset +to no clipping. +Subsequent drawing into \fId\fR is offset and clipped as specified. +The function is only used when \fBTK_NO_DOUBLE_BUFFERING\fR is specified at +compile time. .PP -\fBTk_DrawHighlightBorder\fR draws a rectangular ring around the outside of a widget -to indicate that it has received the input focus. +\fBTk_DrawHighlightBorder\fR draws a rectangular ring around the outside of +a widget to indicate that it has received the input focus. On the Macintosh, this puts a 1 pixel border in the bgGC color between the widget and the focus ring, except in the case where highlightWidth is 1, in which case the border is left out. @@ -226,8 +223,8 @@ which of several three-dimensional effects is desired: \fBTK_RELIEF_RAISED\fR means that the interior of the rectangle should appear raised relative to the exterior of the rectangle, and \fBTK_RELIEF_SUNKEN\fR means that the interior should appear depressed. -\fBTK_RELIEF_GROOVE\fR and \fBTK_RELIEF_RIDGE\fR mean that there should appear to be -a groove or ridge around the exterior of the rectangle. +\fBTK_RELIEF_GROOVE\fR and \fBTK_RELIEF_RIDGE\fR mean that there should +appear to be a groove or ridge around the exterior of the rectangle. .PP \fBTk_Fill3DRectangle\fR is somewhat like \fBTk_Draw3DRectangle\fR except that it first fills the rectangular area with the background color @@ -325,4 +322,5 @@ 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, value, polygon, raised, shadow, three-dimensional effect +3D, background, border, color, depressed, illumination, value, polygon, +raised, shadow, three-dimensional effect diff --git a/doc/AddOption.3 b/doc/AddOption.3 index fc46492..9d20a55 100644 --- a/doc/AddOption.3 +++ b/doc/AddOption.3 @@ -16,6 +16,7 @@ void .sp Tcl_Obj * \fBTk_GetSystemDefault\fR(\fItkwin, dbName, className\fR) +.fi .SH ARGUMENTS .AP Tk_Window tkwin in Token for window. diff --git a/doc/BindTable.3 b/doc/BindTable.3 index af2c8c5..960801d 100644 --- a/doc/BindTable.3 +++ b/doc/BindTable.3 @@ -15,24 +15,25 @@ Tk_CreateBindingTable, Tk_DeleteBindingTable, Tk_CreateBinding, Tk_DeleteBinding \fB#include \fR .sp Tk_BindingTable -\fBTk_CreateBindingTable(\fIinterp\fB)\fR +\fBTk_CreateBindingTable\fR(\fIinterp\fR) .sp -\fBTk_DeleteBindingTable(\fIbindingTable\fB)\fR +\fBTk_DeleteBindingTable\fR(\fIbindingTable\fR) .sp unsigned long -\fBTk_CreateBinding(\fIinterp, bindingTable, object, eventString, script, append\fB)\fR +\fBTk_CreateBinding\fR(\fIinterp, bindingTable, object, eventString, script, append\fR) .sp int -\fBTk_DeleteBinding(\fIinterp, bindingTable, object, eventString\fB)\fR +\fBTk_DeleteBinding\fR(\fIinterp, bindingTable, object, eventString\fR) .sp const char * -\fBTk_GetBinding(\fIinterp, bindingTable, object, eventString\fB)\fR +\fBTk_GetBinding\fR(\fIinterp, bindingTable, object, eventString\fR) .sp -\fBTk_GetAllBindings(\fIinterp, bindingTable, object\fB)\fR +\fBTk_GetAllBindings\fR(\fIinterp, bindingTable, object\fR) .sp -\fBTk_DeleteAllBindings(\fIbindingTable, object\fB)\fR +\fBTk_DeleteAllBindings\fR(\fIbindingTable, object\fR) .sp -\fBTk_BindEvent(\fIbindingTable, eventPtr, tkwin, numObjects, objectPtr\fB)\fR +\fBTk_BindEvent\fR(\fIbindingTable, eventPtr, tkwin, numObjects, objectPtr\fR) +.fi .SH ARGUMENTS .AS Tk_BindingTable bindingTable .AP Tcl_Interp *interp in diff --git a/doc/CanvPsY.3 b/doc/CanvPsY.3 index 3678085..5b613fb 100644 --- a/doc/CanvPsY.3 +++ b/doc/CanvPsY.3 @@ -29,6 +29,7 @@ int .sp int \fBTk_CanvasPsStipple\fR(\fIinterp, canvas, bitmap\fR) +.fi .SH ARGUMENTS .AS Tcl_Size "numPoints" .AP Tk_Canvas canvas in diff --git a/doc/CanvTkwin.3 b/doc/CanvTkwin.3 index 5cb29fa..0862d82 100644 --- a/doc/CanvTkwin.3 +++ b/doc/CanvTkwin.3 @@ -30,6 +30,7 @@ int Tk_OptionParseProc *\fBTk_CanvasTagsParseProc\fR; .sp Tk_OptionPrintProc *\fBTk_CanvasTagsPrintProc\fR; +.fi .SH ARGUMENTS .AS Tk_ItemType *drawableXPtr .AP Tk_Canvas canvas in @@ -149,7 +150,7 @@ static const Tk_CustomOption tagsOption = {Tk_CanvasTagsParseProc, static const Tk_ConfigSpec configSpecs[] = { ... - {TK_CONFIG_CUSTOM, "\-tags", NULL, NULL, + {TK_CONFIG_CUSTOM, "-tags", NULL, NULL, NULL, 0, TK_CONFIG_NULL_OK, &tagsOption}, ... }; diff --git a/doc/CanvTxtInfo.3 b/doc/CanvTxtInfo.3 index 1dd2354..9bc280b 100644 --- a/doc/CanvTxtInfo.3 +++ b/doc/CanvTxtInfo.3 @@ -15,6 +15,7 @@ Tk_CanvasTextInfo \- additional information for managing text items in canvases .sp Tk_CanvasTextInfo * \fBTk_CanvasGetTextInfo\fR(\fIcanvas\fR) +.fi .SH ARGUMENTS .AS Tk_Canvas canvas .AP Tk_Canvas canvas in @@ -31,7 +32,7 @@ a structure that is shared between Tk and all the items that display text. The structure has the following form: .CS -typedef struct Tk_CanvasTextInfo { +typedef struct { Tk_3DBorder \fIselBorder\fR; int \fIselBorderWidth\fR; XColor *\fIselFgColorPtr\fR; diff --git a/doc/Clipboard.3 b/doc/Clipboard.3 index cc09018..a4fcb6b 100644 --- a/doc/Clipboard.3 +++ b/doc/Clipboard.3 @@ -19,6 +19,7 @@ int .sp int \fBTk_ClipboardAppend\fR(\fIinterp, tkwin, target, format, buffer\fR) +.fi .SH ARGUMENTS .AS Tk_ClipboardClear tkwin .AP Tcl_Interp *interp in diff --git a/doc/ClrSelect.3 b/doc/ClrSelect.3 index 1b942b5..27dcd45 100644 --- a/doc/ClrSelect.3 +++ b/doc/ClrSelect.3 @@ -15,6 +15,7 @@ Tk_ClearSelection \- Deselect a selection \fB#include \fR .sp \fBTk_ClearSelection\fR(\fItkwin, selection\fR) +.fi .SH ARGUMENTS .AS Tk_Window tkwin .AP Tk_Window tkwin in diff --git a/doc/ConfigWidg.3 b/doc/ConfigWidg.3 index 09e4df0..61c49e8 100644 --- a/doc/ConfigWidg.3 +++ b/doc/ConfigWidg.3 @@ -15,15 +15,16 @@ Tk_ConfigureWidget, Tk_ConfigureInfo, Tk_ConfigureValue, Tk_FreeOptions \- proce \fB#include \fR .sp int -\fBTk_ConfigureWidget(\fIinterp, tkwin, specs, objc, objv, widgRec, flags\fB)\fR +\fBTk_ConfigureWidget\fR(\fIinterp, tkwin, specs, objc, objv, widgRec, flags\fR) .sp int -\fBTk_ConfigureInfo(\fIinterp, tkwin, specs, widgRec, argvName, flags\fB)\fR +\fBTk_ConfigureInfo\fR(\fIinterp, tkwin, specs, widgRec, argvName, flags\fR) .sp int -\fBTk_ConfigureValue(\fIinterp, tkwin, specs, widgRec, argvName, flags\fB)\fR +\fBTk_ConfigureValue\fR(\fIinterp, tkwin, specs, widgRec, argvName, flags\fR) .sp -\fBTk_FreeOptions(\fIspecs, widgRec, display, flags\fB)\fR +\fBTk_FreeOptions\fR(\fIspecs, widgRec, display, flags\fR) +.fi .SH ARGUMENTS .AS void *widgRec in/out .AP Tcl_Interp *interp in @@ -62,8 +63,8 @@ order to free up resources. .BE .SH DESCRIPTION .PP -Note: \fBTk_ConfigureWidget\fR should be replaced with the new -\fBTcl_Obj\fR based API \fBTk_SetOptions\fR. The old interface is +Note that \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. .PP \fBTk_ConfigureWidget\fR is called to configure various aspects of a @@ -171,6 +172,7 @@ to do with the string value of that configuration option. The legal values for \fItype\fR, and the corresponding actions, are: .TP \fBTK_CONFIG_ACTIVE_CURSOR\fR +. The value must be an ASCII string identifying a cursor in a form suitable for passing to \fBTk_GetCursor\fR. @@ -185,12 +187,14 @@ If the previous value of the target was not \fBNone\fR, then it is freed by passing it to \fBTk_FreeCursor\fR. .TP \fBTK_CONFIG_ANCHOR\fR +. The value must be an ASCII string identifying an anchor point in one of the ways accepted by \fBTk_GetAnchor\fR. The string is converted to a \fBTk_Anchor\fR by calling \fBTk_GetAnchor\fR and the result is stored in the target. .TP \fBTK_CONFIG_BITMAP\fR +. The value must be an ASCII string identifying a bitmap in a form suitable for passing to \fBTk_GetBitmap\fR. The value is converted to a \fBPixmap\fR by calling \fBTk_GetBitmap\fR and the result @@ -201,6 +205,7 @@ If the previous value of the target was not \fBNone\fR, then it is freed by passing it to \fBTk_FreeBitmap\fR. .TP \fBTK_CONFIG_BOOLEAN\fR +. The value must be an ASCII string specifying a boolean value. Any of the values .QW true , @@ -220,6 +225,7 @@ The target is expected to be an integer; for true values it will be set to 1 and for false values it will be set to 0. .TP \fBTK_CONFIG_BORDER\fR +. The value must be an ASCII string identifying a border color in a form suitable for passing to \fBTk_Get3DBorder\fR. The value is converted to a (\fBTk_3DBorder *\fR) by calling \fBTk_Get3DBorder\fR and the result @@ -230,6 +236,7 @@ If the previous value of the target was not NULL, then it is freed by passing it to \fBTk_Free3DBorder\fR. .TP \fBTK_CONFIG_CAP_STYLE\fR +. The value must be an ASCII string identifying a cap style in one of the ways accepted by \fBTk_GetCapStyle\fR. @@ -238,6 +245,7 @@ to the cap style by calling \fBTk_GetCapStyle\fR and the result is stored in the target. .TP \fBTK_CONFIG_COLOR\fR +. The value must be an ASCII string identifying a color in a form suitable for passing to \fBTk_GetColor\fR. The value is converted to an (\fBXColor *\fR) by calling \fBTk_GetColor\fR and the result @@ -248,27 +256,32 @@ If the previous value of the target was not NULL, then it is freed by passing it to \fBTk_FreeColor\fR. .TP \fBTK_CONFIG_CURSOR\fR +. This option is identical to \fBTK_CONFIG_ACTIVE_CURSOR\fR except that the new cursor is not made the active one for \fItkwin\fR. .TP \fBTK_CONFIG_CUSTOM\fR +. This option allows applications to define new option types. The \fIcustomPtr\fR field of the entry points to a structure defining the new option type. See the section \fBCUSTOM OPTION TYPES\fR below for details. .TP \fBTK_CONFIG_DOUBLE\fR +. The value must be an ASCII floating-point number in the format accepted by \fBstrtol\fR. The string is converted to a \fBdouble\fR value, and the value is stored in the target. .TP \fBTK_CONFIG_END\fR +. Marks the end of the table. The last entry in \fIspecs\fR must have this type; all of its other fields are ignored and it will never match any arguments. .TP \fBTK_CONFIG_FONT\fR +. The value must be an ASCII string identifying a font in a form suitable for passing to \fBTk_GetFont\fR. The value is converted to a \fBTk_Font\fR by calling \fBTk_GetFont\fR and the result @@ -279,6 +292,7 @@ If the previous value of the target was not NULL, then it is freed by passing it to \fBTk_FreeFont\fR. .TP \fBTK_CONFIG_INT\fR +. The value must be an ASCII integer string in the format accepted by \fBstrtol\fR (e.g. .QW 0 @@ -289,6 +303,7 @@ numbers, respectively). The string is converted to an integer value and the integer is stored in the target. .TP \fBTK_CONFIG_JOIN_STYLE\fR +. The value must be an ASCII string identifying a join style in one of the ways accepted by \fBTk_GetJoinStyle\fR. @@ -297,6 +312,7 @@ to the join style by calling \fBTk_GetJoinStyle\fR and the result is stored in the target. .TP \fBTK_CONFIG_JUSTIFY\fR +. The value must be an ASCII string identifying a justification method in one of the ways accepted by \fBTk_GetJustify\fR. @@ -304,26 +320,29 @@ The string is converted to a \fBTk_Justify\fR by calling \fBTk_GetJustify\fR and the result is stored in the target. .TP \fBTK_CONFIG_MM\fR +. The value must specify a screen distance in one of the forms acceptable to \fBTk_GetScreenMM\fR. The string is converted to double-precision floating-point distance in millimeters and the value is stored in the target. .TP \fBTK_CONFIG_PIXELS\fR +. The value must specify screen units in one of the forms acceptable to \fBTk_GetPixels\fR. The string is converted to an integer distance in pixels and the value is stored in the target. .TP \fBTK_CONFIG_RELIEF\fR +. The value must be an ASCII string identifying a relief in a form suitable for passing to \fBTk_GetRelief\fR. The value is converted to an integer relief value by calling \fBTk_GetRelief\fR and the result is stored in the target. .TP \fBTK_CONFIG_STRING\fR -A copy -of the value is made by allocating memory space with +. +A copy of the value is made by allocating memory space with \fBTcl_Alloc\fR and copying the value into the dynamically-allocated space. A pointer to the new string is stored in the target. If \fBTK_CONFIG_NULL_OK\fR is specified in \fIspecFlags\fR then the value @@ -332,6 +351,7 @@ If the previous value of the target was not NULL, then it is freed by passing it to \fBTcl_Free\fR. .TP \fBTK_CONFIG_SYNONYM\fR +. This \fItype\fR value identifies special entries in \fIspecs\fR that are synonyms for other entries. If an \fIobjv\fR value matches the \fIargvName\fR of a \fBTK_CONFIG_SYNONYM\fR entry, the entry is not used @@ -346,6 +366,7 @@ and .QW \-bg . .TP \fBTK_CONFIG_UID\fR +. The value is translated to a \fBTk_Uid\fR (by passing it to \fBTk_GetUid\fR). The resulting value is stored in the target. @@ -353,6 +374,7 @@ If \fBTK_CONFIG_NULL_OK\fR is specified in \fIspecFlags\fR and the value is an empty string then the target will be set to NULL. .TP \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" @@ -381,7 +403,8 @@ options. These values are used in three different ways as described below. .PP First, if the \fIflags\fR argument to \fBTk_ConfigureWidget\fR has -the \fBTK_CONFIG_ARGV_ONLY\fR bit set (i.e., \fIflags\fR | \fBTK_CONFIG_ARGV_ONLY\fR != 0), +the \fBTK_CONFIG_ARGV_ONLY\fR bit set +(i.e., \fIflags\fR | \fBTK_CONFIG_ARGV_ONLY\fR != 0), then the option database and \fIdefValue\fR fields are not used. In this case, if an entry in \fIspecs\fR does not match a field in \fIobjv\fR then nothing happens: @@ -395,16 +418,19 @@ to control the processing of that entry. Each \fIspecFlags\fR field may consists of an OR-ed combination of the following values: .TP \fBTK_CONFIG_COLOR_ONLY\fR +. If this bit is set then the entry will only be considered if the display for \fItkwin\fR has more than one bit plane. If the display is monochromatic then this \fIspecs\fR entry will be ignored. .TP \fBTK_CONFIG_MONO_ONLY\fR +. If this bit is set then the entry will only be considered if the display for \fItkwin\fR has exactly one bit plane. If the display is not monochromatic then this \fIspecs\fR entry will be ignored. .TP \fBTK_CONFIG_NULL_OK\fR +. This bit is only relevant for some types of entries (see the descriptions of the various entry types above). If this bit is set, it indicates that an empty string value @@ -418,6 +444,7 @@ If this bit is not set then empty strings are processed as strings, which generally results in an error. .TP \fBTK_CONFIG_DONT_SET_DEFAULT\fR +. If this bit is one, it means that the \fIdefValue\fR field of the entry should only be used for returning the default value in \fBTk_ConfigureInfo\fR. @@ -428,7 +455,7 @@ This flag provides a performance optimization where it is expensive to process the default string: the client can compute the default once, save the value, and provide it before calling \fBTk_ConfigureWidget\fR. -.TP +.PP The \fBTK_CONFIG_MONO_ONLY\fR and \fBTK_CONFIG_COLOR_ONLY\fR flags are typically used to specify different default values for monochrome and color displays. This is done by creating two @@ -525,7 +552,7 @@ Applications can extend the built-in configuration types with additional configuration types by writing procedures to parse and print options of the a type and creating a structure pointing to those procedures: .CS -typedef struct Tk_CustomOption { +typedef struct { Tk_OptionParseProc *\fIparseProc\fR; Tk_OptionPrintProc *\fIprintProc\fR; void *\fIclientData\fR; diff --git a/doc/ConfigWind.3 b/doc/ConfigWind.3 index 3e83387..c5e035a 100644 --- a/doc/ConfigWind.3 +++ b/doc/ConfigWind.3 @@ -39,6 +39,7 @@ Tk_ConfigureWindow, Tk_MoveWindow, Tk_ResizeWindow, Tk_MoveResizeWindow, Tk_SetW \fBTk_DefineCursor\fR(\fItkwin, cursor\fR) .sp \fBTk_UndefineCursor\fR(\fItkwin\fR) +.fi .SH ARGUMENTS .AS XSetWindowAttributes borderWidth .AP Tk_Window tkwin in diff --git a/doc/CoordToWin.3 b/doc/CoordToWin.3 index 1ebd681..be2663d 100644 --- a/doc/CoordToWin.3 +++ b/doc/CoordToWin.3 @@ -16,6 +16,7 @@ Tk_CoordsToWindow \- Find window containing a point .sp Tk_Window \fBTk_CoordsToWindow\fR(\fIrootX, rootY, tkwin\fR) +.fi .SH ARGUMENTS .AS Tk_Window tkwin .AP int rootX in diff --git a/doc/CrtCmHdlr.3 b/doc/CrtCmHdlr.3 index 1ba6f63..a19206c 100644 --- a/doc/CrtCmHdlr.3 +++ b/doc/CrtCmHdlr.3 @@ -16,6 +16,7 @@ Tk_CreateClientMessageHandler, Tk_DeleteClientMessageHandler \- associate proced \fBTk_CreateClientMessageHandler\fR(\fIproc\fR) .sp \fBTk_DeleteClientMessageHandler\fR(\fIproc\fR) +.fi .SH ARGUMENTS .AP Tk_ClientMessageProc *proc in Procedure to invoke whenever a ClientMessage X event occurs on any display. diff --git a/doc/CrtConsoleChan.3 b/doc/CrtConsoleChan.3 index d8e0740..cae5242 100644 --- a/doc/CrtConsoleChan.3 +++ b/doc/CrtConsoleChan.3 @@ -14,6 +14,7 @@ Tk_InitConsoleChannels \- Install the console channels as standard channels \fB#include \fR .sp \fBTk_InitConsoleChannels\fR(\fIinterp\fR) +.fi .SH ARGUMENTS .AS Tcl_Interp *interp in .AP Tcl_Interp *interp in diff --git a/doc/CrtErrHdlr.3 b/doc/CrtErrHdlr.3 index 09dcf8b..6e874b7 100644 --- a/doc/CrtErrHdlr.3 +++ b/doc/CrtErrHdlr.3 @@ -18,6 +18,7 @@ Tk_ErrorHandler \fBTk_CreateErrorHandler\fR(\fIdisplay, error, request, minor, proc, clientData\fR) .sp \fBTk_DeleteErrorHandler\fR(\fIhandler\fR) +.fi .SH ARGUMENTS .AS "Tk_ErrorHandler" clientData .AP Display *display in diff --git a/doc/CrtGenHdlr.3 b/doc/CrtGenHdlr.3 index aaf3285..b203e19 100644 --- a/doc/CrtGenHdlr.3 +++ b/doc/CrtGenHdlr.3 @@ -17,6 +17,7 @@ Tk_CreateGenericHandler, Tk_DeleteGenericHandler \- associate procedure callback \fBTk_CreateGenericHandler\fR(\fIproc, clientData\fR) .sp \fBTk_DeleteGenericHandler\fR(\fIproc, clientData\fR) +.fi .SH ARGUMENTS .AS "Tk_GenericProc" clientData .AP Tk_GenericProc *proc in diff --git a/doc/CrtImgType.3 b/doc/CrtImgType.3 index f59a78e..ddfbc54 100644 --- a/doc/CrtImgType.3 +++ b/doc/CrtImgType.3 @@ -18,6 +18,7 @@ Tk_CreateImageType, Tk_GetImageModelData \- define new kind of image .sp void * \fBTk_GetImageModelData\fR(\fIinterp, name, typePtrPtr\fR) +.fi .SH ARGUMENTS .AS "const Tk_ImageType" *typePtrPtr .AP "const Tk_ImageType" *typePtr in @@ -54,7 +55,7 @@ The first data structure is a Tk_ImageType structure, which contains the name of the image type and pointers to five procedures provided by the image manager to deal with images of this type: .CS -typedef struct Tk_ImageType { +typedef struct { const char *\fIname\fR; Tk_ImageCreateProc *\fIcreateProc\fR; Tk_ImageGetProc *\fIgetProc\fR; diff --git a/doc/CrtItemType.3 b/doc/CrtItemType.3 index 85320d6..3fb2d9f 100644 --- a/doc/CrtItemType.3 +++ b/doc/CrtItemType.3 @@ -17,10 +17,12 @@ Tk_CreateItemType, Tk_GetItemTypes \- define new kind of canvas item .sp Tk_ItemType * \fBTk_GetItemTypes\fR() +.fi .SH ARGUMENTS .AS Tk_ItemType *typePtr .AP Tk_ItemType *typePtr in Structure that defines the new type of canvas item. +Note that this is not \fIconst\fR; Tk may write to these structures. .BE .SH INTRODUCTION .PP @@ -82,7 +84,7 @@ typedef struct Tk_ItemType { Tk_ItemSelectionProc *\fIselectionProc\fR; Tk_ItemInsertProc *\fIinsertProc\fR; Tk_ItemDCharsProc *\fIdCharsProc\fR; - Tk_ItemType *\fInextPtr\fR; + struct Tk_ItemType *\fInextPtr\fR; .VS "8.7, TIP164" Tk_ItemRotateProc *\fIrotateProc\fR; .VE "8.7, TIP164" @@ -113,7 +115,7 @@ the first field. For example, the item record for bitmap items is defined as follows: .PP .CS -typedef struct BitmapItem { +typedef struct { Tk_Item \fIheader\fR; double \fIx\fR, \fIy\fR; Tk_Anchor \fIanchor\fR; @@ -250,7 +252,8 @@ to retrieve option information in the \fBitemcget\fR and \fBitemconfigure\fR widget commands. \fItypePtr\->configSpecs\fR must point to the configuration table for this type. -Note: Tk provides a custom option type \fBtk_CanvasTagsOption\fR +.PP +Note that Tk provides a custom option type \fBtk_CanvasTagsOption\fR for implementing the \fB\-tags\fR option; see an existing type manager for an example of how to use it in \fIconfigSpecs\fR. .SS CONFIGPROC @@ -560,8 +563,8 @@ they used to have coordinates \fIx\fR and \fIy\fR, they will have new coordinates \fIx\(fm\fR and \fIy\(fm\fR, where .PP .CS -\fIrelX\fR = \fIx\fR - \fIoriginX\fR -\fIrelY\fR = \fIy\fR - \fIoriginY\fR +\fIrelX\fR = \fIx\fR \(mi \fIoriginX\fR +\fIrelY\fR = \fIy\fR \(mi \fIoriginY\fR \fIx\(fm\fR = \fIoriginX\fR + \fIrelX\fR \(mu cos(\fIangleRad\fR) + \fIrelY\fR \(mu sin(\fIangleRad\fR) \fIy\(fm\fR = \fIoriginY\fR \(mi \fIrelX\fR \(mu sin(\fIangleRad\fR) + \fIrelY\fR \(mu cos(\fIangleRad\fR) .CE diff --git a/doc/CrtPhImgFmt.3 b/doc/CrtPhImgFmt.3 index 03a4046..0ba68fa 100644 --- a/doc/CrtPhImgFmt.3 +++ b/doc/CrtPhImgFmt.3 @@ -58,7 +58,7 @@ by the handler to deal with files and strings in this format. The Tk_PhotoImageFormatVersion3 structure contains the following fields: .VS 8.7 .CS -typedef struct Tk_PhotoImageFormatVersion3 { +typedef struct { const char *\fIname\fR; Tk_ImageFileMatchProcVersion3 *\fIfileMatchProc\fR; Tk_ImageStringMatchProcVersion3 *\fIstringMatchProc\fR; @@ -151,7 +151,7 @@ return 0. 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 \fBTk_ImageFileReadProc\fR( +typedef int \fBTk_ImageFileReadProcVersion3\fR( Tcl_Interp *\fIinterp\fR, Tcl_Channel \fIchan\fR, const char *\fIfileName\fR, @@ -184,7 +184,7 @@ The return value is a standard Tcl return value. 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 \fBTk_ImageStringReadProc\fR( +typedef int \fBTk_ImageStringReadProcVersion3\fR( Tcl_Interp *\fIinterp\fR, Tcl_Obj *\fIdata\fR, Tcl_Obj *\fIformat\fR, @@ -216,7 +216,7 @@ The return value is a standard Tcl return value. Tk to call to write data from a photo image to a file. \fIformatPtr->fileWriteProc\fR must match the following prototype: .CS -typedef int \fBTk_ImageFileWriteProc\fR( +typedef int \fBTk_ImageFileWriteProcVersion3\fR( Tcl_Interp *\fIinterp\fR, const char *\fIfileName\fR, Tcl_Obj *\fIformat\fR, @@ -245,7 +245,7 @@ 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 \fBTk_ImageStringWriteProc\fR( +typedef int \fBTk_ImageStringWriteProcVersion3\fR( Tcl_Interp *\fIinterp\fR, Tcl_Obj *\fIformat\fR, Tcl_Obj *\fImetadataIn\fR, @@ -276,7 +276,6 @@ level by including dictionary keys into the metadata property of the image. Image metadata may be written to image data on file write or image data output. .PP -.PP .SS "METADATA KEYS" .PP The metadata may contain any key. @@ -285,16 +284,13 @@ documentation. See the photo image manual page for currently defined keys for the system drivers. .PP The following rules may give guidance to name metadata keys: -.RS -Abreviation are in upper case -.RE -.RS +.IP \(bu +Abbreviations are in upper case. +.IP \(bu Words are in US English in small case (except proper nouns) -.RE -.RS +.IP \(bu Vertical DPI is expressed as DPI/aspect. The reason is, that some image formats may feature aspect and no resolution value. -.RE .SS "METADATA INPUT" .PP Each driver function gets a Tcl object pointer \fBmetadataIn\fR as @@ -306,17 +302,20 @@ A typical driver code snipped to check for a metadata key is: .CS if (NULL != metadataIn) { Tcl_Obj *itemData; - Tcl_DictObjGet(interp, metadataIn, Tcl_NewStringObj("Comment",-1), &itemData)); + Tcl_DictObjGet(interp, metadataIn, Tcl_NewStringObj("Comment",-1), + &itemData)); + // use value reference in itemData +} .CE .PP -The \-metadata command option data of the following commands is passed +The \fB\-metadata\fR command option data of the following commands is passed to the driver: \fBimage create\fR, \fBconfigure\fR, \fBput\fR, \fBread\fR, \fBdata\fR and \fBwrite\fR. -If no \-metadata command option available or not given, the metadata +If no \fB\-metadata\fR command option available or not given, the metadata property of the image is passed to the driver using the following commands: \fBcget\fR, \fBconfigure\fR, \fBdata\fR and \fBwrite\fR. .PP -Note that setting the \-metadata property of an image using +Note that setting the \fB\-metadata\fR property of an image using \fBconfigure\fR without any other option does not invoke any driver function. .PP @@ -328,12 +327,12 @@ this purpose. .SS "METADATA OUTPUT" .PP The image match and read driver functions may set keys in a prepared -matadata dict to return them. -Those functions get a Tcl object pointer \fBmetadataOut\fR as +metadata dict to return them. +Those functions get a Tcl object pointer \fImetadataOut\fR as parameter. -metadataOut may be NULL to indicate, that no metadata return is -attended(\fBput\fR, \fBread\fR subcommands). -\fBmetadataOut\fR is initialized to an empty unshared dict object if +\fImetadataOut\fR may be NULL to indicate, that no metadata return is +required (\fBput\fR, \fBread\fR subcommands). The variable pointed to +by \fImetadataOut\fR is initialized to an empty unshared dict object if metadata return is attended (\fBimage create\fR command, \fBconfigure\fR subcommand). The driver may set dict keys in this object to return metadata. @@ -343,7 +342,9 @@ corresponding read function. A sample driver code snippet is: .CS if (NULL != metadataOut) { - Tcl_DictObjPut(NULL, metadataOut, Tcl_NewStringObj("XMP",-1), Tcl_NewStringObj(xmpMetadata); + Tcl_DictObjPut(NULL, metadataOut, Tcl_NewStringObj("XMP",-1), + Tcl_NewStringObj(xmpMetadata)); +} .CE .PP The metadata keys returned by the driver are merged into the present @@ -366,6 +367,7 @@ use the metadata dict for input or output. \fB#include \fR .sp \fBTk_CreatePhotoImageFormat\fR(\fIformatPtr\fR) +.fi .SS ARGUMENTS .AS "const Tk_PhotoImageFormat" *formatPtr .AP "const Tk_PhotoImageFormat" *formatPtr in @@ -376,7 +378,7 @@ A driver using the version 2 interface invokes \fBTk_CreatePhotoImageFormat\fR for driver registration. The Tk_PhotoImageFormat structure contains the following fields: .CS -typedef struct Tk_PhotoImageFormat { +typedef struct { const char *\fIname\fR; Tk_ImageFileMatchProc *\fIfileMatchProc\fR; Tk_ImageStringMatchProc *\fIstringMatchProc\fR; diff --git a/doc/CrtSelHdlr.3 b/doc/CrtSelHdlr.3 index d6d27bb..1984c82 100644 --- a/doc/CrtSelHdlr.3 +++ b/doc/CrtSelHdlr.3 @@ -17,6 +17,7 @@ Tk_CreateSelHandler, Tk_DeleteSelHandler \- arrange to handle requests for a sel \fBTk_CreateSelHandler\fR(\fItkwin, selection, target, proc, clientData, format\fR) .sp \fBTk_DeleteSelHandler\fR(\fItkwin, selection, target\fR) +.fi .SH ARGUMENTS .AS Tk_SelectionProc clientData .AP Tk_Window tkwin in diff --git a/doc/CrtWindow.3 b/doc/CrtWindow.3 index b254460..e6b4437 100644 --- a/doc/CrtWindow.3 +++ b/doc/CrtWindow.3 @@ -26,6 +26,7 @@ Tk_Window \fBTk_DestroyWindow\fR(\fItkwin\fR) .sp \fBTk_MakeWindowExist\fR(\fItkwin\fR) +.fi .SH ARGUMENTS .AS Tcl_Interp *topLevScreen .AP Tcl_Interp *interp out diff --git a/doc/DeleteImg.3 b/doc/DeleteImg.3 index eb6db1e..43944b7 100644 --- a/doc/DeleteImg.3 +++ b/doc/DeleteImg.3 @@ -14,6 +14,7 @@ Tk_DeleteImage \- Destroy an image. \fB#include \fR .sp \fBTk_DeleteImage\fR(\fIinterp, name\fR) +.fi .SH ARGUMENTS .AS Tcl_Interp *interp .AP Tcl_Interp *interp in diff --git a/doc/DrawFocHlt.3 b/doc/DrawFocHlt.3 index 59cd069..1e343e3 100644 --- a/doc/DrawFocHlt.3 +++ b/doc/DrawFocHlt.3 @@ -13,7 +13,8 @@ Tk_DrawFocusHighlight \- draw the traversal highlight ring for a widget .nf \fB#include \fR .sp -\fBTk_DrawFocusHighlight(\fItkwin, gc, width, drawable\fB)\fR +\fBTk_DrawFocusHighlight\fR(\fItkwin, gc, width, drawable\fR) +.fi .SH ARGUMENTS .AS "Tcl_Interp" *joinPtr .AP Tk_Window tkwin in diff --git a/doc/EventHndlr.3 b/doc/EventHndlr.3 index 128f8ee..4e3c9d9 100644 --- a/doc/EventHndlr.3 +++ b/doc/EventHndlr.3 @@ -21,6 +21,7 @@ Tk_CreateEventHandler, Tk_DeleteEventHandler, Tk_GetButtonMask, Tk_SendVirtualEv \fBTk_GetButtonMask\fR(\fIbutton\fR) .sp \fBTk_SendVirtualEvent\fR(\fItkwin, eventName, detail\fR) +.fi .SH ARGUMENTS .AS "unsigned long" clientData .AP unsigned button in diff --git a/doc/FindPhoto.3 b/doc/FindPhoto.3 index dc218bf..57d0b77 100644 --- a/doc/FindPhoto.3 +++ b/doc/FindPhoto.3 @@ -32,17 +32,16 @@ zoomX, zoomY, subsampleX, subsampleY, compRule\fR) int \fBTk_PhotoGetImage\fR(\fIhandle, blockPtr\fR) .sp -void \fBTk_PhotoBlank\fR(\fIhandle\fR) .sp int \fBTk_PhotoExpand\fR(\fIinterp, handle, width, height\fR) .sp -void \fBTk_PhotoGetSize\fR(\fIhandle, widthPtr, heightPtr\fR) .sp int \fBTk_PhotoSetSize\fR(\fIinterp. handle, width, height\fR) +.fi .SH ARGUMENTS .AS Tk_PhotoImageBlock window_path .AP Tcl_Interp *interp in diff --git a/doc/FontId.3 b/doc/FontId.3 index 9d35ae6..fa1427c 100644 --- a/doc/FontId.3 +++ b/doc/FontId.3 @@ -15,12 +15,13 @@ fonts \fB#include \fR .sp Font -\fBTk_FontId(\fItkfont\fB)\fR +\fBTk_FontId\fR(\fItkfont\fR) .sp -\fBTk_GetFontMetrics(\fItkfont, fmPtr\fB)\fR +\fBTk_GetFontMetrics\fR(\fItkfont, fmPtr\fR) .sp int -\fBTk_PostscriptFontName(\fItkfont, dsPtr\fB)\fR +\fBTk_PostscriptFontName\fR(\fItkfont, dsPtr\fR) +.fi .SH ARGUMENTS .AS Tk_FontMetrics *dsPtr .AP Tk_Font tkfont in @@ -69,7 +70,7 @@ Postscript font name may be incorrect or not exist on the printer. The \fBTk_FontMetrics\fR data structure is used by \fBTk_GetFontMetrics\fR to return information about a font and is defined as follows: .CS -typedef struct Tk_FontMetrics { +typedef struct { int \fIascent\fR; int \fIdescent\fR; int \fIlinespace\fR; diff --git a/doc/GeomReq.3 b/doc/GeomReq.3 index 7670521..e6f2eed 100644 --- a/doc/GeomReq.3 +++ b/doc/GeomReq.3 @@ -21,6 +21,7 @@ Tk_GeometryRequest, Tk_SetMinimumRequestSize, Tk_SetInternalBorder, Tk_SetIntern \fBTk_SetInternalBorder\fR(\fItkwin, width\fR) .sp \fBTk_SetInternalBorderEx\fR(\fItkwin, left, right, top, bottom\fR) +.fi .SH ARGUMENTS .AS baseHeight clientData .AP Tk_Window tkwin in @@ -36,13 +37,17 @@ 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. +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. +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. +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. +Space to leave for bottom side of internal border for \fItkwin\fR, +in pixel units. .BE .SH DESCRIPTION .PP diff --git a/doc/GetAnchor.3 b/doc/GetAnchor.3 index 5d41ad6..658911a 100644 --- a/doc/GetAnchor.3 +++ b/doc/GetAnchor.3 @@ -15,13 +15,14 @@ Tk_GetAnchorFromObj, Tk_GetAnchor, Tk_NameOfAnchor \- translate between strings \fB#include \fR .sp int -\fBTk_GetAnchorFromObj(\fIinterp, objPtr, anchorPtr\fB)\fR +\fBTk_GetAnchorFromObj\fR(\fIinterp, objPtr, anchorPtr\fR) .sp int -\fBTk_GetAnchor(\fIinterp, string, anchorPtr\fB)\fR +\fBTk_GetAnchor\fR(\fIinterp, string, anchorPtr\fR) .sp const char * -\fBTk_NameOfAnchor(\fIanchor\fB)\fR +\fBTk_NameOfAnchor\fR(\fIanchor\fR) +.fi .SH ARGUMENTS .AS "Tk_Anchor" *anchorPtr .AP Tcl_Interp *interp in diff --git a/doc/GetBitmap.3 b/doc/GetBitmap.3 index 88418c7..f470638 100644 --- a/doc/GetBitmap.3 +++ b/doc/GetBitmap.3 @@ -15,25 +15,26 @@ Tk_AllocBitmapFromObj, Tk_GetBitmap, Tk_GetBitmapFromObj, Tk_DefineBitmap, Tk_Na \fB#include \fR .sp Pixmap -\fBTk_AllocBitmapFromObj(\fIinterp, tkwin, objPtr\fB)\fR +\fBTk_AllocBitmapFromObj\fR(\fIinterp, tkwin, objPtr\fR) .sp Pixmap -\fBTk_GetBitmap(\fIinterp, tkwin, info\fB)\fR +\fBTk_GetBitmap\fR(\fIinterp, tkwin, info\fR) .sp Pixmap -\fBTk_GetBitmapFromObj(\fItkwin, objPtr\fB)\fR +\fBTk_GetBitmapFromObj\fR(\fItkwin, objPtr\fR) .sp int -\fBTk_DefineBitmap(\fIinterp, name, source, width, height\fB)\fR +\fBTk_DefineBitmap\fR(\fIinterp, name, source, width, height\fR) .sp const char * -\fBTk_NameOfBitmap(\fIdisplay, bitmap\fB)\fR +\fBTk_NameOfBitmap\fR(\fIdisplay, bitmap\fR) .sp -\fBTk_SizeOfBitmap(\fIdisplay, bitmap, widthPtr, heightPtr\fB)\fR +\fBTk_SizeOfBitmap\fR(\fIdisplay, bitmap, widthPtr, heightPtr\fR) .sp -\fBTk_FreeBitmapFromObj(\fItkwin, objPtr\fB)\fR +\fBTk_FreeBitmapFromObj\fR(\fItkwin, objPtr\fR) .sp -\fBTk_FreeBitmap(\fIdisplay, bitmap\fB)\fR +\fBTk_FreeBitmap\fR(\fIdisplay, bitmap\fR) +.fi .SH ARGUMENTS .AS "unsigned long" *pixelPtr .AP Tcl_Interp *interp in @@ -80,98 +81,74 @@ creates a new one otherwise. \fIObjPtr\fR's value must have one of the following forms: .TP 20 \fB@\fIfileName\fR +. \fIFileName\fR must be the name of a file containing a bitmap description in the standard X11 format. .TP 20 \fIname\fR +. \fIName\fR must be the name of a bitmap defined previously with a call to \fBTk_DefineBitmap\fR. The following names are pre-defined by Tk: .RS -.TP 12 -\fBerror\fR +.IP \fBerror\fR 12 The international .QW don't symbol: a circle with a diagonal line across it. -.TP 12 -\fBgray75\fR +.IP \fBgray75\fR 12 75% gray: a checkerboard pattern where three out of four bits are on. -.TP 12 -\fBgray50\fR +.IP \fBgray50\fR 12 50% gray: a checkerboard pattern where every other bit is on. -.TP 12 -\fBgray25\fR +.IP \fBgray25\fR 12 25% gray: a checkerboard pattern where one out of every four bits is on. -.TP 12 -\fBgray12\fR +.IP \fBgray12\fR 12 12.5% gray: a pattern where one-eighth of the bits are on, consisting of every fourth pixel in every other row. -.TP 12 -\fBhourglass\fR +.IP \fBhourglass\fR 12 An hourglass symbol. -.TP 12 -\fBinfo\fR +.IP \fBinfo\fR 12 A large letter .QW i . -.TP 12 -\fBquesthead\fR +.IP \fBquesthead\fR 12 The silhouette of a human head, with a question mark in it. -.TP 12 -\fBquestion\fR +.IP \fBquestion\fR 12 A large question-mark. -.TP 12 -\fBwarning\fR +.IP \fBwarning\fR 12 A large exclamation point. .PP In addition, the following pre-defined names are available only on the \fBMacintosh\fR platform: -.TP 12 -\fBdocument\fR +.IP \fBdocument\fR 12 A generic document. -.TP 12 -\fBstationery\fR +.IP \fBstationery\fR 12 Document stationery. -.TP 12 -\fBedition\fR +.IP \fBedition\fR 12 The \fIedition\fR symbol. -.TP 12 -\fBapplication\fR +.IP \fBapplication\fR 12 Generic application icon. -.TP 12 -\fBaccessory\fR +.IP \fBaccessory\fR 12 A desk accessory. -.TP 12 -\fBfolder\fR +.IP \fBfolder\fR 12 Generic folder icon. -.TP 12 -\fBpfolder\fR +.IP \fBpfolder\fR 12 A locked folder. -.TP 12 -\fBtrash\fR +.IP \fBtrash\fR 12 A trash can. -.TP 12 -\fBfloppy\fR +.IP \fBfloppy\fR 12 A floppy disk. -.TP 12 -\fBramdisk\fR +.IP \fBramdisk\fR 12 A floppy disk with chip. -.TP 12 -\fBcdrom\fR +.IP \fBcdrom\fR 12 A cd disk icon. -.TP 12 -\fBpreferences\fR +.IP \fBpreferences\fR 12 A folder with prefs symbol. -.TP 12 -\fBquerydoc\fR +.IP \fBquerydoc\fR 12 A database document icon. -.TP 12 -\fBstop\fR +.IP \fBstop\fR 12 A stop sign. -.TP 12 -\fBnote\fR +.IP \fBnote\fR 12 A face with balloon words. -.TP 12 -\fBcaution\fR +.IP \fBcaution\fR 12 A triangle with an exclamation point. .RE .LP @@ -210,7 +187,7 @@ describe the bitmap. (e.g. a bitmap named \fInameId\fR has already been defined) then \fBTCL_ERROR\fR is returned and an error message is left in interpreter \fIinterp\fR's result. -Note: \fBTk_DefineBitmap\fR expects the memory pointed to by +Note that \fBTk_DefineBitmap\fR expects the memory pointed to by \fIsource\fR to be static: \fBTk_DefineBitmap\fR does not make a private copy of this memory, but uses the bytes pointed to by \fIsource\fR later in calls to \fBTk_AllocBitmapFromObj\fR or diff --git a/doc/GetCapStyl.3 b/doc/GetCapStyl.3 index 4e5d1d5..bb087a1 100644 --- a/doc/GetCapStyl.3 +++ b/doc/GetCapStyl.3 @@ -15,10 +15,11 @@ Tk_GetCapStyle, Tk_NameOfCapStyle \- translate between strings and cap styles \fB#include \fR .sp int -\fBTk_GetCapStyle(\fIinterp, string, capPtr\fB)\fR +\fBTk_GetCapStyle\fR(\fIinterp, string, capPtr\fR) .sp const char * -\fBTk_NameOfCapStyle(\fIcap\fB)\fR +\fBTk_NameOfCapStyle\fR(\fIcap\fR) +.fi .SH ARGUMENTS .AS "Tcl_Interp" *capPtr .AP Tcl_Interp *interp in diff --git a/doc/GetClrmap.3 b/doc/GetClrmap.3 index 4b72b6c..2bfa4b9 100644 --- a/doc/GetClrmap.3 +++ b/doc/GetClrmap.3 @@ -15,11 +15,12 @@ Tk_GetColormap, Tk_PreserveColormap, Tk_FreeColormap \- allocate and free colorm \fB#include \fR .sp Colormap -\fBTk_GetColormap(\fIinterp, tkwin, string\fB)\fR +\fBTk_GetColormap\fR(\fIinterp, tkwin, string\fR) .sp -\fBTk_PreserveColormap(\fIdisplay, colormap\fB)\fR +\fBTk_PreserveColormap\fR(\fIdisplay, colormap\fR) .sp -\fBTk_FreeColormap(\fIdisplay, colormap\fB)\fR +\fBTk_FreeColormap\fR(\fIdisplay, colormap\fR) +.fi .SH ARGUMENTS .AS "Colormap" colormap .AP Tcl_Interp *interp in diff --git a/doc/GetColor.3 b/doc/GetColor.3 index 15254aa..bfb7ac0 100644 --- a/doc/GetColor.3 +++ b/doc/GetColor.3 @@ -15,26 +15,27 @@ Tk_AllocColorFromObj, Tk_GetColor, Tk_GetColorFromObj, Tk_GetColorByValue, Tk_Na \fB#include \fR .sp XColor * -\fBTk_AllocColorFromObj(\fIinterp, tkwin, objPtr\fB)\fR +\fBTk_AllocColorFromObj\fR(\fIinterp, tkwin, objPtr\fR) .sp XColor * -\fBTk_GetColor(\fIinterp, tkwin, name\fB)\fR +\fBTk_GetColor\fR(\fIinterp, tkwin, name\fR) .sp XColor * -\fBTk_GetColorFromObj(\fItkwin, objPtr\fB)\fR +\fBTk_GetColorFromObj\fR(\fItkwin, objPtr\fR) .sp XColor * -\fBTk_GetColorByValue(\fItkwin, prefPtr\fB)\fR +\fBTk_GetColorByValue\fR(\fItkwin, prefPtr\fR) .sp const char * -\fBTk_NameOfColor(\fIcolorPtr\fB)\fR +\fBTk_NameOfColor\fR(\fIcolorPtr\fR) .sp GC -\fBTk_GCForColor(\fIcolorPtr, drawable\fB)\fR +\fBTk_GCForColor\fR(\fIcolorPtr, drawable\fR) .sp -\fBTk_FreeColorFromObj(\fItkwin, objPtr\fB)\fR +\fBTk_FreeColorFromObj\fR(\fItkwin, objPtr\fR) .sp -\fBTk_FreeColor(\fIcolorPtr\fB)\fR +\fBTk_FreeColor\fR(\fIcolorPtr\fR) +.fi .SH ARGUMENTS .AS "Tcl_Interp" *colorPtr .AP Tcl_Interp *interp in @@ -71,6 +72,7 @@ in a particular window. The desired color is specified with a value whose string value must have one of the following forms: .TP 20 \fIcolorname\fR +. Any of the valid textual names for a color defined in the server's color database file, such as \fBred\fR or \fBPeachPuff\fR. .TP 20 @@ -81,6 +83,7 @@ server's color database file, such as \fBred\fR or \fBPeachPuff\fR. \fB#\fIRRRGGGBBB\fR .TP 20 \fB#\fIRRRRGGGGBBBB\fR +. A numeric specification of the red, green, and blue intensities to use to display the color. Each \fIR\fR, \fIG\fR, or \fIB\fR represents a single hexadecimal digit. The four forms permit diff --git a/doc/GetCursor.3 b/doc/GetCursor.3 index 403c05e..6f8e34f 100644 --- a/doc/GetCursor.3 +++ b/doc/GetCursor.3 @@ -15,23 +15,24 @@ Tk_AllocCursorFromObj, Tk_GetCursor, Tk_GetCursorFromObj, Tk_GetCursorFromData, \fB#include \fR .sp Tk_Cursor -\fBTk_AllocCursorFromObj(\fIinterp, tkwin, objPtr\fB)\fR +\fBTk_AllocCursorFromObj\fR(\fIinterp, tkwin, objPtr\fR) .sp Tk_Cursor -\fBTk_GetCursor(\fIinterp, tkwin, name\fB)\fR +\fBTk_GetCursor\fR(\fIinterp, tkwin, name\fR) .sp Tk_Cursor -\fBTk_GetCursorFromObj(\fItkwin, objPtr\fB)\fR +\fBTk_GetCursorFromObj\fR(\fItkwin, objPtr\fR) .sp Tk_Cursor -\fBTk_GetCursorFromData(\fIinterp, tkwin, source, mask, width, height, xHot, yHot, fg, bg\fB)\fR +\fBTk_GetCursorFromData\fR(\fIinterp, tkwin, source, mask, width, height, xHot, yHot, fg, bg\fR) .sp const char * -\fBTk_NameOfCursor(\fIdisplay, cursor\fB)\fR +\fBTk_NameOfCursor\fR(\fIdisplay, cursor\fR) .sp -\fBTk_FreeCursorFromObj(\fItkwin, objPtr\fB)\fR +\fBTk_FreeCursorFromObj\fR(\fItkwin, objPtr\fR) .sp -\fBTk_FreeCursor(\fIdisplay, cursor\fB)\fR +\fBTk_FreeCursor\fR(\fIdisplay, cursor\fR) +.fi .SH ARGUMENTS .AS "unsigned long" *pixelPtr .AP Tcl_Interp *interp in @@ -87,6 +88,7 @@ if \fIinterp\fR is not NULL. \fIObjPtr\fR must contain a standard Tcl list with one of the following forms: .TP \fIname\fR\0[\fIfgColor\fR\0[\fIbgColor\fR]] +. \fIName\fR is the name of a cursor in the standard X cursor cursor, i.e., any of the names defined in \fBcursorcursor.h\fR, without the \fBXC_\fR. Some example values are \fBX_cursor\fR, \fBhand2\fR, @@ -115,6 +117,7 @@ in preference to black and white cursors. .RE .TP \fB@\fIsourceName\0maskName\0fgColor\0bgColor\fR +. In this form, \fIsourceName\fR and \fImaskName\fR are the names of files describing cursors for the cursor's source bits and mask. Each file must be in standard X11 cursor format. @@ -124,12 +127,14 @@ cursor, in any of the forms acceptable to \fBTk_GetColor\fR. This form of the command will not work on Macintosh or Windows computers. .TP \fB@\fIsourceName\0fgColor\fR +. This form is similar to the one above, except that the source is used as mask also. This means that the cursor's background is transparent. This form of the command will not work on Macintosh or Windows computers. .TP \fB@\fIsourceName\fR +. 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. @@ -196,7 +201,7 @@ argument that was passed to \fBTk_GetCursor\fR to create the cursor. If \fIcursor\fR was created by a call to \fBTk_GetCursorFromData\fR, or by any other mechanism, then the return value is a hexadecimal string giving the X identifier for the cursor. -Note: the string returned by \fBTk_NameOfCursor\fR is +Note that the string returned by \fBTk_NameOfCursor\fR is 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. diff --git a/doc/GetFont.3 b/doc/GetFont.3 index 9497556..60e8232 100644 --- a/doc/GetFont.3 +++ b/doc/GetFont.3 @@ -15,25 +15,25 @@ Tk_AllocFontFromObj, Tk_GetFont, Tk_GetFontFromObj, Tk_NameOfFont, Tk_FontGetDes \fB#include \fR .sp Tk_Font -\fBTk_AllocFontFromObj(\fIinterp, tkwin, objPtr\fB)\fR +\fBTk_AllocFontFromObj\fR(\fIinterp, tkwin, objPtr\fR) .sp Tk_Font -\fBTk_GetFont(\fIinterp, tkwin, string\fB)\fR +\fBTk_GetFont\fR(\fIinterp, tkwin, string\fR) .sp Tk_Font -\fBTk_GetFontFromObj(\fItkwin, objPtr\fB)\fR +\fBTk_GetFontFromObj\fR(\fItkwin, objPtr\fR) .sp Tcl_Obj * -\fBTk_FontGetDescription(\fItkfont\fB)\fR +\fBTk_FontGetDescription\fR(\fItkfont\fR) .sp const char * -\fBTk_NameOfFont(\fItkfont\fB)\fR +\fBTk_NameOfFont\fR(\fItkfont\fR) .sp Tk_Font -\fBTk_FreeFontFromObj(\fItkwin, objPtr\fB)\fR +\fBTk_FreeFontFromObj\fR(\fItkwin, objPtr\fR) .sp -void -\fBTk_FreeFont(\fItkfont\fB)\fR +\fBTk_FreeFont\fR(\fItkfont\fR) +.fi .SH ARGUMENTS .AS "const char" *tkfont .AP "Tcl_Interp" *interp in @@ -92,7 +92,8 @@ shared for all uses. The underlying resources will be freed automatically when no-one is using the font anymore. .PP The procedure \fBTk_FontGetDescription\fR returns information about the font -description as a Tcl list. One possible result is "{{DejaVu Sans} -16 bold underline}". +description as a Tcl list. One possible result is +.QW "{{DejaVu Sans} -16 bold underline}" . .PP The procedure \fBTk_NameOfFont\fR is roughly the inverse of \fBTk_GetFont\fR. Given a \fItkfont\fR that was created by diff --git a/doc/GetGC.3 b/doc/GetGC.3 index 6ee63a9..2b02c9d 100644 --- a/doc/GetGC.3 +++ b/doc/GetGC.3 @@ -17,7 +17,8 @@ Tk_GetGC, Tk_FreeGC \- maintain database of read-only graphics contexts GC \fBTk_GetGC\fR(\fItkwin, valueMask, valuePtr\fR) .sp -\fBTk_FreeGC(\fIdisplay, gc\fR) +\fBTk_FreeGC\fR(\fIdisplay, gc\fR) +.fi .SH ARGUMENTS .AS "unsigned long" valueMask .AP Tk_Window tkwin in diff --git a/doc/GetHINSTANCE.3 b/doc/GetHINSTANCE.3 index 8f82ee9..2069f3f 100644 --- a/doc/GetHINSTANCE.3 +++ b/doc/GetHINSTANCE.3 @@ -13,6 +13,7 @@ Tk_GetHINSTANCE \- retrieve the global application instance handle .sp HINSTANCE \fBTk_GetHINSTANCE\fR() +.fi .BE .SH DESCRIPTION .PP diff --git a/doc/GetHWND.3 b/doc/GetHWND.3 index 1e8cdc9..bf780b4 100644 --- a/doc/GetHWND.3 +++ b/doc/GetHWND.3 @@ -16,6 +16,7 @@ HWND .sp Window \fBTk_AttachHWND\fR(\fItkwin, hwnd\fR) +.fi .SH ARGUMENTS .AP Window window in X token for window. diff --git a/doc/GetImage.3 b/doc/GetImage.3 index c437db7..7d899d8 100644 --- a/doc/GetImage.3 +++ b/doc/GetImage.3 @@ -22,6 +22,7 @@ Tk_Image \fBTk_SizeOfImage\fR(\fIimage, widthPtr, heightPtr\fR) .sp \fBTk_FreeImage\fR(\fIimage\fR) +.fi .SH ARGUMENTS .AS Tk_ImageChangedProc *changeProc .AP Tcl_Interp *interp in diff --git a/doc/GetJoinStl.3 b/doc/GetJoinStl.3 index 616719c..cef93c2 100644 --- a/doc/GetJoinStl.3 +++ b/doc/GetJoinStl.3 @@ -15,10 +15,11 @@ Tk_GetJoinStyle, Tk_NameOfJoinStyle \- translate between strings and join styles \fB#include \fR .sp int -\fBTk_GetJoinStyle(\fIinterp, string, joinPtr\fB)\fR +\fBTk_GetJoinStyle\fR(\fIinterp, string, joinPtr\fR) .sp const char * -\fBTk_NameOfJoinStyle(\fIjoin\fB)\fR +\fBTk_NameOfJoinStyle\fR(\fIjoin\fR) +.fi .SH ARGUMENTS .AS "Tcl_Interp" *joinPtr .AP Tcl_Interp *interp in diff --git a/doc/GetJustify.3 b/doc/GetJustify.3 index 2e871cb..0d8d7ae 100644 --- a/doc/GetJustify.3 +++ b/doc/GetJustify.3 @@ -15,13 +15,14 @@ Tk_GetJustifyFromObj, Tk_GetJustify, Tk_NameOfJustify \- translate between strin \fB#include \fR .sp int -\fBTk_GetJustifyFromObj(\fIinterp, objPtr, justifyPtr\fB)\fR +\fBTk_GetJustifyFromObj\fR(\fIinterp, objPtr, justifyPtr\fR) .sp int -\fBTk_GetJustify(\fIinterp, string, justifyPtr\fB)\fR +\fBTk_GetJustify\fR(\fIinterp, string, justifyPtr\fR) .sp const char * -\fBTk_NameOfJustify(\fIjustify\fB)\fR +\fBTk_NameOfJustify\fR(\fIjustify\fR) +.fi .SH ARGUMENTS .AS "Tk_Justify" *justifyPtr .AP Tcl_Interp *interp in @@ -48,16 +49,13 @@ Justification style (one of the values listed below). \fBTk_GetJustifyFromObj\fR places in \fI*justifyPtr\fR the justify value corresponding to \fIobjPtr\fR's value. This value will be one of the following: -.TP -\fBTK_JUSTIFY_LEFT\fR +.IP \fBTK_JUSTIFY_LEFT\fR Means that the text on each line should start at the left edge of the line; as a result, the right edges of lines may be ragged. -.TP -\fBTK_JUSTIFY_RIGHT\fR +.IP \fBTK_JUSTIFY_RIGHT\fR Means that the text on each line should end at the right edge of the line; as a result, the left edges of lines may be ragged. -.TP -\fBTK_JUSTIFY_CENTER\fR +.IP \fBTK_JUSTIFY_CENTER\fR 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 diff --git a/doc/GetOption.3 b/doc/GetOption.3 index 799786d..b727965 100644 --- a/doc/GetOption.3 +++ b/doc/GetOption.3 @@ -16,6 +16,7 @@ Tk_GetOption \- retrieve an option from the option database .sp Tk_Uid \fBTk_GetOption\fR(\fItkwin, name, class\fR) +.fi .SH ARGUMENTS .AS Tk_Window *class .AP Tk_Window tkwin in diff --git a/doc/GetPixels.3 b/doc/GetPixels.3 index 568c601..8a05a81 100644 --- a/doc/GetPixels.3 +++ b/doc/GetPixels.3 @@ -15,19 +15,20 @@ Tk_GetPixelsFromObj, Tk_GetPixels, Tk_GetMMFromObj, Tk_GetScreenMM, Tk_GetDouble \fB#include \fR .sp int -\fBTk_GetPixelsFromObj(\fIinterp, tkwin, objPtr, intPtr\fB)\fR +\fBTk_GetPixelsFromObj\fR(\fIinterp, tkwin, objPtr, intPtr\fR) .sp int -\fBTk_GetDoublePixelsFromObj(\fIinterp, tkwin, objPtr, doublePtr\fB)\fR +\fBTk_GetDoublePixelsFromObj\fR(\fIinterp, tkwin, objPtr, doublePtr\fR) .sp int -\fBTk_GetPixels(\fIinterp, tkwin, string, intPtr\fB)\fR +\fBTk_GetPixels\fR(\fIinterp, tkwin, string, intPtr\fR) .sp int -\fBTk_GetMMFromObj(\fIinterp, tkwin, objPtr, doublePtr\fB)\fR +\fBTk_GetMMFromObj\fR(\fIinterp, tkwin, objPtr, doublePtr\fR) .sp int -\fBTk_GetScreenMM(\fIinterp, tkwin, string, doublePtr\fB)\fR +\fBTk_GetScreenMM\fR(\fIinterp, tkwin, string, doublePtr\fR) +.fi .SH ARGUMENTS .AS "Tcl_Interp" *joinPtr .AP Tcl_Interp *interp in @@ -56,20 +57,15 @@ In either case, specifies a screen distance as a floating-point number followed by one of the following characters that indicates units: -.TP - +.IP The number specifies a distance in pixels. -.TP -\fBc\fR +.IP \fBc\fR The number specifies a distance in centimeters on the screen. -.TP -\fBi\fR +.IP \fBi\fR The number specifies a distance in inches on the screen. -.TP -\fBm\fR +.IP \fBm\fR The number specifies a distance in millimeters on the screen. -.TP -\fBp\fR +.IP \fBp\fR The number specifies a distance in printer's points (1/72 inch) on the screen. .PP diff --git a/doc/GetPixmap.3 b/doc/GetPixmap.3 index 65fae2d..e9388df 100644 --- a/doc/GetPixmap.3 +++ b/doc/GetPixmap.3 @@ -15,9 +15,10 @@ Tk_GetPixmap, Tk_FreePixmap \- allocate and free pixmaps \fB#include \fR .sp Pixmap -\fBTk_GetPixmap(\fIdisplay, d, width, height, depth\fB)\fR +\fBTk_GetPixmap\fR(\fIdisplay, d, width, height, depth\fR) .sp -\fBTk_FreePixmap(\fIdisplay, pixmap\fB)\fR +\fBTk_FreePixmap\fR(\fIdisplay, pixmap\fR) +.fi .SH ARGUMENTS .AS "Drawable" *pixelPtr .AP Display *display in diff --git a/doc/GetRelief.3 b/doc/GetRelief.3 index 5979662..528e1ba 100644 --- a/doc/GetRelief.3 +++ b/doc/GetRelief.3 @@ -15,13 +15,14 @@ Tk_GetReliefFromObj, Tk_GetRelief, Tk_NameOfRelief \- translate between strings \fB#include \fR .sp int -\fBTk_GetReliefFromObj(\fIinterp, objPtr, reliefPtr\fB)\fR +\fBTk_GetReliefFromObj\fR(\fIinterp, objPtr, reliefPtr\fR) .sp int -\fBTk_GetRelief(\fIinterp, name, reliefPtr\fB)\fR +\fBTk_GetRelief\fR(\fIinterp, name, reliefPtr\fR) .sp const char * -\fBTk_NameOfRelief(\fIrelief\fB)\fR +\fBTk_NameOfRelief\fR(\fIrelief\fR) +.fi .SH ARGUMENTS .AS "Tcl_Interp" *reliefPtr .AP Tcl_Interp *interp in diff --git a/doc/GetRootCrd.3 b/doc/GetRootCrd.3 index 20520ea..46715c4 100644 --- a/doc/GetRootCrd.3 +++ b/doc/GetRootCrd.3 @@ -15,6 +15,7 @@ Tk_GetRootCoords \- Compute root-window coordinates of window \fB#include \fR .sp \fBTk_GetRootCoords\fR(\fItkwin, xPtr, yPtr\fR) +.fi .SH ARGUMENTS .AS Tk_Window tkwin .AP Tk_Window tkwin in diff --git a/doc/GetScroll.3 b/doc/GetScroll.3 index dc929b7..0322991 100644 --- a/doc/GetScroll.3 +++ b/doc/GetScroll.3 @@ -15,10 +15,11 @@ Tk_GetScrollInfoObj, Tk_GetScrollInfo \- parse arguments for scrolling commands \fB#include \fR .sp int -\fBTk_GetScrollInfoObj(\fIinterp, objc, objv, fractionPtr, stepsPtr\fB)\fR +\fBTk_GetScrollInfoObj\fR(\fIinterp, objc, objv, fractionPtr, stepsPtr\fR) .sp int -\fBTk_GetScrollInfo(\fIinterp, argc, argv, fractionPtr, stepsPtr\fB)\fR +\fBTk_GetScrollInfo\fR(\fIinterp, argc, argv, fractionPtr, stepsPtr\fR) +.fi .SH ARGUMENTS .AS "Tcl_Interp" *fractionPtr .AP Tcl_Interp *interp in diff --git a/doc/GetSelect.3 b/doc/GetSelect.3 index 455b142..89760cc 100644 --- a/doc/GetSelect.3 +++ b/doc/GetSelect.3 @@ -16,6 +16,7 @@ Tk_GetSelection \- retrieve the contents of a selection .sp int \fBTk_GetSelection\fR(\fIinterp, tkwin, selection, target, proc, clientData\fR) +.fi .SH ARGUMENTS .AS Tk_GetSelProc clientData .AP Tcl_Interp *interp in diff --git a/doc/GetUid.3 b/doc/GetUid.3 index 2cd95ad..407179e 100644 --- a/doc/GetUid.3 +++ b/doc/GetUid.3 @@ -16,6 +16,7 @@ Tk_GetUid, Tk_Uid \- convert from string to unique identifier .sp Tk_Uid \fBTk_GetUid\fR(\fIstring\fR) +.fi .SH ARGUMENTS .AP char *string in String for which the corresponding unique identifier is diff --git a/doc/GetVRoot.3 b/doc/GetVRoot.3 index 7e6003a..777d0a3 100644 --- a/doc/GetVRoot.3 +++ b/doc/GetVRoot.3 @@ -14,7 +14,8 @@ Tk_GetVRootGeometry \- Get location and size of virtual root for window .nf \fB#include \fR .sp -\fBTk_GetVRootGeometry(\fItkwin, xPtr, yPtr, widthPtr, heightPtr\fB)\fR +\fBTk_GetVRootGeometry\fR(\fItkwin, xPtr, yPtr, widthPtr, heightPtr\fR) +.fi .SH ARGUMENTS .AS Tk_Window heightPtr .AP Tk_Window tkwin in diff --git a/doc/GetVisual.3 b/doc/GetVisual.3 index fc6b6f8..e88f69b 100644 --- a/doc/GetVisual.3 +++ b/doc/GetVisual.3 @@ -15,7 +15,8 @@ Tk_GetVisual \- translate from string to visual \fB#include \fR .sp Visual * -\fBTk_GetVisual(\fIinterp, tkwin, string, depthPtr, colormapPtr\fB)\fR +\fBTk_GetVisual\fR(\fIinterp, tkwin, string, depthPtr, colormapPtr\fR) +.fi .SH ARGUMENTS .AS "Tcl_Interp" *colormapPtr .AP Tcl_Interp *interp in @@ -48,6 +49,7 @@ The \fIstring\fR argument specifies the desired visual in one of the following ways: .TP 15 \fIclass depth\fR +. The string consists of a class name followed by an integer depth, with any amount of white space (including none) in between. \fIclass\fR selects what sort of visual is desired and must be one of @@ -62,17 +64,21 @@ looks first for a visual with greater depth, then one with less depth. .TP 15 \fBdefault\fR +. Use the default visual for \fItkwin\fR's screen. .TP 15 \fIpathName\fR +. Use the visual for the window given by \fIpathName\fR. \fIpathName\fR must be the name of a window on the same screen as \fItkwin\fR. .TP 15 \fInumber\fR +. Use the visual whose X identifier is \fInumber\fR. .TP 15 \fBbest\fR ?\fIdepth\fR? +. Choose the .QW "best possible" visual, using the following rules, in decreasing order of priority: diff --git a/doc/Grab.3 b/doc/Grab.3 index 4966edb..fc78dd2 100644 --- a/doc/Grab.3 +++ b/doc/Grab.3 @@ -14,8 +14,8 @@ Tk_Grab, Tk_Ungrab \- manipulate grab state in an application int \fBTk_Grab\fR(\fIinterp, tkwin, grabGlobal\fR) .sp -void \fBTk_Ungrab\fR(\fItkwin\fR) +.fi .SH ARGUMENTS .AP Tcl_Interp *interp in Interpreter to use for error reporting diff --git a/doc/HWNDToWindow.3 b/doc/HWNDToWindow.3 index c5dafdd..64adebf 100644 --- a/doc/HWNDToWindow.3 +++ b/doc/HWNDToWindow.3 @@ -13,6 +13,7 @@ Tk_HWNDToWindow \- Find Tk's window information for a Windows window .sp Tk_Window \fBTk_HWNDToWindow\fR(\fIhwnd\fR) +.fi .SH ARGUMENTS .AP HWND hwnd in Windows handle for the window. diff --git a/doc/HandleEvent.3 b/doc/HandleEvent.3 index af3fde6..9b9ffc0 100644 --- a/doc/HandleEvent.3 +++ b/doc/HandleEvent.3 @@ -15,6 +15,7 @@ Tk_HandleEvent \- invoke event handlers for window system events \fB#include \fR .sp \fBTk_HandleEvent\fR(\fIeventPtr\fR) +.fi .SH ARGUMENTS .AS XEvent *eventPtr .AP XEvent *eventPtr in diff --git a/doc/IdToWindow.3 b/doc/IdToWindow.3 index f8ce1f9..5c7c896 100644 --- a/doc/IdToWindow.3 +++ b/doc/IdToWindow.3 @@ -15,6 +15,7 @@ Tk_IdToWindow \- Find Tk's window information for an X window .sp Tk_Window \fBTk_IdToWindow\fR(\fIdisplay, window\fR) +.fi .SH ARGUMENTS .AS Tk_Window display .AP Display *display in diff --git a/doc/ImgChanged.3 b/doc/ImgChanged.3 index ed47d26..9faa7aa 100644 --- a/doc/ImgChanged.3 +++ b/doc/ImgChanged.3 @@ -15,6 +15,7 @@ Tk_ImageChanged \- notify widgets that image needs to be redrawn \fB#include \fR .sp \fBTk_ImageChanged\fR(\fImodel, x, y, width, height, imageWidth, imageHeight\fR) +.fi .SH ARGUMENTS .AS Tk_ImageModel imageHeight .AP Tk_ImageModel model in diff --git a/doc/Inactive.3 b/doc/Inactive.3 index ea8d735..46327d2 100644 --- a/doc/Inactive.3 +++ b/doc/Inactive.3 @@ -12,9 +12,10 @@ Tk_GetUserInactiveTime, Tk_ResetUserInactiveTime \- discover user inactivity tim \fB#include \fR .sp long -\fBTk_GetUserInactiveTime(\fIdisplay\fB)\fR +\fBTk_GetUserInactiveTime\fR(\fIdisplay\fR) .sp -\fBTk_ResetUserInactiveTime(\fIdisplay\fB)\fR +\fBTk_ResetUserInactiveTime\fR(\fIdisplay\fR) +.fi .SH ARGUMENTS .AS Display *display .AP Display *display in diff --git a/doc/InternAtom.3 b/doc/InternAtom.3 index e6756a5..7f1a68b 100644 --- a/doc/InternAtom.3 +++ b/doc/InternAtom.3 @@ -15,10 +15,11 @@ Tk_InternAtom, Tk_GetAtomName \- manage cache of X atoms \fB#include \fR .sp Atom -\fBTk_InternAtom(\fItkwin, name\fR) +\fBTk_InternAtom\fR(\fItkwin, name\fR) .sp const char * -\fBTk_GetAtomName(\fItkwin, atom\fR) +\fBTk_GetAtomName\fR(\fItkwin, atom\fR) +.fi .SH ARGUMENTS .AS Tk_Window parent .AP Tk_Window tkwin in diff --git a/doc/MainLoop.3 b/doc/MainLoop.3 index 770f254..7dbda0f 100644 --- a/doc/MainLoop.3 +++ b/doc/MainLoop.3 @@ -15,6 +15,7 @@ Tk_MainLoop \- loop for events until all windows are deleted \fB#include \fR .sp \fBTk_MainLoop\fR() +.fi .BE .SH DESCRIPTION .PP diff --git a/doc/MainWin.3 b/doc/MainWin.3 index b11b6cd..d6da326 100644 --- a/doc/MainWin.3 +++ b/doc/MainWin.3 @@ -17,14 +17,13 @@ Tk_MainWindow, Tk_GetNumMainWindows \- functions for querying main window inform Tk_Window \fBTk_MainWindow\fR(\fIinterp\fR) .sp -void \fBTk_SetMainMenubar\fR(\fIinterp, tkwin, menuName\fR) .sp -void \fBTk_SetWindowMenubar\fR(\fIinterp, tkwin, oldMenuName, menuName\fR) .sp int \fBTk_GetNumMainWindows\fR() +.fi .SH ARGUMENTS .AS Tcl_Interp *pathName .AP Tcl_Interp *interp in/out @@ -52,7 +51,7 @@ leaves an error message in interpreter \fIinterp\fR's result. windows currently open in the current thread. \fBTk_SetMainMenubar\fR Called when a toplevel widget is brought to front. On the Macintosh, -sets up the menubar that goes accross the top of the main monitor. On +sets up the menubar that goes across the top of the main monitor. On other platforms, nothing is necessary. \fBTk_SetWindowMenubar\fR associates a menu with a window. The old menu clones for the menubar are thrown away, and a handler is diff --git a/doc/MaintGeom.3 b/doc/MaintGeom.3 index d6418b5..0196a0d 100644 --- a/doc/MaintGeom.3 +++ b/doc/MaintGeom.3 @@ -17,6 +17,7 @@ Tk_MaintainGeometry, Tk_UnmaintainGeometry \- maintain geometry of one window re \fBTk_MaintainGeometry\fR(\fIwindow, container, x, y, width, height\fR) .sp \fBTk_UnmaintainGeometry\fR(\fIwindow, container\fR) +.fi .SH ARGUMENTS .AS Tk_Window container .AP Tk_Window window in diff --git a/doc/ManageGeom.3 b/doc/ManageGeom.3 index dd69273..dd2703c 100644 --- a/doc/ManageGeom.3 +++ b/doc/ManageGeom.3 @@ -15,6 +15,7 @@ Tk_ManageGeometry \- arrange to handle geometry requests for a window \fB#include \fR .sp \fBTk_ManageGeometry\fR(\fItkwin, mgrPtr, clientData\fR) +.fi .SH ARGUMENTS .AS Tk_GeometryProc clientData .AP Tk_Window tkwin in diff --git a/doc/MapWindow.3 b/doc/MapWindow.3 index a3c6296..7de87df 100644 --- a/doc/MapWindow.3 +++ b/doc/MapWindow.3 @@ -18,6 +18,7 @@ Tk_Window \fBTk_MapWindow\fR(\fItkwin\fR) .sp \fBTk_UnmapWindow\fR(\fItkwin\fR) +.fi .SH ARGUMENTS .AS Tk_Window parent .AP Tk_Window tkwin in diff --git a/doc/MeasureChar.3 b/doc/MeasureChar.3 index 0922fd5..1f62a55 100644 --- a/doc/MeasureChar.3 +++ b/doc/MeasureChar.3 @@ -14,15 +14,15 @@ Tk_MeasureChars, Tk_TextWidth, Tk_DrawChars, Tk_UnderlineChars \- routines to me \fB#include \fR .sp int -\fBTk_MeasureChars(\fItkfont, string, numBytes, maxPixels, flags, lengthPtr\fB)\fR +\fBTk_MeasureChars\fR(\fItkfont, string, numBytes, maxPixels, flags, lengthPtr\fR) .sp int -\fBTk_TextWidth(\fItkfont, string, numBytes\fB)\fR +\fBTk_TextWidth\fR(\fItkfont, string, numBytes\fR) .sp -\fBTk_DrawChars(\fIdisplay, drawable, gc, tkfont, string, numBytes, x, y\fB)\fR -.sp -\fBTk_UnderlineChars(\fIdisplay, drawable, gc, tkfont, string, x, y, firstByte, lastByte\fB)\fR +\fBTk_DrawChars\fR(\fIdisplay, drawable, gc, tkfont, string, numBytes, x, y\fR) .sp +\fBTk_UnderlineChars\fR(\fIdisplay, drawable, gc, tkfont, string, x, y, firstByte, lastByte\fR) +.fi .SH ARGUMENTS .AS "const char" firstChar .AP Tk_Font tkfont in @@ -48,8 +48,8 @@ otherwise, a character must fit completely to be considered. \fBTK_WHOLE_WORDS\fR means stop on a word boundary, if possible. If \fBTK_AT_LEAST_ONE\fR is set, it means return at least one character even if no characters could fit in the length given by \fImaxPixels\fR. If -\fBTK_AT_LEAST_ONE\fR is set and \fBTK_WHOLE_WORDS\fR is also set, it means that if -not even one word fits on the line, return the first few letters of the +\fBTK_AT_LEAST_ONE\fR is set and \fBTK_WHOLE_WORDS\fR is also set, it means +that if not even one word fits on the line, return the first few letters of the word that did fit; if not even one letter of the word fit, then the first letter will still be returned. .AP int *lengthPtr out diff --git a/doc/MoveToplev.3 b/doc/MoveToplev.3 index f67627f..a8646f3 100644 --- a/doc/MoveToplev.3 +++ b/doc/MoveToplev.3 @@ -14,7 +14,8 @@ Tk_MoveToplevelWindow \- Adjust the position of a top-level window .nf \fB#include \fR .sp -\fBTk_MoveToplevelWindow(\fItkwin, x, y\fB)\fR +\fBTk_MoveToplevelWindow\fR(\fItkwin, x, y\fR) +.fi .SH ARGUMENTS .AS Tk_Window tkwin .AP Tk_Window tkwin in diff --git a/doc/Name.3 b/doc/Name.3 index 1653cf5..538c57c 100644 --- a/doc/Name.3 +++ b/doc/Name.3 @@ -22,6 +22,7 @@ char * .sp Tk_Window \fBTk_NameToWindow\fR(\fIinterp, pathName, tkwin\fR) +.fi .SH ARGUMENTS .AS Tcl_Interp *pathName .AP Tk_Window tkwin in diff --git a/doc/NameOfImg.3 b/doc/NameOfImg.3 index 781650f..afca117 100644 --- a/doc/NameOfImg.3 +++ b/doc/NameOfImg.3 @@ -15,6 +15,7 @@ Tk_NameOfImage \- Return name of image. .sp const char * \fBTk_NameOfImage\fR(\fIimageModel\fR) +.fi .SH ARGUMENTS .AS Tk_ImageModel imageModel .AP Tk_ImageModel imageModel in diff --git a/doc/OwnSelect.3 b/doc/OwnSelect.3 index 67bac55..eb8eabe 100644 --- a/doc/OwnSelect.3 +++ b/doc/OwnSelect.3 @@ -15,6 +15,7 @@ Tk_OwnSelection \- make a window the owner of the primary selection \fB#include \fR .sp \fBTk_OwnSelection\fR(\fItkwin, selection, proc, clientData\fR) +.fi .SH ARGUMENTS .AS Tk_LostSelProc clientData .AP Tk_Window tkwin in diff --git a/doc/ParseArgv.3 b/doc/ParseArgv.3 index 727dcfa..08ad292 100644 --- a/doc/ParseArgv.3 +++ b/doc/ParseArgv.3 @@ -16,6 +16,7 @@ Tk_ParseArgv \- process command-line options .sp int \fBTk_ParseArgv\fR(\fIinterp, tkwin, argcPtr, argv, argTable, flags\fR) +.fi .SH ARGUMENTS .AS Tk_ArgvInfo *argTable .AP Tcl_Interp *interp in @@ -113,18 +114,15 @@ after the matching argument, which is called .QW "the following argument" . The legal values for \fItype\fR, and the processing that they cause, are as follows: -.TP -\fBTK_ARGV_END\fR +.IP \fBTK_ARGV_END\fR Marks the end of the table. The last entry in \fIargTable\fR must have this type; all of its other fields are ignored and it will never match any arguments. -.TP -\fBTK_ARGV_CONSTANT\fR +.IP \fBTK_ARGV_CONSTANT\fR \fISrc\fR is treated as an integer and \fIdst\fR is treated as a pointer to an integer. \fISrc\fR is stored at \fI*dst\fR. The matching argument is discarded. -.TP -\fBTK_ARGV_INT\fR +.IP \fBTK_ARGV_INT\fR The following argument must contain an integer string in the format accepted by \fBstrtol\fR (e.g. .QW 0 @@ -135,22 +133,19 @@ numbers, respectively). \fIDst\fR is treated as a pointer to an integer; the following argument is converted to an integer value and stored at \fI*dst\fR. \fISrc\fR is ignored. The matching and following arguments are discarded from \fIargv\fR. -.TP -\fBTK_ARGV_FLOAT\fR +.IP \fBTK_ARGV_FLOAT\fR The following argument must contain a floating-point number in the format accepted by \fBstrtol\fR. \fIDst\fR is treated as the address of a double-precision floating point value; the following argument is converted to a double-precision value and stored at \fI*dst\fR. The matching and following arguments are discarded from \fIargv\fR. -.TP -\fBTK_ARGV_STRING\fR +.IP \fBTK_ARGV_STRING\fR In this form, \fIdst\fR is treated as a pointer to a (char *); \fBTk_ParseArgv\fR stores at \fI*dst\fR a pointer to the following argument, and discards the matching and following arguments from \fIargv\fR. \fISrc\fR is ignored. -.TP -\fBTK_ARGV_UID\fR +.IP \fBTK_ARGV_UID\fR This form is similar to \fBTK_ARGV_STRING\fR, except that the argument is turned into a Tk_Uid by calling \fBTk_GetUid\fR. \fIDst\fR is treated as a pointer to a @@ -158,32 +153,28 @@ Tk_Uid; \fBTk_ParseArgv\fR stores at \fI*dst\fR the Tk_Uid corresponding to the following argument, and discards the matching and following arguments from \fIargv\fR. \fISrc\fR is ignored. -.TP -\fBTK_ARGV_CONST_OPTION\fR +.IP \fBTK_ARGV_CONST_OPTION\fR This form causes a Tk option to be set (as if the \fBoption\fR command had been invoked). The \fIsrc\fR field is treated as a pointer to a string giving the value of an option, and \fIdst\fR is treated as a pointer to the name of the option. The matching argument is discarded. If \fItkwin\fR is NULL, then argument specifiers of this type are ignored (as if they did not exist). -.TP -\fBTK_ARGV_OPTION_VALUE\fR +.IP \fBTK_ARGV_OPTION_VALUE\fR This form is similar to \fBTK_ARGV_CONST_OPTION\fR, except that the value of the option is taken from the following argument instead of from \fIsrc\fR. \fIDst\fR is used as the name of the option. \fISrc\fR is ignored. The matching and following arguments are discarded. If \fItkwin\fR is NULL, then argument specifiers of this type are ignored (as if they did not exist). -.TP -\fBTK_ARGV_OPTION_NAME_VALUE\fR +.IP \fBTK_ARGV_OPTION_NAME_VALUE\fR In this case the following argument is taken as the name of a Tk option and the argument after that is taken as the value for that option. Both \fIsrc\fR and \fIdst\fR are ignored. All three arguments are discarded from \fIargv\fR. If \fItkwin\fR is NULL, then argument specifiers of this type are ignored (as if they did not exist). -.TP -\fBTK_ARGV_HELP\fR +.IP \fBTK_ARGV_HELP\fR When this kind of option is encountered, \fBTk_ParseArgv\fR uses the \fIhelp\fR fields of \fIargTable\fR to format a message describing all the valid arguments. The message is placed in interpreter @@ -194,8 +185,7 @@ field of a \fBTK_ARGV_HELP\fR specifier is NULL, then the specifier will never match any arguments; in this case the specifier simply provides extra documentation, which will be included when some other \fBTK_ARGV_HELP\fR entry causes help information to be returned. -.TP -\fBTK_ARGV_REST\fR +.IP \fBTK_ARGV_REST\fR This option is used by programs or commands that allow the last several of their options to be the name and/or options for some other program. If a \fBTK_ARGV_REST\fR argument is found, then @@ -207,8 +197,7 @@ integer value, and stores at \fI*dst\fR the index of the first of the \fBTK_ARGV_REST\fR options in the returned \fIargv\fR. This allows the program to distinguish the \fBTK_ARGV_REST\fR options from other unprocessed options that preceded the \fBTK_ARGV_REST\fR. -.TP -\fBTK_ARGV_FUNC\fR +.IP \fBTK_ARGV_FUNC\fR For this kind of argument, \fIsrc\fR is treated as the address of a procedure, which is invoked to process the following argument. The procedure should have the following structure: @@ -232,8 +221,7 @@ should return 0 and \fBTkParseArgv\fR will process the following argument in the normal fashion. In either event the matching argument is discarded. .RE -.TP -\fBTK_ARGV_GENFUNC\fR +.IP \fBTK_ARGV_GENFUNC\fR This form provides a more general procedural escape. It treats \fIsrc\fR as the address of a procedure, and passes that procedure all of the remaining arguments. The procedure should have the following @@ -266,27 +254,23 @@ in the usual Tcl fashion, and return \-1; when this happens \fBTk_ParseArgv\fR will abort its processing and return \fBTCL_ERROR\fR. .RE .SS "FLAGS" -.TP -\fBTK_ARGV_DONT_SKIP_FIRST_ARG\fR +.IP \fBTK_ARGV_DONT_SKIP_FIRST_ARG\fR \fBTk_ParseArgv\fR normally treats \fIargv[0]\fR as a program or command name, and returns it to the caller just as if it had not matched \fIargTable\fR. If this flag is given, then \fIargv[0]\fR is not given special treatment. -.TP -\fBTK_ARGV_NO_ABBREV\fR +.IP \fBTK_ARGV_NO_ABBREV\fR Normally, \fBTk_ParseArgv\fR accepts unique abbreviations for \fIkey\fR values in \fIargTable\fR. If this flag is given then only exact matches will be acceptable. -.TP -\fBTK_ARGV_NO_LEFTOVERS\fR +.IP \fBTK_ARGV_NO_LEFTOVERS\fR Normally, \fBTk_ParseArgv\fR returns unrecognized arguments to the caller. If this bit is set in \fIflags\fR then \fBTk_ParseArgv\fR will return an error if it encounters any argument that does not match \fIargTable\fR. The only exception to this rule is \fIargv[0]\fR, which will be returned to the caller with no errors as long as \fBTK_ARGV_DONT_SKIP_FIRST_ARG\fR is not specified. -.TP -\fBTK_ARGV_NO_DEFAULTS\fR +.IP \fBTK_ARGV_NO_DEFAULTS\fR Normally, \fBTk_ParseArgv\fR searches an internal table of standard argument specifiers in addition to \fIargTable\fR. If this bit is set in \fIflags\fR, then \fBTk_ParseArgv\fR will @@ -312,11 +296,11 @@ Boolean exec = FALSE; * Define option descriptions. */ Tk_ArgvInfo argTable[] = { - {"\-X", TK_ARGV_CONSTANT, (char *) 1, &debugFlag, + {"-X", TK_ARGV_CONSTANT, (char *) 1, &debugFlag, "Turn on debugging printfs"}, - {"\-N", TK_ARGV_INT, NULL, &numReps, + {"-N", TK_ARGV_INT, NULL, &numReps, "Number of repetitions"}, - {"\-of", TK_ARGV_STRING, NULL, &fileName, + {"-of", TK_ARGV_STRING, NULL, &fileName, "Name of file for output"}, {"x", TK_ARGV_REST, NULL, &exec, "File to exec, followed by any arguments (must be last argument)."}, @@ -324,9 +308,7 @@ Tk_ArgvInfo argTable[] = { NULL} }; -main(argc, argv) - int argc; - char *argv[]; +int main(int argc, char *argv[]) { \&... @@ -346,9 +328,9 @@ Note that default values can be assigned to variables named in particular arguments are present in \fIargv\fR. Here are some example command lines and their effects. .CS -prog \-N 200 infile # just sets the numReps variable to 200 -prog \-of out200 infile # sets fileName to reference "out200" -prog \-XN 10 infile # sets the debug flag, also sets numReps +prog -N 200 infile # just sets the numReps variable to 200 +prog -of out200 infile # sets fileName to reference "out200" +prog -XN 10 infile # sets the debug flag, also sets numReps .CE In all of the above examples, \fIargc\fR will be set by \fBTk_ParseArgv\fR to 2, \fIargv\fR[0] will be diff --git a/doc/QWinEvent.3 b/doc/QWinEvent.3 index 9c43ce5..28db0c9 100644 --- a/doc/QWinEvent.3 +++ b/doc/QWinEvent.3 @@ -17,6 +17,7 @@ int \fBTk_CollapseMotionEvents\fR(\fIdisplay, collapse\fR) .sp \fBTk_QueueWindowEvent\fR(\fIeventPtr, position\fR) +.fi .SH ARGUMENTS .AS Tcl_QueuePosition position .AP Display *display in diff --git a/doc/Restack.3 b/doc/Restack.3 index 5cd02eb..59ab9ec 100644 --- a/doc/Restack.3 +++ b/doc/Restack.3 @@ -16,6 +16,7 @@ Tk_RestackWindow \- Change a window's position in the stacking order .sp int \fBTk_RestackWindow\fR(\fItkwin, aboveBelow, other\fR) +.fi .SH ARGUMENTS .AS Tk_Window aboveBelow .AP Tk_Window tkwin in diff --git a/doc/RestrictEv.3 b/doc/RestrictEv.3 index f61e764..fdf2250 100644 --- a/doc/RestrictEv.3 +++ b/doc/RestrictEv.3 @@ -16,6 +16,7 @@ Tk_RestrictEvents \- filter and selectively delay X events .sp Tk_RestrictProc * \fBTk_RestrictEvents\fR(\fIproc, arg, prevArgPtr\fR) +.fi .SH ARGUMENTS .AS Tk_RestrictProc **prevArgPtr .AP Tk_RestrictProc *proc in diff --git a/doc/SetAppName.3 b/doc/SetAppName.3 index 91516a0..84984a7 100644 --- a/doc/SetAppName.3 +++ b/doc/SetAppName.3 @@ -16,6 +16,7 @@ Tk_SetAppName \- Set the name of an application for 'send' commands .sp const char * \fBTk_SetAppName\fR(\fItkwin, name\fR) +.fi .SH ARGUMENTS .AS Tk_Window parent .AP Tk_Window tkwin in diff --git a/doc/SetCaret.3 b/doc/SetCaret.3 index 24cc18c..401b57f 100644 --- a/doc/SetCaret.3 +++ b/doc/SetCaret.3 @@ -15,6 +15,7 @@ Tk_SetCaretPos \- set the display caret location .sp int \fBTk_SetCaretPos\fR(\fItkwin, x, y, height\fR) +.fi .SH ARGUMENTS .AP Tk_Window tkwin in Token for window. diff --git a/doc/SetClass.3 b/doc/SetClass.3 index 0ea81bb..c5a02c8 100644 --- a/doc/SetClass.3 +++ b/doc/SetClass.3 @@ -18,6 +18,7 @@ Tk_SetClass, Tk_Class \- set or retrieve a window's class .sp Tk_Uid \fBTk_Class\fR(\fItkwin\fR) +.fi .SH ARGUMENTS .AS Tk_Window parent .AP Tk_Window tkwin in diff --git a/doc/SetClassProcs.3 b/doc/SetClassProcs.3 index d8f89a4..c0a702f 100644 --- a/doc/SetClassProcs.3 +++ b/doc/SetClassProcs.3 @@ -14,6 +14,7 @@ Tk_SetClassProcs \- register widget specific procedures \fB#include \fR .sp \fBTk_SetClassProcs\fR(\fItkwin, procs, instanceData\fR) +.fi .SH ARGUMENTS .AS Tk_ClassProc instanceData .AP Tk_Window tkwin in @@ -32,7 +33,7 @@ are used as callbacks in different places. .PP The structure pointed to by \fIprocs\fR contains the following: .CS -typedef struct Tk_ClassProcs { +typedef struct { size_t \fIsize\fR; Tk_ClassWorldChangedProc *\fIworldChangedProc\fR; Tk_ClassCreateProc *\fIcreateProc\fR; diff --git a/doc/SetGrid.3 b/doc/SetGrid.3 index ea32afb..5440ebf 100644 --- a/doc/SetGrid.3 +++ b/doc/SetGrid.3 @@ -17,6 +17,7 @@ Tk_SetGrid, Tk_UnsetGrid \- control the grid for interactive resizing \fBTk_SetGrid\fR(\fItkwin, reqWidth, reqHeight, widthInc, heightInc\fR) .sp \fBTk_UnsetGrid\fR(\fItkwin\fR) +.fi .SH ARGUMENTS .AS Tk_Window heightInc .AP Tk_Window tkwin in diff --git a/doc/SetOptions.3 b/doc/SetOptions.3 index 5dea561..9db5d9d 100644 --- a/doc/SetOptions.3 +++ b/doc/SetOptions.3 @@ -14,27 +14,28 @@ Tk_CreateOptionTable, Tk_DeleteOptionTable, Tk_InitOptions, Tk_SetOptions, Tk_Fr \fB#include \fR .sp Tk_OptionTable -\fBTk_CreateOptionTable(\fIinterp, templatePtr\fB)\fR +\fBTk_CreateOptionTable\fR(\fIinterp, templatePtr\fR) .sp -\fBTk_DeleteOptionTable(\fIoptionTable\fB)\fR +\fBTk_DeleteOptionTable\fR(\fIoptionTable\fR) .sp int -\fBTk_InitOptions(\fIinterp, recordPtr, optionTable, tkwin\fB)\fR +\fBTk_InitOptions\fR(\fIinterp, recordPtr, optionTable, tkwin\fR) .sp int -\fBTk_SetOptions(\fIinterp, recordPtr, optionTable, objc, objv, tkwin, savePtr, maskPtr\fB)\fR +\fBTk_SetOptions\fR(\fIinterp, recordPtr, optionTable, objc, objv, tkwin, savePtr, maskPtr\fR) .sp -\fBTk_FreeSavedOptions(\fIsavedPtr\fB)\fR +\fBTk_FreeSavedOptions\fR(\fIsavedPtr\fR) .sp -\fBTk_RestoreSavedOptions(\fIsavedPtr\fB)\fR +\fBTk_RestoreSavedOptions\fR(\fIsavedPtr\fR) .sp Tcl_Obj * -\fBTk_GetOptionValue(\fIinterp, recordPtr, optionTable, namePtr, tkwin\fB)\fR +\fBTk_GetOptionValue\fR(\fIinterp, recordPtr, optionTable, namePtr, tkwin\fR) .sp Tcl_Obj * -\fBTk_GetOptionInfo(\fIinterp, recordPtr, optionTable, namePtr, tkwin\fB)\fR +\fBTk_GetOptionInfo\fR(\fIinterp, recordPtr, optionTable, namePtr, tkwin\fR) .sp -\fBTk_FreeConfigOptions(\fIrecordPtr, optionTable, tkwin\fB)\fR +\fBTk_FreeConfigOptions\fR(\fIrecordPtr, optionTable, tkwin\fR) +.fi .SH ARGUMENTS .AS Tk_SavedOptions "*const objv[]" in/out .AP Tcl_Interp *interp in @@ -98,7 +99,7 @@ practice the object may not actually be a widget. The term is used to refer to the C-level structure in which information about a particular widget or object is stored. .PP -Note: the easiest way to learn how to use these procedures is to +Note that the easiest way to learn how to use these procedures is to look at a working example. In Tk, the simplest example is the code that implements the button family of widgets, which is in \fBtkButton.c\fR. Other examples are in \fBtkSquare.c\fR and \fBtkMenu.c\fR. @@ -301,8 +302,7 @@ greater than or equal to zero. .PP The \fIflags\fR field consists of one or more bits ORed together. The following flags are supported: -.TP -\fBTK_OPTION_NULL_OK\fR +.IP \fBTK_OPTION_NULL_OK\fR If this bit is set for an option then an empty string will be accepted as the value for the option and the resulting internal form will be a NULL pointer, a zero value, or \fBNone\fR, depending on the type of the option. @@ -313,26 +313,24 @@ feature to be turned off entirely, e.g. set a cursor value to Not all option types support the \fBTK_OPTION_NULL_OK\fR flag; for those that do, there is an explicit indication of that fact in the descriptions below. -.TP -\fBTK_OPTION_DONT_SET_DEFAULT\fR +.IP \fBTK_OPTION_DONT_SET_DEFAULT\fR If this bit is set for an option then no default value will be set in \fBTk_InitOptions\fR for this option. Neither the option database, nor any system default value, nor \fIoptionTable\fR are used to give a default value to this option. Instead it is assumed that the caller has already supplied a default value in the widget code. -.TP -\fBTK_OPTION_ENUM_VAR\fR +.IP \fBTK_OPTION_ENUM_VAR\fR If this value is set for an option, then it indicates the the internalOffset points to an enum variable in stead of an int variable. Only useful in combination with \fBTK_OPTION_STRING_TABLE\fR, \fBTK_OPTION_BOOLEAN\fR, \fBTK_OPTION_ANCHOR\fR, \fBTK_OPTION_JUSTIFY\fR, or \fBTK_OPTION_ANCHOR\fR. -.TP -\fBTK_OPTION_VAR(type)\fR +.IP \fBTK_OPTION_VAR(\fItype\fB)\fR If this value is set for an option, then it indicates the the internalOffset points to a \fItype\fR variable in stead of an int variable. Only useful in combination with \fBTK_OPTION_STRING_TABLE\fR or \fBTK_OPTION_BOOLEAN\fR +.RS .PP The \fItype\fR field of each Tk_OptionSpec structure determines how to parse the value of that configuration option. The @@ -342,43 +340,38 @@ passed into procedures like \fBTk_SetOptions\fR, or if it uses the \fIclientData\fR field of the Tk_OptionSpec, then it is indicated explicitly; if not mentioned, the type requires neither \fItkwin\fR nor \fIclientData\fR. -.TP -\fBTK_OPTION_ANCHOR\fR +.RE +.IP \fBTK_OPTION_ANCHOR\fR The value must be a standard anchor position such as \fBne\fR or \fBcenter\fR. The internal form is a Tk_Anchor value like the ones -returned by \fBTk_GetAnchorFromObj\fR. This option type supports the \fBTK_OPTION_NULL_OK\fR -flag; if the empty string is specified as the value for the option, -the integer relief value is set to \fBTK_ANCHOR_NULL\fR. -.TP -\fBTK_OPTION_BITMAP\fR +returned by \fBTk_GetAnchorFromObj\fR. This option type supports the +\fBTK_OPTION_NULL_OK\fR flag; if the empty string is specified as the +value for the option, the integer relief value is set to \fBTK_ANCHOR_NULL\fR. +.IP \fBTK_OPTION_BITMAP\fR The value must be a standard Tk bitmap name. The internal form is a Pixmap token like the ones returned by \fBTk_AllocBitmapFromObj\fR. This option type requires \fItkwin\fR to be supplied to procedures such as \fBTk_SetOptions\fR, and it supports the \fBTK_OPTION_NULL_OK\fR flag. -.TP -\fBTK_OPTION_BOOLEAN\fR +.IP \fBTK_OPTION_BOOLEAN\fR The value must be a standard boolean value such as \fBtrue\fR or -\fBno\fR. The internal form is an integer with value 0 or 1. Note: if the -\fIobjOffset\fR field is not used then information about the original value -of this option will be lost. This option type supports the +\fBno\fR. The internal form is an integer with value 0 or 1. Note that if +the \fIobjOffset\fR field is not used, information about the original +value of this option will be lost. This option type supports the \fBTK_OPTION_NULL_OK\fR flag; if a NULL value is set, the internal representation is set to -1. -.TP -\fBTK_OPTION_BORDER\fR +.IP \fBTK_OPTION_BORDER\fR The value must be a standard color name such as \fBred\fR or \fB#ff8080\fR. The internal form is a Tk_3DBorder token like the ones returned by \fBTk_Alloc3DBorderFromObj\fR. This option type requires \fItkwin\fR to be supplied to procedures such as \fBTk_SetOptions\fR, and it supports the \fBTK_OPTION_NULL_OK\fR flag. -.TP -\fBTK_OPTION_COLOR\fR +.IP \fBTK_OPTION_COLOR\fR The value must be a standard color name such as \fBred\fR or \fB#ff8080\fR. The internal form is an (XColor *) token like the ones returned by \fBTk_AllocColorFromObj\fR. This option type requires \fItkwin\fR to be supplied to procedures such as \fBTk_SetOptions\fR, and it supports the \fBTK_OPTION_NULL_OK\fR flag. -.TP -\fBTK_OPTION_CURSOR\fR +.IP \fBTK_OPTION_CURSOR\fR The value must be a standard cursor name such as \fBcross\fR or \fB@foo\fR. The internal form is a Tk_Cursor token like the ones returned by \fBTk_AllocCursorFromObj\fR. @@ -386,19 +379,16 @@ This option type requires \fItkwin\fR to be supplied to procedures such as \fBTk_SetOptions\fR, and when the option is set the cursor for the window is changed by calling \fBXDefineCursor\fR. This option type also supports the \fBTK_OPTION_NULL_OK\fR flag. -.TP -\fBTK_OPTION_CUSTOM\fR +.IP \fBTK_OPTION_CUSTOM\fR This option allows applications to define new option types. The clientData field of the entry points to a structure defining the new option type. See the section \fBCUSTOM OPTION TYPES\fR below for details. -.TP -\fBTK_OPTION_DOUBLE\fR +.IP \fBTK_OPTION_DOUBLE\fR The string value must be a floating-point number in the format accepted by \fBstrtol\fR. The internal form is a C \fBdouble\fR value. This option type supports the \fBTK_OPTION_NULL_OK\fR flag; if a NULL value is set, the internal representation is set to NaN. -.TP -\fBTK_OPTION_END\fR +.IP \fBTK_OPTION_END\fR Marks the end of the template. There must be a Tk_OptionSpec structure with \fItype\fR \fBTK_OPTION_END\fR at the end of each template. If the \fIclientData\fR field of this structure is not NULL, then it points to @@ -406,60 +396,54 @@ an additional array of Tk_OptionSpec's, which is itself terminated by another \fBTK_OPTION_END\fR entry. Templates may be chained arbitrarily deeply. This feature allows common options to be shared by several widget classes. -.TP -\fBTK_OPTION_FONT\fR +.IP \fBTK_OPTION_FONT\fR The value must be a standard font name such as \fBTimes 16\fR. The internal form is a Tk_Font handle like the ones returned by \fBTk_AllocFontFromObj\fR. This option type requires \fItkwin\fR to be supplied to procedures such as \fBTk_SetOptions\fR, and it supports the \fBTK_OPTION_NULL_OK\fR flag. -.TP -\fBTK_OPTION_INT\fR +.IP \fBTK_OPTION_INT\fR The string value must be an integer in the format accepted by \fBstrtol\fR (e.g. \fB0\fR and \fB0x\fR prefixes may be used to -specify octal or hexadecimal numbers, respectively). The internal -form is a C \fBint\fR value. This option type supports the \fBTK_OPTION_NULL_OK\fR +specify octal or hexadecimal numbers, respectively). The internal form is +a C \fBint\fR value. This option type supports the \fBTK_OPTION_NULL_OK\fR flag; if a NULL value is set, the internal representation is set to INT_MIN. -.TP -\fBTK_OPTION_INDEX\fR -The string value must be an index in the format accepted by \fBTcl_GetIntForIndex()\fR +.IP \fBTK_OPTION_INDEX\fR +The string value must be an index in the format accepted by +\fBTcl_GetIntForIndex()\fR or the empty string. The internal form is a C \fBint\fR value. If the string -starts with \fB-\fR, the internal representation will be set to INT_MIN. If the +starts with \fB\-\fR, the internal representation will be set to INT_MIN. If the string has the form \fBend-???\fR, then the result will be a negative number: \fB-1\fR stands for \fBend\fR, \fB-2\fR stands for \fBend-1\fR and so on. This option type supports the \fBTK_OPTION_NULL_OK\fR flag; if a NULL value is set, the internal representation is set to INT_MIN. -.TP -\fBTK_OPTION_JUSTIFY\fR +.IP \fBTK_OPTION_JUSTIFY\fR The value must be a standard justification value such as \fBleft\fR. The internal form is a Tk_Justify like the values returned by -\fBTk_GetJustifyFromObj\fR. This option type supports the \fBTK_OPTION_NULL_OK\fR +\fBTk_GetJustifyFromObj\fR. This option type supports the +\fBTK_OPTION_NULL_OK\fR flag; if the empty string is specified as the value for the option, the integer relief value is set to \fBTK_JUSTIFY_NULL\fR. -.TP -\fBTK_OPTION_PIXELS\fR +.IP \fBTK_OPTION_PIXELS\fR The value must specify a screen distance such as \fB2i\fR or \fB6.4\fR. The internal form is an integer value giving a distance in pixels, like the values returned by -\fBTk_GetPixelsFromObj\fR. Note: if the \fIobjOffset\fR field is not -used then information about the original value of this option will be lost. +\fBTk_GetPixelsFromObj\fR. Note that if the \fIobjOffset\fR field is not +used, information about the original value of this option will be lost. See \fBOBJOFFSET VS. INTERNALOFFSET\fR below for details. This option type supports the \fBTK_OPTION_NULL_OK\fR flag; if a NULL value is set, the internal representation is set to INT_MIN. -.TP -\fBTK_OPTION_RELIEF\fR +.IP \fBTK_OPTION_RELIEF\fR The value must be standard relief such as \fBraised\fR. The internal form is an integer relief value such as \fBTK_RELIEF_RAISED\fR. This option type supports the \fBTK_OPTION_NULL_OK\fR flag; if a NULL value is set, the internal representation is set to \fBTK_RELIEF_NULL\fR. -.TP -\fBTK_OPTION_STRING\fR +.IP \fBTK_OPTION_STRING\fR The value may be any string. The internal form is a (char *) pointer that points to a dynamically allocated copy of the value. This option type supports the \fBTK_OPTION_NULL_OK\fR flag. -.TP -\fBTK_OPTION_STRING_TABLE\fR +.IP \fBTK_OPTION_STRING_TABLE\fR For this type, \fIclientData\fR is a pointer to an array of strings suitable for passing to \fBTcl_GetIndexFromObj\fR. The value must be one of the strings in the table, or a unique abbreviation of @@ -468,15 +452,13 @@ into the table of the matching string, like the return value from \fBTcl_GetStringFromObj\fR. This option type supports the \fBTK_OPTION_NULL_OK\fR flag; if a NULL value is set, the internal representation is set to -1. -.TP -\fBTK_OPTION_SYNONYM\fR +.IP \fBTK_OPTION_SYNONYM\fR This type is used to provide alternative names for an option (for example, \fB\-bg\fR is often used as a synonym for \fB\-background\fR). The \fBclientData\fR field is a string that gives the name of another option in the same table. Whenever the synonym option is used, the information from the other option will be used instead. -.TP -\fBTK_OPTION_WINDOW\fR +.IP \fBTK_OPTION_WINDOW\fR The value must be a window path name. The internal form is a \fBTk_Window\fR token for the window. This option type requires \fItkwin\fR to be supplied to procedures @@ -526,8 +508,8 @@ the option is retrieved. In most cases it is convenient to use the \fIinternalOffset\fR field as well, so that the integer value is immediately available for use in the widget code (alternatively, \fBTk_GetPixelsFromObj\fR can be used to extract the integer value from -the object whenever it is needed). Note: the problem of losing information -on retrievals exists only for \fBTK_OPTION_PIXELS\fR options. +the object whenever it is needed). Note that the problem of losing +information on retrievals exists only for \fBTK_OPTION_PIXELS\fR options. .PP The second reason to use the \fIobjOffset\fR field is in order to implement new types of options not supported by these procedures. @@ -546,7 +528,7 @@ additional configuration types by writing procedures to parse, print, free, and restore saved copies of the type and creating a structure pointing to those procedures: .CS -typedef struct Tk_ObjCustomOption { +typedef struct { char *name; Tk_CustomOptionSetProc *\fIsetProc\fR; Tk_CustomOptionGetProc *\fIgetProc\fR; @@ -596,18 +578,14 @@ The \fIsetProc\fR procedure is invoked by \fBTk_SetOptions\fR to convert a Tcl_Obj into an internal representation and store the resulting value in the widget record. The arguments are: .RS -.TP -\fIclientData\fR +.IP \fIclientData\fR A copy of the \fIclientData\fR field in the Tk_ObjCustomOption structure. -.TP -\fIinterp\fR +.IP \fIinterp\fR A pointer to a Tcl interpreter, used for error reporting. -.TP -\fITkwin\fR +.IP \fITkwin\fR A copy of the \fItkwin\fR argument to \fBTk_SetOptions\fR -.TP -\fIvaluePtr\fR +.IP \fIvaluePtr\fR A pointer to a reference to a Tcl_Obj describing the new value for the option; it could have been specified explicitly in the call to \fBTk_SetOptions\fR or it could come from the option database or a @@ -617,22 +595,18 @@ pointer referenced by \fIvaluePtr\fR is the pointer that will be stored at the objOffset for the option. \fISetProc\fR may modify the value if necessary; for example, \fIsetProc\fR may change the value to NULL to support the \fBTK_OPTION_NULL_OK\fR flag. -.TP -\fIrecordPtr\fR +.IP \fIrecordPtr\fR A pointer to the start of the widget record to modify. -.TP -\fIinternalOffset\fR +.IP \fIinternalOffset\fR Offset in bytes from the start of the widget record to the location where the internal representation of the option value is to be placed. -.TP -\fIsaveInternalPtr\fR +.IP \fIsaveInternalPtr\fR A pointer to storage allocated in a Tk_SavedOptions structure for the internal representation of the original option value. Before setting the option to its new value, \fIsetProc\fR should set the value referenced by \fIsaveInternalPtr\fR to the original value of the option in order to support \fBTk_RestoreSavedOptions\fR. -.TP -\fIflags\fR +.IP \fIflags\fR A copy of the \fIflags\fR field in the Tk_OptionSpec structure for the option .RE diff --git a/doc/SetVisual.3 b/doc/SetVisual.3 index a5b9efd..a3b50d1 100644 --- a/doc/SetVisual.3 +++ b/doc/SetVisual.3 @@ -16,6 +16,7 @@ Tk_SetWindowVisual \- change visual characteristics of window .sp int \fBTk_SetWindowVisual\fR(\fItkwin, visual, depth, colormap\fR) +.fi .SH ARGUMENTS .AS "Tk_Window int" colormap .AP Tk_Window tkwin in @@ -43,7 +44,7 @@ is called then it returns 0 and does not make any changes; otherwise it returns 1 to signify that the operation completed successfully. .PP -Note: \fBTk_SetWindowVisual\fR should not be called if you just want +Note that \fBTk_SetWindowVisual\fR should not be called if you just want to change a window's colormap without changing its visual or depth; call \fBTk_SetWindowColormap\fR instead. .SH KEYWORDS diff --git a/doc/StrictMotif.3 b/doc/StrictMotif.3 index ec9319f..c8a6e08 100644 --- a/doc/StrictMotif.3 +++ b/doc/StrictMotif.3 @@ -15,6 +15,7 @@ Tk_StrictMotif \- Return value of tk_strictMotif variable .sp int \fBTk_StrictMotif\fR(\fItkwin\fR) +.fi .SH ARGUMENTS .AS Tk_Window tkwin .AP Tk_Window tkwin in diff --git a/doc/TextLayout.3 b/doc/TextLayout.3 index 335ab39..5e83a7b 100644 --- a/doc/TextLayout.3 +++ b/doc/TextLayout.3 @@ -14,31 +14,28 @@ Tk_ComputeTextLayout, Tk_FreeTextLayout, Tk_DrawTextLayout, Tk_UnderlineTextLayo \fB#include \fR .sp Tk_TextLayout -\fBTk_ComputeTextLayout(\fItkfont, string, numChars, wrapLength, justify, flags, widthPtr, heightPtr\fB)\fR +\fBTk_ComputeTextLayout\fR(\fItkfont, string, numChars, wrapLength, justify, flags, widthPtr, heightPtr\fR) .sp -void -\fBTk_FreeTextLayout(\fIlayout\fB)\fR +\fBTk_FreeTextLayout\fR(\fIlayout\fR) .sp -void -\fBTk_DrawTextLayout(\fIdisplay, drawable, gc, layout, x, y, firstChar, lastChar\fB)\fR +\fBTk_DrawTextLayout\fR(\fIdisplay, drawable, gc, layout, x, y, firstChar, lastChar\fR) .sp -void -\fBTk_UnderlineTextLayout(\fIdisplay, drawable, gc, layout, x, y, underline\fB)\fR +\fBTk_UnderlineTextLayout\fR(\fIdisplay, drawable, gc, layout, x, y, underline\fR) .sp int -\fBTk_PointToChar(\fIlayout, x, y\fB)\fR +\fBTk_PointToChar\fR(\fIlayout, x, y\fR) .sp int -\fBTk_CharBbox(\fIlayout, index, xPtr, yPtr, widthPtr, heightPtr\fB)\fR +\fBTk_CharBbox\fR(\fIlayout, index, xPtr, yPtr, widthPtr, heightPtr\fR) .sp int -\fBTk_DistanceToTextLayout(\fIlayout, x, y\fB)\fR +\fBTk_DistanceToTextLayout\fR(\fIlayout, x, y\fR) .sp int -\fBTk_IntersectTextLayout(\fIlayout, x, y, width, height\fB)\fR +\fBTk_IntersectTextLayout\fR(\fIlayout, x, y, width, height\fR) .sp -void -\fBTk_TextLayoutToPostscript(\fIinterp, layout\fB)\fR +\fBTk_TextLayoutToPostscript\fR(\fIinterp, layout\fR) +.fi .SH ARGUMENTS .AS Tk_TextLayout "*xPtr, *yPtr" .AP Tk_Font tkfont in diff --git a/doc/TkInitStubs.3 b/doc/TkInitStubs.3 index 57ec9e6..4429bc9 100644 --- a/doc/TkInitStubs.3 +++ b/doc/TkInitStubs.3 @@ -15,6 +15,7 @@ Tk_InitStubs \- initialize the Tk stubs mechanism .sp const char * \fBTk_InitStubs\fR(\fIinterp, version, exact\fR) +.fi .SH ARGUMENTS .AS Tcl_Interp *interp in .AP Tcl_Interp *interp in diff --git a/doc/Tk_Init.3 b/doc/Tk_Init.3 index fc29318..1f769c6 100644 --- a/doc/Tk_Init.3 +++ b/doc/Tk_Init.3 @@ -47,38 +47,48 @@ all Tk commands that are considered unsafe. Those commands and the reasons for their exclusion are: .TP \fBbell\fR +. Continuous ringing of the bell is a nuisance. .TP \fBclipboard\fR +. A malicious script could replace the contents of the clipboard with the string .QW "\fBrm \-r *\fR" and lead to surprises when the contents of the clipboard are pasted. .TP \fBgrab\fR +. Grab can be used to block the user from using any other applications. .TP \fBmenu\fR +. Menus can be used to cover the entire screen and to steal input from the user. .TP \fBselection\fR +. See clipboard. .TP \fBsend\fR +. Send can be used to cause unsafe interpreters to execute commands. .TP \fBtk\fR +. The tk command recreates the send command, which is unsafe. .TP \fBtkwait\fR +. Tkwait can block the containing process forever .TP \fBtoplevel\fR +. Toplevels can be used to cover the entire screen and to steal input from the user. .TP \fBwm\fR +. If toplevels are ever allowed, wm can be used to remove decorations, move windows around, etc. .SH KEYWORDS diff --git a/doc/WinUtil.3 b/doc/WinUtil.3 index 253ed19..7208200 100644 --- a/doc/WinUtil.3 +++ b/doc/WinUtil.3 @@ -15,14 +15,15 @@ Tk_GetOtherWindow, Tk_MakeContainer, Tk_MakeWindow, Tk_UseWindow \- window utili \fB#include \fR .sp Tk_Window -\fBTk_GetOtherWindow(\fItkwin\fB)\fR +\fBTk_GetOtherWindow\fR(\fItkwin\fR) .sp -\fBTk_MakeContainer(\fItkwin\fB)\fR +\fBTk_MakeContainer\fR(\fItkwin\fR) .sp -\fBTk_MakeWindow(\fItkwin, parent\fB)\fR +\fBTk_MakeWindow\fR(\fItkwin, parent\fR) .sp int -\fBTk_UseWindow(\fIinterp, tkwin, string\fB)\fR +\fBTk_UseWindow\fR(\fIinterp, tkwin, string\fR) +.fi .SH ARGUMENTS .AS XSetWindowAttributes borderWidth .AP Tcl_Interp * interp in diff --git a/doc/WindowId.3 b/doc/WindowId.3 index 477efe1..68597d8 100644 --- a/doc/WindowId.3 +++ b/doc/WindowId.3 @@ -103,6 +103,7 @@ Tcl_Interp * .sp Tcl_Obj * \fBTk_NewWindowObj\fR(\fItkwin\fR) +.fi .SH ARGUMENTS .AS Tk_Window tkwin .AP Tk_Window tkwin in @@ -147,7 +148,7 @@ information plus a few other fields. \fBTk_Attributes\fR returns a pointer to an XSetWindowAttributes structure describing all of the attributes of the \fItkwin\fR's window, such as background pixmap, event mask, and so on (Tk keeps track of all this information -as it is changed by the application). Note: it is essential that +as it is changed by the application). Note that it is essential that applications use Tk procedures like \fBTk_ResizeWindow\fR instead of X procedures like \fBXResizeWindow\fR, so that Tk can keep its data structures up-to-date. diff --git a/doc/bind.n b/doc/bind.n index 3fe72f1..a388152 100644 --- a/doc/bind.n +++ b/doc/bind.n @@ -149,8 +149,9 @@ substantial mouse motion in between. For example, \fB\fR is equivalent to \fB\fR with the extra time and space requirement. .PP -The \fBCommand\fR, \fBOption\fR, \fBNum\fR and \fBFn\fRmodifiers are equivalents -of \fBMod1\fR up to \fBMod4\fR, they correspond to Macintosh-specific modifier keys. +The \fBCommand\fR, \fBOption\fR, \fBNum\fR and \fBFn\fRmodifiers are +equivalents of \fBMod1\fR up to \fBMod4\fR; they correspond to +Macintosh-specific modifier keys. .PP The \fBExtended\fR modifier is, at present, specific to Windows. It appears on events that are associated with the keys on the @@ -739,7 +740,7 @@ The \fBbgerror\fR command will be executed at global level Arrange for a string describing the motion of the mouse to be printed out when the mouse is double-clicked: .CS -\fBbind\fR . { +\fBbind\fR . { puts "hi from (%x,%y)" } .CE @@ -748,7 +749,7 @@ A little GUI that displays what the keysym name of the last key pressed is: .CS set keysym "Press any key" -pack [label .l \-textvariable keysym \-padx 2m \-pady 1m] +pack [label .l -textvariable keysym -padx 2m -pady 1m] \fBbind\fR . { set keysym "You pressed %K" } diff --git a/doc/bitmap.n b/doc/bitmap.n index 8afcdfd..3ef2254 100644 --- a/doc/bitmap.n +++ b/doc/bitmap.n @@ -39,6 +39,7 @@ data is zero. Like all images, bitmaps are created using the \fBimage create\fR command. Bitmaps support the following \fIoptions\fR: +.\" OPTION: -background .TP \fB\-background \fIcolor\fR . @@ -47,6 +48,7 @@ ways accepted by Tk. If this option is set to an empty string then the background pixels will be transparent. This effect is achieved by using the source bitmap as the mask bitmap, ignoring any \fB\-maskdata\fR or \fB\-maskfile\fR options. +.\" OPTION: -data .TP \fB\-data \fIstring\fR . @@ -55,6 +57,7 @@ The string must adhere to X11 bitmap format (e.g., as generated by the \fBbitmap\fR program). If both the \fB\-data\fR and \fB\-file\fR options are specified, the \fB\-data\fR option takes precedence. +.\" OPTION: -file .TP \fB\-file \fIname\fR . @@ -62,11 +65,13 @@ the \fB\-data\fR option takes precedence. source bitmap. The file must adhere to X11 bitmap format (e.g., as generated by the \fBbitmap\fR program). +.\" OPTION: -foreground .TP \fB\-foreground \fIcolor\fR . Specifies a foreground color for the image in any of the standard ways accepted by Tk. +.\" OPTION: -maskdata .TP \fB\-maskdata \fIstring\fR . @@ -75,6 +80,7 @@ The string must adhere to X11 bitmap format (e.g., as generated by the \fBbitmap\fR program). If both the \fB\-maskdata\fR and \fB\-maskfile\fR options are specified, the \fB\-maskdata\fR option takes precedence. +.\" OPTION: -maskfile .TP \fB\-maskfile \fIname\fR . diff --git a/doc/busy.n b/doc/busy.n index 649187a..b1453bb 100644 --- a/doc/busy.n +++ b/doc/busy.n @@ -30,19 +30,15 @@ .SH NAME busy \- Make Tk widgets busy, temporarily blocking user interactions .SH SYNOPSIS +.nf \fBtk busy\fI window \fR?\fIoptions\fR? -.sp \fBtk busy busywindow \fIwindow\fR -.sp \fBtk busy hold\fI window \fR?\fIoptions\fR? -.sp \fBtk busy configure \fIwindow\fR ?\fIoption value\fR?... -.sp \fBtk busy forget\fI window \fR?\fIwindow \fR?... -.sp \fBtk busy current\fR ?\fIpattern\fR? -.sp \fBtk busy status \fIwindow\fR +.fi .BE .SH DESCRIPTION .PP @@ -116,7 +112,7 @@ The busy window has a configurable cursor. You can change the busy cursor using the \fBconfigure\fR operation. .PP .CS -\fBtk busy\fR configure .top \-cursor "watch" +\fBtk busy\fR configure .top -cursor "watch" .CE .PP Destroying the widget will also clean up any resources allocated by the \fBtk @@ -203,6 +199,7 @@ command returns the pathname of the busy window that was created (i.e. the transparent window shielding the window appearing busy). The following configuration options are valid: .RS +.\" OPTION: -cursor .TP \fB\-cursor \fIcursorName\fR . diff --git a/doc/button.n b/doc/button.n index 79cf14e..9850670 100644 --- a/doc/button.n +++ b/doc/button.n @@ -196,17 +196,17 @@ This is the classic Tk demonstration: .PP .CS -\fBbutton\fR .b \-text "Hello, World!" \-command exit +\fBbutton\fR .b -text "Hello, World!" -command exit pack .b .CE .PP This example demonstrates how to handle button accelerators: .PP .CS -\fBbutton\fR .b1 \-text Hello \-underline 0 -\fBbutton\fR .b2 \-text World \-underline 0 -bind . {.b1 flash; .b1 invoke} -bind . {.b2 flash; .b2 invoke} +\fBbutton\fR .b1 -text Hello -underline 0 +\fBbutton\fR .b2 -text World -underline 0 +bind . {.b1 flash; .b1 invoke} +bind . {.b2 flash; .b2 invoke} pack .b1 .b2 .CE .SH "SEE ALSO" diff --git a/doc/canvas.n b/doc/canvas.n index 52f27d6..7484a6e 100644 --- a/doc/canvas.n +++ b/doc/canvas.n @@ -256,9 +256,7 @@ tasks as inserting new text at the end of the item. Lines and Polygons do not support the insertion cursor and the selection. Their indices are supposed to be even always, because coordinates always appear in pairs. -.TP 10 -\fInumber\fR -. +.IP \fInumber\fR 10 A decimal number giving the position of the desired character within the text item. 0 refers to the first character, 1 to the next character, and @@ -271,30 +269,20 @@ polygons, numbers less than 0 or greater than the length of the coordinate list will be adjusted by adding or subtracting the length until the result is between zero and the length, inclusive. -.TP 10 -\fBend\fR -. +.IP \fBend\fR 10 Refers to the character or coordinate just after the last one in the item (same as the number of characters or coordinates in the item). -.TP 10 -\fBinsert\fR -. +.IP \fBinsert\fR 10 Refers to the character just before which the insertion cursor is drawn in this item. Not valid for lines and polygons. -.TP 10 -\fBsel.first\fR -. +.IP \fBsel.first\fR 10 Refers to the first selected character in the item. If the selection is not in this item then this form is illegal. -.TP 10 -\fBsel.last\fR -. +.IP \fBsel.last\fR 10 Refers to the last selected character in the item. If the selection is not in this item then this form is illegal. -.TP 10 -\fB@\fIx,y\fR -. +.IP \fB@\fIx,y\fR 10 Refers to the character or coordinate at the point given by \fIx\fR and \fIy\fR, where \fIx\fR and \fIy\fR are specified in the coordinate system of the canvas. @@ -368,27 +356,19 @@ This command returns an empty string as result. \fISearchSpec\fR and \fIarg\fR's may take any of the following forms: .RS -.TP -\fBabove \fItagOrId\fR -. +.IP "\fBabove \fItagOrId\fR" Selects the item just after (above) the one given by \fItagOrId\fR in the display list. If \fItagOrId\fR denotes more than one item, then the last (topmost) of these items in the display list is used. -.TP -\fBall\fR -. +.IP \fBall\fR Selects all the items in the canvas. -.TP -\fBbelow \fItagOrId\fR -. +.IP "\fBbelow \fItagOrId\fR" Selects the item just before (below) the one given by \fItagOrId\fR in the display list. If \fItagOrId\fR denotes more than one item, then the first (lowest) of these items in the display list is used. -.TP -\fBclosest \fIx y \fR?\fIhalo\fR? ?\fIstart\fR? -. +.IP "\fBclosest \fIx y \fR?\fIhalo\fR? ?\fIstart\fR?" Selects the item closest to the point given by \fIx\fR and \fIy\fR. If more than one item is at the same closest distance (e.g. two items overlap the point), then the top-most of these items (the @@ -406,24 +386,18 @@ Instead of selecting the topmost closest item, this form will select the topmost closest item that is below \fIstart\fR in the display list; if no such item exists, then the selection behaves as if the \fIstart\fR argument had not been specified. -.TP -\fBenclosed\fI x1 y1 x2 y2\fR -. +.IP "\fBenclosed\fI x1 y1 x2 y2\fR" Selects all the items completely enclosed within the rectangular region given by \fIx1\fR, \fIy1\fR, \fIx2\fR, and \fIy2\fR. \fIX1\fR must be no greater than \fIx2\fR and \fIy1\fR must be no greater than \fIy2\fR. -.TP -\fBoverlapping\fI x1 y1 x2 y2\fR -. +.IP "\fBoverlapping\fI x1 y1 x2 y2\fR" Selects all the items that overlap or are enclosed within the rectangular region given by \fIx1\fR, \fIy1\fR, \fIx2\fR, and \fIy2\fR. \fIX1\fR must be no greater than \fIx2\fR and \fIy1\fR must be no greater than \fIy2\fR. -.TP -\fBwithtag \fItagOrId\fR -. +.IP "\fBwithtag \fItagOrId\fR" Selects all the items given by \fItagOrId\fR. .RE .\" METHOD: bbox @@ -673,26 +647,36 @@ If some or all of the items given by \fItagOrId\fR do not support an insertion cursor then this command has no effect on them. See \fBINDICES\fR above for a description of the legal forms for \fIindex\fR. -Note: the insertion cursor is only displayed in an item if +.RS +.PP +Note that the insertion cursor is only displayed in an item if that item currently has the keyboard focus (see the \fBfocus\fR widget command, above), but the cursor position may be set even when the item does not have the focus. +.PP This command returns an empty string. +.RE .\" METHOD: image .TP \fIpathName \fBimage \fIimagename\fR ?\fIsubsample\fR? ?\fIzoom\fR? . -Draw the canvas into the Tk photo image named \fIimagename\fR. If a \fB\-scrollregion\fR -has been defined then this will be the boundaries of the canvas region drawn and the -final size of the photo image. Otherwise the widget width and height with an origin -of 0,0 will be the size of the canvas region drawn and the final size of the photo -image. Optionally an integer \fIsubsample\fR factor may be given and the photo image -will be reduced in size. In addition to the \fIsubsample\fR an integer \fIzoom\fR -factor can also be given and the photo image will be enlarged. The image background -will be filled with the canvas background colour. The canvas widget does not need to -be mapped for this widget command to work, but at least one of it's ancestors must be -mapped. +Draw the canvas into the Tk photo image named \fIimagename\fR. +If a \fB\-scrollregion\fR has been defined then this will be the boundaries +of the canvas region drawn and the final size of the photo image. Otherwise +the widget width and height with an origin of 0,0 will be the size of the +canvas region drawn and the final size of the photo image. Optionally an +integer \fIsubsample\fR factor may be given and the photo image +will be reduced in size. +.RS +.PP +In addition to the \fIsubsample\fR an integer \fIzoom\fR factor can also +be given and the photo image will be enlarged. The image background will +be filled with the canvas background colour. The canvas widget does not +need to be mapped for this widget command to work, but at least one of +it's ancestors must be mapped. +.PP This command returns an empty string. +.RE .\" METHOD: imove .TP \fIpathName \fBimove \fItagOrId index x y\fR @@ -728,9 +712,13 @@ Text items interpret \fIbeforeThis\fR as an index to a character, line and polygon items interpret it as an index to a coordinate (an x,y pair). For lines and polygons the \fIstring\fR must be a valid coordinate sequence. +.RS +.PP See \fBINDICES\fR above for information about the forms allowed for \fIbeforeThis\fR. +.PP This command returns an empty string. +.RE .\" METHOD: itemcget .TP \fIpathName \fBitemcget\fI tagOrId option\fR @@ -777,7 +765,7 @@ but the relative order of the moved items will not be changed. \fIBelowThis\fR is a tag or id; if it refers to more than one item then the first (lowest) of these items in the display list is used as the destination location for the moved items. -Note: this command has no effect on window items. Window items always +Note that this command has no effect on window items. Window items always obscure other item types, and the stacking order of window items is determined by the \fBraise\fR command and \fBlower\fR command, not the \fBraise\fR widget command and \fBlower\fR widget command for canvases. @@ -831,6 +819,7 @@ The \fIoption\fR\-\fIvalue\fR argument pairs provide additional information to control the generation of Postscript. The following options are supported: .RS +.\" OPTION: -channel .TP \fB\-channel \fIchannelName\fR . @@ -838,6 +827,7 @@ Specifies the name of the channel to which to write the Postscript. If this option and the \fB\-file\fR option are not specified then the Postscript is returned as the result of the command. +.\" OPTION: -colormap .TP \fB\-colormap \fIvarName\fR . @@ -851,9 +841,13 @@ to see if there is an element of \fIvarName\fR with the same name as the color. If so, Tk uses the value of the element as the Postscript command to set the color. +.RS +.PP If this option has not been specified, or if there is no entry in \fIvarName\fR for a given color, then Tk uses the red, green, and blue intensities from the X color. +.RE +.\" OPTION: -colormode .TP \fB\-colormode \fImode\fR . @@ -861,6 +855,7 @@ Specifies how to output color information. \fIMode\fR must be either \fBcolor\fR (for full color output), \fBgray\fR (convert all colors to their gray-scale equivalents) or \fBmono\fR (convert all colors to black or white). +.\" OPTION: -file .TP \fB\-file \fIfileName\fR . @@ -868,6 +863,7 @@ Specifies the name of the file in which to write the Postscript. If this option and the \fB\-channel\fR option are not specified then the Postscript is returned as the result of the command. +.\" OPTION: -fontmap .TP \fB\-fontmap \fIvarName\fR . @@ -884,23 +880,32 @@ Otherwise Tk attempts to guess what Postscript font to use. Tk's guesses generally only work for well-known fonts such as Times and Helvetica and Courier, and only if the X font name does not omit any dashes up through the point size. +.RS +.PP For example, \fB\-*\-Courier\-Bold\-R\-Normal\-\-*\-120\-*\fR will work but \fB*Courier\-Bold\-R\-Normal*120*\fR will not; Tk needs the dashes to parse the font name). +.RE +.\" OPTION: -height .TP \fB\-height \fIsize\fR . Specifies the height of the area of the canvas to print. Defaults to the height of the canvas window. +.\" OPTION: -pageanchor .TP \fB\-pageanchor \fIanchor\fR . Specifies which point of the printed area of the canvas should appear over the positioning point on the page (which is given by the \fB\-pagex\fR and \fB\-pagey\fR options). +.RS +.PP For example, \fB\-pageanchor n\fR means that the top center of the area of the canvas being printed (as it appears in the canvas window) should be over the positioning point. Defaults to \fBcenter\fR. +.RE +.\" OPTION: -pageheight .TP \fB\-pageheight \fIsize\fR . @@ -913,6 +918,7 @@ Defaults to the height of the printed area on the screen. If both \fB\-pageheight\fR and \fB\-pagewidth\fR are specified then the scale factor from \fB\-pagewidth\fR is used (non-uniform scaling is not implemented). +.\" OPTION: -pagewidth .TP \fB\-pagewidth \fIsize\fR . @@ -923,6 +929,7 @@ Defaults to the width of the printed area on the screen. If both \fB\-pageheight\fR and \fB\-pagewidth\fR are specified then the scale factor from \fB\-pagewidth\fR is used (non-uniform scaling is not implemented). +.\" OPTION: -pagex .TP \fB\-pagex \fIposition\fR . @@ -931,6 +938,7 @@ the Postscript page, using any of the forms allowed for \fB\-pageheight\fR. Used in conjunction with the \fB\-pagey\fR and \fB\-pageanchor\fR options to determine where the printed area appears on the Postscript page. Defaults to the center of the page. +.\" OPTION: -pagey .TP \fB\-pagey \fIposition\fR . @@ -939,6 +947,7 @@ the Postscript page, using any of the forms allowed for \fB\-pageheight\fR. Used in conjunction with the \fB\-pagex\fR and \fB\-pageanchor\fR options to determine where the printed area appears on the Postscript page. Defaults to the center of the page. +.\" OPTION: -rotate .TP \fB\-rotate \fIboolean\fR . @@ -950,11 +959,13 @@ the short dimension of the page in rotated output the x-axis runs along the long dimension of the page .PQ landscape " orientation" . Defaults to non-rotated. +.\" OPTION: -width .TP \fB\-width \fIsize\fR . Specifies the width of the area of the canvas to print. Defaults to the width of the canvas window. +.\" OPTION: -x .TP \fB\-x \fIposition\fR . @@ -962,6 +973,7 @@ Specifies the x-coordinate of the left edge of the area of the canvas that is to be printed, in canvas coordinates, not window coordinates. Defaults to the coordinate of the left edge of the window. +.\" OPTION: -y .TP \fB\-y \fIposition\fR . @@ -984,7 +996,7 @@ as the destination location for the moved items. This command returns an empty string. .RS .PP -Note: this command has no effect on window items. Window items always +Note this this command has no effect on window items. Window items always obscure other item types, and the stacking order of window items is determined by the \fBraise\fR command and \fBlower\fR command, not the \fBraise\fR widget command and \fBlower\fR widget command for canvases. @@ -1255,6 +1267,7 @@ the coordinates of the item. .PP Many items share a common set of options. These options are explained here, and then referred to be each widget type for brevity. +.\" OPTION: -anchor .TP \fB\-anchor \fIanchorPos\fR . @@ -1265,18 +1278,22 @@ is \fBcenter\fR then the item is centered on the point; if \fIanchorPos\fR is \fBn\fR then the item will be drawn so that its top center point is at the positioning point. This option defaults to \fBcenter\fR. +.\" OPTION: -dash .TP \fB\-dash \fIpattern\fR +.\" OPTION: -activedash .TP \fB\-activedash \fIpattern\fR +.\" OPTION: -disableddash .TP \fB\-disableddash \fIpattern\fR . -This option specifies dash patterns for the normal, active +These options specify dash patterns for the normal, active state, and disabled state of an item. \fIpattern\fR may have any of the forms accepted by \fBTk_GetDash\fR. If the dash options are omitted then the default is a solid outline. See \fBDASH PATTERNS\fR for more information. +.\" OPTION: -dashoffset .TP \fB\-dashoffset \fIoffset\fR . @@ -1284,14 +1301,17 @@ The starting \fIoffset\fR in pixels into the pattern provided by the \fB\-dash\fR option. \fB\-dashoffset\fR is ignored if there is no \fB\-dash\fR pattern. The \fIoffset\fR may have any of the forms described in the \fBCOORDINATES\fR section above. +.\" OPTION: -fill .TP \fB\-fill \fIcolor\fR +.\" OPTION: -activefill .TP \fB\-activefill \fIcolor\fR +.\" OPTION: -disabledfill .TP \fB\-disabledfill \fIcolor\fR . -Specifies the color to be used to fill item's area. +These options specify the color to be used to fill item's area. in its normal, active, and disabled states. The even-odd fill rule is used. \fIColor\fR may have any of the forms accepted by \fBTk_GetColor\fR. @@ -1299,18 +1319,22 @@ For the line item, it specifies the color of the line drawn. For the text item, it specifies the foreground color of the text. If \fIcolor\fR is an empty string (the default for all canvas items except line and text), then the item will not be filled. +.\" OPTION: -outline .TP \fB\-outline \fIcolor\fR +.\" OPTION: -activeoutline .TP \fB\-activeoutline \fIcolor\fR +.\" OPTION: -disabledoutline .TP \fB\-disabledoutline \fIcolor\fR . -This option specifies the color that should be used to draw the +These options specify the color that should be used to draw the outline of the item in its normal, active and disabled states. \fIColor\fR may have any of the forms accepted by \fBTk_GetColor\fR. If \fIcolor\fR is specified as an empty string then no outline is drawn for the item. +.\" OPTION: -offset .TP \fB\-offset \fIoffset\fR . @@ -1325,14 +1349,17 @@ used for stippling as well. For the line and polygon canvas items you can also specify an index as argument, which connects the stipple origin to one of the coordinate points of the line/polygon. Note that stipple offsets are \fIonly supported on X11\fR; they are silently ignored on other platforms. +.\" OPTION: -outlinestipple .TP \fB\-outlinestipple \fIbitmap\fR +.\" OPTION: -activeoutlinestipple .TP \fB\-activeoutlinestipple \fIbitmap\fR +.\" OPTION: -disabledoutlinestipple .TP \fB\-disabledoutlinestipple \fIbitmap\fR . -This option specifies stipple patterns that should be used to draw the +These options specify stipple patterns that should be used to draw the outline of the item in its normal, active and disabled states. Indicates that the outline for the item should be drawn with a stipple pattern; \fIbitmap\fR specifies the stipple pattern to use, in any of the @@ -1343,20 +1370,24 @@ If \fIbitmap\fR is an empty string (the default), then the outline is drawn in a solid fashion. \fINote that stipples are not well supported on platforms that do not use X11 as their drawing API.\fR +.\" OPTION: -outlineoffset .TP \fB\-outlineoffset \fIoffset\fR . Specifies the offset of the stipple pattern used for outlines, in the same way that the \fB\-outline\fR option controls fill stipples. (See the \fB\-outline\fR option for a description of the syntax of \fIoffset\fR.) +.\" OPTION: -stipple .TP \fB\-stipple \fIbitmap\fR +.\" OPTION: -activestipple .TP \fB\-activestipple \fIbitmap\fR +.\" OPTION: -disabledstipple .TP \fB\-disabledstipple \fIbitmap\fR . -This option specifies stipple patterns that should be used to fill +These options specify stipple patterns that should be used to fill the item in its normal, active and disabled states. \fIbitmap\fR specifies the stipple pattern to use, in any of the forms accepted by \fBTk_GetBitmap\fR. @@ -1367,26 +1398,31 @@ in a solid fashion. For the text item, it affects the actual text. \fINote that stipples are not well supported on platforms that do not use X11 as their drawing API.\fR +.\" OPTION: -state .TP \fB\-state \fIstate\fR . This allows an item to override the canvas widget's global \fIstate\fR option. It takes the same values: \fInormal\fR, \fIdisabled\fR or \fIhidden\fR. +.\" OPTION: -tags .TP \fB\-tags \fItagList\fR . Specifies a set of tags to apply to the item. \fITagList\fR consists of a list of tag names, which replace any existing tags for the item. \fITagList\fR may be an empty list. +.\" OPTION: -width .TP \fB\-width \fIoutlineWidth\fR +.\" OPTION: -activewidth .TP \fB\-activewidth \fIoutlineWidth\fR +.\" OPTION: -disabledwidth .TP \fB\-disabledwidth \fIoutlineWidth\fR . -Specifies the width of the outline to be drawn around +These options specify the width of the outline to be drawn around the item's region, in its normal, active and disabled states. \fIoutlineWidth\fR may be in any of the forms described in the \fBCOORDINATES\fR section above. @@ -1399,8 +1435,9 @@ arc's region. .PP Items of type \fBarc\fR appear on the display as arc-shaped regions. An arc is a section of an oval delimited by two angles (specified -by either the \fB\-start\fR and \fB\-extent\fR options or the \fB\-height\fR option) -and displayed in one of several ways (specified by the \fB\-style\fR option). +by either the \fB\-start\fR and \fB\-extent\fR options or the \fB\-height\fR +option) and displayed in one of several ways (specified by the \fB\-style\fR +option). Arcs are created with widget commands of the following form: .CS \fIpathName \fBcreate arc \fIx1 y1 x2 y2 \fR?\fIoption value ...\fR? @@ -1436,22 +1473,28 @@ The following standard options are supported by arcs: \fB\-disabledwidth\fR .DE The following extra options are supported for arcs: +.\" OPTION: -extent .TP \fB\-extent \fIdegrees\fR +. Specifies the size of the angular range occupied by the arc. The arc's range extends for \fIdegrees\fR degrees counter-clockwise from the starting angle given by the \fB\-start\fR option. \fIDegrees\fR may be negative. If it is greater than 360 or less than \-360, then \fIdegrees\fR modulo 360 is used as the extent. +.\" OPTION: -start .TP \fB\-start \fIdegrees\fR +. Specifies the beginning of the angular range occupied by the arc. \fIDegrees\fR is given in units of degrees measured counter-clockwise from the 3-o'clock position; it may be either positive or negative. +.\" OPTION: -height .TP \fB\-height \fIdistance\fR +. Provides a shortcut for creating a circular arc segment by defining the distance of the mid-point of the arc from its chord. When this option is used the coordinates are interpreted as the start and end coordinates @@ -1478,8 +1521,10 @@ choosing the minus sign for the minor arc and the plus sign for the major arc. Note that \fBitemcget \-height\fR always returns 0 so that introspection code can be kept simple. .RE +.\" OPTION: -style .TP \fB\-style \fItype\fR +. Specifies how to draw the arc. If \fItype\fR is \fBpieslice\fR (the default) then the arc's region is defined by a section of the oval's perimeter plus two line segments, one between the center @@ -1517,12 +1562,16 @@ The following standard options are supported by bitmaps: \fB\-tags\fR .DE The following extra options are supported for bitmaps: +.\" OPTION: -background .TP \fB\-background \fIcolor\fR +.\" OPTION: -activebackground .TP \fB\-activebackground \fIcolor\fR +.\" OPTION: -disabledbackground .TP \fB\-disabledbackground \fIcolor\fR +. Specifies the color to use for each of the bitmap's .QW 0 valued pixels in its normal, active and disabled states. @@ -1530,22 +1579,30 @@ valued pixels in its normal, active and disabled states. If this option is not specified, or if it is specified as an empty string, then nothing is displayed where the bitmap pixels are 0; this produces a transparent effect. +.\" OPTION: -bitmap .TP \fB\-bitmap \fIbitmap\fR +.\" OPTION: -activebitmap .TP \fB\-activebitmap \fIbitmap\fR +.\" OPTION: -disabledbitmap .TP \fB\-disabledbitmap \fIbitmap\fR -Specifies the bitmaps to display in the item in its normal, active and -disabled states. +. +These options specify the bitmaps to display in the item in its normal, +active and disabled states. \fIBitmap\fR may have any of the forms accepted by \fBTk_GetBitmap\fR. +.\" OPTION: -foreground .TP \fB\-foreground \fIcolor\fR +.\" OPTION: -activeforeground .TP \fB\-activeforeground \fIcolor\fR +.\" OPTION: -disabledforeground .TP \fB\-disabledforeground \fIcolor\fR -Specifies the color to use for each of the bitmap's +. +These options specify the color to use for each of the bitmap's .QW 1 valued pixels in its normal, active and disabled states. \fIColor\fR may have any of the forms accepted by \fBTk_GetColor\fR. @@ -1575,12 +1632,16 @@ The following standard options are supported by images: \fB\-tags\fR .DE The following extra options are supported for images: +.\" OPTION: -image .TP \fB\-image \fIname\fR +.\" OPTION: -activeimage .TP \fB\-activeimage \fIname\fR +.\" OPTION: -disabledimage .TP \fB\-disabledimage \fIname\fR +. Specifies the name of the images to display in the item in is normal, active and disabled states. This image must have been created previously with the @@ -1620,8 +1681,10 @@ The following standard options are supported by lines: \fB\-disabledwidth\fR .DE The following extra options are supported for lines: +.\" OPTION: -arrow .TP \fB\-arrow \fIwhere\fR +. Indicates whether or not arrowheads are to be drawn at one or both ends of the line. \fIWhere\fR must have one of the values \fBnone\fR (for no arrowheads), @@ -1635,8 +1698,10 @@ rather than at its tip so that the line doesn't extend past the edge of the arrowhead. This may trigger a \fBLeave\fR event if the mouse is hovering this line end. Conversely, when removing an arrowhead Tk adjusts the corresponding line point the other way round, which may trigger an \fBEnter\fR event. +.\" OPTION: -arrowshape .TP \fB\-arrowshape \fIshape\fR +. This option indicates how to draw arrowheads. The \fIshape\fR argument must be a list with three elements, each specifying a distance in any of the forms described in @@ -1650,16 +1715,20 @@ trailing points. If this option is not specified then Tk picks a .QW reasonable shape. +.\" OPTION: -capstyle .TP \fB\-capstyle \fIstyle\fR +. Specifies the ways in which caps are to be drawn at the endpoints of the line. \fIStyle\fR may have any of the forms accepted by \fBTk_GetCapStyle\fR (\fBbutt\fR, \fBprojecting\fR, or \fBround\fR). If this option is not specified then it defaults to \fBbutt\fR. Where arrowheads are drawn the cap style is ignored. +.\" OPTION: -joinstyle .TP \fB\-joinstyle \fIstyle\fR +. Specifies the ways in which joints are to be drawn at the vertices of the line. \fIStyle\fR may have any of the forms accepted by \fBTk_GetJoinStyle\fR @@ -1667,12 +1736,15 @@ of the line. If this option is not specified then it defaults to \fBround\fR. If the line only contains two points then this option is irrelevant. +.\" OPTION: -smooth .TP \fB\-smooth \fIsmoothMethod\fR +. \fIsmoothMethod\fR must have one of the forms accepted by \fBTcl_GetBoolean\fR or a line smoothing method. Only \fBtrue\fR and \fBraw\fR are -supported in the core (with \fBbezier\fR being an alias for \fBtrue\fR), but more can be added at runtime. If a boolean +supported in the core (with \fBbezier\fR being an alias for \fBtrue\fR), +but more can be added at runtime. If a boolean false value or empty string is given, no smoothing is applied. A boolean truth value assumes \fBtrue\fR smoothing. If the smoothing method is \fBtrue\fR, this indicates that the line @@ -1689,8 +1761,10 @@ line segments can be generated within a curve by making control points equal to their neighbouring knot points. If the last point is a control point and not a knot point, the point is repeated (one or two times) so that it also becomes a knot point. +.\" OPTION: -splinesteps .TP \fB\-splinesteps \fInumber\fR +. Specifies the degree of smoothness desired for curves: each spline will be approximated with \fInumber\fR line segments. This option is ignored unless the \fB\-smooth\fR option is true or \fBraw\fR. @@ -1747,8 +1821,8 @@ Polygons are created with widget commands of the following form: \fIpathName \fBcreate polygon \fIx1 y1 ... xn yn \fR?\fIoption value ...\fR? \fIpathName \fBcreate polygon \fIcoordList\fR ?\fIoption value ...\fR? .CE -The arguments \fIx1\fR through \fIyn\fR or \fIcoordList\fR specify the coordinates for -three or more points that define a polygon. +The arguments \fIx1\fR through \fIyn\fR or \fIcoordList\fR specify the +coordinates for three or more points that define a polygon. The first point should not be repeated as the last to close the shape; Tk will automatically close the periphery between the first and last points. @@ -1777,18 +1851,23 @@ The following standard options are supported by polygons: \fB\-disabledwidth\fR .DE The following extra options are supported for polygons: +.\" OPTION: -joinstyle .TP \fB\-joinstyle \fIstyle\fR +. Specifies the ways in which joints are to be drawn at the vertices of the outline. \fIStyle\fR may have any of the forms accepted by \fBTk_GetJoinStyle\fR (\fBbevel\fR, \fBmiter\fR, or \fBround\fR). If this option is not specified then it defaults to \fBround\fR. +.\" OPTION: -smooth .TP \fB\-smooth \fIboolean\fR +. \fIBoolean\fR must have one of the forms accepted by \fBTcl_GetBoolean\fR or a line smoothing method. Only \fBtrue\fR and \fBraw\fR are -supported in the core (with \fBbezier\fR being an alias for \fBtrue\fR), but more can be added at runtime. If a boolean +supported in the core (with \fBbezier\fR being an alias for \fBtrue\fR), +but more can be added at runtime. If a boolean false value or empty string is given, no smoothing is applied. A boolean truth value assumes \fBtrue\fR smoothing. If the smoothing method is \fBtrue\fR, this indicates that the polygon @@ -1806,8 +1885,10 @@ equal to their neighbouring knot points. If the last point is not the second point of a pair of control points, the point is repeated (one or two times) so that it also becomes the second point of a pair of control points (the associated knot point will be the first control point). +.\" OPTION: -splinesteps .TP \fB\-splinesteps \fInumber\fR +. Specifies the degree of smoothness desired for curves: each spline will be approximated with \fInumber\fR line segments. This option is ignored unless the \fB\-smooth\fR option is true or \fBraw\fR. @@ -1898,6 +1979,7 @@ The following standard options are supported by text items: \fB\-tags\fR .DE The following extra options are supported for text items: +.\" OPTION: -angle .TP \fB\-angle \fIrotationDegrees\fR . @@ -1906,36 +1988,46 @@ about the positioning point for the text; it may have any floating-point value from 0.0 to 360.0. For example, if \fIrotationDegrees\fR is \fB90\fR, then the text will be drawn vertically from bottom to top. This option defaults to \fB0.0\fR. +.\" OPTION: -font .TP \fB\-font \fIfontName\fR +. Specifies the font to use for the text item. \fIFontName\fR may be any string acceptable to \fBTk_GetFont\fR. If this option is not specified, it defaults to a system-dependent font. +.\" OPTION: -justify .TP \fB\-justify \fIhow\fR +. Specifies how to justify the text within its bounding region. \fIHow\fR must be one of the values \fBleft\fR, \fBright\fR, or \fBcenter\fR. This option will only matter if the text is displayed as multiple lines. If the option is omitted, it defaults to \fBleft\fR. +.\" OPTION: -text .TP \fB\-text \fIstring\fR +. \fIString\fR specifies the characters to be displayed in the text item. Newline characters cause line breaks. The characters in the item may also be changed with the \fBinsert\fR and \fBdelete\fR widget commands. This option defaults to an empty string. +.\" OPTION: -underline .TP -\fB\-underline \fI\fR +\fB\-underline \fInumber\fR +. Specifies the integer index of a character within the text to be underlined. 0 corresponds to the first character of the text displayed, 1 to the next character, and so on. \-1 means that no underline should be drawn (if the whole text item is to be underlined, the appropriate font should be used instead). +.\" OPTION: -width .TP \fB\-width \fIlineLength\fR +. Specifies a maximum line length for the text, in any of the forms described in the \fBCOORDINATES\fR section above. If this option is zero (the default) the text is broken into @@ -1974,6 +2066,7 @@ The following standard options are supported by window items: \fB\-tags\fR .DE The following extra options are supported for window items: +.\" OPTION: -height .TP \fB\-height \fIpixels\fR . @@ -1982,6 +2075,7 @@ Specifies the height to assign to the item's window. forms described in the \fBCOORDINATES\fR section above. If this option is not specified, or if it is specified as zero, then the window is given whatever height it requests internally. +.\" OPTION: -width .TP \fB\-width \fIpixels\fR . @@ -1990,6 +2084,7 @@ Specifies the width to assign to the item's window. forms described in the \fBCOORDINATES\fR section above. If this option is not specified, or if it is specified as zero, then the window is given whatever width it requests internally. +.\" OPTION: -window .TP \fB\-window \fIpathName\fR . @@ -1998,7 +2093,7 @@ The window specified by \fIpathName\fR must either be a child of the canvas widget or a child of some ancestor of the canvas widget. \fIPathName\fR may not refer to a top-level window. .PP -Note: due to restrictions in the ways that windows are managed, it is not +Note that, due to restrictions in the ways that windows are managed, it is not possible to draw other graphical items (such as lines and images) on top of window items. A window item always obscures any graphics that overlap it, regardless of their order in the display list. Also note that diff --git a/doc/checkbutton.n b/doc/checkbutton.n index 0f27d49..ccfe691 100644 --- a/doc/checkbutton.n +++ b/doc/checkbutton.n @@ -291,11 +291,11 @@ individual widgets or by redefining the class bindings. This example shows a group of uncoupled checkbuttons. .PP .CS -labelframe .lbl \-text "Steps:" -\fBcheckbutton\fR .c1 \-text Lights \-variable lights -\fBcheckbutton\fR .c2 \-text Cameras \-variable cameras -\fBcheckbutton\fR .c3 \-text Action! \-variable action -pack .c1 .c2 .c3 \-in .lbl +labelframe .lbl -text "Steps:" +\fBcheckbutton\fR .c1 -text Lights -variable lights +\fBcheckbutton\fR .c2 -text Cameras -variable cameras +\fBcheckbutton\fR .c3 -text Action! -variable action +pack .c1 .c2 .c3 -in .lbl pack .lbl .CE .SH "SEE ALSO" diff --git a/doc/chooseColor.n b/doc/chooseColor.n index be24c8e..b485b77 100644 --- a/doc/chooseColor.n +++ b/doc/chooseColor.n @@ -18,17 +18,23 @@ tk_chooseColor \- pops up a dialog box for the user to select a color. The procedure \fBtk_chooseColor\fR pops up a dialog box for the user to select a color. The following \fIoption\-value\fR pairs are possible as command line arguments: +.\" OPTION: -initialcolor .TP \fB\-initialcolor\fI color\fR +. Specifies the color to display in the color dialog when it pops up. \fIcolor\fR must be in a form acceptable to the \fBTk_GetColor\fR function. +.\" OPTION: -parent .TP \fB\-parent\fI window\fR +. Makes \fIwindow\fR the logical parent of the color dialog. The color dialog is displayed on top of its parent window. +.\" OPTION: -title .TP \fB\-title\fI titleString\fR +. Specifies a string to display as the title of the dialog box. If this option is not specified, then a default title will be displayed. .LP @@ -39,7 +45,7 @@ string. .SH EXAMPLE .PP .CS -button .b \-bg [tk_chooseColor \-initialcolor gray \-title "Choose color"] +button .b -bg [tk_chooseColor -initialcolor gray -title "Choose color"] .CE .SH KEYWORDS color, color selection, dialog diff --git a/doc/chooseDirectory.n b/doc/chooseDirectory.n index 7de09b5..44e9530 100644 --- a/doc/chooseDirectory.n +++ b/doc/chooseDirectory.n @@ -16,15 +16,19 @@ tk_chooseDirectory \- pops up a dialog box for the user to select a directory. The procedure \fBtk_chooseDirectory\fR pops up a dialog box for the user to select a directory. The following \fIoption\-value\fR pairs are possible as command line arguments: +.\" OPTION: -command .TP \fB\-command\fI string\fR +. Specifies the prefix of a Tcl command to invoke when the user closes the dialog after having selected an item. This callback is not called if the user cancelled the dialog. The actual command consists of \fIstring\fR followed by a space and the value selected by the user in the dialog. This is only available on Mac OS X. +.\" OPTION: -initialdir .TP \fB\-initialdir\fI dirname\fR +. Specifies that the directories in \fIdirectory\fR should be displayed when the dialog pops up. If this parameter is not specified, the initial directory defaults to the current working directory @@ -33,33 +37,41 @@ On Vista and later systems, the initial directory defaults to the last user-selected directory for the application. If the parameter specifies a relative path, the return value will convert the relative path to an absolute path. +.\" OPTION: -message .TP \fB\-message\fI string\fR +. Specifies a message to include in the client area of the dialog. This is only available on Mac OS X. +.\" OPTION: -mustexist .TP \fB\-mustexist\fI boolean\fR +. Specifies whether the user may specify non-existent directories. If this parameter is true, then the user may only select directories that already exist. The default value is \fIfalse\fR. +.\" OPTION: -parent .TP \fB\-parent\fI window\fR +. Makes \fIwindow\fR the logical parent of the dialog. The dialog is displayed on top of its parent window. On Mac OS X, this turns the file dialog into a sheet attached to the parent window. +.\" OPTION: -title .TP \fB\-title\fI titleString\fR +. Specifies a string to display as the title of the dialog box. If this option is not specified, then a default title will be displayed. .SH EXAMPLE .PP .CS set dir [\fBtk_chooseDirectory\fR \e - \-initialdir ~ \-title "Choose a directory"] + -initialdir ~ -title "Choose a directory"] if {$dir eq ""} { - label .l \-text "No directory selected" + label .l -text "No directory selected" } else { - label .l \-text "Selected $dir" + label .l -text "Selected $dir" } .CE .SH "SEE ALSO" diff --git a/doc/clipboard.n b/doc/clipboard.n index 0be7936..587ab34 100644 --- a/doc/clipboard.n +++ b/doc/clipboard.n @@ -125,7 +125,7 @@ proc getItemConfig {canvas tag} { append script {$canvas create } [$canvas type $item] append script { } [$canvas coords $item] { } foreach config [$canvas itemconf $item] { - lassign $config name \- \- \- value + lassign $config name - - - value append script [list $name $value] { } } append script \en @@ -136,10 +136,10 @@ proc getItemConfig {canvas tag} { # Set up a binding on a canvas to cut and paste an item set c [canvas .c] pack $c -$c create text 150 30 \-text "cut and paste me" +$c create text 150 30 -text "cut and paste me" bind $c <> { \fBclipboard clear\fR - \fBclipboard append \-type\fR TkCanvasItem \e + \fBclipboard append -type\fR TkCanvasItem \e [getItemConfig %W current] # Delete because this is cut, not copy. %W delete current @@ -147,7 +147,7 @@ bind $c <> { bind $c <> { catch { set canvas %W - eval [\fBclipboard get \-type\fR TkCanvasItem] + eval [\fBclipboard get -type\fR TkCanvasItem] } } .CE diff --git a/doc/colors.n b/doc/colors.n index 9c64b1d..09c2289 100644 --- a/doc/colors.n +++ b/doc/colors.n @@ -896,7 +896,7 @@ systemTextColor . The numbered systemWindowBackgroundColors below are used in the \fBttk::notebook\fR and \fBttk::labelframe\fR widgets -to provide a contrasting background. Each numbered color constrasts +to provide a contrasting background. Each numbered color contrasts with its predecessor. .RS .DS @@ -911,7 +911,6 @@ systemWindowBackgroundColor7 .DE .RE .TP - \fBWindows\fR . On Windows, the following additional system colors are available diff --git a/doc/console.n b/doc/console.n index d3b5f9d..9ca7475 100644 --- a/doc/console.n +++ b/doc/console.n @@ -30,7 +30,8 @@ and stdin is \fB/dev/null\fR (as is the case e.g. when a bundled application embedding Tk is started by the macOS Launcher). To enable the command in that case, define the environment variable \fBTK_CONSOLE\fR. This can be done by modifying the Info.plist file by adding the LSEnvironment key -to the main dict and setting its value to be a dict with the key \fBTK_CONSOLE\fR. +to the main dict and setting its value to be a dict with the key +\fBTK_CONSOLE\fR. .PP .\" METHOD: eval .TP diff --git a/doc/cursors.n b/doc/cursors.n index bf8a05e..7a757f5 100644 --- a/doc/cursors.n +++ b/doc/cursors.n @@ -101,6 +101,7 @@ The \fBnone\fR cursor can be specified to eliminate the cursor. .SH "PORTABILITY ISSUES" .TP \fBWindows\fR +. On Windows systems, the following cursors are mapped to native cursors: .RS .CS @@ -131,6 +132,7 @@ wait .RE .TP \fBMac OS X\fR +. On Mac OS X systems, the following cursors are mapped to native cursors: .RS .CS diff --git a/doc/dialog.n b/doc/dialog.n index e4938d2..f1f63ef 100644 --- a/doc/dialog.n +++ b/doc/dialog.n @@ -19,31 +19,25 @@ tk_dialog \- Create modal dialog and wait for response This procedure is part of the Tk script library. It is largely \fIdeprecated\fR by the \fBtk_messageBox\fR. Its arguments describe a dialog box: -.TP -\fIwindow\fR +.IP \fIwindow\fR Name of top-level window to use for dialog. Any existing window by this name is destroyed. -.TP -\fItitle\fR +.IP \fItitle\fR Text to appear in the window manager's title bar for the dialog. -.TP -\fItext\fR +.IP \fItext\fR Message to appear in the top portion of the dialog box. -.TP -\fIbitmap\fR +.IP \fIbitmap\fR If non-empty, specifies a bitmap (in a form suitable for Tk_GetBitmap) to display in the top portion of the dialog, to the left of the text. If this is an empty string then no bitmap is displayed in the dialog. -.TP -\fIdefault\fR +.IP \fIdefault\fR If this is an integer greater than or equal to zero, then it gives the index of the button that is to be the default button for the dialog (0 for the leftmost button, and so on). If less than zero or an empty string then there will not be any default button. -.TP -\fIstring\fR +.IP \fIstring\fR There will be one button for each of these arguments. Each \fIstring\fR specifies text to display in a button, in order from left to right. diff --git a/doc/entry.n b/doc/entry.n index f60bc20..747e99c 100644 --- a/doc/entry.n +++ b/doc/entry.n @@ -176,9 +176,9 @@ entry widget from within either the \fB\-validatecommand\fR or the \fB\-invalidcommand\fR. Such editions will override the one that was being validated. If you wish to edit the entry widget (for example set it to {}) during validation and still have the \fB\-validate\fR option set, you should -include the command +include the command: .CS -after idle {%W config \-validate %v} +after idle {%W config -validate %v} .CE in the \fB\-validatecommand\fR or \fB\-invalidcommand\fR (whichever one you were editing the entry widget from). It is also recommended to not set an @@ -201,32 +201,39 @@ arguments. An index specifies a particular character in the entry's string, in any of the following ways: .TP 12 \fInumber\fR +. Specifies the character as a numerical index, where 0 corresponds to the first character in the string. .TP 12 \fBanchor\fR +. Indicates the anchor point for the selection, which is set with the \fBselect from\fR and \fBselect adjust\fR widget commands. .TP 12 \fBend\fR +. Indicates the character just after the last one in the entry's string. This is equivalent to specifying a numerical index equal to the length of the entry's string. .TP 12 \fBinsert\fR +. Indicates the character adjacent to and immediately following the insertion cursor. .TP 12 \fBsel.first\fR +. Indicates the first character in the selection. It is an error to use this form if the selection is not in the entry window. .TP 12 \fBsel.last\fR +. Indicates the character just after the last one in the selection. It is an error to use this form if the selection is not in the entry window. .TP 12 \fB@\fInumber\fR +. In this form, \fInumber\fR is treated as an x-coordinate in the entry's window; the character spanning that x-coordinate is used. For example, @@ -323,12 +330,14 @@ two forms, depending on \fIoption\fR: .RS .TP \fIpathName \fBscan mark \fIx\fR +. Records \fIx\fR and the current view in the entry window; used in conjunction with later \fBscan dragto\fR commands. Typically this command is associated with a mouse button press in the widget. It returns an empty string. .TP \fIpathName \fBscan dragto \fIx\fR +. This command computes the difference between its \fIx\fR argument and the \fIx\fR argument to the last \fBscan mark\fR command for the widget. It then adjusts the view left or right by 10 times the @@ -340,11 +349,13 @@ value is an empty string. .\" METHOD: selection .TP \fIpathName \fBselection \fIoption arg\fR +. This command is used to adjust the selection within an entry. It has several forms, depending on \fIoption\fR: .RS .TP \fIpathName \fBselection adjust \fIindex\fR +. Locate the end of the selection nearest to the character given by \fIindex\fR, and adjust that end of the selection to be at \fIindex\fR (i.e. including but not going beyond \fIindex\fR). The other @@ -356,20 +367,24 @@ selection anchor point, inclusive. Returns an empty string. .TP \fIpathName \fBselection clear\fR +. Clear the selection if it is currently in this widget. If the selection is not in this widget then the command has no effect. Returns an empty string. .TP \fIpathName \fBselection from \fIindex\fR +. Set the selection anchor point to just before the character given by \fIindex\fR. Does not change the selection. Returns an empty string. .TP \fIpathName \fBselection present\fR +. Returns 1 if there is are characters selected in the entry, 0 if nothing is selected. .TP \fIpathName \fBselection range \fIstart end\fR +. Sets the selection to include the characters starting with the one indexed by \fIstart\fR and ending with the one just before \fIend\fR. @@ -377,6 +392,7 @@ If \fIend\fR refers to the same character as \fIstart\fR or an earlier one, then the entry's selection is cleared. .TP \fIpathName \fBselection to \fIindex\fR +. If \fIindex\fR is before the anchor point, set the selection to the characters from \fIindex\fR up to but not including the anchor point. diff --git a/doc/event.n b/doc/event.n index a77861c..760efcc 100644 --- a/doc/event.n +++ b/doc/event.n @@ -93,6 +93,7 @@ The following options are supported for the \fBevent generate\fR command. These correspond to the .QW % expansions allowed in binding scripts for the \fBbind\fR command. +.\" OPTION: -above .TP \fB\-above\fI window\fR . @@ -100,6 +101,7 @@ expansions allowed in binding scripts for the \fBbind\fR command. either as a window path name or as an integer window id. Valid for \fBConfigure\fR events. Corresponds to the \fB%a\fR substitution for binding scripts. +.\" OPTION: -borderwidth .TP \fB\-borderwidth\fI size\fR . @@ -107,6 +109,7 @@ Corresponds to the \fB%a\fR substitution for binding scripts. \fIborder_width\fR field for the event. Valid for \fBConfigure\fR events. Corresponds to the \fB%B\fR substitution for binding scripts. +.\" OPTION: -button .TP \fB\-button\fI number\fR . @@ -114,18 +117,21 @@ Corresponds to the \fB%B\fR substitution for binding scripts. for a \fBButton\fR or \fBButtonRelease\fR event, overriding any button number provided in the base \fIevent\fR argument. Corresponds to the \fB%b\fR substitution for binding scripts. +.\" OPTION: -count .TP \fB\-count\fI number\fR . \fINumber\fR must be an integer; it specifies the \fIcount\fR field for the event. Valid for \fBExpose\fR events. Corresponds to the \fB%c\fR substitution for binding scripts. +.\" OPTION: -data .TP \fB\-data\fI string\fR . \fIString\fR may be any value; it specifies the \fIuser_data\fR field for the event. Only valid for virtual events. Corresponds to the \fB%d\fR substitution for virtual events in binding scripts. +.\" OPTION: -delta .TP \fB\-delta\fI number\fR . @@ -138,6 +144,7 @@ scroll the text widget up 4 lines and \-240 would scroll the text widget down 8 lines. Of course, other widgets may define different behaviors for mouse wheel motion. This field corresponds to the \fB%D\fR substitution for binding scripts. +.\" OPTION: -detail .TP \fB\-detail\fI detail\fR . @@ -155,6 +162,7 @@ Valid for \fBEnter\fR, \fBLeave\fR, \fBFocusIn\fR and \fBFocusOut\fR events. Corresponds to the \fB%d\fR substitution for binding scripts. .RE +.\" OPTION: -focus .TP \fB\-focus\fI boolean\fR . @@ -162,12 +170,14 @@ Corresponds to the \fB%d\fR substitution for binding scripts. field for the event. Valid for \fBEnter\fR and \fBLeave\fR events. Corresponds to the \fB%f\fR substitution for binding scripts. +.\" OPTION: -height .TP \fB\-height\fI size\fR . \fISize\fR must be a screen distance; it specifies the \fIheight\fR field for the event. Valid for \fBConfigure\fR events. Corresponds to the \fB%h\fR substitution for binding scripts. +.\" OPTION: -keycode .TP \fB\-keycode\fI number\fR . @@ -175,6 +185,7 @@ Corresponds to the \fB%h\fR substitution for binding scripts. field for the event. Valid for \fBKey\fR and \fBKeyRelease\fR events. Corresponds to the \fB%k\fR substitution for binding scripts. +.\" OPTION: -keysym .TP \fB\-keysym\fI name\fR . @@ -184,6 +195,7 @@ keycode value is used as the \fIkeycode\fR field for event, overriding any detail specified in the base \fIevent\fR argument. Valid for \fBKey\fR and \fBKeyRelease\fR events. Corresponds to the \fB%K\fR substitution for binding scripts. +.\" OPTION: -mode .TP \fB\-mode\fI notify\fR . @@ -193,6 +205,7 @@ one of \fBNotifyNormal\fR, \fBNotifyGrab\fR, \fBNotifyUngrab\fR, or Valid for \fBEnter\fR, \fBLeave\fR, \fBFocusIn\fR, and \fBFocusOut\fR events. Corresponds to the \fB%m\fR substitution for binding scripts. +.\" OPTION: -override .TP \fB\-override\fI boolean\fR . @@ -200,6 +213,7 @@ Corresponds to the \fB%m\fR substitution for binding scripts. \fIoverride_redirect\fR field for the event. Valid for \fBMap\fR, \fBReparent\fR, and \fBConfigure\fR events. Corresponds to the \fB%o\fR substitution for binding scripts. +.\" OPTION: -place .TP \fB\-place\fI where\fR . @@ -207,6 +221,7 @@ Corresponds to the \fB%o\fR substitution for binding scripts. either \fBPlaceOnTop\fR or \fBPlaceOnBottom\fR. Valid for \fBCirculate\fR events. Corresponds to the \fB%p\fR substitution for binding scripts. +.\" OPTION: -root .TP \fB\-root\fI window\fR . @@ -216,6 +231,7 @@ Valid for \fBKey\fR, \fBKeyRelease\fR, \fBButton\fR, \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, and \fBMotion\fR events. Corresponds to the \fB%R\fR substitution for binding scripts. +.\" OPTION: -rootx .TP \fB\-rootx\fI coord\fR . @@ -224,6 +240,7 @@ field for the event. Valid for \fBKey\fR, \fBKeyRelease\fR, \fBButton\fR, \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, and \fBMotion\fR events. Corresponds to the \fB%X\fR substitution for binding scripts. +.\" OPTION: -rooty .TP \fB\-rooty\fI coord\fR . @@ -233,18 +250,21 @@ Valid for \fBKey\fR, \fBKeyRelease\fR, \fBButton\fR, \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, and \fBMotion\fR events. Corresponds to the \fB%Y\fR substitution for binding scripts. +.\" OPTION: -sendevent .TP \fB\-sendevent\fI boolean\fR . \fIBoolean\fR must be a boolean value; it specifies the \fIsend_event\fR field for the event. Valid for all events. Corresponds to the \fB%E\fR substitution for binding scripts. +.\" OPTION: -serial .TP \fB\-serial\fI number\fR . \fINumber\fR must be an integer; it specifies the \fIserial\fR field for the event. Valid for all events. Corresponds to the \fB%#\fR substitution for binding scripts. +.\" OPTION: -state .TP \fB\-state\fI state\fR . @@ -257,6 +277,7 @@ For \fBVisibility\fR events it must be one of \fBVisibilityUnobscured\fR, This option overrides any modifiers such as \fBMeta\fR or \fBControl\fR specified in the base \fIevent\fR. Corresponds to the \fB%s\fR substitution for binding scripts. +.\" OPTION: -subwindow .TP \fB\-subwindow\fI window\fR . @@ -265,16 +286,18 @@ as a path name for a Tk widget or as an integer window identifier. Valid for \fBKey\fR, \fBKeyRelease\fR, \fBButton\fR, \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, and \fBMotion\fR events. Similar to \fB%S\fR substitution for binding scripts. +.\" OPTION: -time .TP \fB\-time\fI integer\fR . \fIInteger\fR must be an integer value; it specifies the \fItime\fR field -for the event. Additonally the special value \fBcurrent\fR is allowed, +for the event. Additionally, the special value \fBcurrent\fR is allowed; this value will be substituted by the current event time. Valid for \fBKey\fR, \fBKeyRelease\fR, \fBButton\fR, \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, \fBMotion\fR, and \fBProperty\fR events. Corresponds to the \fB%t\fR substitution for binding scripts. +.\" OPTION: -warp .TP \fB\-warp\fI boolean\fR . @@ -283,6 +306,7 @@ the screen pointer should be warped as well. Valid for \fBKey\fR, \fBKeyRelease\fR, \fBButton\fR, \fBButtonRelease\fR, and \fBMotion\fR events. The pointer will only warp to a window if it is mapped. +.\" OPTION: -width .TP \fB\-width\fI size\fR . @@ -290,6 +314,7 @@ only warp to a window if it is mapped. for the event. Valid for \fBConfigure\fR events. Corresponds to the \fB%w\fR substitution for binding scripts. +.\" OPTION: -when .TP \fB\-when\fI when\fR . @@ -311,6 +336,7 @@ other events already queued with \fB\-when mark\fR. This option is useful when generating a series of events that should be processed in order but at the front of the queue. .RE +.\" OPTION: -x .TP \fB\-x\fI coord\fR . @@ -324,6 +350,7 @@ Corresponds to the \fB%x\fR substitution for binding scripts. If \fIWindow\fR is empty the coordinate is relative to the screen, and this option corresponds to the \fB%X\fR substitution for binding scripts. +.\" OPTION: -y .TP \fB\-y\fI coord\fR . diff --git a/doc/focus.n b/doc/focus.n index 2aebd53..8b50765 100644 --- a/doc/focus.n +++ b/doc/focus.n @@ -114,12 +114,13 @@ you use C code to query the X server directly. To make a window that only participates in the focus traversal ring when a variable is set, add the following bindings to the widgets \fIbefore\fR and \fIafter\fR it in that focus ring: +.PP .CS -button .before \-text "Before" -button .middle \-text "Middle" -button .after \-text "After" -checkbutton .flag \-variable traverseToMiddle \-takefocus 0 -pack .flag \-side left +button .before -text "Before" +button .middle -text "Middle" +button .after -text "After" +checkbutton .flag -variable traverseToMiddle -takefocus 0 +pack .flag -side left pack .before .middle .after bind .before { if {!$traverseToMiddle} { @@ -127,7 +128,7 @@ bind .before { break } } -bind .after { +bind .after { if {!$traverseToMiddle} { \fBfocus\fR .before break diff --git a/doc/focusNext.n b/doc/focusNext.n index 3283d4b..4740346 100644 --- a/doc/focusNext.n +++ b/doc/focusNext.n @@ -12,11 +12,11 @@ .SH NAME tk_focusNext, tk_focusPrev, tk_focusFollowsMouse \- Utility procedures for managing the input focus. .SH SYNOPSIS +.nf \fBtk_focusNext \fIwindow\fR -.sp \fBtk_focusPrev \fIwindow\fR -.sp \fBtk_focusFollowsMouse\fR +.fi .BE .SH DESCRIPTION .PP @@ -49,7 +49,8 @@ Tk will automatically give it the input focus. The \fBfocus\fR command may be used to move the focus to a window other than the one under the mouse, but as soon as the mouse moves into a new window the focus will jump to that window. -Note: at present there is no built-in support for returning the +.PP +Note that at present there is no built-in support for returning the application to an explicit focus model; to do this you will have to write a script that deletes the bindings created by \fBtk_focusFollowsMouse\fR. diff --git a/doc/font.n b/doc/font.n index ac503a1..c479e48 100644 --- a/doc/font.n +++ b/doc/font.n @@ -209,16 +209,19 @@ horizontal line where the bottom of most letters line up; certain letters, such as lower-case .QW g stick below the baseline. +.\" OPTION: -ascent .TP -\fB\-ascent \0\fR +\fB\-ascent\fR . The amount in pixels that the tallest letter sticks up above the baseline of the font, plus any extra blank space added by the designer of the font. +.\" OPTION: -descent .TP -\fB\-descent \0\fR +\fB\-descent\fR . The largest amount in pixels that any letter sticks down below the baseline of the font, plus any extra blank space added by the designer of the font. +.\" OPTION: -linespace .TP \fB\-linespace\fR . @@ -226,8 +229,9 @@ Returns how far apart vertically in pixels two lines of text using the same font should be placed so that none of the characters in one line overlap any of the characters in the other line. This is generally the sum of the ascent above the baseline line plus the descent below the baseline. +.\" OPTION: -fixed .TP -\fB\-fixed \0\fR +\fB\-fixed\fR . Returns a boolean flag that is .QW \fB1\fR @@ -244,6 +248,7 @@ included when calculating this value. The following options are supported on all platforms, and are used when constructing a named font or when specifying a font using style [5] as above: +.\" OPTION: -family .TP \fB\-family \fIname\fR . @@ -260,6 +265,7 @@ 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. +.\" OPTION: -size .TP \fB\-size \fIsize\fR . @@ -279,6 +285,7 @@ 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 +.\" OPTION: -weight .TP \fB\-weight \fIweight\fR . @@ -286,20 +293,26 @@ The nominal thickness of the characters in the font. The value \fBnormal\fR specifies a normal weight font, while \fBbold\fR specifies a bold font. The closest available weight to the one specified will be chosen. The default weight is \fBnormal\fR. +.\" OPTION: -slant .TP \fB\-slant \fIslant\fR +. The amount the characters in the font are slanted away from the vertical. Valid values for slant are \fBroman\fR and \fBitalic\fR. A roman font is the normal, upright appearance of a font, while an italic font is one that is tilted some number of degrees from upright. The closest available slant to the one specified will be chosen. The default slant is \fBroman\fR. +.\" OPTION: -underline .TP \fB\-underline \fIboolean\fR +. The value is a boolean flag that specifies whether characters in this font should be underlined. The default value for underline is \fBfalse\fR. +.\" OPTION: -overstrike .TP \fB\-overstrike \fIboolean\fR +. The value is a boolean flag that specifies whether a horizontal line should be drawn through the middle of characters in this font. The default value for overstrike is \fBfalse\fR. @@ -307,41 +320,23 @@ for overstrike is \fBfalse\fR. .PP The following named fonts are supported on all systems, and default to values that match appropriate system defaults. -.TP -\fBTkDefaultFont\fR -. +.IP \fBTkDefaultFont\fR This font is the default for all GUI items not otherwise specified. -.TP -\fBTkTextFont\fR -. +.IP \fBTkTextFont\fR This font should be used for user text in entry widgets, listboxes etc. -.TP -\fBTkFixedFont\fR -. +.IP \fBTkFixedFont\fR This font is the standard fixed-width font. -.TP -\fBTkMenuFont\fR -. +.IP \fBTkMenuFont\fR This font is used for menu items. -.TP -\fBTkHeadingFont\fR -. +.IP \fBTkHeadingFont\fR This font should be used for column headings in lists and tables. -.TP -\fBTkCaptionFont\fR -. +.IP \fBTkCaptionFont\fR This font should be used for window and dialog caption bars. -.TP -\fBTkSmallCaptionFont\fR -. +.IP \fBTkSmallCaptionFont\fR This font should be used for captions on contained windows or tool dialogs. -.TP -\fBTkIconFont\fR -. +.IP \fBTkIconFont\fR This font should be used for icon captions. -.TP -\fBTkTooltipFont\fR -. +.IP \fBTkTooltipFont\fR This font should be used for tooltip windows (transient information windows). .LP It is \fInot\fR advised to change these fonts, as they may be modified by Tk @@ -352,9 +347,11 @@ modify that. The following system fonts are supported: .TP \fBX Windows\fR +. All valid X font names, including those listed by xlsfonts(1), are available. .TP \fBMS Windows\fR +. The following fonts are supported, and are mapped to the user's style defaults. .RS @@ -366,6 +363,7 @@ style defaults. .RE .TP \fBMac OS X\fR +. The following fonts are supported, and are mapped to the user's style defaults. .RS @@ -395,17 +393,17 @@ theme fonts: Fill a text widget with lots of font demonstrators, one for every font family installed on your system: .CS -pack [text .t \-wrap none] \-fill both \-expand 1 +pack [text .t -wrap none] -fill both -expand 1 set count 0 set tabwidth 0 -foreach family [lsort \-dictionary [\fBfont families\fR]] { - .t tag configure f[incr count] \-font [list $family 10] - .t insert end ${family}:\\t {} \e +foreach family [lsort -dictionary [\fBfont families\fR]] { + .t tag configure f[incr count] -font [list $family 10] + .t insert end ${family}:\et {} \e "This is a simple sampler\en" f$count - set w [\fBfont measure\fR [.t cget \-font] ${family}:] - if {$w+5 > $tabwidth} { - set tabwidth [expr {$w+5}] - .t configure \-tabs $tabwidth + set w [\fBfont measure\fR [.t cget -font] ${family}:] + if {$w + 5 > $tabwidth} { + set tabwidth [expr {$w + 5}] + .t configure -tabs $tabwidth } } .CE diff --git a/doc/fontchooser.n b/doc/fontchooser.n index 02c2d61..4e667e5 100644 --- a/doc/fontchooser.n +++ b/doc/fontchooser.n @@ -11,11 +11,11 @@ .SH NAME fontchooser \- control font selection dialog .SH SYNOPSIS +.nf \fBtk fontchooser\fR \fBconfigure\fR ?\fI\-option value ...\fR? -.sp \fBtk fontchooser\fR \fBshow\fR -.sp \fBtk fontchooser\fR \fBhide\fR +.fi .BE .SH DESCRIPTION .PP @@ -50,24 +50,32 @@ Hide the font selection dialog if it is visible and cause any pending \fBtk fontchooser\fR \fBshow\fR command to return. .PP .SH "CONFIGURATION OPTIONS" +.\" OPTION: -parent .TP \fB\-parent\fR +. Specifies/returns the logical parent window of the font selection dialog (similar to the \fB\-parent\fR option to other dialogs). The font selection dialog is hidden if it is visible when the parent window is destroyed. +.\" OPTION: -title .TP \fB\-title\fR +. Specifies/returns the title of the dialog. Has no effect on platforms where the font selection dialog does not support titles. +.\" OPTION: -font .TP \fB\-font\fR +. Specifies/returns the font that is currently selected in the dialog if it is visible, or that will be initially selected when the dialog is shown (if supported by the platform). Can be set to the empty string to indicate that no font should be selected. Fonts can be specified in any form given by the "FONT DESCRIPTION" section in the \fBfont\fR manual page. +.\" OPTION: -command .TP \fB\-command\fR +. Specifies/returns the command prefix to be called when a font selection has been made by the user. The command prefix is evaluated at the global level after having the specification of the selected font appended. On platforms @@ -77,8 +85,10 @@ evaluation. Can be set to the empty string to indicate that no callback should be invoked. Fonts are specified by a list of form [3] of the "FONT DESCRIPTION" section in the \fBfont\fR manual page (i.e. a list of the form \fI{family size style ?style ...?}\fR). +.\" OPTION: -visible .TP \fB\-visible\fR +. Read-only option that returns a boolean indicating whether the font selection dialog is currently visible. Attempting to set this option results in an error. @@ -86,6 +96,7 @@ dialog is currently visible. Attempting to set this option results in an error. .SH "VIRTUAL EVENTS" .TP \fB<>\fR +. Sent to the dialog parent whenever the visibility of the font selection dialog changes, both as a result of user action (e.g. disposing of the dialog via OK/Cancel button or close box) and of the \fBtk fontchooser\fR @@ -94,6 +105,7 @@ current visibility of the dialog by querying the \fB\-visible\fR configuration option. .TP \fB<>\fR +. Sent to the dialog parent whenever the font selection dialog is visible and the selected font changes, both as a result of user action and of the \fB\-font\fR configuration option being set. Binding scripts can determine the currently @@ -142,36 +154,36 @@ to ensure its selected font matches the new value of the named font. .CS proc fontchooserDemo {} { wm title . "Font Chooser Demo" - \fBtk fontchooser\fR \fBconfigure\fR \-parent . - button .b \-command fontchooserToggle \-takefocus 0 + \fBtk fontchooser\fR \fBconfigure\fR -parent . + button .b -command fontchooserToggle -takefocus 0 fontchooserVisibility .b - bind . \fB<>\fR \\ + bind . \fB<>\fR \e [list fontchooserVisibility .b] foreach w {.t1 .t2} { - text $w \-width 20 \-height 4 \-borderwidth 1 \-relief solid + text $w -width 20 -height 4 -borderwidth 1 -relief solid bind $w [list fontchooserFocus $w] $w insert end "Text Widget $w" } - .t1 configure \-font {Courier 14} - .t2 configure \-font {Times 16} + .t1 configure -font {Courier 14} + .t2 configure -font {Times 16} pack .b .t1 .t2; focus .t1 } proc fontchooserToggle {} { \fBtk fontchooser\fR [expr { - [\fBtk fontchooser\fR \fBconfigure\fR \-visible] ? + [\fBtk fontchooser\fR \fBconfigure\fR -visible] ? "\fBhide\fR" : "\fBshow\fR"}] } proc fontchooserVisibility {w} { - $w configure \-text [expr { - [\fBtk fontchooser\fR \fBconfigure\fR \-visible] ? + $w configure -text [expr { + [\fBtk fontchooser\fR \fBconfigure\fR -visible] ? "Hide Font Dialog" : "Show Font Dialog"}] } proc fontchooserFocus {w} { - \fBtk fontchooser\fR \fBconfigure\fR \-font [$w cget \-font] \\ - \-command [list fontchooserFontSelection $w] + \fBtk fontchooser\fR \fBconfigure\fR -font [$w cget -font] \e + -command [list fontchooserFontSelection $w] } proc fontchooserFontSelection {w font args} { - $w configure \-font [font actual $font] + $w configure -font [font actual $font] } fontchooserDemo .CE diff --git a/doc/getOpenFile.n b/doc/getOpenFile.n index 747145d..757d91f 100644 --- a/doc/getOpenFile.n +++ b/doc/getOpenFile.n @@ -34,19 +34,24 @@ whether the existing file should be overwritten or not. .PP The following \fIoption\-value\fR pairs are possible as command line arguments to these two commands: +.\" OPTION: -command .TP \fB\-command\fI string\fR +. Specifies the prefix of a Tcl command to invoke when the user closes the dialog after having selected an item. This callback is not called if the user cancelled the dialog. The actual command consists of \fIstring\fR followed by a space and the value selected by the user in the dialog. This is only available on Mac OS X. +.\" OPTION: -confirmoverwrite .TP \fB\-confirmoverwrite\fI boolean\fR +. Configures how the Save dialog reacts when the selected file already exists, and saving would overwrite it. A true value requests a confirmation dialog be presented to the user. A false value requests that the overwrite take place without confirmation. Default value is true. +.\" OPTION: -defaultextension .TP \fB\-defaultextension\fI extension\fR . @@ -57,6 +62,7 @@ any case. This option is ignored on Mac OS X, which does not require extensions to filenames, and the UNIX implementation guesses reasonable values for this from the \fB\-filetypes\fR option when this is not supplied. +.\" OPTION: -filetypes .TP \fB\-filetypes\fI filePatternList\fR . @@ -68,6 +74,7 @@ empty list, or if the \fBFile types\fR listbox is not supported by the particular platform then all files are listed regardless of their types. See the section \fBSPECIFYING FILE PATTERNS\fR below for a discussion on the contents of \fIfilePatternList\fR. +.\" OPTION: -initialdir .TP \fB\-initialdir\fI directory\fR . @@ -79,30 +86,36 @@ On Vista and later systems, the initial directory defaults to the last user-selected directory for the application. If the parameter specifies a relative path, the return value will convert the relative path to an absolute path. +.\" OPTION: -initialfile .TP \fB\-initialfile\fI filename\fR . Specifies a filename to be displayed in the dialog when it pops up. +.\" OPTION: -message .TP \fB\-message\fI string\fR . Specifies a message to include in the client area of the dialog. This is only available on Mac OS X. +.\" OPTION: -multiple .TP \fB\-multiple\fI boolean\fR . Allows the user to choose multiple files from the Open dialog. +.\" OPTION: -parent .TP \fB\-parent\fI window\fR . Makes \fIwindow\fR the logical parent of the file dialog. The file dialog is displayed on top of its parent window. On Mac OS X, this turns the file dialog into a sheet attached to the parent window. +.\" OPTION: -title .TP \fB\-title\fI titleString\fR . Specifies a string to display as the title of the dialog box. If this option is not specified, then a default title is displayed. +.\" OPTION: -typevariable .TP \fB\-typevariable\fI variableName\fR . @@ -192,7 +205,7 @@ set types { {{GIF Files} {} GIFF} {{All Files} * } } -set filename [\fBtk_getOpenFile\fR \-filetypes $types] +set filename [\fBtk_getOpenFile\fR -filetypes $types] if {$filename ne ""} { # Open the file ... diff --git a/doc/grab.n b/doc/grab.n index 72bc8ee..fc4ce02 100644 --- a/doc/grab.n +++ b/doc/grab.n @@ -12,9 +12,10 @@ .SH NAME grab \- Confine pointer and keyboard events to a window sub-tree .SH SYNOPSIS +.nf \fBgrab \fR?\fB\-global\fR? \fIwindow\fR -.sp \fBgrab \fIoption \fR?\fIarg \fR...? +.fi .BE .SH DESCRIPTION .PP @@ -83,6 +84,7 @@ grab on a given display at once. The \fBgrab\fR command can take any of the following forms: .TP \fBgrab \fR?\fB\-global\fR? \fIwindow\fR +. Same as \fBgrab set\fR, described below. .\" METHOD: current .TP @@ -144,9 +146,9 @@ Set a grab so that only one button may be clicked out of a group. The other buttons are unresponsive to the mouse until the middle button is clicked. .CS -pack [button .b1 \-text "Click me! #1" \-command {destroy .b1}] -pack [button .b2 \-text "Click me! #2" \-command {destroy .b2}] -pack [button .b3 \-text "Click me! #3" \-command {destroy .b3}] +pack [button .b1 -text "Click me! #1" -command {destroy .b1}] +pack [button .b2 -text "Click me! #2" -command {destroy .b2}] +pack [button .b3 -text "Click me! #3" -command {destroy .b3}] \fBgrab\fR .b2 .CE .SH "SEE ALSO" diff --git a/doc/grid.n b/doc/grid.n index 3bcfd3f..eaeaf41 100644 --- a/doc/grid.n +++ b/doc/grid.n @@ -85,7 +85,7 @@ If only an option is specified, with no value, the current value of that option is returned. If only the container window and index is specified, all the current settings are returned in a list of -.QW "\-option value" +.QW "\fI\-option value\fR" pairs. .\" METHOD: configure .TP @@ -100,6 +100,7 @@ location of a \fIwindow\fR, as described in the \fBRELATIVE PLACEMENT\fR section, below. The following options are supported: .RS +.\" OPTION: -column .TP \fB\-column \fIn\fR . @@ -112,6 +113,7 @@ if it is the first window. For each \fBx\fR that immediately precedes the \fIwindow\fR, the column position is incremented by one. Thus the \fBx\fR represents a blank column for this row in the grid. +.\" OPTION: -columnspan .TP \fB\-columnspan \fIn\fR . @@ -119,12 +121,14 @@ Insert the window so that it occupies \fIn\fR columns in the grid. The default is one column, unless the window name is followed by a \fB\-\fR, in which case the columnspan is incremented once for each immediately following \fB\-\fR. +.\" OPTION: -in .TP \fB\-in \fIcontainer\fR . Insert the window(s) in the container window given by \fIcontainer\fR. The default is the first window's parent window. +.\" OPTION: -ipadx .TP \fB\-ipadx \fIamount\fR . @@ -133,6 +137,7 @@ leave on each side of the content. This is space is added inside the content border. The \fIamount\fR must be a valid screen distance, such as \fB2\fR or \fB.5c\fR. It defaults to 0. +.\" OPTION: -ipady .TP \fB\-ipady \fIamount\fR . @@ -140,6 +145,7 @@ The \fIamount\fR specifies how much vertical internal padding to leave on the top and bottom of the content. This space is added inside the content border. The \fIamount\fR defaults to 0. +.\" OPTION: -padx .TP \fB\-padx \fIamount\fR . @@ -149,6 +155,7 @@ leave on each side of the content, in screen units. of two values to specify padding for left and right separately. The \fIamount\fR defaults to 0. This space is added outside the content border. +.\" OPTION: -pady .TP \fB\-pady \fIamount\fR . @@ -158,6 +165,7 @@ leave on the top and bottom of the content, in screen units. of two values to specify padding for top and bottom separately. The \fIamount\fR defaults to 0. This space is added outside the content border. +.\" OPTION: -row .TP \fB\-row \fIn\fR . @@ -166,6 +174,7 @@ Row numbers start with 0. If this option is not supplied, then the content is arranged on the same row as the previous content specified on this call to \fBgrid\fR, or the next row after the highest occupied row if this is the first content. +.\" OPTION: -rowspan .TP \fB\-rowspan \fIn\fR . @@ -174,6 +183,7 @@ The default is one row. If the next \fBgrid\fR command contains \fB^\fR characters instead of \fIcontent\fR that line up with the columns of this \fIcontent\fR, then the \fBrowspan\fR of this \fIcontent\fR is extended by one. +.\" OPTION: -sticky .TP \fB\-sticky \fIstyle\fR . @@ -219,8 +229,8 @@ default settings are used. .RS .PP .VS "TIP 518" -If the last content window of the container becomes unmanaged, this will also send -the virtual event \fB<>\fR to the container; the container +If the last content window of the container becomes unmanaged, this will also +send the virtual event \fB<>\fR to the container; the container may choose to resize itself (or otherwise respond) to such a change. .VE "TIP 518" .RE @@ -238,10 +248,10 @@ where \fIcontainer\fR is the windows's container window. .TP \fBgrid location \fIwindow x y\fR . -Given \fIx\fR and \fIy\fR values in screen units relative to the container window, -the column and row number at that \fIx\fR and \fIy\fR location is returned. -For locations that are above or to the left of the grid, \fB\-1\fR is -returned. +Given \fIx\fR and \fIy\fR values in screen units relative to the container +window, the column and row number at that \fIx\fR and \fIy\fR location is +returned. For locations that are above or to the left of the grid, \fB\-1\fR +is returned. .\" METHOD: propagate .TP \fBgrid propagate \fIwindow\fR ?\fIboolean\fR? @@ -255,7 +265,10 @@ In either of these cases an empty string is returned. If \fIboolean\fR is omitted then the command returns \fB0\fR or \fB1\fR to indicate whether propagation is currently enabled for \fIwindow\fR. +.RS +.PP Propagation is enabled by default. +.RE .\" METHOD: rowconfigure .TP \fBgrid rowconfigure \fIwindow index \fR?\fI\-option value...\fR? @@ -267,9 +280,9 @@ and \fB\-pad\fR. If one or more options are provided, then \fIindex\fR may be given as a list of row indices to which the configuration options will operate on. Indices may be integers, window names or the keyword \fIall\fR. For \fIall\fR -the options apply to all rows currently occupied by content windows. For -a window name, that window must be a content window of this container and the options -apply to all rows currently occupied by the container window. +the options apply to all rows currently occupied by content windows. For a +window name, that window must be a content window of this container and the +options apply to all rows currently occupied by the container window. The \fB\-minsize\fR option sets the minimum size, in screen units, that will be permitted for this row. The \fB\-weight\fR option (an integer value) @@ -307,9 +320,9 @@ geometry manager, the previous values are retained. .RS .PP .VS "TIP 518" -If the last content window of the container becomes unmanaged, this will also send -the virtual event \fB<>\fR to the container; the container -may choose to resize itself (or otherwise respond) to such a change. +If the last content window of the container becomes unmanaged, this will also +send the virtual event \fB<>\fR to the container; the +container may choose to resize itself (or otherwise respond) to such a change. .VE "TIP 518" .RE .\" METHOD: size @@ -341,21 +354,15 @@ relative to other \fIcontent\fRs in the same grid command, and the presence of the characters \fB\-\fR, \fBx\fR, and \fB^\fR in \fBgrid\fR command where \fIcontent\fR names are normally expected. .RS -.TP -\fB\-\fR -. +.IP \fB\-\fR This increases the \fB\-columnspan\fR of the \fIcontent\fR to the left. Several -\fB\-\fR's in a row will successively increase the number of columns spanned. A \fB\-\fR -may not follow a \fB^\fR or a \fBx\fR, nor may it be the first \fIcontent\fR -argument to \fBgrid configure\fR. -.TP -\fBx\fR -. +\fB\-\fR's in a row will successively increase the number of columns spanned. +A \fB\-\fR may not follow a \fB^\fR or a \fBx\fR, nor may it be the first +\fIcontent\fR argument to \fBgrid configure\fR. +.IP \fBx\fR This leaves an empty column between the \fIcontent\fR on the left and the \fIcontent\fR on the right. -.TP -\fB^\fR -. +.IP \fB^\fR This extends the \fB\-rowspan\fR of the \fIcontent\fR above the \fB^\fR's in the grid. The number of \fB^\fR's in a row must match the number of columns spanned by the \fIcontent\fR above it. @@ -372,8 +379,8 @@ away from the layout as needed. For the final step, each content is positioned in its row(s) and column(s) based on the setting of its \fIsticky\fR flag. .PP -To compute the minimum size of a layout, the grid geometry manager -first looks at all content whose \fB\-columnspan\fR and \fB\-rowspan\fR values are one, +To compute the minimum size of a layout, the grid geometry manager first looks +at all content whose \fB\-columnspan\fR and \fB\-rowspan\fR values are one, and computes the nominal size of each row or column to be either the \fIminsize\fR for that row or column, or the sum of the \fIpad\fRding plus the size of the largest content, whichever is greater. After that @@ -454,17 +461,17 @@ A toplevel window containing a text widget and two scrollbars: .CS # Make the widgets toplevel .t -text .t.txt \-wrap none \-xscroll {.t.h set} \-yscroll {.t.v set} -scrollbar .t.v \-orient vertical \-command {.t.txt yview} -scrollbar .t.h \-orient horizontal \-command {.t.txt xview} +text .t.txt -wrap none -xscroll {.t.h set} -yscroll {.t.v set} +scrollbar .t.v -orient vertical -command {.t.txt yview} +scrollbar .t.h -orient horizontal -command {.t.txt xview} # Lay them out -\fBgrid\fR .t.txt .t.v \-sticky nsew -\fBgrid\fR .t.h \-sticky nsew +\fBgrid\fR .t.txt .t.v -sticky nsew +\fBgrid\fR .t.h -sticky nsew # Tell the text widget to take all the extra room -\fBgrid rowconfigure\fR .t .t.txt \-weight 1 -\fBgrid columnconfigure\fR .t .t.txt \-weight 1 +\fBgrid rowconfigure\fR .t .t.txt -weight 1 +\fBgrid columnconfigure\fR .t .t.txt -weight 1 .CE .PP Three widgets of equal width, despite their different @@ -472,12 +479,12 @@ Three widgets of equal width, despite their different widths: .PP .CS -button .b \-text "Foo" -entry .e \-textvariable foo ; set foo "Hello World!" -label .l \-text "This is a fairly long piece of text" +button .b -text "Foo" +entry .e -textvariable foo ; set foo "Hello World!" +label .l -text "This is a fairly long piece of text" -\fBgrid\fR .b .e .l \-sticky ew -\fBgrid columnconfigure\fR . "all" \-uniform allTheSame +\fBgrid\fR .b .e .l -sticky ew +\fBgrid columnconfigure\fR . "all" -uniform allTheSame .CE .SH "SEE ALSO" pack(n), place(n) diff --git a/doc/image.n b/doc/image.n index 9946544..0d14e02 100644 --- a/doc/image.n +++ b/doc/image.n @@ -99,21 +99,15 @@ page for the particular image type for details. The following image types are defined by Tk so they will be available in any Tk application. Individual applications or extensions may define additional types. -.TP -\fBbitmap\fR -. +.IP \fBbitmap\fR Each pixel in the image displays a foreground color, a background color, or nothing. See the \fBbitmap\fR manual entry for more information. -.TP -\fBphoto\fR -. +.IP \fBphoto\fR Displays a variety of full-color images, using dithering to approximate colors on displays with limited color capabilities. See the \fBphoto\fR manual entry for more information. -.TP -\fBnsimage\fR -. +.IP \fBnsimage\fR This type is only available in the Aqua platform. It is a full-color image which may be created from a named system image. It has options designed to facilitate the use of these images in buttons. An diff --git a/doc/label.n b/doc/label.n index 5d28e31..e50f8b1 100644 --- a/doc/label.n +++ b/doc/label.n @@ -112,18 +112,18 @@ labels are not intended to be interactive. .PP .CS # Make the widgets -\fBlabel\fR .t \-text "This widget is at the top" \-bg red -\fBlabel\fR .b \-text "This widget is at the bottom" \-bg green -\fBlabel\fR .l \-text "Left\enHand\enSide" -\fBlabel\fR .r \-text "Right\enHand\enSide" +\fBlabel\fR .t -text "This widget is at the top" -bg red +\fBlabel\fR .b -text "This widget is at the bottom" -bg green +\fBlabel\fR .l -text "Left\enHand\enSide" +\fBlabel\fR .r -text "Right\enHand\enSide" text .mid \&.mid insert end "This layout is like Java's BorderLayout" # Lay them out -pack .t \-side top \-fill x -pack .b \-side bottom \-fill x -pack .l \-side left \-fill y -pack .r \-side right \-fill y -pack .mid \-expand 1 \-fill both +pack .t -side top -fill x +pack .b -side bottom -fill x +pack .l -side left -fill y +pack .r -side right -fill y +pack .mid -expand 1 -fill both .CE .SH "SEE ALSO" labelframe(n), button(n), ttk::label(n) diff --git a/doc/labelframe.n b/doc/labelframe.n index da8eab9..4d3aacb 100644 --- a/doc/labelframe.n +++ b/doc/labelframe.n @@ -136,10 +136,10 @@ This shows how to build part of a GUI for a hamburger vendor. The the kinds of things that the choices are being made over. .PP .CS -grid [\fBlabelframe\fR .burger \-text "Burger"] \e - [\fBlabelframe\fR .bun \-text "Bun"] \-sticky news -grid [\fBlabelframe\fR .cheese \-text "Cheese Option"] \e - [\fBlabelframe\fR .pickle \-text "Pickle Option"] \-sticky news +grid [\fBlabelframe\fR .burger -text "Burger"] \e + [\fBlabelframe\fR .bun -text "Bun"] -sticky news +grid [\fBlabelframe\fR .cheese -text "Cheese Option"] \e + [\fBlabelframe\fR .pickle -text "Pickle Option"] -sticky news foreach {type name val} { burger Beef beef burger Lamb lamb @@ -161,9 +161,9 @@ foreach {type name val} { pickle Onions onion pickle Chili chili } { - set w [radiobutton .$type.$val \-text $name \-anchor w \e - \-variable $type \-value $val] - pack $w \-side top \-fill x + set w [radiobutton .$type.$val -text $name -anchor w \e + -variable $type -value $val] + pack $w -side top -fill x } set burger beef set bun white diff --git a/doc/listbox.n b/doc/listbox.n index 68f6e80..e1ac2de 100644 --- a/doc/listbox.n +++ b/doc/listbox.n @@ -95,37 +95,28 @@ Many of the widget commands for listboxes take one or more indices as arguments. An index specifies a particular element of the listbox, in any of the following ways: -.TP 12 -\fInumber\fR -. +.IP \fInumber\fR 12 Specifies the element as a numerical index, where 0 corresponds to the first element in the listbox. -.TP 12 -\fBactive\fR -. +.IP \fBactive\fR 12 Indicates the element that has the location cursor. This element will be displayed as specified by \fB\-activestyle\fR when the listbox has the keyboard focus, and it is specified with the \fBactivate\fR widget command. -.TP 12 -\fBanchor\fR -. +.IP \fBanchor\fR 12 Indicates the anchor point for the selection, which is set with the \fBselection anchor\fR widget command. -.TP 12 -\fBend\fR -. +.IP \fBend\fR 12 Indicates the end of the listbox. 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. -.TP 12 -\fB@\fIx\fB,\fIy\fR +.IP \fB@\fIx\fB,\fIy\fR 12 Indicates the element that covers the point in the listbox window specified by \fIx\fR and \fIy\fR (in pixel coordinates). If no element covers that point, then the closest element to that point is used. -.LP +.PP Indexes support the same simple interpretation as for the command \fBstring index\fR, with simple integer index arithmetic and indexing relative to \fBend\fR. @@ -260,22 +251,26 @@ modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. The following options are currently supported for items: .RS +.\" OPTION: -background .TP \fB\-background \fIcolor\fR . \fIColor\fR specifies the background color to use when displaying the item. It may have any of the forms accepted by \fBTk_GetColor\fR. +.\" OPTION: -foreground .TP \fB\-foreground \fIcolor\fR . \fIColor\fR specifies the foreground color to use when displaying the item. It may have any of the forms accepted by \fBTk_GetColor\fR. +.\" OPTION: -selectbackground .TP \fB\-selectbackground \fIcolor\fR . \fIcolor\fR specifies the background color to use when displaying the item while it is selected. It may have any of the forms accepted by \fBTk_GetColor\fR. +.\" OPTION: -selectforeground .TP \fB\-selectforeground \fIcolor\fR . @@ -426,6 +421,7 @@ It can take any of the following forms: .RS .TP \fIpathName \fByview\fR +. Returns a list containing two elements, both of which are real fractions between 0 and 1. The first element gives the position of the listbox element at the diff --git a/doc/menu.n b/doc/menu.n index 40ebf8c..9894a6c 100644 --- a/doc/menu.n +++ b/doc/menu.n @@ -15,6 +15,7 @@ menu, tk_menuSetFocus \- Create and manipulate 'menu' widgets and menubars .nf \fBmenu\fI pathName \fR?\fIoptions\fR? \fBtk_menuSetFocus\fI pathName\fR +.fi .SO \-activebackground \-borderwidth \-foreground \-activeborderwidth \-cursor \-relief @@ -312,52 +313,36 @@ Many of the widget commands for a menu take as one argument an indicator of which entry of the menu to operate on. These indicators are called \fIindex\fRes and may be specified in any of the following forms: -.TP 12 -\fBactive\fR -. +.IP \fBactive\fR 12 Indicates the entry that is currently active. If no entry is active then this form is equivalent to \fB{}\fR. This form may not be abbreviated. -.TP 12 -\fBend\fR -. +.IP \fBend\fR 12 Indicates the bottommost entry in the menu. If there are no entries in the menu then this form is equivalent to \fB{}\fR. This form may not be abbreviated. -.TP 12 -\fBlast\fR -. +.IP \fBlast\fR 12 Same as \fBend\fR. -.TP 12 -\fB{}\fR -. +.IP \fB{}\fR 12 Indicates .QW "no entry at all" ; this is used most commonly with the \fBactivate\fR option to deactivate all the entries in the menu. In most cases the specification of \fB{}\fR causes nothing to happen in the widget command. -.TP 12 -\fB@\fIx\fB,\fIy\fR -. +.IP \fB@\fIx\fB,\fIy\fR 12 Indicates the entry that covers the point in the menu's window specified by \fIx\fR and \fIy\fR (in pixel coordinates). If no entry covers that point, then this form is equivalent to \fB{}\fR. If only a single number is specified, it is treated as the y-coordinate. -.TP 12 -\fInumber\fR -. +.IP \fInumber\fR 12 Specifies the entry numerically, where 0 corresponds to the top-most entry of the menu, 1 to the entry below it, and so on. -.TP 12 -\fIid\fR -. +.IP \fIid\fR 12 If the index does not satisfy one of the above forms then the menu is searched for an entry with the specified id. -.TP 12 -\fIpattern\fR -. +.IP \fIpattern\fR 12 If all of the above methods for finding an entry fail, this form is used. \fIPattern\fR is pattern-matched against the label of each entry in the menu, in order from the top down, until a @@ -555,6 +540,7 @@ window of the topmost pixel in the entry specified by \fIindex\fR. .SH "MENU ENTRY OPTIONS" The following options are allowed on menu entries. Most options are not supported by all entry types. +.\" OPTION: -activebackground .TP \fB\-activebackground \fIvalue\fR . @@ -566,6 +552,7 @@ If the \fBtk_strictMotif\fR variable has been set to request strict Motif compliance, then this option is ignored and the \fB\-background\fR option is used in its place. This option is not available for separator or tear-off entries. +.\" OPTION: -activeforeground .TP \fB\-activeforeground \fIvalue\fR . @@ -573,7 +560,7 @@ Specifies a foreground color to use for displaying this entry when it is active. This option is ignored on Aqua/macOS. If this option is specified as an empty string (the default), then the \fB\-activeforeground\fR option for the overall menu is used. -This option is not available for separator or tear-off entries. +.\" OPTION: -accelerator .TP \fB\-accelerator \fIvalue\fR . @@ -583,6 +570,7 @@ used to invoke the same function as the menu entry. This is a display option, it does not actually set the corresponding binding (which can be achieved using the \fBbind\fR command). This option is not available for separator or tear-off entries. +.\" OPTION: -background .TP \fB\-background \fIvalue\fR . @@ -592,6 +580,7 @@ This option is ignored on Aqua/macOS. If it is specified as an empty string (the default), then the \fB\-background\fR option for the overall menu is used. This option is not available for separator or tear-off entries. +.\" OPTION: -bitmap .TP \fB\-bitmap \fIvalue\fR . @@ -604,6 +593,7 @@ to an empty string to enable a textual label to be displayed. If a \fB\-image\fR option has been specified, it overrides \fB\-bitmap\fR. This option is not available for separator or tear-off entries. +.\" OPTION: -columnbreak .TP \fB\-columnbreak \fIvalue\fR . @@ -612,11 +602,13 @@ this option is one, the entry appears at the top of a new column in the menu. This option is ignored on Aqua/macOS, where menus are always a single column. +.\" OPTION: -command .TP \fB\-command \fIvalue\fR . Specifies a Tcl command to execute when the menu entry is invoked. Not available for separator or tear-off entries. +.\" OPTION: -compound .TP \fB\-compound \fIvalue\fR . @@ -627,6 +619,7 @@ 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. +.\" OPTION: -font .TP \fB\-font \fIvalue\fR . @@ -635,6 +628,7 @@ string in this entry. If this option is specified as an empty string (the default) then the \fB\-font\fR option for the overall menu is used. This option is not available for separator or tear-off entries. +.\" OPTION: -foreground .TP \fB\-foreground \fIvalue\fR . @@ -644,6 +638,7 @@ This option is ignored on Aqua/macOS. If it is specified as an empty string (the default), then the \fB\-foreground\fR option for the overall menu is used. This option is not available for separator or tear-off entries. +.\" OPTION: -hidemargin .TP \fB\-hidemargin \fIvalue\fR . @@ -651,6 +646,7 @@ 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. +.\" OPTION: -image .TP \fB\-image \fIvalue\fR . @@ -663,34 +659,40 @@ This option overrides the \fB\-label\fR and \fB\-bitmap\fR options but may be reset to an empty string to enable a textual or bitmap label to be displayed. This option is not available for separator or tear-off entries. +.\" OPTION: -indicatoron .TP \fB\-indicatoron \fIvalue\fR . Available only for checkbutton and radiobutton entries. \fIValue\fR is a boolean that determines whether or not the indicator should be displayed. +.\" OPTION: -label .TP \fB\-label \fIvalue\fR . Specifies a string to display as an identifying label in the menu entry. Not available for separator or tear-off entries. +.\" OPTION: -menu .TP \fB\-menu \fIvalue\fR . Available only for cascade entries. Specifies the path name of the submenu associated with this entry. The submenu must be a child of the menu. +.\" OPTION: -offvalue .TP \fB\-offvalue \fIvalue\fR . Available only for checkbutton entries. Specifies the value to store in the entry's associated variable when the entry is deselected. +.\" OPTION: -onvalue .TP \fB\-onvalue \fIvalue\fR . Available only for checkbutton entries. Specifies the value to store in the entry's associated variable when the entry is selected. +.\" OPTION: -selectcolor .TP \fB\-selectcolor \fIvalue\fR . @@ -699,6 +701,7 @@ Specifies the color to display in the indicator when the entry is selected. If the value is an empty string (the default) then the \fB\-selectcolor\fR option for the menu determines the indicator color. +.\" OPTION: -selectimage .TP \fB\-selectimage \fIvalue\fR . @@ -709,6 +712,7 @@ the \fB\-image\fR option) when it is selected. by some previous invocation of \fBimage create\fR. This option is ignored unless the \fB\-image\fR option has been specified. +.\" OPTION: -state .TP \fB\-state \fIvalue\fR . @@ -726,6 +730,7 @@ In this state the entry is displayed according to the \fB\-disabledforeground\fR option for the menu and the \fB\-background\fR option from the entry. This option is not available for separator entries. +.\" OPTION: -underline .TP \fB\-underline \fIvalue\fR . @@ -736,6 +741,7 @@ implement keyboard traversal. 1 to the next character, and so on. If a bitmap or image is displayed in the entry then this option is ignored. This option is not available for separator or tear-off entries. +.\" OPTION: -value .TP \fB\-value \fIvalue\fR . @@ -743,6 +749,7 @@ Available only for radiobutton entries. Specifies the value to store in the entry's associated variable when the entry is selected. If an empty string is specified, then the \fB\-label\fR option for the entry as the value to store in the variable. +.\" OPTION: -variable .TP \fB\-variable \fIvalue\fR . diff --git a/doc/messageBox.n b/doc/messageBox.n index b7be4e8..33825dc 100644 --- a/doc/messageBox.n +++ b/doc/messageBox.n @@ -23,12 +23,15 @@ popped up, \fBtk_messageBox\fR waits for the user to select one of the buttons. Then it returns the symbolic name of the selected button. .PP The following option-value pairs are supported: +.\" OPTION: -command .TP \fB\-command\fI string\fR +. Specifies the prefix of a Tcl command to invoke when the user closes the dialog. The actual command consists of \fIstring\fR followed by a space and the name of the button clicked by the user to close the dialog. This is only available on Mac OS X. +.\" OPTION: -default .TP \fB\-default\fI name\fR . @@ -39,6 +42,7 @@ this message window ( and so on). See \fB\-type\fR for a list of the symbolic names. If this option is not specified, the first button in the dialog will be made the default. +.\" OPTION: -detail .TP \fB\-detail\fI string\fR . @@ -46,6 +50,7 @@ Specifies an auxiliary message to the main message given by the \fB\-message\fR option. The message detail will be presented beneath the main message and, where supported by the OS, in a less emphasized font than the main message. +.\" OPTION: -icon .TP \fB\-icon\fI iconImage\fR . @@ -53,51 +58,43 @@ Specifies an icon to display. \fIIconImage\fR must be one of the following: \fBerror\fR, \fBinfo\fR, \fBquestion\fR or \fBwarning\fR. If this option is not specified, then the info icon will be displayed. +.\" OPTION: -message .TP \fB\-message\fI string\fR . Specifies the message to display in this message box. The default value is an empty string. +.\" OPTION: -parent .TP \fB\-parent\fI window\fR . Makes \fIwindow\fR the logical parent of the message box. The message box is displayed on top of its parent window. +.\" OPTION: -title .TP \fB\-title\fI titleString\fR . Specifies a string to display as the title of the message box. The default value is an empty string. +.\" OPTION: -type .TP \fB\-type\fI predefinedType\fR . Arranges for a predefined set of buttons to be displayed. The following values are possible for \fIpredefinedType\fR: .RS -.TP 18 -\fBabortretryignore\fR -. +.IP \fBabortretryignore\fR 18 Displays three buttons whose symbolic names are \fBabort\fR, \fBretry\fR and \fBignore\fR. -.TP 18 -\fBok\fR -. +.IP \fBok\fR 18 Displays one button whose symbolic name is \fBok\fR. -.TP 18 -\fBokcancel\fR -. +.IP \fBokcancel\fR 18 Displays two buttons whose symbolic names are \fBok\fR and \fBcancel\fR. -.TP 18 -\fBretrycancel\fR -. +.IP \fBretrycancel\fR 18 Displays two buttons whose symbolic names are \fBretry\fR and \fBcancel\fR. -.TP 18 -\fByesno\fR -. +.IP \fByesno\fR 18 Displays two buttons whose symbolic names are \fByes\fR and \fBno\fR. -.TP 18 -\fByesnocancel\fR -. +.IP \fByesnocancel\fR 18 Displays three buttons whose symbolic names are \fByes\fR, \fBno\fR and \fBcancel\fR. .RE @@ -105,13 +102,13 @@ and \fBcancel\fR. .SH EXAMPLE .PP .CS -set answer [\fBtk_messageBox\fR \-message "Really quit?" \e - \-icon question \-type yesno \e - \-detail "Select \e"Yes\e" to make the application exit"] -switch \-\- $answer { +set answer [\fBtk_messageBox\fR -message "Really quit?" \e + -icon question -type yesno \e + -detail "Select \e"Yes\e" to make the application exit"] +switch -- $answer { yes exit - no {\fBtk_messageBox\fR \-message "I know you like this application!" \e - \-type ok} + no {\fBtk_messageBox\fR -message "I know you like this application!" \e + -type ok} } .CE .SH KEYWORDS diff --git a/doc/nsimage.n b/doc/nsimage.n index cf2fe82..d62416f 100644 --- a/doc/nsimage.n +++ b/doc/nsimage.n @@ -26,68 +26,68 @@ name. .SH OPTIONS .PP Valid \fIoptions\fR are: +.\" OPTION: -source .TP -\fB\-source\fR +\fB\-source\fI string\fR .PP The value of the \fB\-source\fR option is a string describing an NSimage. There are several ways to interpret this string, and the interpretation is determined by the value of the \fB\-as\fR option. This option is required. .PP +.\" OPTION: -as .TP -\fB\-as\fR +\fB\-as\fI type\fR .PP There are four possible values for the \fB\-as\fR option which specify how the source string should be interpreted. The allowed values and their meanings are: -.IP -\fBname\fR -.IP +.RS +.IP \fBname\fR The source should be interpreted as the name of a named NSImage provided by the system. This is the default if the \fB\-as\fR option is not specified. -.IP -\fBfile\fR -.IP +.IP \fBfile\fR The source should be interpreted as a path to an image file in one of the formats understood by the NSImage class. -.IP -\fBpath\fR -.IP +.IP \fBpath\fR The source should be interpreted as a path to an arbitrary file. The type of the file will be examined and the resulting image will be the system icon for files of that type. -.IP -\fBfiletype\fR -.IP +.IP \fBfiletype\fR The source is interpreted as a string identifying a particular file type. It may be a filename extension, an Apple Uniform Type Identifier or a 4-character OSType value as used in the HFS filesystem. +.RE +.\" OPTION: -width .TP -\fB\-width\fR +\fB\-width\fI pixels\fR .PP The value of the \fIwidth\fR option is an integer specifying the width in pixels of the nsimage. If the width is not specified it will be computed from the height so as to preserve the aspect ration. If neither width nor height are specified then the width and height of the underlying NSImage will be used. +.\" OPTION: -height .TP -\fB\-height\fR +\fB\-height\fI pixels\fR .PP The value of the \fIheight\fR option is an integer specifying the height in pixels of the nsimage. If the height is not specified it will be computed from the height so as to preserve the aspect ration. If neither width nor height are specified then the width and height of the underlying NSImage will be used. +.\" OPTION: -radius .TP -\fB\-radius\fR +\fB\-radius\fI pixels\fR .PP The value of the \fIradius\fR option is an integer. If non-zero the image will be clipped to a rounded rectangle with the same width and height as the image, but with circular arcs of the specified radius cutting off the corners of the rectangle. +.\" OPTION: -ring .TP -\fB\-ring\fR +\fB\-ring\fI pixels\fR .PP The value of the \fIring\fR option is an integer. If non-zero then it specifies the thickness of a focus ring which will be drawn around the @@ -96,15 +96,17 @@ Preferences. The image is resized to reduce its width and height by twice the thickness of the ring. Note that this may create a small amount of distortion. The aspect ration of a non-square image will change slightly. +.\" OPTION: -alpha .TP -\fB\-alpha\fR +\fB\-alpha\fI float\fR .PP The value of the \fIalpha\fR option should be a floating point number between 0.0 and 1.0. This alpha value will be applied to each pixel of the nsimage, producing a partially transparent image. The default value is 1.0, which makes the image opaque. +.\" OPTION: -pressed .TP -\fB\-pressed\fR +\fB\-pressed\fI boolean\fR .PP The \fIpressed\fR option takes a boolean value. If the value is true or 1 then the image will be algorithmically modified to become darker @@ -112,8 +114,9 @@ in light mode or lighter in dark mode. The default is false. For an image button, the primary image should use the value false while the pressed image should be the same image but with the \fIpressed\fR option set to true. +.\" OPTION: -template .TP -\fB\-template\fR +\fB\-template\fI boolean\fR .PP The \fItemplate\fR option takes a boolean value. If the value is true or 1 then the image will be marked as being a template image. This diff --git a/doc/option.n b/doc/option.n index 9ec408f..8411ce4 100644 --- a/doc/option.n +++ b/doc/option.n @@ -71,20 +71,16 @@ This cannot be changed, setting the [encoding system] has no effect. .PP The \fIpriority\fR arguments to the \fBoption\fR command are normally specified symbolically using one of the following values: -.TP -\fBwidgetDefault\fR +.IP \fBwidgetDefault\fR3 Level 20. Used for default values hard-coded into widgets. -.TP -\fBstartupFile\fR +.IP \fBstartupFile\fR Level 40. Used for options specified in application-specific startup files. -.TP -\fBuserDefault\fR +.IP \fBuserDefault\fR Level 60. Used for options specified in user-specific defaults files, such as \fB.Xdefaults\fR, resource databases loaded into the X server, or user-specific startup files. -.TP -\fBinteractive\fR +.IP \fBinteractive\fR Level 80. Used for options specified interactively after the application starts running. If \fIpriority\fR is not specified, it defaults to this level. diff --git a/doc/options.n b/doc/options.n index 913c912..f540c60 100644 --- a/doc/options.n +++ b/doc/options.n @@ -292,7 +292,7 @@ The script must return \fB0\fR, \fB1\fR, or an empty string: a \fB0\fR or \fB1\fR value specifies whether the window will receive the input focus, and an empty string results in the default decision described above. -Note: this interpretation of the option is defined entirely by +Note that this interpretation of the option is defined entirely by the Tcl scripts that implement traversal: the widget implementations ignore the option entirely, so you can change its meaning if you redefine the keyboard traversal scripts. diff --git a/doc/pack.n b/doc/pack.n index ae12ead..3956be0 100644 --- a/doc/pack.n +++ b/doc/pack.n @@ -23,6 +23,7 @@ The \fBpack\fR command can have any of several forms, depending on the \fIoption\fR argument: .TP \fBpack \fIwindow \fR?\fIwindow ...\fR? ?\fIoptions\fR? +. If the first argument to \fBpack\fR is a window name (any value starting with .QW . ), @@ -38,80 +39,98 @@ See \fBTHE PACKER ALGORITHM\fR below for details on how the options are used by the packer. The following options are supported: .RS +.\" OPTION: -after .TP \fB\-after \fIother\fR +. \fIOther\fR must the name of another window. Use its container as the container for the content, and insert the content just after \fIother\fR in the packing order. +.\" OPTION: -anchor .TP \fB\-anchor \fIanchor\fR +. \fIAnchor\fR must be a valid anchor position such as \fBn\fR or \fBsw\fR; it specifies where to position each content in its parcel. Defaults to \fBcenter\fR. +.\" OPTION: -before .TP \fB\-before \fIother\fR +. \fIOther\fR must the name of another window. Use its container as the container for the content, and insert the content just before \fIother\fR in the packing order. +.\" OPTION: -expand .TP \fB\-expand \fIboolean\fR +. Specifies whether the content should be expanded to consume extra space in their container. \fIBoolean\fR may have any proper boolean value, such as \fB1\fR or \fBno\fR. Defaults to 0. +.\" OPTION: -fill .TP \fB\-fill \fIstyle\fR +. If a content's parcel is larger than its requested dimensions, this option may be used to stretch the content. \fIStyle\fR must have one of the following values: .RS -.TP -\fBnone\fR +.IP \fBnone\fR Give the content its requested dimensions plus any internal padding requested with \fB\-ipadx\fR or \fB\-ipady\fR. This is the default. -.TP -\fBx\fR +.IP \fBx\fR Stretch the content horizontally to fill the entire width of its parcel (except leave external padding as specified by \fB\-padx\fR). -.TP -\fBy\fR +.IP \fBy\fR Stretch the content vertically to fill the entire height of its parcel (except leave external padding as specified by \fB\-pady\fR). -.TP -\fBboth\fR +.IP \fBboth\fR Stretch the content both horizontally and vertically. .RE +.\" OPTION: -in .TP \fB\-in \fIcontainer\fR +. Insert the window at the end of the packing order for the container window given by \fIcontainer\fR. +.\" OPTION: -ipadx .TP \fB\-ipadx \fIamount\fR +. \fIAmount\fR specifies how much horizontal internal padding to leave on each side of the content. \fIAmount\fR must be a valid screen distance, such as \fB2\fR or \fB.5c\fR. It defaults to 0. +.\" OPTION: -ipady .TP \fB\-ipady \fIamount\fR +. \fIAmount\fR specifies how much vertical internal padding to leave on each side of the content. \fIAmount\fR defaults to 0. +.\" OPTION: -padx .TP \fB\-padx \fIamount\fR +. \fIAmount\fR specifies how much horizontal external padding to leave on each side of the content. \fIAmount\fR may be a list of two values to specify padding for left and right separately. \fIAmount\fR defaults to 0. +.\" OPTION: -pady .TP \fB\-pady \fIamount\fR +. \fIAmount\fR specifies how much vertical external padding to leave on each side of the content. \fIAmount\fR may be a list of two values to specify padding for top and bottom separately. \fIAmount\fR defaults to 0. +.\" OPTION: -side .TP \fB\-side \fIside\fR +. Specifies which side of the container the content will be packed against. Must be \fBleft\fR, \fBright\fR, \fBtop\fR, or \fBbottom\fR. Defaults to \fBtop\fR. @@ -130,27 +149,29 @@ than receiving default values. .TP \fBpack content \fIwindow\fR . -Returns a list of all of the content windows in the packing order for \fIwindow\fR. -The order of the content windows in the list is the same as their order in -the packing order. +Returns a list of all of the content windows in the packing order for +\fIwindow\fR. The order of the content windows in the list is the same as +their order in the packing order. If \fIwindow\fR has no content then an empty string is returned. .\" METHOD: forget .TP \fBpack forget \fIwindow \fR?\fIwindow ...\fR? +. Removes each of the \fIwindow\fRs from the packing order for its container and unmaps their windows. The content will no longer be managed by the packer. .RS .PP .VS "TIP 518" -If the last content window of the container becomes unmanaged, this will also send -the virtual event \fB<>\fR to the container; the container -may choose to resize itself (or otherwise respond) to such a change. +If the last content window of the container becomes unmanaged, this will +also send the virtual event \fB<>\fR to the container; the +container may choose to resize itself (or otherwise respond) to such a change. .VE "TIP 518" .RE .\" METHOD: info .TP \fBpack info \fIwindow\fR +. Returns a list whose elements are the current configuration state of the window given by \fIwindow\fR in the same option-value form that might be specified to \fBpack configure\fR. @@ -282,18 +303,18 @@ the stacking order of either the container or the content. .PP .CS # Make the widgets -label .t \-text "This widget is at the top" \-bg red -label .b \-text "This widget is at the bottom" \-bg green -label .l \-text "Left\enHand\enSide" -label .r \-text "Right\enHand\enSide" +label .t -text "This widget is at the top" -bg red +label .b -text "This widget is at the bottom" -bg green +label .l -text "Left\enHand\enSide" +label .r -text "Right\enHand\enSide" text .mid \&.mid insert end "This layout is like Java's BorderLayout" # Lay them out -\fBpack\fR .t \-side top \-fill x -\fBpack\fR .b \-side bottom \-fill x -\fBpack\fR .l \-side left \-fill y -\fBpack\fR .r \-side right \-fill y -\fBpack\fR .mid \-expand 1 \-fill both +\fBpack\fR .t -side top -fill x +\fBpack\fR .b -side bottom -fill x +\fBpack\fR .l -side left -fill y +\fBpack\fR .r -side right -fill y +\fBpack\fR .mid -expand 1 -fill both .CE .SH "SEE ALSO" grid(n), place(n) diff --git a/doc/palette.n b/doc/palette.n index 6a04450..ed0da59 100644 --- a/doc/palette.n +++ b/doc/palette.n @@ -11,11 +11,11 @@ .SH NAME tk_setPalette, tk_bisque \- Modify the Tk color palette .SH SYNOPSIS +.nf \fBtk_setPalette \fIbackground\fR -.sp \fBtk_setPalette \fIname value \fR?\fIname value ...\fR? -.sp \fBtk_bisque\fR +.fi .BE .SH DESCRIPTION .PP diff --git a/doc/panedwindow.n b/doc/panedwindow.n index 54abb8f..1d19219 100644 --- a/doc/panedwindow.n +++ b/doc/panedwindow.n @@ -167,16 +167,19 @@ modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. The following options are supported: .RS +.\" OPTION: -after .TP \fB\-after \fIwindow\fR . Insert the window after the window specified. \fIwindow\fR should be the name of a window already managed by \fIpathName\fR. +.\" OPTION: -before .TP \fB\-before \fIwindow\fR . Insert the window before the window specified. \fIwindow\fR should be the name of a window already managed by \fIpathName\fR. +.\" OPTION: -height .TP \fB\-height \fIsize\fR . @@ -186,12 +189,14 @@ is an empty string, or if \fB\-height\fR is not specified, then the height requested internally by the window will be used initially; the height may later be adjusted by the movement of sashes in the panedwindow. \fISize\fR may be any value accepted by \fBTk_GetPixels\fR. +.\" OPTION: -hide .TP \fB\-hide \fIboolean\fR . Controls the visibility of a pane. When the \fIboolean\fR is true (according to \fBTcl_GetBoolean\fR) the pane will not be visible, but it will still be maintained in the list of panes. +.\" OPTION: -minsize .TP \fB\-minsize \fIn\fR . @@ -200,18 +205,21 @@ Specifies that the size of the window cannot be made less than paned dimension \(em the x dimension for horizontal panedwindows, the y dimension for vertical panedwindows. May be any value accepted by \fBTk_GetPixels\fR. +.\" OPTION: -padx .TP \fB\-padx \fIn\fR . Specifies a non-negative value indicating how much extra space to leave on each side of the window in the X-direction. The value may have any of the forms accepted by \fBTk_GetPixels\fR. +.\" OPTION: -pady .TP \fB\-pady \fIn\fR . Specifies a non-negative value indicating how much extra space to leave on each side of the window in the Y-direction. The value may have any of the forms accepted by \fBTk_GetPixels\fR. +.\" OPTION: -sticky .TP \fB\-sticky \fIstyle\fR . @@ -226,6 +234,7 @@ will to. If both \fBn\fR and \fBs\fR (or \fBe\fR and \fBw\fR) are specified, the window will be stretched to fill the entire height (or width) of its cavity. +.\" OPTION: -stretch .TP \fB\-stretch \fIwhen\fR . @@ -238,29 +247,20 @@ for stretching. The space will be distributed based on each panes current ratio of the whole. The \fIwhen\fR values have the following definition: .RS -.TP -\fBalways\fR -. +.IP \fBalways\fR This pane will always stretch. -.TP -\fBfirst\fR -. +.IP \fBfirst\fR Only if this pane is the first pane (left-most or top-most) will it stretch. -.TP -\fBlast\fR -. +.IP \fBlast\fR Only if this pane is the last pane (right-most or bottom-most) will it stretch. This is the default value. -.TP -\fBmiddle\fR -. +.IP \fBmiddle\fR Only if this pane is not the first or last pane will it stretch. -.TP -\fBnever\fR -. +.IP \fBnever\fR This pane will never stretch. .RE +.\" OPTION: -width .TP \fB\-width \fIsize\fR . @@ -301,6 +301,7 @@ Place the proxy at the given \fIx\fR and \fIy\fR coordinates. .\" METHOD: sash .TP \fIpathName \fBsash \fR?\fIargs\fR? +. This command is used to query and change the position of sashes in the panedwindow. It can take any of the following forms: .RS diff --git a/doc/photo.n b/doc/photo.n index d8a48df..2a27d9b 100644 --- a/doc/photo.n +++ b/doc/photo.n @@ -50,7 +50,7 @@ and (read-only) SVG formats are supported, but an interface exists to allow additional image file formats to be added easily. A photo image is (semi)transparent if the image data it was obtained from had -transparency informaton. In regions where no image data has been +transparency information. In regions where no image data has been supplied, it is fully transparent. Transparency may also be modified with the \fBtransparency set\fR subcommand. .SH "CREATING PHOTOS" @@ -58,6 +58,7 @@ with the \fBtransparency set\fR subcommand. Like all images, photos are created using the \fBimage create\fR command. Photos support the following \fIoptions\fR: +.\" OPTION: -data .TP \fB\-data \fIstring\fR . @@ -72,20 +73,23 @@ format of the string must be one of those for which there is an image file format handler that will accept string data. If both the \fB\-data\fR and \fB\-file\fR options are specified, the \fB\-file\fR option takes precedence. +.\" OPTION: -format .TP \fB\-format\fR {\fIformat-name\fR ?\fIoption value ...\fR?} . Specifies the name of the file format for the data specified with the \fB\-data\fR or \fB\-file\fR option and optional arguments passed to -the format handler. Note: the value of this option must be a Tcl list. +the format handler. Note that the value of this option must be a Tcl list. This means that the braces may be omitted if the argument has only one word. Also, instead of braces, double quotes may be used for quoting. +.\" OPTION: -file .TP \fB\-file \fIname\fR . \fIname\fR gives the name of a file that is to be read to supply data for the photo image. The file format must be one of those for which there is an image file format handler that can read data. +.\" OPTION: -gamma .TP \fB\-gamma \fIvalue\fR . @@ -98,6 +102,7 @@ The value specified must be greater than zero. The default value is one (no correction). In general, values greater than one will make the image lighter, and values less than one will make it darker. +.\" OPTION: -height .TP \fB\-height \fInumber\fR . @@ -106,6 +111,7 @@ primarily in situations where the user wishes to build up the contents of the image piece by piece. A value of zero (the default) allows the image to expand or shrink vertically to fit the data stored in it. .VS 8.7 +.\" OPTION: -metadata .TP \fB\-metadata \fImetadata\fR . @@ -115,6 +121,7 @@ if image data is processed due to a \fB\-file\fR or \fB\-data\fR options and the driver outputs any metadata keys. See section \fBMETADATA DICTIONARY\fR below. .VE 8.7 +.\" OPTION: -palette .TP \fB\-palette \fIpalette-spec\fR . @@ -127,6 +134,7 @@ numbers separated by slashes (/), specifying the number of shades of red, green and blue to use, respectively. If the first form (a single number) is used, the image will be displayed in monochrome (i.e., grayscale). +.\" OPTION: -width .TP \fB\-width \fInumber\fR . @@ -161,7 +169,8 @@ The following commands are possible for photo images: . Blank the image; that is, set the entire image to have no data, so it will be displayed as transparent, and the background of whatever -window it is displayed in will show through. The metadata dict of the image is not changed. +window it is displayed in will show through. The metadata dict of the +image is not changed. .\" METHOD: cget .TP \fIimageName \fBcget\fI option\fR @@ -187,7 +196,7 @@ this case the command returns an empty string. \fIOption\fR may have any of the values accepted by the \fBimage create\fR \fBphoto\fR command. .VS 8.7 -Note: setting the \fB\-metadata\fR option without any other option +Note that setting the \fB\-metadata\fR option without any other option will not invoke the image format driver to recreate the bitmap. .VE 8.7 .\" METHOD: copy @@ -201,6 +210,7 @@ command copies the whole of \fIsourceImage\fR into \fIimageName\fR, starting at coordinates (0,0) in \fIimageName\fR. The following options may be specified: .RS +.\" OPTION: -from .TP \fB\-from \fIx1 y1 x2 y2\fR . @@ -211,6 +221,7 @@ default value is the bottom-right corner of the source image. The pixels copied will include the left and top edges of the specified rectangle but not the bottom or right edges. If the \fB\-from\fR option is not given, the default is the whole source image. +.\" OPTION: -to .TP \fB\-to \fIx1 y1 x2 y2\fR . @@ -221,6 +232,7 @@ the default value is (\fIx1,y1\fR) plus the size of the source region (after subsampling and zooming, if specified). If \fIx2\fR and \fIy2\fR are specified, the source region will be replicated if necessary to fill the destination region in a tiled fashion. +.\" OPTION: -shrink .TP \fB\-shrink\fR . @@ -229,6 +241,7 @@ necessary, so that the region being copied into is at the bottom-right corner of the image. This option will not affect the width or height of the image if the user has specified a non-zero value for the \fB\-width\fR or \fB\-height\fR configuration option, respectively. +.\" OPTION: -zoom .TP \fB\-zoom \fIx y\fR . @@ -238,6 +251,7 @@ is not given, the default value is the same as \fIx\fR. With this option, each pixel in the source image will be expanded into a block of \fIx\fR x \fIy\fR pixels in the destination image, all the same color. \fIx\fR and \fIy\fR must be greater than 0. +.\" OPTION: -subsample .TP \fB\-subsample \fIx y\fR . @@ -246,6 +260,7 @@ only every \fIx\fRth pixel in the X direction and \fIy\fRth pixel in the Y direction. Negative values will cause the image to be flipped about the Y or X axes, respectively. If \fIy\fR is not given, the default value is the same as \fIx\fR. +.\" OPTION: -compositingrule .TP \fB\-compositingrule \fIrule\fR . @@ -271,12 +286,14 @@ See \fBIMAGE FORMATS\fR below for details. .VE 8.7 The following options may be specified: .RS +.\" OPTION: -background .TP \fB\-background\fI color\fR . If the color is specified, the data will not contain any transparency information. In all transparent pixels the color will be replaced by the specified color. +.\" OPTION: -format .TP \fB\-format\fR {\fIformat-name\fR ?\fIoption value ...\fR?} . @@ -292,9 +309,10 @@ per pixel/column) of colors in .QW \fB#\fIrrggbb\fR format (see \fBIMAGE FORMATS\fR below). .VE 8.7 -Note: the value of this option must be a Tcl list. +Note that the value of this option must be a Tcl list. This means that the braces may be omitted if the argument has only one word. Also, instead of braces, double quotes may be used for quoting. +.\" OPTION: -from .TP \fB\-from \fIx1 y1 x2 y2\fR . @@ -305,12 +323,14 @@ extends from \fI(x1,y1)\fR to the bottom-right corner of diagonally opposite corners of the rectangular region, including x1,y1 and excluding x2,y2. The default, if this option is not given, is the whole image. +.\" OPTION: -grayscale .TP \fB\-grayscale\fR . If this options is specified, the data will not contain color information. All pixel data will be transformed into grayscale. .VS 8.7 +.\" OPTION: -metadata .TP \fB\-metadata\fI metadata\fR . @@ -345,6 +365,7 @@ See \fBIMAGE FORMATS\fR below for details on formats for image data. .VE 8.7 The following options may be specified: .RS +.\" OPTION: -format .TP \fB\-format\fR {\fIformat-name\fR ?\fIoption value ..\fR?} . @@ -353,18 +374,20 @@ arguments to be passed to the format handler. Specifically, only image file format handlers whose names begin with \fIformat-name\fR will be used while searching for an image data format handler to read the data. -Note: the value of this option must be a Tcl list. +Note that the value of this option must be a Tcl list. This means that the braces may be omitted if the argument has only one word. Also, instead of braces, double quotes may be used for quoting. .VS 8.7 +.\" OPTION: -metadata .TP \fB\-metadata\fI metadata\fR . A specified \fImetadata\fR is passed to the image format driver when interpreting the data. -Note: The current metadata of the image is not passed to the format driver +Note that the current metadata of the image is not passed to the format driver and is not changed by the command. .VE 8.7 +.\" OPTION: -to .TP \fB\-to \fIx1 y1\fR ?\fIx2 y2\fR? . @@ -373,7 +396,7 @@ of the region of \fIimageName\fR into which the image data will be copied. The default position is (0,0). If \fIx2\fR,\fIy2\fR is given and \fIdata\fR is not large enough to cover the rectangle specified by this option, the image data extracted will be tiled so it covers the -entire destination rectangle. If the region specified with this opion +entire destination rectangle. If the region specified with this option is smaller than the supplied \fIdata\fR, the exceeding data is silently discarded. Note that if \fIdata\fR specifies a single color value, then a region extending to the bottom-right corner @@ -390,6 +413,7 @@ in \fIfilename\fR, and then reads the image in \fIfilename\fR into \fIimageName\fR (the destination image). The following options may be specified: .RS +.\" OPTION: -format .TP \fB\-format {\fIformat-name\fR ?\fIoption value ..\fR?} . @@ -398,9 +422,10 @@ optionally, additional options to the format handler. Specifically, only image file format handlers whose names begin with \fIformat-name\fR will be used while searching for an image data format handler to read the data. -Note: the value of this option must be a Tcl list. +Note that the value of this option must be a Tcl list. This means that the braces may be omitted if the argument has only one word. Also, instead of braces, double quotes may be used for quoting. +.\" OPTION: -from .TP \fB\-from \fIx1 y1 x2 y2\fR . @@ -412,14 +437,16 @@ specified, they specify diagonally opposite corners or the region. The default, if this option is not specified, is the whole of the image in the image file. .VS 8.7 +.\" OPTION: -metadata .TP \fB\-metadata\fI metadata\fR . A specified \fImetadata\fR is passed to the image format driver when interpreting the data. -Note: The current metadata of the image is not passed to the format driver +Note that the current metadata of the image is not passed to the format driver and is not changed by the command. .VE 8.7 +.\" OPTION: -shrink .TP \fB\-shrink\fR . @@ -429,6 +456,7 @@ is at the bottom-right corner of the \fIimageName\fR. This option will not affect the width or height of the image if the user has specified a non-zero value for the \fB\-width\fR or \fB\-height\fR configuration option, respectively. +.\" OPTION: -to .TP \fB\-to \fIx y\fR . @@ -479,12 +507,14 @@ value for the pixel, which must be in the range 0 to 255. Writes image data from \fIimageName\fR to a file named \fIfilename\fR. The following options may be specified: .RS +.\" OPTION: -background .TP \fB\-background\fI color\fR . If the color is specified, the data will not contain any transparency information. In all transparent pixels the color will be replaced by the specified color. +.\" OPTION: -format .TP \fB\-format\fR {\fIformat-name\fR ?\fIoption value ...\fR?} . @@ -496,9 +526,10 @@ and which has the capability to write an image file. If this option is not given, the format is guessed from the file extension. If that cannot be determined, this subcommand uses the first handler that has the capability to write an image file. -Note: the value of this option must be a Tcl list. +Note that the value of this option must be a Tcl list. This means that the braces may be omitted if the argument has only one word. Also, instead of braces, double quotes may be used for quoting. +.\" OPTION: -from .TP \fB\-from \fIx1 y1 x2 y2\fR . @@ -508,12 +539,14 @@ extends from \fI(x1,y1)\fR to the bottom-right corner of \fIimageName\fR. If all four coordinates are given, they specify diagonally opposite corners of the rectangular region. The default, if this option is not given, is the whole image. +.\" OPTION: -grayscale .TP \fB\-grayscale\fR . If this options is specified, the data will not contain color information. All pixel data will be transformed into grayscale. .VS 8.7 +.\" OPTION: -metadata .TP \fB\-metadata\fI metadata\fR . @@ -580,12 +613,13 @@ the forms described in the \fBCOLOR FORMATS\fR section below. .SS "FORMAT SUBOPTIONS" .PP .VS 8.6 -Image formats may support sub-options, wich ahre specified using +Image formats may support sub-options, which are specified using additional words in the value to the \fB\-format\fR option. These suboptions can affect how image data is read or written to file or string. The nature and values of these options is up to the format handler. The built-in handlers support these suboptions: +.\" OPTION -colorformat .VS 8.7 .TP \fBdefault \-colorformat\fI formatType\fR @@ -598,6 +632,7 @@ pixel data in the form \fB#\fIRRGGBBAA\fR or \fBlist\fR to encode pixel data as a list with four elements. See \fBCOLOR FORMATS\fR below for details. The default is \fBrgb\fR. .VE 8.7 +.\" OPTION -index .TP \fBgif \-index\fI indexValue\fR . @@ -606,6 +641,7 @@ parsing a multi-part GIF image, Tk normally only accesses the first image. By giving the \fB\-index\fR sub-option, the \fIindexValue\fR'th value may be used instead. The \fIindexValue\fR must be an integer from 0 up to the number of image parts in the GIF data. +.\" OPTION -alpha .TP \fBpng \-alpha\fI alphaValue\fR . @@ -614,6 +650,10 @@ an additional alpha filtering for the overall image, which allows the background on which the image is displayed to show through. This usually also has the effect of desaturating the image. The \fIalphaValue\fR must be between 0.0 and 1.0. +.\" OPTION -dpi +.\" OPTION -scale +.\" OPTION -scaletowidth +.\" OPTION -scaletoheight .TP \fBsvg \-dpi\fI dpiValue \fB\-scale\fI scaleValue \fB\-scaletowidth\fI width \fB\-scaletoheight\fI height\fR . @@ -628,7 +668,7 @@ be greater than 0 and the default value is 1. will be adjusted to. Only one parameter among \fB\-scale\fR, \fB\-scaletowidth\fR and \fB\-scaletoheight\fR can be given at a time and the aspect ratio of the original image is always preserved. -The svg format supports a wide range of SVG features, but the +The \fBsvg\fR format supports a wide range of SVG features, but the full SVG standard is not available, for instance the 'text' feature is missing and silently ignored when reading the SVG data. The supported SVG features are: @@ -780,19 +820,13 @@ parsed, or may use metadata to be included in image files or formats. .PP Each image format driver supports an individual set of metadata dictionary keys. Predefined keys are: -.TP -\fBDPI\fR -. +.IP \fBDPI\fR Horizontal image resolution in DPI as a double value. Supported by format \fBpng\fR. -.TP -\fBaspect\fR -. +.IP \fBaspect\fR Aspect ratio horizontal divided by vertical as double value. Supported by formats \fBgif\fR and \fBpng\fR. -.TP -\fBcomment\fR -. +.IP \fBcomment\fR Image text comment. Supported by formats \fBgif\fR and \fBpng\fR. .PP @@ -807,7 +841,8 @@ The options are linked to each subimage selected by \fB\-index\fR. .TP \fBdelay time\fI time\fR . -Update delay time in 10ms units. This key is only present if the delay time is not 0. +Update delay time in 10ms units. +This key is only present if the delay time is not 0. .TP \fBdisposal method\fI method\fR . @@ -838,14 +873,14 @@ is useful for producing a tiled background: .PP .CS # These lines should be called once -\fBimage create photo\fR untiled \-file "theFile.ppm" +\fBimage create photo\fR untiled -file "theFile.ppm" \fBimage create photo\fR tiled # These lines should be called whenever .someWidget changes # size; a binding is useful here set width [winfo width .someWidget] set height [winfo height .someWidget] -tiled \fBcopy\fR untiled \-to 0 0 $width $height \-shrink +tiled \fBcopy\fR untiled -to 0 0 $width $height -shrink .CE .PP .VS 8.6 @@ -854,10 +889,10 @@ during loading, which is useful for generating images suitable for disabled buttons: .PP .CS -\fBimage create photo\fR icon \-file "icon.png" -\fBimage create photo\fR iconDisabled \-file "icon.png" \e - \-format "png \-alpha 0.5" -button .b \-image icon \-disabledimage iconDisabled +\fBimage create photo\fR icon -file "icon.png" +\fBimage create photo\fR iconDisabled -file "icon.png" \e + -format "png -alpha 0.5" +button .b -image icon -disabledimage iconDisabled .CE .VE 8.6 .PP diff --git a/doc/place.n b/doc/place.n index b1189cd..22e9699 100644 --- a/doc/place.n +++ b/doc/place.n @@ -53,8 +53,10 @@ the command returns an empty string. .RS .PP The following \fIoption\-value\fR pairs are supported: +.\" OPTION: -anchor .TP \fB\-anchor \fIwhere\fR +. \fIWhere\fR specifies which point of \fIwindow\fR is to be positioned at the (x,y) location selected by the \fB\-x\fR, \fB\-y\fR, \fB\-relx\fR, and \fB\-rely\fR options. @@ -64,8 +66,10 @@ Thus if \fIwhere\fR is \fBse\fR then the lower-right corner of \fIwindow\fR's border will appear at the given (x,y) location in the container. The anchor position defaults to \fBnw\fR. +.\" OPTION: -bordermode .TP \fB\-bordermode \fImode\fR +. \fIMode\fR determines the degree to which borders within the container are used in determining the placement of the content. The default and most common value is \fBinside\fR. @@ -87,8 +91,10 @@ to be its official X area, which includes any internal border but no external border. A bordermode of \fBignore\fR is probably not very useful. .RE +.\" OPTION: -height .TP \fB\-height \fIsize\fR +. \fISize\fR specifies the height for \fIwindow\fR in screen units (i.e. any of the forms accepted by \fBTk_GetPixels\fR). The height will be the outer dimension of \fIwindow\fR including its @@ -96,8 +102,10 @@ border, if any. If \fIsize\fR is an empty string, or if no \fB\-height\fR or \fB\-relheight\fR option is specified, then the height requested internally by the window will be used. +.\" OPTION: -in .TP \fB\-in \fIcontainer\fR +. \fIContainer\fR specifies the path name of the window relative to which \fIwindow\fR is to be placed. \fIContainer\fR must either be \fIwindow\fR's parent or a descendant @@ -108,8 +116,10 @@ These restrictions are necessary to guarantee that \fIwindow\fR is visible whenever \fIcontainer\fR is visible. If this option is not specified then the other window defaults to \fIwindow\fR's parent. +.\" OPTION: -relheight .TP \fB\-relheight \fIsize\fR +. \fISize\fR specifies the height for \fIwindow\fR. In this case the height is specified as a floating-point number relative to the height of the container: 0.5 means \fIwindow\fR will @@ -118,8 +128,10 @@ the same height as the container, and so on. If both \fB\-height\fR and \fB\-relheight\fR are specified for a content, their values are summed. For example, \fB\-relheight 1.0 \-height \-2\fR makes the content 2 pixels shorter than the container. +.\" OPTION: -relwidth .TP \fB\-relwidth \fIsize\fR +. \fISize\fR specifies the width for \fIwindow\fR. In this case the width is specified as a floating-point number relative to the width of the container: 0.5 means \fIwindow\fR will @@ -128,8 +140,10 @@ the same width as the container, and so on. If both \fB\-width\fR and \fB\-relwidth\fR are specified for a content, their values are summed. For example, \fB\-relwidth 1.0 \-width 5\fR makes the content 5 pixels wider than the container. +.\" OPTION: -relx .TP \fB\-relx \fIlocation\fR +. \fILocation\fR specifies the x-coordinate within the container window of the anchor point for \fIwindow\fR. In this case the location is specified in a relative fashion @@ -140,8 +154,10 @@ If both \fB\-x\fR and \fB\-relx\fR are specified for a content then their values are summed. For example, \fB\-relx 0.5 \-x \-2\fR positions the left edge of the content 2 pixels to the left of the center of its container. +.\" OPTION: -rely .TP \fB\-rely \fIlocation\fR +. \fILocation\fR specifies the y-coordinate within the container window of the anchor point for \fIwindow\fR. In this case the value is specified in a relative fashion @@ -152,8 +168,10 @@ If both \fB\-y\fR and \fB\-rely\fR are specified for a content then their values are summed. For example, \fB\-rely 0.5 \-x 3\fR positions the top edge of the content 3 pixels below the center of its container. +.\" OPTION: -width .TP \fB\-width \fIsize\fR +. \fISize\fR specifies the width for \fIwindow\fR in screen units (i.e. any of the forms accepted by \fBTk_GetPixels\fR). The width will be the outer width of \fIwindow\fR including its @@ -161,15 +179,19 @@ border, if any. If \fIsize\fR is an empty string, or if no \fB\-width\fR or \fB\-relwidth\fR option is specified, then the width requested internally by the window will be used. +.\" OPTION: -x .TP \fB\-x \fIlocation\fR +. \fILocation\fR specifies the x-coordinate within the container window of the anchor point for \fIwindow\fR. The location is specified in screen units (i.e. any of the forms accepted by \fBTk_GetPixels\fR) and need not lie within the bounds of the container window. +.\" OPTION: -y .TP \fB\-y \fIlocation\fR +. \fILocation\fR specifies the y-coordinate within the container window of the anchor point for \fIwindow\fR. The location is specified in screen units (i.e. any of the forms @@ -184,8 +206,9 @@ the most recent option is used and the older one is ignored. .TP \fBplace content \fIwindow\fR . -Returns a list of all the content windows for which \fIwindow\fR is the container. -If there is no content for \fIwindow\fR then an empty string is returned. +Returns a list of all the content windows for which \fIwindow\fR is the +container. If there is no content for \fIwindow\fR then an empty string +is returned. .\" METHOD: forget .TP \fBplace forget \fIwindow\fR @@ -257,13 +280,14 @@ frames and canvases that provide configuration options for this purpose. Make the label occupy the middle bit of the toplevel, no matter how it is resized: .CS -label .l \-text "In the\enMiddle!" \-bg black \-fg white -\fBplace\fR .l \-relwidth .3 \-relx .35 \-relheight .3 \-rely .35 +label .l -text "In the\enMiddle!" -bg black -fg white +\fBplace\fR .l -relwidth .3 -relx .35 -relheight .3 -rely .35 .CE .SH "SEE ALSO" grid(n), pack(n) .SH KEYWORDS -geometry manager, height, location, container, place, rubber sheet, content, width +geometry manager, height, location, container, place, rubber sheet, +content, width '\" Local Variables: '\" mode: nroff '\" End: diff --git a/doc/popup.n b/doc/popup.n index 9543750..ca9d485 100644 --- a/doc/popup.n +++ b/doc/popup.n @@ -31,11 +31,11 @@ How to attach a simple popup menu to a widget. .CS # Create a menu set m [menu .popupMenu] -$m add command \-label "Example 1" \-command bell -$m add command \-label "Example 2" \-command bell +$m add command -label "Example 1" -command bell +$m add command -label "Example 2" -command bell # Create something to attach it to -pack [label .l \-text "Click me!"] +pack [label .l -text "Click me!"] # Arrange for the menu to pop up when the label is clicked bind .l {\fBtk_popup\fR .popupMenu %X %Y} diff --git a/doc/radiobutton.n b/doc/radiobutton.n index 6033954..b51a7e6 100644 --- a/doc/radiobutton.n +++ b/doc/radiobutton.n @@ -65,8 +65,8 @@ The empty string is the default value. Specifies a background color to use when the button is selected. If \fBindicatorOn\fR is true then the color is used as the background for the indicator regardless of the select state. -If \fB\-indicatoron\fR is false, this color is used as the background -for the entire widget, in place of \fB\-background\fR or \fB\-activeBackground\fR, +If \fB\-indicatoron\fR is false, this color is used as the background for the +entire widget, in place of \fB\-background\fR or \fB\-activeBackground\fR, whenever the widget is selected. If specified as an empty string then no special color is used for displaying when the widget is selected. @@ -263,7 +263,8 @@ actions occur: the radiobutton is completely non-responsive. The behavior of radiobuttons can be changed by defining new bindings for individual widgets or by redefining the class bindings. .SH "SEE ALSO" -checkbutton(n), labelframe(n), listbox(n), options(n), scale(n), ttk::radiobutton(n) +checkbutton(n), labelframe(n), listbox(n), options(n), scale(n), +ttk::radiobutton(n) .SH KEYWORDS radiobutton, widget '\" Local Variables: diff --git a/doc/raise.n b/doc/raise.n index 7741001..752bcd6 100644 --- a/doc/raise.n +++ b/doc/raise.n @@ -41,11 +41,11 @@ it. This is is often necessary when building GUIs in the style where you create your activity widgets first before laying them out on the display: .CS -button .b \-text "Hi there!" -pack [frame .f \-background blue] -pack [label .f.l1 \-text "This is above"] -pack .b \-in .f -pack [label .f.l2 \-text "This is below"] +button .b -text "Hi there!" +pack [frame .f -background blue] +pack [label .f.l1 -text "This is above"] +pack .b -in .f +pack [label .f.l2 -text "This is below"] \fBraise\fR .b .CE .SH "SEE ALSO" diff --git a/doc/scale.n b/doc/scale.n index 97e0de3..9aeb8c0 100644 --- a/doc/scale.n +++ b/doc/scale.n @@ -78,7 +78,9 @@ specified by the \fB\-activebackground\fR option. .OP \-tickinterval tickInterval TickInterval Must be a real value. Determines the spacing between numerical -tick marks displayed below or to the left of the slider. The values will all be displayed with the same number of decimal places, which will be enough to ensure they are all accurate to within 20% of a tick interval. +tick marks displayed below or to the left of the slider. The values will all +be displayed with the same number of decimal places, which will be enough to +ensure they are all accurate to within 20% of a tick interval. If 0, no tick marks will be displayed. .OP \-to to To Specifies a real value corresponding diff --git a/doc/scrollbar.n b/doc/scrollbar.n index 86b6214..0bbfb70 100644 --- a/doc/scrollbar.n +++ b/doc/scrollbar.n @@ -81,20 +81,15 @@ below for details. .PP A scrollbar displays five elements, which are referred to in the widget commands for the scrollbar: -.TP 10 -\fBarrow1\fR +.IP \fBarrow1\fR 10 The top or left arrow in the scrollbar. -.TP 10 -\fBtrough1\fR +.IP \fBtrough1\fR 10 The region between the slider and \fBarrow1\fR. -.TP 10 -\fBslider\fR +.IP \fBslider\fR 10 The rectangle that indicates what is visible in the associated widget. -.TP 10 -\fBtrough2\fR +.IP \fBtrough2\fR 10 The region between the slider and \fBarrow2\fR. -.TP 10 -\fBarrow2\fR +.IP \fBarrow2\fR 10 The bottom or right arrow in the scrollbar. .SH "WIDGET COMMAND" .PP @@ -212,6 +207,7 @@ The command may take any of the following forms. In each case, \fIprefix\fR is the contents of the \fB\-command\fR option, which usually has a form like .QW "\fB.t yview\fR" . +.\" METHOD: moveto .TP \fIprefix \fBmoveto \fIfraction\fR . @@ -222,6 +218,7 @@ If \fIfraction\fR is 0 it refers to the beginning of the document. 1.0 refers to the end of the document, 0.333 refers to a point one-third of the way through the document, and so on. +.\" METHOD: scroll .TP \fIprefix \fBscroll \fInumber \fBpages\fR . @@ -316,11 +313,11 @@ The End key adjusts the view to the bottom (right edge) of the document. Create a window with a scrollable \fBtext\fR widget: .CS toplevel .tl -text .tl.t \-yscrollcommand {.tl.s set} -\fBscrollbar\fR .tl.s \-command {.tl.t yview} -grid .tl.t .tl.s \-sticky nsew -grid columnconfigure .tl 0 \-weight 1 -grid rowconfigure .tl 0 \-weight 1 +text .tl.t -yscrollcommand {.tl.s set} +\fBscrollbar\fR .tl.s -command {.tl.t yview} +grid .tl.t .tl.s -sticky nsew +grid columnconfigure .tl 0 -weight 1 +grid rowconfigure .tl 0 -weight 1 .CE .SH "SEE ALSO" ttk:scrollbar(n) diff --git a/doc/selection.n b/doc/selection.n index 19117ee..2f51d51 100644 --- a/doc/selection.n +++ b/doc/selection.n @@ -190,14 +190,14 @@ On X11 platforms, one of the standard selections available is the it using Tk: .PP .CS -set selContents [\fBselection get\fR \-selection SECONDARY] +set selContents [\fBselection get\fR -selection SECONDARY] .CE .PP Many different types of data may be available for a selection; the special type \fBTARGETS\fR allows you to get a list of available types: .PP .CS -foreach type [\fBselection get\fR \-type TARGETS] { +foreach type [\fBselection get\fR -type TARGETS] { puts "Selection PRIMARY supports type $type" } .CE @@ -207,7 +207,7 @@ data for the selection. Then you have to claim the selection... .CS # Set up the data handler ready for incoming requests set foo "This is a string with some data in it... blah blah" -\fBselection handle\fR \-selection SECONDARY . getData +\fBselection handle\fR -selection SECONDARY . getData proc getData {offset maxChars} { puts "Retrieving selection starting at $offset" return [string range $::foo $offset [expr {$offset+$maxChars-1}]] @@ -215,7 +215,7 @@ proc getData {offset maxChars} { # Now we grab the selection itself puts "Claiming selection" -\fBselection own\fR \-command lost \-selection SECONDARY . +\fBselection own\fR -command lost -selection SECONDARY . proc lost {} { puts "Lost selection" } diff --git a/doc/send.n b/doc/send.n index b8a92c5..943c92f 100644 --- a/doc/send.n +++ b/doc/send.n @@ -30,21 +30,27 @@ command to be executed, just as for the \fBeval\fR command. If the initial arguments of the command begin with .QW \- they are treated as options. The following options are currently defined: +.\" OPTION: -async .TP \fB\-async\fR +. Requests asynchronous invocation. In this case the \fBsend\fR command will complete immediately without waiting for \fIcmd\fR to complete in the target application; no result will be available and errors in the sent command will be ignored. If the target application is in the same process as the sending application then the \fB\-async\fR option is ignored. +.\" OPTION: -displayof .TP \fB\-displayof\fI pathName\fR +. Specifies that the target application's main window is on the display of the window given by \fIpathName\fR, instead of the display containing the application's main window. +.\" OPTION: -- .TP \fB\-\|\-\fR +. Serves no purpose except to terminate the list of options. This option is needed only if \fIapp\fR could contain a leading .QW \- @@ -90,7 +96,7 @@ This script fragment can be used to make an application that only runs once on a particular display. .CS if {[tk appname FoobarApp] ne "FoobarApp"} { - \fBsend\fR \-async FoobarApp RemoteStart $argv + \fBsend\fR -async FoobarApp RemoteStart $argv exit } # The command that will be called remotely, which raises diff --git a/doc/spinbox.n b/doc/spinbox.n index d358e62..e7ed8e0 100644 --- a/doc/spinbox.n +++ b/doc/spinbox.n @@ -168,8 +168,8 @@ The \fB\-validatecommand\fR will be called when the spinbox is edited. The \fB\-validatecommand\fR will be called for all above conditions. .PP It is possible to perform percent substitutions on the \fB\-validatecommand\fR -and \fB\-invalidcommand\fR scripts, just as you would in a \fBbind\fR script. The -following substitutions are recognized: +and \fB\-invalidcommand\fR scripts, just as you would in a \fBbind\fR script. +The following substitutions are recognized: .PP .IP \fB%d\fR 5 Type of action: 1 for \fBinsert\fR, 0 for \fBdelete\fR, @@ -213,7 +213,7 @@ validated. If you wish to edit the value of the widget during validation and still have the \fB\-validate\fR option set, you should include the command .CS - \fI%W config \-validate %v\fR + \fI%W config -validate %v\fR .CE in the \fB\-validatecommand\fR or \fB\-invalidcommand\fR (whichever one you were editing the spinbox widget from). It is also recommended to not set an @@ -224,7 +224,7 @@ Also, the \fB\-validate\fR option will set itself to \fBnone\fR when the spinbox value gets changed because of adjustment of \fB\-from\fR or \fB\-to\fR and the \fB\-validatecommand\fR returns false. For instance .CS - \fIspinbox pathName \-from 1 \-to 10 \-validate all \-validatecommand {return 0}\fR + \fIspinbox pathName -from 1 -to 10 -validate all -validatecommand {return 0}\fR .CE will in fact set the \fB\-validate\fR option to \fBnone\fR because the default value for the spinbox gets changed (due to the \fB\-from\fR and \fB\-to\fR @@ -250,32 +250,39 @@ arguments. An index specifies a particular character in the spinbox's string, in any of the following ways: .TP 12 \fInumber\fR +. Specifies the character as a numerical index, where 0 corresponds to the first character in the string. .TP 12 \fBanchor\fR +. Indicates the anchor point for the selection, which is set with the \fBselect from\fR and \fBselect adjust\fR widget commands. .TP 12 \fBend\fR +. Indicates the character just after the last one in the spinbox's string. This is equivalent to specifying a numerical index equal to the length of the spinbox's string. .TP 12 \fBinsert\fR +. Indicates the character adjacent to and immediately following the insertion cursor. .TP 12 \fBsel.first\fR +. Indicates the first character in the selection. It is an error to use this form if the selection is not in the spinbox window. .TP 12 \fBsel.last\fR +. Indicates the character just after the last one in the selection. It is an error to use this form if the selection is not in the spinbox window. .TP 12 \fB@\fInumber\fR +. In this form, \fInumber\fR is treated as an x-coordinate in the spinbox's window; the character spanning that x-coordinate is used. For example, @@ -385,12 +392,14 @@ two forms, depending on \fIoption\fR: .RS .TP \fIpathName \fBscan mark \fIx\fR +. Records \fIx\fR and the current view in the spinbox window; used in conjunction with later \fBscan dragto\fR commands. Typically this command is associated with a mouse button press in the widget. It returns an empty string. .TP \fIpathName \fBscan dragto \fIx\fR +. This command computes the difference between its \fIx\fR argument and the \fIx\fR argument to the last \fBscan mark\fR command for the widget. It then adjusts the view left or right by 10 times the diff --git a/doc/sysnotify.n b/doc/sysnotify.n index ea126b4..a80f316 100644 --- a/doc/sysnotify.n +++ b/doc/sysnotify.n @@ -7,6 +7,7 @@ '\" .TH tk sysnotify n "" Tk "Tk Built-In Commands" .so man.macros +.BS .SH NAME sysnotify \- Creates a notification window with a title and message. .SH SYNOPSIS diff --git a/doc/systray.n b/doc/systray.n index c215c29..44f5fda 100644 --- a/doc/systray.n +++ b/doc/systray.n @@ -7,17 +7,16 @@ '\" .TH tk systray n "" Tk "Tk Built-In Commands" .so man.macros +.BS .SH NAME systray \- Creates an icon display in the platform-specific system tray. .SH SYNOPSIS -\fBtk systray create \fI\-image image\fR \fI?\-text text\fR? \fI?\-button1 callback?\fR \fI?\-button3 callback?\fR -.sp +.nf +\fBtk systray create \fB\-image \fIimage\fR ?\fB\-text \fItext\fR? ?\fB\-button1 \fIcallback\fR? ?\fB\-button3 \fIcallback\fR? \fBtk systray configure \fI?option? ?value option value ...?\fR -.sp \fBtk systray exists\fR -.sp \fBtk systray destroy\fR -.BE +.fi .BE .SH DESCRIPTION .PP diff --git a/doc/text.n b/doc/text.n index bd1f029..088b524 100644 --- a/doc/text.n +++ b/doc/text.n @@ -17,6 +17,7 @@ text, tk_textCopy, tk_textCut, tk_textPaste \- Create and manipulate 'text' hype \fBtk_textCopy\fI pathName\fR \fBtk_textCut\fI pathName\fR \fBtk_textPaste\fI pathName\fR +.fi .SO \-background \-highlightthickness \-relief \-borderwidth \-insertbackground \-selectbackground @@ -415,11 +416,13 @@ individual tags using the widget command. If a character has been tagged, then the display options associated with the tag override the default display style. The following options are currently supported for tags: +.\" OPTION: -background .TP \fB\-background \fIcolor\fR . \fIColor\fR specifies the background color to use for characters associated with the tag. It may have any of the forms accepted by \fBTk_GetColor\fR. +.\" OPTION: -bgstipple .TP \fB\-bgstipple \fIbitmap\fR . @@ -427,18 +430,21 @@ with the tag. It may have any of the forms accepted by \fBTk_GetColor\fR. background. It may have any of the forms accepted by \fBTk_GetBitmap\fR. If \fIbitmap\fR has not been specified, or if it is specified as an empty string, then a solid fill will be used for the background. +.\" OPTION: -borderwidth .TP \fB\-borderwidth \fIpixels\fR . \fIPixels\fR specifies the width of a border to draw around the tag using any of the forms accepted by \fBTk_GetPixels\fR. This option should be used in conjunction with the \fB\-relief\fR option to provide the desired border. +.\" OPTION: -elide .TP \fB\-elide \fIboolean\fR . \fIElide\fR specifies whether the data should be elided. Elided data (characters, images, embedded windows, etc.) is not displayed and takes no space on screen, but further on behaves just as normal data. +.\" OPTION: -fgstipple .TP \fB\-fgstipple \fIbitmap\fR . @@ -447,17 +453,20 @@ text and other foreground information such as underlines. It may have any of the forms accepted by \fBTk_GetBitmap\fR. If \fIbitmap\fR has not been specified, or if it is specified as an empty string, then a solid fill will be used. +.\" OPTION: -font .TP \fB\-font \fIfontName\fR . \fIFontName\fR is the name of a font to use for drawing characters. It may have any of the forms accepted by \fBTk_GetFont\fR. +.\" OPTION: -foreground .TP \fB\-foreground \fIcolor\fR . \fIColor\fR specifies the color to use when drawing text and other foreground information such as underlines. It may have any of the forms accepted by \fBTk_GetColor\fR. +.\" OPTION: -justify .TP \fB\-justify \fIjustify\fR . @@ -466,6 +475,7 @@ option has been specified, then \fIjustify\fR determines how to justify the line. It must be one of \fBleft\fR, \fBright\fR, or \fBcenter\fR. If a line wraps, then the justification for each line on the display is determined by the first non-elided character of that display line. +.\" OPTION: -lmargin1 .TP \fB\-lmargin1 \fIpixels\fR . @@ -475,6 +485,7 @@ should be indented from the left edge of the window. \fIPixels\fR may have any of the standard forms for screen distances. If a line of text wraps, this option only applies to the first line on the display; the \fB\-lmargin2\fR option controls the indentation for subsequent lines. +.\" OPTION: -lmargin2 .TP \fB\-lmargin2 \fIpixels\fR . @@ -485,6 +496,7 @@ much the line should be indented from the left edge of the window. \fIPixels\fR may have any of the standard forms for screen distances. This option is only used when wrapping is enabled, and it only applies to the second and later display lines for a text line. +.\" OPTION: -lmargincolor .TP \fB\-lmargincolor \fIcolor\fR . @@ -495,6 +507,7 @@ contain characters because they are indented by \fB\-lmargin1\fR or specified as an empty string, then the color used is specified by the \fB\-background\fR tag option (or, if this is also unspecified, by the \fB\-background\fR widget option). +.\" OPTION: -offset .TP \fB\-offset \fIpixels\fR . @@ -503,12 +516,14 @@ vertically from the baseline of the overall line, in pixels. For example, a positive offset can be used for superscripts and a negative offset can be used for subscripts. \fIPixels\fR may have any of the standard forms for screen distances. +.\" OPTION: -overstrike .TP \fB\-overstrike \fIboolean\fR . Specifies whether or not to draw a horizontal rule through the middle of characters. \fIBoolean\fR may have any of the forms accepted by \fBTcl_GetBoolean\fR. +.\" OPTION: -overstrikefg .TP \fB\-overstrikefg \fIcolor\fR . @@ -516,6 +531,7 @@ characters. \fIBoolean\fR may have any of the forms accepted by have any of the forms accepted by \fBTk_GetColor\fR. If \fIcolor\fR has not been specified, or if it is specified as an empty string, then the color specified by the \fB\-foreground\fR tag option is used. +.\" OPTION: -relief .TP \fB\-relief \fIrelief\fR . @@ -523,6 +539,7 @@ specified by the \fB\-foreground\fR tag option is used. of the forms accepted by \fBTk_GetRelief\fR. This option is used in conjunction with the \fB\-borderwidth\fR option to enable to the desired border appearance. +.\" OPTION: -rmargin .TP \fB\-rmargin \fIpixels\fR . @@ -533,6 +550,7 @@ leave between the end of the line and the right edge of the window. option is only used when wrapping is enabled. If a text line wraps, the right margin for each line on the display is determined by the first non-elided character of that display line. +.\" OPTION: -rmargincolor .TP \fB\-rmargincolor \fIcolor\fR . @@ -542,38 +560,46 @@ have any of the forms accepted by \fBTk_GetColor\fR. If \fIcolor\fR has not been specified, or if it is specified as an empty string, then the color used is specified by the \fB\-background\fR tag option (or, if this is also unspecified, by the \fB\-background\fR widget option). +.\" OPTION: -selectbackground .TP \fB\-selectbackground \fIcolor\fR +. \fIColor\fR specifies the background color to use when displaying selected items. It may have any of the forms accepted by \fBTk_GetColor\fR. If \fIcolor\fR has not been specified, or if it is specified as an empty string, then the color specified by the \fB\-background\fR tag option is used. +.\" OPTION: -selectforeground .TP \fB\-selectforeground \fIcolor\fR +. \fIColor\fR specifies the foreground color to use when displaying selected items. It may have any of the forms accepted by \fBTk_GetColor\fR. If \fIcolor\fR has not been specified, or if it is specified as an empty string, then the color specified by the \fB\-foreground\fR tag option is used. +.\" OPTION: -spacing1 .TP \fB\-spacing1 \fIpixels\fR . \fIPixels\fR specifies how much additional space should be left above each text line, using any of the standard forms for screen distances. If a line wraps, this option only applies to the first line on the display. +.\" OPTION: -spacing2 .TP \fB\-spacing2 \fIpixels\fR . For lines that wrap, this option specifies how much additional space to leave between the display lines for a single text line. \fIPixels\fR may have any of the standard forms for screen distances. +.\" OPTION: -spacing3 .TP \fB\-spacing3 \fIpixels\fR . \fIPixels\fR specifies how much additional space should be left below each text line, using any of the standard forms for screen distances. If a line wraps, this option only applies to the last line on the display. +.\" OPTION: -tabs .TP \fB\-tabs \fItabList\fR . @@ -585,6 +611,7 @@ unspecified for the tag (the default). If the option is specified as a non-empty string that is an empty list, such as \fB\-tags\0{\0}\fR, then it requests default 8-character tabs as described for the \fB\-tags\fR widget option. +.\" OPTION: -tabstyle .TP \fB\-tabstyle \fIstyle\fR . @@ -593,11 +620,13 @@ tabbing to use for the text widget. This option only applies to a display line if it applies to the first non-elided character on that display line. If this option is specified as an empty string, it cancels the option, leaving it unspecified for the tag (the default). +.\" OPTION: -underline .TP \fB\-underline \fIboolean\fR . \fIBoolean\fR specifies whether or not to draw an underline underneath characters. It may have any of the forms accepted by \fBTcl_GetBoolean\fR. +.\" OPTION: -underlinefg .TP \fB\-underlinefg \fIcolor\fR . @@ -605,6 +634,7 @@ characters. It may have any of the forms accepted by \fBTcl_GetBoolean\fR. have any of the forms accepted by \fBTk_GetColor\fR. If \fIcolor\fR has not been specified, or if it is specified as an empty string, then the color specified by the \fB\-foreground\fR tag option is used. +.\" OPTION: -wrap .TP \fB\-wrap \fImode\fR . @@ -706,6 +736,7 @@ When an embedded window is added to a text widget with the \fIpathName associated with it. These options may be modified later with the \fIpathName \fBwindow configure\fR widget command. The following options are currently supported: +.\" OPTION: -align .TP \fB\-align \fIwhere\fR . @@ -716,6 +747,7 @@ line), \fBcenter\fR (center the window within the range of the line), \fBbottom\fR (align the bottom of the window with the bottom of the line's area), or \fBbaseline\fR (align the bottom of the window with the baseline of the line). +.\" OPTION: -create .TP \fB\-create \fIscript\fR . @@ -728,18 +760,21 @@ the name of that window as its result. Two substitutions will be performed in the parent text widget, and \fI%%\fR will be substituted by a single \fI%\fR. If the annotation's window should ever be deleted, \fIscript\fR will be evaluated again the next time the annotation is displayed. +.\" OPTION: -padx .TP \fB\-padx \fIpixels\fR . \fIPixels\fR specifies the amount of extra space to leave on each side of the embedded window. It may have any of the usual forms defined for a screen distance. +.\" OPTION: -pady .TP \fB\-pady \fIpixels\fR . \fIPixels\fR specifies the amount of extra space to leave on the top and on the bottom of the embedded window. It may have any of the usual forms defined for a screen distance. +.\" OPTION: -stretch .TP \fB\-stretch \fIboolean\fR . @@ -748,6 +783,7 @@ line in which it is displayed, this option can be used to specify whether the window should be stretched vertically to fill its line. If the \fB\-pady\fR option has been specified as well, then the requested padding will be retained even if the window is stretched. +.\" OPTION: -window .TP \fB\-window \fIpathName\fR . @@ -796,6 +832,7 @@ When an embedded image is added to a text widget with the \fIpathName \fBimage create\fR widget command, several configuration options may be associated with it. These options may be modified later with the \fIpathName \fBimage configure\fR widget command. The following options are currently supported: +.\" OPTION: -align .TP \fB\-align \fIwhere\fR . @@ -805,11 +842,13 @@ of the values \fBtop\fR (align the top of the image with the top of the line), \fBcenter\fR (center the image within the range of the line), \fBbottom\fR (align the bottom of the image with the bottom of the line's area), or \fBbaseline\fR (align the bottom of the image with the baseline of the line). +.\" OPTION: -image .TP \fB\-image \fIimage\fR . Specifies the name of the Tk image to display in the annotation. If \fIimage\fR is not a valid Tk image, then an error is returned. +.\" OPTION: -name .TP \fB\-name \fIImageName\fR . @@ -817,12 +856,14 @@ Specifies the name by which this image instance may be referenced in the text widget. If \fIImageName\fR is not supplied, then the name of the Tk image is used instead. If the \fIimageName\fR is already in use, \fI#nn\fR is appended to the end of the name as described above. +.\" OPTION: -padx .TP \fB\-padx \fIpixels\fR . \fIPixels\fR specifies the amount of extra space to leave on each side of the embedded image. It may have any of the usual forms defined for a screen distance. +.\" OPTION: -pady .TP \fB\-pady \fIpixels\fR . @@ -1250,11 +1291,13 @@ the text, mark name, tag name, image name, or window name. The \fIindex\fR information is the index of the start of the text, mark, tag transition, image or window. One or more of the following switches (or abbreviations thereof) may be specified to control the dump: +.\" OPTION: -all .TP \fB\-all\fR . Return information about all elements: text, marks, tags, images and windows. This is the default. +.\" OPTION: -command .TP \fB\-command \fIcommand\fR . @@ -1262,20 +1305,24 @@ Instead of returning the information as the result of the dump operation, invoke the \fIcommand\fR on each element of the text widget within the range. The command has three arguments appended to it before it is evaluated: the \fIkey\fR, \fIvalue\fR, and \fIindex\fR. +.\" OPTION: -image .TP \fB\-image\fR . Include information about images in the dump results. +.\" OPTION: -mark .TP \fB\-mark\fR . Include information about marks in the dump results. +.\" OPTION: -tag .TP \fB\-tag\fR . Include information about tag transitions in the dump results. Tag information is returned as \fBtagon\fR and \fBtagoff\fR elements that indicate the begin and end of each range of each tag, respectively. +.\" OPTION: -text .TP \fB\-text\fR . @@ -1284,6 +1331,7 @@ to the next element or the end of range indicated by \fIindex2\fR. A text element does not span newlines. A multi-line block of text that contains no marks or tag transitions will still be dumped as a set of text segments that each end with a newline. The newline is part of the value. +.\" OPTION: -window .TP \fB\-window\fR . @@ -1570,12 +1618,14 @@ first character in the match is returned as result; otherwise an empty string is returned. One or more of the following switches (or abbreviations thereof) may be specified to control the search: .RS +.\" OPTION: -forwards .TP \fB\-forwards\fR . The search will proceed forward through the text, finding the first matching range starting at or after the position given by \fIindex\fR. This is the default. +.\" OPTION: -backwards .TP \fB\-backwards\fR . @@ -1585,11 +1635,13 @@ allowed to be at \fIindex\fR). Note that, for a variety of reasons, backwards searches can be substantially slower than forwards searches (particularly when using \fB\-regexp\fR), so it is recommended that performance-critical code use forward searches. +.\" OPTION: -exact .TP \fB\-exact\fR . Use exact matching: the characters in the matching range must be identical to those in \fIpattern\fR. This is the default. +.\" OPTION: -regexp .TP \fB\-regexp\fR . @@ -1601,6 +1653,7 @@ details). The default matching automatically passes both the \fB\-nolinestop\fR is used), so that \fI^$\fR match beginning and end of line, and \fI.\fR, \fI[^\fR sequences will never match the newline character \fI\en\fR. +.\" OPTION: -nolinestop .TP \fB\-nolinestop\fR . @@ -1609,10 +1662,12 @@ This allows \fI.\fR and \fI[^\fR sequences to match the newline character details). This option is only meaningful if \fB\-regexp\fR is also given, and an error will be thrown otherwise. For example, to match the entire text, use .QW "\fIpathName \fBsearch \-nolinestop \-regexp\fR \N'34'.*\N'34' 1.0" . +.\" OPTION: -nocase .TP \fB\-nocase\fR . Ignore case differences between the pattern and the text. +.\" OPTION: -count .TP \fB\-count\fI varName\fR . @@ -1623,6 +1678,7 @@ or windows in the matching range (and there are no elided characters if \fB\-elide\fR is not given), this is equivalent to the number of characters matched. In either case, the range \fImatchIdx\fR to \fImatchIdx + $count chars\fR will return the entire matched text. +.\" OPTION: -all .TP \fB\-all\fR . @@ -1642,6 +1698,7 @@ will just match twice, once for each word, and matching against .QW ZooZooZoo will just match once. +.\" OPTION: -overlap .TP \fB\-overlap\fR . @@ -1659,6 +1716,7 @@ against .QW ZooZooZoo will now match twice. An error will be thrown if this switch is used without \fB\-all\fR. +.\" OPTION: -strictlimits .TP \fB\-strictlimits\fR . @@ -1666,10 +1724,12 @@ When performing any search, the normal behaviour is that the start and stop limits are checked with respect to the start of the matching text. With the \fB\-strictlimits\fR flag, the entire matching range must lie inside the start and stop limits specified for the match to be valid. +.\" OPTION: -elide .TP \fB\-elide\fR . Find elided (hidden) text as well. By default only displayed text is searched. +.\" OPTION: -- .TP \fB\-\|\-\fR . @@ -2285,7 +2345,7 @@ practice this is a rare problem, but it can occur, for example: .CS pack [\fBtext\fR .t] \&.t insert 1.0 "aaaa\enbbbb\encccc\enbbbb\enaaaa\en" -\&.t search \-regexp \-\- {(a+|b+\enc+\enb+)+\ena+} 1.0 +\&.t search -regexp -- {(a+|b+\enc+\enb+)+\ena+} 1.0 .CE will not find a match when one exists of 19 characters starting from the first .QW b . @@ -2301,7 +2361,7 @@ portions of the widget. For example: .CS pack [\fBtext\fR .t] \&.t insert 1.0 "aaaa\enbbbb\enbbbb\enbbbb\enbbbb\\n" -\&.t search \-regexp \-backward \-\- {b+\en|a+\en(b+\en)+} end +\&.t search -regexp -backward -- {b+\en|a+\en(b+\en)+} end .CE matches at .QW 5.0 diff --git a/doc/tk_mac.n b/doc/tk_mac.n index 9ea8f85..39be09c 100644 --- a/doc/tk_mac.n +++ b/doc/tk_mac.n @@ -44,6 +44,7 @@ The Aqua/Mac OS X application environment defines a number of additional events that applications should respond to. These events are mapped by Tk to calls to commands in the \fB::tk::mac\fR namespace; unless otherwise noted, if the command is absent, no action will be taken. +.\" COMMAND: DoScriptFile .TP \fB::tk::mac::DoScriptFile\fR . @@ -51,6 +52,7 @@ The default Apple Event handler for AEDoScriptHandler. This command executes a Tcl file when an AppleScript sends a .QW "do script" command to Wish with a file path as a parameter. +.\" COMMAND: DoScriptText .TP \fB::tk::mac::DoScriptText\fR . @@ -58,6 +60,7 @@ The default Apple Event handler for AEDoScriptHandler. This command executes Tcl code when an AppleScript sends a .QW "do script" command to Wish with Tcl code or a Tcl procedure as a parameter. +.\" COMMAND: ShowPreferences .TP \fB::tk::mac::ShowPreferences\fR . @@ -76,6 +79,7 @@ proc ::tk::mac::ShowPreferences {} { } .CE .RE +.\" COMMAND: OpenApplication .TP \fB::tk::mac::OpenApplication\fR . @@ -83,6 +87,7 @@ If a proc of this name is defined, this proc fill fire when your application is initially opened. It is the default Apple Event handler for kAEOpenApplication, .QW oapp . +.\" COMMAND: ReopenApplication .TP \fB::tk::mac::ReopenApplication\fR . @@ -105,6 +110,7 @@ proc ::tk::mac::ReopenApplication {} { } .CE .RE +.\" COMMAND: OpenDocument .TP \fB::tk::mac::OpenDocument \fIfile...\fR . @@ -123,6 +129,7 @@ proc ::tk::mac::OpenDocument {args} { } .CE .RE +.\" COMMAND: PrintDocument .TP \fB::tk::mac::PrintDocument \fIfile...\fR . @@ -131,6 +138,7 @@ kAEPrintDocuments, .QW pdoc , the Apple Event sent when your application is asked to print a document. It takes a single absolute file path as an argument. +.\" COMMAND: Quit .TP \fB::tk::mac::Quit\fR . @@ -141,17 +149,20 @@ the Apple Event sent when your application is asked to be quit, e.g. via the quit menu item in the application menu, the quit menu item in the Dock menu, or during a logout/restart/shutdown etc. If this is not defined, \fBexit\fR is called instead. +.\" COMMAND: OnHide .TP \fB::tk::mac::OnHide\fR . If defined, this is called when your application receives a kEventAppHidden event, e.g. via the hide menu item in the application or Dock menus. +.\" COMMAND: OnShow .TP \fB::tk::mac::OnShow\fR . If defined, this is called when your application receives a kEventAppShown event, e.g. via the show all menu item in the application menu, or by clicking the Dock icon of a hidden application. +.\" COMMAND: ShowHelp .TP \fB::tk::mac::ShowHelp\fR . @@ -161,6 +172,7 @@ platform-specific standard Help menu item performs the default Cocoa action of showing the Help Book configured in the application's Info.plist (or displaying an alert if no Help Book is set). +.\" COMMAND: PerformService .TP \fB::tk::mac::PerformService\fR . @@ -192,6 +204,7 @@ key in Wish's Info.plist file is currently set as .QW "Wish" ; if a developer changes the name of the Wish executable to something else, this key should be modified with the same name. +.\" COMMAND: LaunchURL .TP \fB::tk::mac::LaunchURL \fIURL...\fR . @@ -201,8 +214,8 @@ an RSS feed, rather than launching a default application to handle the URL, although it can defined as such. Wish includes a stub URL scheme of .QW foo:// -in the CFBundleURLSchemes key of its Info.plist file; this should be customized for the specific URL -scheme the developer wants to support. +in the CFBundleURLSchemes key of its Info.plist file; this should be +customized for the specific URL scheme the developer wants to support. .TP \fB::tk::mac::GetAppPath\fR . @@ -212,6 +225,7 @@ Returns the current applications's file path. .PP The Aqua/Mac OS X defines additional dialogs that applications should support. +.\" COMMAND: standardAboutPanel .TP \fB::tk::mac::standardAboutPanel\fR . @@ -230,22 +244,26 @@ procedure will be called instead of opening the standardAboutPanel. .PP There are a number of additional global configuration options that control the details of how Tk renders by default. +.\" COMMAND: useCompatibilityMetrics .TP \fB::tk::mac::useCompatibilityMetrics \fIboolean\fR . Preserves compatibility with older Tk/Aqua metrics; set to \fBfalse\fR for more native spacing. +.\" COMMAND: CGAntialiasLimit .TP \fB::tk::mac::CGAntialiasLimit \fIlimit\fR . Sets the antialiasing limit; lines thinner that \fIlimit\fR pixels will not be antialiased. Integer, set to 0 by default, making all lines be antialiased. +.\" COMMAND: antialiasedtext .TP \fB::tk::mac::antialiasedtext \fInumber\fR . Sets anti-aliased text. Controls text antialiasing, possible values for \fInumber\fR are -1 (default, use system default for text AA), 0 (no text AA), 1 (use text AA). +.\" COMMAND: useThemedToplevel .TP \fB::tk::mac::useThemedToplevel \fIboolean\fR . @@ -254,6 +272,7 @@ background. Equivalent to configuring the toplevel with .QW "\fB\-background systemWindowHeaderBackground\fR" , or to using a \fBttk::frame\fR. .SH "SUPPORT COMMANDS" +.\" COMMAND: iconBitmap .TP \fB::tk::mac::iconBitmap \fIname width height \-kind value\fR . @@ -275,26 +294,32 @@ NSImage url string .PP The \fIwidth\fR and \fIheight\fR arguments to \fBtk::mac::iconBitmap\fR define the dimensions of the image to create, and \fI\-kind\fR must be one of: +.\" OPTION: -file .TP \fB\-file\fR . icon of file at given path +.\" OPTION: -fileType .TP \fB\-fileType\fR . icon of given file type +.\" OPTION: -osType .TP \fB\-osType\fR . icon of given 4-char OSType file type +.\" OPTION: -systemType .TP \fB\-systemType\fR . icon for given IconServices 4-char OSType +.\" OPTION: -namedImage .TP \fB\-namedImage\fR . named NSImage for given name +.\" OPTION: -imageFile .TP \fB\-imageFile\fR . diff --git a/doc/tkerror.n b/doc/tkerror.n index 53cb0d1..b1e4b81 100644 --- a/doc/tkerror.n +++ b/doc/tkerror.n @@ -18,13 +18,15 @@ tkerror \- Command invoked to process background errors .PP Note: as of Tk 4.1 the \fBtkerror\fR command has been renamed to \fBbgerror\fR because the event loop (which is what usually invokes -it) is now part of Tcl. For backward compatibility +it) is now part of Tcl. Using the \fBtkerror\fR name is deprecated. +.PP +For backward compatibility the \fBbgerror\fR provided by the current Tk version still tries to call \fBtkerror\fR if there is one (or an auto loadable one), so old script defining that error handler should still work, but you should anyhow modify your scripts to use \fBbgerror\fR instead of \fBtkerror\fR because that support for the old name might vanish -in the near future. If that call fails, \fBbgerror\fR +in the future. If that call fails, \fBbgerror\fR posts a dialog showing the error and offering to see the stack trace to the user. If you want your own error management you should directly override \fBbgerror\fR instead of \fBtkerror\fR. diff --git a/doc/tkvars.n b/doc/tkvars.n index e211575..cd69906 100644 --- a/doc/tkvars.n +++ b/doc/tkvars.n @@ -16,6 +16,7 @@ geometry, tk_library, tk_patchLevel, tk::scalingPct, tk_strictMotif, tk::svgFmt, .PP The following Tcl variables are either set or used by Tk at various times in its execution: +.\" VARIABLE: tk_library .TP 15 \fBtk_library\fR . @@ -40,6 +41,7 @@ working directory. The variable can be modified by an application to switch to a different library. .RE +.\" VARIABLE: tk_patchLevel .TP \fBtk_patchLevel\fR . @@ -52,6 +54,7 @@ it uniquely identifies an official version of Tk. This value is normally the same as the result of .QW "\fBpackage require\fR \fBtk\fR" . .RE +.\" VARIABLE: scalingPct .TP \fBtk::scalingPct\fR . @@ -87,6 +90,7 @@ additional step, Tk synchronizes the scaling factor used to convert between physical units and pixels with the scaling percentage, with the aid of the \fBtk scaling\fR command. .RE +.\" VARIABLE: tk_strictMotif .TP \fBtk_strictMotif\fR . @@ -96,6 +100,7 @@ closely as possible to Motif look-and-feel standards. For example, active elements such as buttons and scrollbar sliders will not change color when the pointer passes over them. Modern applications should not normally set this variable. +.\" VARIABLE: svgFmt .TP \fBtk::svgFmt\fR . @@ -119,6 +124,7 @@ read-only! Note also that whenever the scaling factor used to convert between physical units and pixels is changed via \fBtk scaling\fR, the value of the variable \fBtk::svgFmt\fR is automatically updated. .RE +.\" VARIABLE: tk_version .TP \fBtk_version\fR . @@ -134,6 +140,7 @@ major version number changes. .SS "INTERNAL AND DEBUGGING VARIABLES" .PP These variables should not normally be set by user code. +.\" VARIABLE: Priv .TP \fBtk::Priv\fR . @@ -141,6 +148,8 @@ This variable is an array containing several pieces of information that are private to Tk. The elements of \fBtk::Priv\fR are used by Tk library procedures and default bindings. They should not be accessed by any code outside Tk. +.\" VARIABLE: tk_textRedraw +.\" VARIABLE: tk_textRelayout .TP \fBtk_textRedraw\fR .TP @@ -154,6 +163,7 @@ used by Tk's test suite. The following variables are only guaranteed to exist in \fBwish\fR executables; the Tk library does not define them itself but many Tk environments do. +.\" VARIABLE: geometry .TP \fBgeometry\fR . diff --git a/doc/tkwait.n b/doc/tkwait.n index 42d5ea6..958d4f3 100644 --- a/doc/tkwait.n +++ b/doc/tkwait.n @@ -12,11 +12,11 @@ .SH NAME tkwait \- Wait for variable to change or window to be destroyed .SH SYNOPSIS +.nf \fBtkwait variable \fIname\fR -.sp \fBtkwait visibility \fIname\fR -.sp \fBtkwait window \fIname\fR +.fi .BE .SH DESCRIPTION .PP diff --git a/doc/ttk_Geometry.3 b/doc/ttk_Geometry.3 index 0f8a171..20295d1 100644 --- a/doc/ttk_Geometry.3 +++ b/doc/ttk_Geometry.3 @@ -100,7 +100,8 @@ A bitmask containing one or more of the bits \fBTTK_STICK_E\fR (east, or right), \fBTTK_STICK_N\fR (north, or top), and \fBTTK_STICK_S\fR (south, or bottom). -\fBTTK_FILL_X\fR is defined as a synonym for (\fBTTK_STICK_W\fR|\fBTTK_STICK_E\fR), +\fBTTK_FILL_X\fR is defined as a synonym for +(\fBTTK_STICK_W\fR|\fBTTK_STICK_E\fR), \fBTTK_FILL_Y\fR is a synonym for (\fBTTK_STICK_N\fR|\fBTTK_STICK_S\fR), and \fBTTK_FILL_BOTH\fR is a synonym for (\fBTTK_FILL_X\fR|\fBTTK_FILL_Y\fR). diff --git a/doc/ttk_button.n b/doc/ttk_button.n index cd54add..4c24a45 100644 --- a/doc/ttk_button.n +++ b/doc/ttk_button.n @@ -105,7 +105,7 @@ are: .RS \fB\-shiftrelief\fP specifies how far the button contents are shifted down and right in the \fIpressed\fP state. -This action provides additional skeumorphic feedback. +This action provides additional skeuomorphic feedback. .RE \fB\-width\fP \fIamount\fP .PP diff --git a/doc/ttk_entry.n b/doc/ttk_entry.n index 7f7b202..c4176ec 100644 --- a/doc/ttk_entry.n +++ b/doc/ttk_entry.n @@ -442,7 +442,8 @@ value is specified for \fB\-fieldbackground\fP. Otherwise it is ignored. .br \fB\-fieldbackground\fP \fIcolor\fP .RS -Some themes use a graphical background and their field background colors cannot be changed. +Some themes use a graphical background and their field background colors +cannot be changed. .RE \fB\-foreground\fP \fIcolor\fP .br diff --git a/doc/ttk_image.n b/doc/ttk_image.n index 8bc1b9e..09cf1f8 100644 --- a/doc/ttk_image.n +++ b/doc/ttk_image.n @@ -25,24 +25,30 @@ in a particular state or combination of states. .SH OPTIONS .PP Valid \fIoptions\fR are: +.\" OPTION: -border .TP \fB\-border\fI padding\fR +. \fIpadding\fR is a list of up to four integers, specifying the left, top, right, and bottom borders, respectively. If fewer than four elements are specified, \fIbottom\fR defaults to \fItop\fR, \fIright\fR defaults to \fIleft\fR, and \fItop\fR defaults to \fIleft\fR. -In other words, a list of three numbers specify the left, vertical, and right border; -a list of two numbers specify the horizontal and the vertical border; +In other words, a list of three numbers specify the left, vertical, and right +border; a list of two numbers specify the horizontal and the vertical border; a single number specifies the same border all the way around the element. See \fBIMAGE STRETCHING\fR, below. +.\" OPTION: -height .TP \fB\-height \fIheight\fR +. Specifies a minimum height for the element. If less than zero, the base image's height is used as a default. +.\" OPTION: -padding .TP \fB\-padding\fI padding\fR +. Specifies the element's interior padding. The padding is a list of up to four length specifications \fIleft top right bottom\fR. @@ -50,12 +56,14 @@ If fewer than four elements are specified, \fIbottom\fR defaults to \fItop\fR, \fIright\fR defaults to \fIleft\fR, and \fItop\fR defaults to \fIleft\fR. -In other words, a list of three numbers specify the left, vertical, and right padding; -a list of two numbers specify the horizontal and the vertical padding; +In other words, a list of three numbers specify the left, vertical, and right +padding; a list of two numbers specify the horizontal and the vertical padding; a single number specifies the same padding all the way around the widget. Defaults to \fB\-border\fR if not specified. +.\" OPTION: -sticky .TP \fB\-sticky\fI spec\fR +. Specifies how the image is placed within the final parcel. \fIspec\fR contains zero or more characters .QW n , @@ -63,8 +71,10 @@ Specifies how the image is placed within the final parcel. .QW w , or .QW e . +.\" OPTION: -width .TP \fB\-width \fIwidth\fR +. Specifies a minimum width for the element. If less than zero, the base image's width is used as a default. .SH "IMAGE STRETCHING" @@ -85,12 +95,12 @@ as a background image) should use \fB\-width 0\fR and \fB\-height 0\fR. .SH "EXAMPLE" .PP .CS -set img1 [image create photo \-file button.png] -set img2 [image create photo \-file button-pressed.png] -set img3 [image create photo \-file button-active.png] +set img1 [image create photo -file button.png] +set img2 [image create photo -file button-pressed.png] +set img3 [image create photo -file button-active.png] ttk::style element create Button.button image \e [list $img1 pressed $img2 active $img3] \e - \-border {2 4} \-sticky we + -border {2 4} -sticky we .CE .SH "SEE ALSO" ttk::intro(n), ttk::style(n), ttk_vsapi(n), image(n), photo(n) diff --git a/doc/ttk_intro.n b/doc/ttk_intro.n index c146dd1..783ebb6 100644 --- a/doc/ttk_intro.n +++ b/doc/ttk_intro.n @@ -83,10 +83,10 @@ For example, the layout for a horizontal scrollbar is: .PP .CS ttk::\fBstyle layout\fR Horizontal.TScrollbar { - Scrollbar.trough \-children { - Scrollbar.leftarrow \-side left \-sticky w - Scrollbar.rightarrow \-side right \-sticky e - Scrollbar.thumb \-sticky ew + Scrollbar.trough -children { + Scrollbar.leftarrow -side left -sticky w + Scrollbar.rightarrow -side right -sticky e + Scrollbar.thumb -sticky ew } } .CE @@ -151,9 +151,9 @@ For example: .PP .CS ttk::\fBstyle configure\fR TButton \e - \-background #d9d9d9 \e - \-foreground black \e - \-relief raised \e + -background #d9d9d9 \e + -foreground black \e + -relief raised \e ; .CE .PP @@ -165,9 +165,9 @@ for a particular style: .PP .CS ttk::\fBstyle map\fR TButton \e - \-background [list disabled #d9d9d9 active #ececec] \e - \-foreground [list disabled #a3a3a3] \e - \-relief [list {pressed !disabled} sunken] \e + -background [list disabled #d9d9d9 active #ececec] \e + -foreground [list disabled #a3a3a3] \e + -relief [list {pressed !disabled} sunken] \e ; .CE .SH "SEE ALSO" diff --git a/doc/ttk_notebook.n b/doc/ttk_notebook.n index f93f234..b7844a7 100644 --- a/doc/ttk_notebook.n +++ b/doc/ttk_notebook.n @@ -41,8 +41,8 @@ If fewer than four elements are specified, \fIbottom\fR defaults to \fItop\fR, \fIright\fR defaults to \fIleft\fR, and \fItop\fR defaults to \fIleft\fR. -In other words, a list of three numbers specify the left, vertical, and right padding; -a list of two numbers specify the horizontal and the vertical padding; +In other words, a list of three numbers specify the left, vertical, and right +padding; a list of two numbers specify the horizontal and the vertical padding; a single number specifies the same padding all the way around the widget. .OP \-width width Width If present and greater than zero, @@ -144,9 +144,11 @@ The following subcommands are supported: .RS .TP \fIpathname \fBidentify element\fI x y\fR +. Returns the name of the element at the specified location. .TP \fIpathname \fBidentify tab\fI x y\fR +. Returns the index of the tab at the specified location. .RE .\" METHOD: index @@ -219,8 +221,8 @@ virtual event after a new tab is selected. .SH "EXAMPLE" .CS pack [\fBttk::notebook\fR .nb] -\&.nb add [frame .nb.f1] \-text "First tab" -\&.nb add [frame .nb.f2] \-text "Second tab" +\&.nb add [frame .nb.f1] -text "First tab" +\&.nb add [frame .nb.f2] -text "Second tab" \&.nb select .nb.f2 ttk::notebook::enableTraversal .nb .CE diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n index adf92bb..695f668 100644 --- a/doc/ttk_panedwindow.n +++ b/doc/ttk_panedwindow.n @@ -77,9 +77,11 @@ The following subcommands are supported: .RS .TP \fIpathname \fBidentify element \fIx y\fR +. Returns the name of the element at the specified location. .TP \fIpathname \fBidentify sash \fIx y\fR +. Returns the index of the sash at the specified location. .RE .\" METHOD: insert diff --git a/doc/ttk_sizegrip.n b/doc/ttk_sizegrip.n index 1f63821..050d0bf 100644 --- a/doc/ttk_sizegrip.n +++ b/doc/ttk_sizegrip.n @@ -37,14 +37,14 @@ the built-in grip will just mask the widget. .PP Using pack: .CS -pack [ttk::frame $top.statusbar] \-side bottom \-fill x -pack [\fBttk::sizegrip\fR $top.statusbar.grip] \-side right \-anchor se +pack [ttk::frame $top.statusbar] -side bottom -fill x +pack [\fBttk::sizegrip\fR $top.statusbar.grip] -side right -anchor se .CE .PP Using grid: .CS grid [\fBttk::sizegrip\fR $top.statusbar.grip] \e - \-row $lastRow \-column $lastColumn \-sticky se + -row $lastRow -column $lastColumn -sticky se # ... optional: add vertical scrollbar in $lastColumn, # ... optional: add horizontal scrollbar in $lastRow .CE diff --git a/doc/ttk_spinbox.n b/doc/ttk_spinbox.n index 3b038f0..c976095 100644 --- a/doc/ttk_spinbox.n +++ b/doc/ttk_spinbox.n @@ -36,15 +36,15 @@ when using the \fB\-from\fR and \fB\-to\fR range. This must be a format specifier of the form \fB%.f\fR, as it will format a floating-point number. .OP \-from from From -A floating\-point value specifying the lowest value for the spinbox. This is +A floating-point value specifying the lowest value for the spinbox. This is used in conjunction with \fB\-to\fR and \fB\-increment\fR to set a numerical range. .OP \-increment increment Increment -A floating\-point value specifying the change in value to be applied each +A floating-point value specifying the change in value to be applied each time one of the widget spin buttons is pressed. The up button applies a positive increment, the down button applies a negative increment. .OP \-to to To -A floating\-point value specifying the highest permissible value for the +A floating-point value specifying the highest permissible value for the widget. See also \fB\-from\fR and \fB\-increment\fR. range. .OP \-values values Values diff --git a/doc/ttk_style.n b/doc/ttk_style.n index dcd5567..85d6a06 100644 --- a/doc/ttk_style.n +++ b/doc/ttk_style.n @@ -148,17 +148,24 @@ Valid options are: .\" -border should remain undocumented for now (dubious usefulness) .\" .TP .\" \fB\-border\fI boolean\fR +.\" . .\" Specifies whether the element is drawn after its children. Defaults to 0. +.\" OPTION: -children .TP \fB\-children { \fIsublayout...\fB }\fR +. Specifies a list of elements to place inside the element. +.\" OPTION: -expand .TP \fB\-expand\fI boolean\fR +. Specifies whether the allocated parcel is the entire cavity. If so, simultaneous specification of \fB\-side\fR is ignored. Defaults to 0. +.\" OPTION: -side .TP \fB\-side \fIside\fR +. Specifies which side of the cavity to place the element; one of \fBleft\fR, \fBright\fR, \fBtop\fR, or \fBbottom\fR. For instance, \fB\-side top\fR allocates the parcel along the top of @@ -166,24 +173,27 @@ the cavity having width and height respectively the width of the cavity and the height of the element. If omitted, the allocated parcel is the entire cavity (same effect as \fB\-expand\fR 1). +.\" OPTION: -sticky .TP \fB\-sticky\fR \fB[\fInswe\fB]\fR +. Specifies the actual parcel position and size inside the allocated parcel. If specified as an empty string then the actual parcel is centered in the allocated parcel. Default is \fBnswe\fR. .\" -unit should remain undocumented for now (dubious usefulness) .\" .TP .\" \fB\-unit\fI boolean\fR +.\" . .\" Specifies whether the element propagates its state to its children. .\" Defaults to 0. .PP For example: .CS ttk::style layout Horizontal.TScrollbar { - Scrollbar.trough \-children { - Scrollbar.leftarrow \-side left - Scrollbar.rightarrow \-side right - Horizontal.Scrollbar.thumb \-side left \-sticky ew + Scrollbar.trough -children { + Scrollbar.leftarrow -side left + Scrollbar.rightarrow -side right + Horizontal.Scrollbar.thumb -side left -sticky ew } } .CE diff --git a/doc/ttk_treeview.n b/doc/ttk_treeview.n index d2ef877..8ff0091 100644 --- a/doc/ttk_treeview.n +++ b/doc/ttk_treeview.n @@ -62,7 +62,7 @@ If set to \fB#all\fP (the default), all columns are shown in the order given. .OP \-height height Height Specifies the number of rows which should be visible. -Note: +Note that the requested width is determined from the sum of the column widths. .OP \-selectmode selectMode SelectMode Controls how the built-in class bindings manage the selection. @@ -95,13 +95,13 @@ even if \fB\-show tree\fR is not specified. .RE .OP \-striped striped Striped Boolean specifying zebra striped item coloring. -Note: -Striped items uses the \fB\-stripedbackground\fR option if set by the theme or a tag. -If not supported by the current theme, it will not show. +Note that +striped items uses the \fB\-stripedbackground\fR option if set by the theme or +a tag. If not supported by the current theme, it will not show. .OP \-titlecolumns titleColumns TitleColumns -Number of display columns at the left that should not be scrolled. The tree column counts, even -if \fB\-show tree\fR is not specified. Thus for value N of this option, column #N is -the first one that is scrollable. Default is 0. +Number of display columns at the left that should not be scrolled. The tree +column counts, even if \fB\-show tree\fR is not specified. Thus for value N of +this option, column #N is the first one that is scrollable. Default is 0. .OP \-titleitems titleItems TitleItems Number of items at the top that should not be vertically scrolled. Default is 0. .SH "WIDGET COMMAND" @@ -116,14 +116,13 @@ treeview widgets support the following additional commands: \fIpathname \fBbbox \fIitem\fR ?\fIcolumn\fR? . Returns the bounding box (relative to the treeview widget's window) -of the specified \fIitem\fR -in the form \fIx y width height\fR. +of the specified \fIitem\fR in the form \fIx y width height\fR. If the \fIitem\fR is not visible -(i.e., if it is a descendant of a closed item or is vertically scrolled offscreen), -returns the empty list. -If \fIcolumn\fR is specified and is not hidden (by the \fB\-displaycolumns\fR option), -returns the bounding box of that cell within \fIitem\fR (even if the cell -is horizontally scrolled offscreen). +(i.e., if it is a descendant of a closed item or is vertically scrolled +offscreen), returns the empty list. +If \fIcolumn\fR is specified and is not hidden (by the \fB\-displaycolumns\fR +option), returns the bounding box of that cell within \fIitem\fR +(even if the cell is horizontally scrolled offscreen). .\" METHOD: cellselection .TP \fIpathname \fBcellselection\fR ?\fIselop arg ...\fR? @@ -197,6 +196,7 @@ returns the value of that option. Otherwise, the options are updated with the specified values. The following options may be set on each column: .RS +.\" OPTION: -id .TP \fB\-id \fIname\fR . @@ -204,6 +204,7 @@ The column name. This is a read-only option. For example, [\fI$pathname \fBcolumn #\fIn \fB\-id\fR] returns the data column associated with display column \fIn\fR. The tree column has \fB\-id #0\fR. +.\" OPTION: -anchor .TP \fB\-anchor \fIanchor\fR . @@ -211,6 +212,7 @@ Specifies how the text in this column should be aligned with respect to the cell. \fIAnchor\fR is one of \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR, \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR. +.\" OPTION: -minwidth .TP \fB\-minwidth \fIminwidth\fR . @@ -218,11 +220,13 @@ The minimum width of the column in pixels. The treeview widget will not make the column any smaller than \fB\-minwidth\fR when the widget is resized or the user drags a heading column separator. Default is 20 pixels. +.\" OPTION: -separator .TP \fB\-separator \fIboolean\fR . Specifies whether or not a column separator should be drawn to the right of the column. Default is false. +.\" OPTION: -stretch .TP \fB\-stretch \fIboolean\fR . @@ -230,6 +234,7 @@ Specifies whether or not the column width should be adjusted when the widget is resized or the user drags a heading column separator. \fIBoolean\fR may have any of the forms accepted by \fBTcl_GetBoolean\fR. By default columns are stretchable. +.\" OPTION: -width .TP \fB\-width \fIwidth\fR . @@ -287,19 +292,23 @@ Otherwise, returns the current focus item, or \fB{}\fR if there is none. Query or modify the heading options for the specified \fIcolumn\fR. Valid options are: .RS +.\" OPTION: -text .TP \fB\-text \fItext\fR . The text to display in the column heading. +.\" OPTION: -image .TP \fB\-image \fIimageName\fR . Specifies an image to display to the right of the column heading. +.\" OPTION: -anchor .TP \fB\-anchor \fIanchor\fR . Specifies how the heading text should be aligned. One of the standard Tk anchor values. +.\" OPTION: -command .TP \fB\-command \fIscript\fR . @@ -511,7 +520,7 @@ The binding \fIscript\fR undergoes \fB%\fR-substitutions before evaluation; see \fBbind\fR(n) for details. .RE .TP -\fIpathName \fBtag cell \fIsubcmd...\fR +\fIpathName \fBtag cell \fIsubcommand...\fR . Manages tags on individual cells. A \fIcellList\fR argument may be a single cell or a list of cells. @@ -550,8 +559,8 @@ See \fBTAG OPTIONS\fR for the list of available options. .TP \fIpathName \fBtag delete \fItagName\fR . -Deletes all tag information for the \fItagName\fR argument. The -command removes the tag from all items and cells in the widget and also deletes any +Deletes all tag information for the \fItagName\fR argument. The command +removes the tag from all items and cells in the widget and also deletes any other information associated with the tag, such as bindings and display information. The command returns an empty string. .TP @@ -582,10 +591,11 @@ The textual label to display for the item in the tree column. .IP \fB\-height\fR The height for the item, in integer multiples of \fB\-rowheight\fP. Default is 1. .IP \fB\-image\fR -A Tk image, displayed next to the label in the tree column, placed according to \fB\-imageanchor\fR. +A Tk image, displayed next to the label in the tree column, placed according +to \fB\-imageanchor\fR. .IP \fB\-imageanchor\fR -Specifies how the \fB\-image\fR is displayed relative to the text. Default is \fBw\fR. -One of the standard Tk anchor values. +Specifies how the \fB\-image\fR is displayed relative to the text. +Default is \fBw\fR. One of the standard Tk anchor values. .IP \fB\-values\fR The list of values associated with the item. .RS @@ -622,17 +632,19 @@ Specifies the cell or item image anchor. .IP \fB\-padding\fR Specifies the cell padding. A data cell will have a default padding of {4 0} .IP \fB\-stripedbackground\fR -Specifies the cell or item background color for alternate lines, if \fB\-striped\fR is true. +Specifies the cell or item background color for alternate lines, +if \fB\-striped\fR is true. .PP .\" .PP .\" \fI(@@@ TODO: sort out order of precedence for options)\fR .PP Tags on cells have precedence over tags on items. Then, tag priority is decided by the creation order: tags created first receive higher priority. -An item's options, like \fB\-image\fR and \fB\-imageanchor\fR, have priority over tags. +An item's options, like \fB\-image\fR and \fB\-imageanchor\fR, have priority +over tags. .SH "IMAGES" -The -image option on an item, and on an item tag, controls the image next to the label -in the tree column. +The -image option on an item, and on an item tag, controls the image next to +the label in the tree column. Other cells can have images through the cell tag -image option. .SH "COLUMN IDENTIFIERS" .PP @@ -724,7 +736,7 @@ way to how the default value is set: .PP .CS ttk::style configure Treeview \\ - \-rowheight [expr {[font metrics \fIfont\fP \-linespace] + 2}] + -rowheight [expr {[font metrics \fIfont\fP -linespace] + 2}] .CE .br \fB\-stripedbackground\fP \fIcolor\fP diff --git a/doc/ttk_vsapi.n b/doc/ttk_vsapi.n index 52b18c9..4b7e3cc 100644 --- a/doc/ttk_vsapi.n +++ b/doc/ttk_vsapi.n @@ -28,6 +28,7 @@ Visual Styles API states (see \fBSTATE MAP\fR). .SH "OPTIONS" .PP Valid \fIoptions\fR are: +.\" OPTION: -padding .TP \fB\-padding \fIpadding\fR . @@ -38,10 +39,11 @@ If fewer than four elements are specified, \fIbottom\fR defaults to \fItop\fR, \fIright\fR defaults to \fIleft\fR, and \fItop\fR defaults to \fIleft\fR. -In other words, a list of three numbers specify the left, vertical, and right padding; -a list of two numbers specify the horizontal and the vertical padding; +In other words, a list of three numbers specify the left, vertical, and right +padding; a list of two numbers specify the horizontal and the vertical padding; a single number specifies the same padding all the way around the widget. This option may not be mixed with any other options. +.\" OPTION: -margins .TP \fB\-margins \fIpadding\fR . @@ -49,6 +51,7 @@ Specifies the elements exterior padding. \fIpadding\fR is a list of up to four integers specifying the left, top, right and bottom padding quantities respectively. This option may not be mixed with any other options. +.\" OPTION: -width .TP \fB\-width \fIwidth\fR . @@ -57,6 +60,7 @@ the Visual Styles API will not be queried for the recommended size or the part. If this option is set then \fB\-height\fR should also be set. The \fB\-width\fR and \fB\-height\fR options cannot be mixed with the \fB\-padding\fR or \fB\-margins\fR options. +.\" OPTION: -height .TP \fB\-height \fIheight\fR . diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n index e286eb0..03d45c1 100644 --- a/doc/ttk_widget.n +++ b/doc/ttk_widget.n @@ -125,12 +125,12 @@ If fewer than four elements are specified, \fIbottom\fR defaults to \fItop\fR, \fIright\fR defaults to \fIleft\fR, and \fItop\fR defaults to \fIleft\fR. -In other words, a list of three numbers specify the left, vertical, and right padding; -a list of two numbers specify the horizontal and the vertical padding; +In other words, a list of three numbers specify the left, vertical, and right +padding; a list of two numbers specify the horizontal and the vertical padding; a single number specifies the same padding all the way around the widget. .OP \-text text Text -Specifies a text string to be displayed inside the widget -(unless overridden by \fB\-textvariable\fR for the widgets supporting this option). +Specifies a text string to be displayed inside the widget (unless overridden +by \fB\-textvariable\fR for the widgets supporting this option). .OP \-textvariable textVariable Variable Specifies the name of a global variable whose value will be used in place of the \fB\-text\fR resource. @@ -337,9 +337,7 @@ If \fIwhat\fR is \fBunits\fR, the view adjusts up or down by .SH "WIDGET STATES" The widget state is a bitmap of independent state flags. Widget state flags include: -.TP -\fBactive\fR -. +.IP \fBactive\fR The mouse cursor is over the widget and pressing a mouse button will cause some action to occur. (aka .QW prelight @@ -347,60 +345,42 @@ and pressing a mouse button will cause some action to occur. (aka .QW hot (Windows), .QW hover ). -.TP -\fBdisabled\fR -. +.IP \fBdisabled\fR Widget is disabled under program control (aka .QW unavailable , .QW inactive ). -.TP -\fBfocus\fR -. +.IP \fBfocus\fR Widget has keyboard focus. -.TP -\fBpressed\fR -. +.IP \fBpressed\fR Widget is being pressed (aka .QW armed in Motif). -.TP -\fBselected\fR -. +.IP \fBselected\fR .QW On , .QW true , or .QW current for things like checkbuttons and radiobuttons. -.TP -\fBbackground\fR -. +.IP \fBbackground\fR Windows and the Mac have a notion of an .QW active or foreground window. The \fBbackground\fR state is set for widgets in a background window, and cleared for those in the foreground window. -.TP -\fBreadonly\fR -. +.IP \fBreadonly\fR Widget should not allow user modification. -.TP -\fBalternate\fR -. +.IP \fBalternate\fR A widget-specific alternate display format. For example, used for checkbuttons and radiobuttons in the .QW tristate or .QW mixed state, and for buttons with \fB\-default active\fR. -.TP -\fBinvalid\fR -. +.IP \fBinvalid\fR The widget's value is invalid. (Potential uses: scale widget value out of bounds, entry widget value failed validation.) -.TP -\fBhover\fR -. +.IP \fBhover\fR The mouse cursor is within the widget. This is similar to the \fBactive\fP state; it is used in some themes for widgets that diff --git a/doc/winfo.n b/doc/winfo.n index 136eaf7..e37e0a7 100644 --- a/doc/winfo.n +++ b/doc/winfo.n @@ -22,6 +22,7 @@ depending on the \fIoption\fR argument. The legal forms are: .\" METHOD: atom .TP \fBwinfo atom \fR?\fB\-displayof \fIwindow\fR? \fIname\fR +. Returns a decimal string giving the integer identifier for the atom whose name is \fIname\fR. If no atom exists with the name \fIname\fR then a new one is created. @@ -31,6 +32,7 @@ the display of the application's main window. .\" METHOD: atomname .TP \fBwinfo atomname \fR?\fB\-displayof \fIwindow\fR? \fIid\fR +. Returns the textual name for the atom whose integer identifier is \fIid\fR. If the \fB\-displayof\fR option is given then the identifier is looked @@ -41,11 +43,13 @@ It generates an error if no such atom exists. .\" METHOD: cells .TP \fBwinfo cells \fIwindow\fR +. Returns a decimal string giving the number of cells in the color map for \fIwindow\fR. .\" METHOD: children .TP \fBwinfo children \fIwindow\fR +. Returns a list containing the path names of all the children of \fIwindow\fR. Top-level windows are returned as children of their logical parents. The list is in stacking order, with @@ -55,10 +59,12 @@ command to query the stacking order of Top-level windows. .\" METHOD: class .TP \fBwinfo class \fIwindow\fR +. Returns the class name for \fIwindow\fR. .\" METHOD: colormapfull .TP \fBwinfo colormapfull \fIwindow\fR +. Returns 1 if the colormap for \fIwindow\fR is known to be full, 0 otherwise. The colormap for a window is .QW known @@ -69,6 +75,7 @@ failed allocation. .\" METHOD: containing .TP \fBwinfo containing \fR?\fB\-displayof \fIwindow\fR? \fIrootX rootY\fR +. Returns the path name for the window containing the point given by \fIrootX\fR and \fIrootY\fR. \fIRootX\fR and \fIrootY\fR are specified in screen units (i.e. @@ -89,16 +96,19 @@ chosen. .\" METHOD: depth .TP \fBwinfo depth \fIwindow\fR +. Returns a decimal string giving the depth of \fIwindow\fR (number of bits per pixel). .\" METHOD: exists .TP \fBwinfo exists \fIwindow\fR +. Returns 1 if there exists a window named \fIwindow\fR, 0 if no such window exists. .\" METHOD: fpixels .TP \fBwinfo fpixels \fIwindow number\fR +. Returns a floating-point value giving the number of pixels in \fIwindow\fR corresponding to the distance given by \fInumber\fR. \fINumber\fR may be specified in any of the forms acceptable @@ -111,12 +121,14 @@ The return value may be fractional; for an integer value, use .\" METHOD: geometry .TP \fBwinfo geometry \fIwindow\fR +. Returns the geometry for \fIwindow\fR, in the form \fIwidth\fBx\fIheight\fB+\fIx\fB+\fIy\fR. All dimensions are in pixels. .\" METHOD: height .TP \fBwinfo height \fIwindow\fR +. Returns a decimal string giving \fIwindow\fR's height in pixels. When a window is first created its height will be 1 pixel; the height will eventually be changed by a geometry manager to fulfil @@ -128,6 +140,7 @@ instead of its actual height. .\" METHOD: id .TP \fBwinfo id \fIwindow\fR +. 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 @@ -135,6 +148,7 @@ HWND. On the Macintosh the value has no meaning outside Tk. .\" METHOD: interps .TP \fBwinfo interps \fR?\fB\-displayof \fIwindow\fR? +. Returns a list whose members are the names of all Tcl interpreters (e.g. all Tk-based applications) currently registered for a particular display. If the \fB\-displayof\fR option is given then the return value refers @@ -143,6 +157,7 @@ the display of the application's main window. .\" METHOD: ismapped .TP \fBwinfo ismapped \fIwindow\fR +. Returns \fB1\fR if \fIwindow\fR is currently mapped, \fB0\fR otherwise. .\" METHOD: manager .TP @@ -158,17 +173,20 @@ name is the widget's class command, such as \fBcanvas\fR. .\" METHOD: name .TP \fBwinfo name \fIwindow\fR +. Returns \fIwindow\fR's name (i.e. its name within its parent, as opposed to its full path name). The command \fBwinfo name .\fR will return the name of the application. .\" METHOD: parent .TP \fBwinfo parent \fIwindow\fR +. Returns the path name of \fIwindow\fR's parent, or an empty string if \fIwindow\fR is the main window of the application. .\" METHOD: pathname .TP \fBwinfo pathname \fR?\fB\-displayof \fIwindow\fR? \fIid\fR +. Returns the path name of the window whose X identifier is \fIid\fR. \fIId\fR must be a decimal, hexadecimal, or octal integer and must correspond to a window in the invoking application. @@ -178,6 +196,7 @@ the display of the application's main window. .\" METHOD: pixels .TP \fBwinfo pixels \fIwindow number\fR +. Returns the number of pixels in \fIwindow\fR corresponding to the distance given by \fInumber\fR. \fINumber\fR may be specified in any of the forms acceptable @@ -190,6 +209,7 @@ fractional result, use \fBwinfo fpixels\fR. .\" METHOD: pointerx .TP \fBwinfo pointerx \fIwindow\fR +. If the mouse pointer is on the same screen as \fIwindow\fR, returns the pointer's x coordinate, measured in pixels in the screen's root window. If a virtual root window is in use on the screen, the position is @@ -199,6 +219,7 @@ If the mouse pointer is not on the same screen as \fIwindow\fR then .\" METHOD: pointerxy .TP \fBwinfo pointerxy \fIwindow\fR +. If the mouse pointer is on the same screen as \fIwindow\fR, returns a list with two elements, which are the pointer's x and y coordinates measured in pixels in the screen's root window. @@ -209,6 +230,7 @@ both of the returned coordinates are \-1. .\" METHOD: pointery .TP \fBwinfo pointery \fIwindow\fR +. If the mouse pointer is on the same screen as \fIwindow\fR, returns the pointer's y coordinate, measured in pixels in the screen's root window. If a virtual root window is in use on the screen, the position @@ -218,18 +240,21 @@ If the mouse pointer is not on the same screen as \fIwindow\fR then .\" METHOD: reqheight .TP \fBwinfo reqheight \fIwindow\fR +. Returns a decimal string giving \fIwindow\fR's requested height, in pixels. This is the value used by \fIwindow\fR's geometry manager to compute its geometry. .\" METHOD: reqwidth .TP \fBwinfo reqwidth \fIwindow\fR +. Returns a decimal string giving \fIwindow\fR's requested width, in pixels. This is the value used by \fIwindow\fR's geometry manager to compute its geometry. .\" METHOD: rgb .TP \fBwinfo rgb \fIwindow color\fR +. Returns a list containing three decimal values in the range 0 to 65535, which are the red, green, and blue intensities that correspond to \fIcolor\fR in @@ -239,6 +264,7 @@ option. .\" METHOD: rootx .TP \fBwinfo rootx \fIwindow\fR +. Returns a decimal string giving the x-coordinate, in the root window of the screen, of the upper-left corner of \fIwindow\fR's border (or \fIwindow\fR if it @@ -246,6 +272,7 @@ has no border). .\" METHOD: rooty .TP \fBwinfo rooty \fIwindow\fR +. Returns a decimal string giving the y-coordinate, in the root window of the screen, of the upper-left corner of \fIwindow\fR's border (or \fIwindow\fR if it @@ -253,36 +280,43 @@ has no border). .\" METHOD: screen .TP \fBwinfo screen \fIwindow\fR +. Returns the name of the screen associated with \fIwindow\fR, in the form \fIdisplayName\fR.\fIscreenIndex\fR. .\" METHOD: screencells .TP \fBwinfo screencells \fIwindow\fR +. Returns a decimal string giving the number of cells in the default color map for \fIwindow\fR's screen. .\" METHOD: screendepth .TP \fBwinfo screendepth \fIwindow\fR +. Returns a decimal string giving the depth of the root window of \fIwindow\fR's screen (number of bits per pixel). .\" METHOD: screenheight .TP \fBwinfo screenheight \fIwindow\fR +. Returns a decimal string giving the height of \fIwindow\fR's screen, in pixels. .\" METHOD: screenmmheight .TP \fBwinfo screenmmheight \fIwindow\fR +. Returns a decimal string giving the height of \fIwindow\fR's screen, in millimeters. .\" METHOD: screenmmwidth .TP \fBwinfo screenmmwidth \fIwindow\fR +. Returns a decimal string giving the width of \fIwindow\fR's screen, in millimeters. .\" METHOD: screenvisual .TP \fBwinfo screenvisual \fIwindow\fR +. Returns one of the following strings to indicate the default visual class for \fIwindow\fR's screen: \fBdirectcolor\fR, \fBgrayscale\fR, \fBpseudocolor\fR, \fBstaticcolor\fR, \fBstaticgray\fR, or @@ -290,11 +324,13 @@ class for \fIwindow\fR's screen: \fBdirectcolor\fR, \fBgrayscale\fR, .\" METHOD: screenwidth .TP \fBwinfo screenwidth \fIwindow\fR +. Returns a decimal string giving the width of \fIwindow\fR's screen, in pixels. .\" METHOD: server .TP \fBwinfo server \fIwindow\fR +. Returns a string containing information about the server for \fIwindow\fR's display. The exact format of this string may vary from platform to platform. For X servers the string @@ -307,18 +343,21 @@ is an integer release number provided by the server. .\" METHOD: toplevel .TP \fBwinfo toplevel \fIwindow\fR +. Returns the path name of the top-of-hierarchy window containing \fIwindow\fR. In standard Tk this will always be a \fBtoplevel\fR widget, but extensions may create other kinds of top-of-hierarchy widgets. .\" METHOD: viewable .TP \fBwinfo viewable \fIwindow\fR +. Returns 1 if \fIwindow\fR and all of its ancestors up through the nearest toplevel window are mapped. Returns 0 if any of these windows are not mapped. .\" METHOD: visual .TP \fBwinfo visual \fIwindow\fR +. Returns one of the following strings to indicate the visual class for \fIwindow\fR: \fBdirectcolor\fR, \fBgrayscale\fR, \fBpseudocolor\fR, \fBstaticcolor\fR, \fBstaticgray\fR, or @@ -326,10 +365,12 @@ class for \fIwindow\fR: \fBdirectcolor\fR, \fBgrayscale\fR, .\" METHOD: visualid .TP \fBwinfo visualid \fIwindow\fR +. Returns the X identifier for the visual for \fIwindow\fR. .\" METHOD: visualsavailable .TP \fBwinfo visualsavailable \fIwindow\fR ?\fBincludeids\fR? +. Returns a list whose elements describe the visuals available for \fIwindow\fR's screen. Each element consists of a visual class followed by an integer depth. @@ -340,16 +381,19 @@ depth is followed by the X identifier for the visual. .\" METHOD: vrootheight .TP \fBwinfo vrootheight \fIwindow\fR +. Returns the height of the virtual root window associated with \fIwindow\fR if there is one; otherwise returns the height of \fIwindow\fR's screen. .\" METHOD: vrootwidth .TP \fBwinfo vrootwidth \fIwindow\fR +. Returns the width of the virtual root window associated with \fIwindow\fR if there is one; otherwise returns the width of \fIwindow\fR's screen. .\" METHOD: vrootx .TP \fBwinfo vrootx \fIwindow\fR +. Returns the x-offset of the virtual root window associated with \fIwindow\fR, relative to the root window of its screen. This is normally either zero or negative. @@ -357,6 +401,7 @@ Returns 0 if there is no virtual root window for \fIwindow\fR. .\" METHOD: vrooty .TP \fBwinfo vrooty \fIwindow\fR +. Returns the y-offset of the virtual root window associated with \fIwindow\fR, relative to the root window of its screen. This is normally either zero or negative. @@ -364,6 +409,7 @@ Returns 0 if there is no virtual root window for \fIwindow\fR. .\" METHOD: width .TP \fBwinfo width \fIwindow\fR +. Returns a decimal string giving \fIwindow\fR's width in pixels. When a window is first created its width will be 1 pixel; the width will eventually be changed by a geometry manager to fulfil @@ -375,6 +421,7 @@ instead of its actual width. .\" METHOD: x .TP \fBwinfo x \fIwindow\fR +. Returns a decimal string giving the x-coordinate, in \fIwindow\fR's parent, of the upper-left corner of \fIwindow\fR's border (or \fIwindow\fR if it @@ -382,6 +429,7 @@ has no border). .\" METHOD: y .TP \fBwinfo y \fIwindow\fR +. Returns a decimal string giving the y-coordinate, in \fIwindow\fR's parent, of the upper-left corner of \fIwindow\fR's border (or \fIwindow\fR if it @@ -391,7 +439,7 @@ has no border). Print where the mouse pointer is and what window it is currently over: .CS lassign [\fBwinfo pointerxy\fR .] x y -puts \-nonewline "Mouse pointer at ($x,$y) which is " +puts -nonewline "Mouse pointer at ($x,$y) which is " set win [\fBwinfo containing\fR $x $y] if {$win eq ""} { puts "over no window" diff --git a/doc/wish.1 b/doc/wish.1 index 115911e..920c1f3 100644 --- a/doc/wish.1 +++ b/doc/wish.1 @@ -14,25 +14,32 @@ wish \- Simple windowing shell .SH SYNOPSIS \fBwish\fR ?\fB\-encoding \fIname\fR? ?\fIfileName arg ...\fR? .SH OPTIONS +.\" OPTION: -encoding .IP "\fB\-encoding \fIname\fR" 20 Specifies the encoding of the text stored in \fIfileName\fR. This option is only recognized prior to the \fIfileName\fR argument. +.\" OPTION: -colormap .IP "\fB\-colormap \fInew\fR" 20 Specifies that the window should have a new private colormap instead of using the default colormap for the screen. +.\" OPTION: -display .IP "\fB\-display \fIdisplay\fR" 20 Display (and screen) on which to display window. +.\" OPTION: -geometry .IP "\fB\-geometry \fIgeometry\fR" 20 Initial geometry to use for window. If this option is specified, its value is stored in the \fBgeometry\fR global variable of the application's Tcl interpreter. +.\" OPTION: -name .IP "\fB\-name \fIname\fR" 20 Use \fIname\fR as the title to be displayed in the window, and as the name of the interpreter for \fBsend\fR commands. +.\" OPTION: -sync .IP "\fB\-sync\fR" 20 Execute all X server commands synchronously, so that errors are reported immediately. This will result in much slower execution, but it is useful for debugging. +.\" OPTION: -use .IP "\fB\-use\fR \fIid\fR" 20 Specifies that the main window for the application is to be embedded in the window whose identifier is \fIid\fR, instead of being created as an @@ -44,10 +51,12 @@ Note that on some platforms this will only work correctly if \fIid\fR refers to a Tk \fBframe\fR or \fBtoplevel\fR that has its \fB\-container\fR option enabled. .RE +.\" OPTION: -visual .IP "\fB\-visual \fIvisual\fR" 20 Specifies the visual to use for the window. \fIVisual\fR may have any of the forms supported by the \fBTk_GetVisual\fR procedure. +.\" OPTION: -- .IP "\fB\-\|\-\fR" 20 Pass all remaining arguments through to the script's \fBargv\fR variable without interpreting them. @@ -117,30 +126,40 @@ file, is the same as its name except that the first letter is capitalized. .SH "VARIABLES" .PP -\fBWish\fR sets the following Tcl variables: +\fBWish\fR sets the following global Tcl variables: +.\" VARIABLE: argc .TP 15 \fBargc\fR +. Contains a count of the number of \fIarg\fR arguments (0 if none), not including the options described above. +.\" VARIABLE: argv .TP 15 \fBargv\fR +. Contains a Tcl list whose elements are the \fIarg\fR arguments that follow a \fB\-\|\-\fR option or do not match any of the options described in \fBOPTIONS\fR above, in order, or an empty string if there are no such arguments. +.\" VARIABLE: argv0 .TP 15 \fBargv0\fR +. Contains \fIfileName\fR if it was specified. Otherwise, contains the name by which \fBwish\fR was invoked. +.\" VARIABLE: geometry .TP 15 \fBgeometry\fR +. If the \fB\-geometry\fR option is specified, \fBwish\fR copies its value into this variable. If the variable still exists after \fIfileName\fR has been evaluated, \fBwish\fR uses the value of the variable in a \fBwm geometry\fR command to set the main window's geometry. +.\" VARIABLE: tcl_interactive .TP 15 \fBtcl_interactive\fR +. Contains 1 if \fBwish\fR is reading commands interactively (\fIfileName\fR was not specified and standard input is a terminal-like device), 0 otherwise. diff --git a/doc/wm.n b/doc/wm.n index ce5a4c5..5f76384 100644 --- a/doc/wm.n +++ b/doc/wm.n @@ -60,6 +60,7 @@ values are as follows: .PP All platforms support the following attributes (though X11 users should see the notes below): +.\" OPTION: -alpha .TP \fB\-alpha\fR . @@ -67,26 +68,31 @@ Specifies 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. Where not supported, the \fB\-alpha\fR value remains at \fB1.0\fR. +.\" OPTION: -fullscreen .TP \fB\-fullscreen\fR . Places the window in a mode that takes up the entire screen, has no borders, and covers the general use area (i.e. Start menu and taskbar on Windows, dock and menubar on OSX, general window decorations on X11). +.\" OPTION: -topmost .TP \fB\-topmost\fR . Specifies whether this is a topmost window (displays above all other windows). .PP On Windows, the following attributes may be set. +.\" OPTION: -disabled .TP \fB\-disabled\fR . Specifies whether the window is in a disabled state. +.\" OPTION: -toolwindow .TP \fB\-toolwindow\fR . Specifies a toolwindow style window (as defined in the MSDN). +.\" OPTION: -transparentcolor .TP \fB\-transparentcolor\fR . @@ -97,6 +103,7 @@ value accepted by \fBTk_GetColor\fR. If the empty string is specified at \fB{}\fR. .PP On MacOS, the following attributes may be set. +.\" OPTION: -appearance .TP \fB\-appearance\fR . @@ -104,6 +111,7 @@ Specifies whether the window is rendered in "dark mode". Allowed values are \fBauto\fR, \fBaqua\fR and \fBdarkaqua\fR. If the setting is auto then the appearance of the window is controlled by the System Settings. +.\" OPTION: -class .TP \fB\-class\fR . @@ -117,21 +125,25 @@ does not correspond to an existing window. Doing that causes the class name to be cached for later use. When a toplevel with that pathname is eventually created, the cached class name will determine which class is used for the underlying Aqua window. +.\" OPTION: -isdark .TP \fB\-isdark\fR . Returns a boolean value which is true if the window is currently in dark mode. +.\" OPTION: -modified .TP \fB\-modified\fR . Specifies the modification state of the window (determines whether the window close widget contains the modification indicator and whether the proxy icon is draggable). +.\" OPTION: -notify .TP \fB\-notify\fR . Specifies process notification state (bouncing of the application dock icon). +.\" OPTION: -stylemask .TP \fB\-stylemask\fR . @@ -145,6 +157,7 @@ bits will be set to 0. The allowed bitnames are: \fBtitled\fR, \fBnonactivatingpanel\fR, and \fBHUDwindow\fR. Note that a side effect of setting the fullsizecontentview bit is that the window title bar becomes transparent. +.\" OPTION: -tabbingid .TP \fB\-tabbingid\fR . @@ -158,6 +171,7 @@ a normal non-tabbed toplevel. It is allowed to set the tabbingid before the toplevel is created. If the pathname provided in the command does not correspond to a toplevel, the value will be cached and used later when the toplevel is actually created. +.\" OPTION: -tabbingmode .TP \fB\-tabbingmode\fR . @@ -171,11 +185,13 @@ Settings application. It is allowed to set the tabbingmode before the toplevel is created. If the pathname provided in the command does not correspond to a toplevel, the value will be cached and used later when the toplevel is actually created. +.\" OPTION: -titlepath .TP \fB\-titlepath\fR . Specifies the path of the file referenced as the window proxy icon (which can be dragged and dropped in lieu of the file's finder icon). +.\" OPTION: -transparent .TP \fB\-transparent\fR . @@ -187,6 +203,7 @@ color with some alpha, e.g. On X11, the following attributes may be set. These are not supported by all window managers, and will have no effect under older WMs. .\" See https://www.freedesktop.org/wiki/Specifications/wm-spec/ +.\" OPTION: -type .TP \fB\-type\fR .VS 8.6 @@ -197,76 +214,49 @@ entirely up to the window manager. A list of types may be used, in order of preference. The following values are mapped to constants defined in the EWMH specification (using others is possible, but not advised): .RS -.TP -\fBdesktop\fR -. +.IP \fBdesktop\fR indicates a desktop feature, -.TP -\fBdock\fR -. +.IP \fBdock\fR indicates a dock/panel feature, -.TP -\fBtoolbar\fR -. +.IP \fBtoolbar\fR indicates a toolbar window that should be acting on behalf of another window, as indicated with \fBwm transient\fR, -.TP -\fBmenu\fR -. +.IP \fBmenu\fR indicates a torn-off menu that should be acting on behalf of another window, as indicated with \fBwm transient\fR, -.TP -\fButility\fR -. +.IP \fButility\fR indicates a utility window (e.g., palette or toolbox) that should be acting on behalf of another window, as indicated with \fBwm transient\fR, -.TP -\fBsplash\fR -. +.IP \fBsplash\fR indicates a splash screen, displayed during application start up, -.TP -\fBdialog\fR -. +.IP \fBdialog\fR indicates a general dialog window, that should be acting on behalf of another window, as indicated with \fBwm transient\fR, -.TP -\fBdropdown_menu\fR -. +.IP \fBdropdown_menu\fR indicates a menu summoned from a menu bar, which should usually also be set to be override-redirected (with \fBwm overrideredirect\fR), -.TP -\fBpopup_menu\fR -. +.IP \fBpopup_menu\fR indicates a popup menu, which should usually also be set to be override-redirected (with \fBwm overrideredirect\fR), -.TP -\fBtooltip\fR -. +.IP \fBtooltip\fR indicates a tooltip window, which should usually also be set to be override-redirected (with \fBwm overrideredirect\fR), -.TP -\fBnotification\fR -. +.IP \fBnotification\fR indicates a window that provides a background notification of some event, which should usually also be set to be override-redirected (with \fBwm overrideredirect\fR), -.TP -\fBcombo\fR -. +.IP \fBcombo\fR indicates the drop-down list of a combobox widget, which should usually also be set to be override-redirected (with \fBwm overrideredirect\fR), -.TP -\fBdnd\fR -. +.IP \fBdnd\fR indicates a window that represents something being dragged, which should usually also be set to be override-redirected (with \fBwm overrideredirect\fR), -.TP -\fBnormal\fR -. +.IP \fBnormal\fR indicates a window that has no special interpretation. .RE .VE 8.6 +.\" OPTION: -zoomed .TP \fB\-zoomed\fR . @@ -466,7 +456,7 @@ four elements corresponding to the current \fIbaseWidth\fR, \fIwindow\fR is not currently gridded, then an empty string is returned. .PP -Note: this command should not be needed very often, since the +Note that this command should not be needed very often, since the \fBTk_SetGrid\fR library procedure and the \fBsetGrid\fR option provide easier access to the same functionality. .RE @@ -495,9 +485,9 @@ of the developer. .RS .PP On X11, for this command to work, -the variable \fB::tk::icons::base_icon($window)\fR must be set to the image that is -being used for the window icon of $window. On Windows and X11, the iconphoto -images work best at 32x32 or a similar dimension, as +the variable \fB::tk::icons::base_icon($window)\fR must be set to the image +that is being used for the window icon of $window. On Windows and X11, the +iconphoto images work best at 32x32 or a similar dimension, as the badge images are provided by Tk and drawn to overlay the icon images using native (Windows) API's or Tk rendering. On macOS, the icon badge is rendered by a system API and is not provided by Tk. The icon image itself @@ -508,7 +498,7 @@ The icon badge is intended for display in the Dock (macOS), taskbar displayed in the Dock, regardless of how many different icon badges may be assigned to different windows. On Windows, the taskbar display depends on whether the taskbar buttons are combined or not (this is an OS setting -available to the user): if combined the behavior is the same as on macOS, +available to the user): if combined, the behavior is the same as on macOS, otherwise each button in the taskbar shows the badge it was assigned. Badge display on macOS is configured in the system preferences. App panel display behavior on X11 will depend on the window manager and/or @@ -639,7 +629,8 @@ Button press events are disabled for \fIwindow\fR as long as it is an icon window; this is needed in order to allow window managers to .QW own those events. -Note: not all window managers support the notion of an icon window. +Note that not all window managers support the notion of an icon window, and +the concept is entirely meaningless on non-X11 platforms. .\" METHOD: manage .TP \fBwm manage \fIwidget\fR @@ -877,7 +868,7 @@ has never been mapped, then this command causes the window to be mapped in the withdrawn state. Not all window managers appear to know how to handle windows that are mapped in the withdrawn state. -Note: it sometimes seems to be necessary to withdraw a +Note that it sometimes seems to be necessary to withdraw a window and then re-map it (e.g. with \fBwm deiconify\fR) to get some window managers to pay attention to changes in window attributes such as group. @@ -975,10 +966,10 @@ A simple dialog-like window, centred on the screen: .CS # Create and arrange the dialog contents. toplevel .msg -label .msg.l \-text "This is a very simple dialog demo." -button .msg.ok \-text OK \-default active \-command {destroy .msg} -pack .msg.ok \-side bottom \-fill x -pack .msg.l \-expand 1 \-fill both +label .msg.l -text "This is a very simple dialog demo." +button .msg.ok -text OK -default active -command {destroy .msg} +pack .msg.ok -side bottom -fill x +pack .msg.l -expand 1 -fill both # Now set the widget up as a centred dialog. @@ -987,8 +978,8 @@ pack .msg.l \-expand 1 \-fill both # event loop with the widget hidden completely... \fBwm withdraw\fR .msg update -set x [expr {([winfo screenwidth .]\-[winfo width .msg])/2}] -set y [expr {([winfo screenheight .]\-[winfo height .msg])/2}] +set x [expr {([winfo screenwidth .] - [winfo width .msg]) / 2}] +set y [expr {([winfo screenheight .] - [winfo height .msg]) / 2}] \fBwm geometry\fR .msg +$x+$y \fBwm transient\fR .msg . \fBwm title\fR .msg "Dialog demo" @@ -997,7 +988,8 @@ set y [expr {([winfo screenheight .]\-[winfo height .msg])/2}] .SH "SEE ALSO" toplevel(n), winfo(n) .SH KEYWORDS -aspect ratio, deiconify, focus model, geometry, grid, group, icon, iconify, increments, position, size, title, top-level window, units, window manager +aspect ratio, deiconify, focus model, geometry, grid, group, icon, iconify, +increments, position, size, title, top-level window, units, window manager '\" Local Variables: '\" mode: nroff '\" End: -- cgit v0.12