From 82d2040671447e9314544a6d93f93a98ae969f8e Mon Sep 17 00:00:00 2001 From: "donal.k.fellows@manchester.ac.uk" Date: Wed, 24 Oct 2007 14:32:55 +0000 Subject: Lots of improvements to look and feel of manual pages --- ChangeLog | 5 +++ doc/3DBorder.3 | 6 ++- doc/ConfigWidg.3 | 38 ++++++++++++---- doc/CrtErrHdlr.3 | 7 ++- doc/CrtWindow.3 | 7 +-- doc/FontId.3 | 8 ++-- doc/GetAnchor.3 | 5 ++- doc/GetBitmap.3 | 5 ++- doc/GetCapStyl.3 | 12 +++-- doc/GetCursor.3 | 5 ++- doc/GetJoinStl.3 | 12 +++-- doc/GetJustify.3 | 14 +++--- doc/GetRelief.3 | 5 ++- doc/GetUid.3 | 5 ++- doc/GetVRoot.3 | 9 ++-- doc/GetVisual.3 | 7 +-- doc/InternAtom.3 | 5 ++- doc/Name.3 | 16 +++++-- doc/ParseArgv.3 | 29 ++++++++---- doc/RestrictEv.3 | 5 ++- doc/SetAppName.3 | 7 +-- doc/SetOptions.3 | 12 ++--- doc/StrictMotif.3 | 7 +-- doc/Tk_Main.3 | 5 ++- doc/bind.n | 43 +++++++++++------- doc/bindtags.n | 7 +-- doc/canvas.n | 51 ++++++++++++++------- doc/checkbutton.n | 38 +++++++++++----- doc/clipboard.n | 11 +++-- doc/destroy.n | 8 ++-- doc/entry.n | 26 +++++++---- doc/event.n | 7 +-- doc/focusNext.n | 6 ++- doc/font.n | 55 ++++++++++++++++------- doc/grab.n | 6 ++- doc/grid.n | 8 ++-- doc/listbox.n | 7 +-- doc/loadTk.n | 14 +++--- doc/menu.n | 18 +++++--- doc/message.n | 7 +-- doc/options.n | 35 ++++++++++----- doc/pack.n | 18 ++++---- doc/palette.n | 5 ++- doc/place.n | 9 ++-- doc/radiobutton.n | 4 +- doc/scale.n | 5 ++- doc/selection.n | 15 ++++--- doc/send.n | 8 ++-- doc/spinbox.n | 22 +++++---- doc/text.n | 79 +++++++++++++++++++++----------- doc/tk.n | 10 +++-- doc/ttk_button.n | 6 ++- doc/ttk_checkbutton.n | 9 ++-- doc/ttk_entry.n | 28 +++++++----- doc/ttk_radiobutton.n | 9 ++-- doc/ttk_sizegrip.n | 37 +++++++-------- doc/ttk_style.n | 121 ++++++++++++++++++++++++++------------------------ doc/ttk_treeview.n | 9 ++-- doc/ttk_widget.n | 59 +++++++++++++++--------- doc/winfo.n | 19 +++++--- doc/wish.1 | 25 ++++++++--- doc/wm.n | 35 ++++++++------- 62 files changed, 703 insertions(+), 412 deletions(-) diff --git a/ChangeLog b/ChangeLog index 12e15f0..2bf0afd 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2007-10-24 Donal K. Fellows + + * doc/*.n, doc/*.3, doc/*.1: Lots of changes to take advantage of the + new macros. + 2007-10-24 Pat Thoyts * win/tkWinDraw.c: Applied patch #1723362 for transparent bitmaps diff --git a/doc/3DBorder.3 b/doc/3DBorder.3 index 88829f2..aaea6e8 100644 --- a/doc/3DBorder.3 +++ b/doc/3DBorder.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: 3DBorder.3,v 1.7 2007/01/05 00:00:48 nijtmans Exp $ +'\" RCS: @(#) $Id: 3DBorder.3,v 1.8 2007/10/24 14:32:56 dkf Exp $ '\" .so man.macros .TH Tk_Alloc3DBorderFromObj 3 8.1 Tk "Tk Library Procedures" @@ -238,7 +238,9 @@ Each procedure takes \fIx\fR, \fIy\fR, \fIwidth\fR, and \fIheight\fR arguments that describe the rectangular area of the beveled edge (e.g., \fIwidth\fR is the border width for \fBTk_3DVerticalBevel\fR). The \fIleftBorder\fR and \fItopBorder\fR arguments indicate the -position of the border relative to the ``inside'' of the object, and +position of the border relative to the +.QW inside +of the object, and \fIrelief\fR indicates the relief of the inside of the object relative to the outside. \fBTk_3DVerticalBevel\fR just draws a rectangular region. diff --git a/doc/ConfigWidg.3 b/doc/ConfigWidg.3 index 4a1bcda..bb4c6cf 100644 --- a/doc/ConfigWidg.3 +++ b/doc/ConfigWidg.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ConfigWidg.3,v 1.16 2007/01/05 00:00:48 nijtmans Exp $ +'\" RCS: @(#) $Id: ConfigWidg.3,v 1.17 2007/10/24 14:32:56 dkf Exp $ '\" .so man.macros .TH Tk_ConfigureWidget 3 4.1 Tk "Tk Library Procedures" @@ -118,7 +118,10 @@ The \fItype\fR field indicates what type of configuration option this is (e.g. \fBTK_CONFIG_COLOR\fR for a color value, or \fBTK_CONFIG_INT\fR for an integer value). The \fItype\fR field indicates how to use the value of the option (more on this below). -The \fIargvName\fR field is a string such as ``\-font'' or ``\-bg'', +The \fIargvName\fR field is a string such as +.QW \-font +or +.QW \-bg , which is compared with the values in \fIargv\fR (if \fIargvName\fR is NULL it means this is a grouped entry; see GROUPED ENTRIES below). The \fIdbName\fR and \fIdbClass\fR fields are used to look up a value @@ -162,7 +165,8 @@ of each \fIspecs\fR entry indicates where in \fIwidgRec\fR to store the information about this configuration option. You should use the \fBTk_Offset\fR macro to generate \fIoffset\fR values (see below for a description of \fBTk_Offset\fR). The location indicated by -\fIwidgRec\fR and \fIoffset\fR will be referred to as the ``target'' +\fIwidgRec\fR and \fIoffset\fR will be referred to as the +.QW target in the descriptions below. .PP The \fItype\fR field of each entry in \fIspecs\fR determines what @@ -201,10 +205,20 @@ wasn't \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 ``true'', ``yes'', ``on'', or ``1'', +of the values +.QW true , +.QW yes , +.QW on , +or +.QW 1, or an abbreviation of one of these values, means true; -any of the values ``false'', ``no'', ``off'', or ``0'', or an abbreviation of -one of these values, means false. +any of the values +.QW false , +.QW no , +.QW off , +or +.QW 0 , +or an abbreviation of one of these values, means false. 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 @@ -269,8 +283,11 @@ wasn't NULL, then it is freed by passing it to \fBTk_FreeFont\fR. .TP \fBTK_CONFIG_INT\fR The value must be an ASCII integer string -in the format accepted by \fBstrtol\fR (e.g. ``0'' -and ``0x'' prefixes may be used to specify octal or hexadecimal +in the format accepted by \fBstrtol\fR (e.g. +.QW 0 +and +.QW 0x +prefixes may be used to specify octal or hexadecimal numbers, respectively). The string is converted to an integer value and the integer is stored in the target. .TP @@ -326,7 +343,10 @@ for another entry whose \fIargvName\fR is the same as the \fIdbName\fR field in the \fBTK_CONFIG_SYNONYM\fR entry; this new entry is used just as if its \fIargvName\fR had matched the \fIargv\fR value. The synonym mechanism allows multiple \fIargv\fR values to be used for -a single configuration option, such as ``\-background'' and ``\-bg''. +a single configuration option, such as +.QW \-background +and +.QW \-bg . .TP \fBTK_CONFIG_UID\fR The value is translated to a \fBTk_Uid\fR diff --git a/doc/CrtErrHdlr.3 b/doc/CrtErrHdlr.3 index 3cf7ba1..689bf7c 100644 --- a/doc/CrtErrHdlr.3 +++ b/doc/CrtErrHdlr.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtErrHdlr.3,v 1.3 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: CrtErrHdlr.3,v 1.4 2007/10/24 14:32:56 dkf Exp $ '\" .so man.macros .TH Tk_CreateErrorHandler 3 "" Tk "Tk Library Procedures" @@ -103,9 +103,8 @@ default error handler, which prints an error message and aborts the program. If you wish to have a default handler that deals with errors that no other handler can deal with, then declare it first. .PP -The X documentation states that ``the error handler should not call -any functions (directly or indirectly) on the display that will -generate protocol requests or that will look for input events.'' +The X documentation states that +.QW "the error handler should not call any functions (directly or indirectly) on the display that will generate protocol requests or that will look for input events." This restriction applies to handlers declared by \fBTk_CreateErrorHandler\fR; disobey it at your own risk. .PP diff --git a/doc/CrtWindow.3 b/doc/CrtWindow.3 index b938c2f..f5f65d6 100644 --- a/doc/CrtWindow.3 +++ b/doc/CrtWindow.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtWindow.3,v 1.8 2007/01/05 00:00:47 nijtmans Exp $ +'\" RCS: @(#) $Id: CrtWindow.3,v 1.9 2007/10/24 14:32:56 dkf Exp $ '\" .so man.macros .TH Tk_CreateWindow 3 4.2 Tk "Tk Library Procedures" @@ -43,8 +43,9 @@ the same \fIparent\fR. Has same format as \fIscreenName\fR. If NULL, then new window is created as an internal window. If non-NULL, new window is created as a top-level window on screen \fItopLevScreen\fR. If \fItopLevScreen\fR -is an empty string (``'') then new -window is created as top-level window of \fIparent\fR's screen. +is an empty string +.PQ "" +then new window is created as top-level window of \fIparent\fR's screen. .AP Tk_Window tkwin in Token for window. .AP "const char" *pathName in diff --git a/doc/FontId.3 b/doc/FontId.3 index c121963..bf01912 100644 --- a/doc/FontId.3 +++ b/doc/FontId.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: FontId.3,v 1.6 2005/04/22 21:32:23 georgeps Exp $ +'\" RCS: @(#) $Id: FontId.3,v 1.7 2007/10/24 14:32:56 dkf Exp $ '\" .so man.macros .TH Tk_FontId 3 8.0 Tk "Tk Library Procedures" @@ -56,8 +56,10 @@ ascent, descent, and linespace, used in font metrics. Postscript font name that should be used when printing. The return value is the size in points of the \fItkfont\fR and the Postscript font name is appended to \fIdsPtr\fR. \fIDsPtr\fR must refer to an initialized -\fBTcl_DString\fR. Given a ``reasonable'' Postscript printer, the -following screen font families should print correctly: +\fBTcl_DString\fR. Given a +.QW reasonable +Postscript printer, the following screen font families should print +correctly: .IP \fBAvant Garde\fR, \fBArial\fR, \fBBookman\fR, \fBCourier\fR, \fBCourier New\fR, \fBGeneva\fR, \fBHelvetica\fR, \fBMonaco\fR, diff --git a/doc/GetAnchor.3 b/doc/GetAnchor.3 index b52583f..469fc77 100644 --- a/doc/GetAnchor.3 +++ b/doc/GetAnchor.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetAnchor.3,v 1.6 2007/01/05 00:00:49 nijtmans Exp $ +'\" RCS: @(#) $Id: GetAnchor.3,v 1.7 2007/10/24 14:32:56 dkf Exp $ '\" .so man.macros .TH Tk_GetAnchorFromObj 3 8.1 Tk "Tk Library Procedures" @@ -74,7 +74,8 @@ return value, so \fBTk_GetAnchor\fR is less efficient than Given an anchor position such as \fBTK_ANCHOR_N\fR it returns a statically-allocated string corresponding to \fIanchor\fR. If \fIanchor\fR isn't a legal anchor value, then -``unknown anchor position'' is returned. +.QW "unknown anchor position" +is returned. .SH KEYWORDS anchor position diff --git a/doc/GetBitmap.3 b/doc/GetBitmap.3 index 9742785..f7c04b4 100644 --- a/doc/GetBitmap.3 +++ b/doc/GetBitmap.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetBitmap.3,v 1.10 2007/01/05 00:00:48 nijtmans Exp $ +'\" RCS: @(#) $Id: GetBitmap.3,v 1.11 2007/10/24 14:32:56 dkf Exp $ '\" .so man.macros .TH Tk_AllocBitmapFromObj 3 8.1 Tk "Tk Library Procedures" @@ -113,7 +113,8 @@ every fourth pixel in every other row. An hourglass symbol. .TP 12 \fBinfo\fR -A large letter ``i''. +A large letter +.QW i . .TP 12 \fBquesthead\fR The silhouette of a human head, with a question mark in it. diff --git a/doc/GetCapStyl.3 b/doc/GetCapStyl.3 index e0e04a2..83bbeed 100644 --- a/doc/GetCapStyl.3 +++ b/doc/GetCapStyl.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetCapStyl.3,v 1.4 2007/01/05 00:00:49 nijtmans Exp $ +'\" RCS: @(#) $Id: GetCapStyl.3,v 1.5 2007/10/24 14:32:56 dkf Exp $ '\" .so man.macros .TH Tk_GetCapStyle 3 "" Tk "Tk Library Procedures" @@ -26,8 +26,11 @@ const char * .AP Tcl_Interp *interp in Interpreter to use for error reporting. .AP "const char" *string in -String containing name of cap style: one of ```butt'', ``projecting'', -or ``round''. +String containing name of cap style: one of +.QW butt , +.QW projecting , +or +.QW round . .AP int *capPtr out Pointer to location in which to store X cap style corresponding to \fIstring\fR. @@ -57,7 +60,8 @@ stored in \fIinterp->result\fR, \fBTCL_ERROR\fR is returned, and Given a cap style such as \fBCapButt\fR it returns a statically-allocated string corresponding to \fIcap\fR. If \fIcap\fR isn't a legal cap style, then -``unknown cap style'' is returned. +.QW "unknown cap style" +is returned. .SH KEYWORDS butt, cap style, projecting, round diff --git a/doc/GetCursor.3 b/doc/GetCursor.3 index 0b9efb6..1b229cd 100644 --- a/doc/GetCursor.3 +++ b/doc/GetCursor.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetCursor.3,v 1.9 2007/01/05 00:00:48 nijtmans Exp $ +'\" RCS: @(#) $Id: GetCursor.3,v 1.10 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_AllocCursorFromObj 3 8.1 Tk "Tk Library Procedures" @@ -93,7 +93,8 @@ list with one of the following forms: \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, -or \fBleft_ptr\fR. Appendix B of ``The X Window System'' +or \fBleft_ptr\fR. Appendix B of +.QW "The X Window System" by Scheifler & Gettys has illustrations showing what each of these cursors looks like. If \fIfgColor\fR and \fIbgColor\fR are both specified, they give the foreground and background colors to use diff --git a/doc/GetJoinStl.3 b/doc/GetJoinStl.3 index b715424..8fe81ab 100644 --- a/doc/GetJoinStl.3 +++ b/doc/GetJoinStl.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetJoinStl.3,v 1.4 2007/01/05 00:00:48 nijtmans Exp $ +'\" RCS: @(#) $Id: GetJoinStl.3,v 1.5 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_GetJoinStyle 3 "" Tk "Tk Library Procedures" @@ -26,8 +26,11 @@ const char * .AP Tcl_Interp *interp in Interpreter to use for error reporting. .AP "const char" *string in -String containing name of join style: one of ``bevel'', ``miter'', -or ``round''. +String containing name of join style: one of +.QW bevel , +.QW miter , +or +.QW round . .AP int *joinPtr out Pointer to location in which to store X join style corresponding to \fIstring\fR. @@ -56,7 +59,8 @@ stored in \fIinterp->result\fR, \fBTCL_ERROR\fR is returned, and Given a join style such as \fBJoinBevel\fR it returns a statically-allocated string corresponding to \fIjoin\fR. If \fIjoin\fR isn't a legal join style, then -``unknown join style'' is returned. +.QW "unknown join style" +is returned. .SH KEYWORDS bevel, join style, miter, round diff --git a/doc/GetJustify.3 b/doc/GetJustify.3 index 47df31e..402831a 100644 --- a/doc/GetJustify.3 +++ b/doc/GetJustify.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetJustify.3,v 1.6 2007/01/05 00:00:48 nijtmans Exp $ +'\" RCS: @(#) $Id: GetJustify.3,v 1.7 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_GetJustifyFromObj 3 8.1 Tk "Tk Library Procedures" @@ -29,9 +29,12 @@ const char * .AP Tcl_Interp *interp in Interpreter to use for error reporting, or NULL. .AP Tcl_Obj *objPtr in/out -String value contains name of justification style (\fBleft\fR, \fBright\fR, or -\fBcenter\fR). The -internal rep will be modified to cache corresponding justify value. +String value contains name of justification style; one of: +.QW \fBleft\fR , +.QW \fBright\fR , +or +.QW \fBcenter\fR ). +The internal rep will be modified to cache corresponding justify value. .AP "const char" *string in Same as \fIobjPtr\fR except description of justification style is passed as a string. @@ -80,7 +83,8 @@ return value, so \fBTk_GetJustify\fR is less efficient than Given a justify value it returns a statically-allocated string corresponding to \fIjustify\fR. If \fIjustify\fR isn't a legal justify value, then -``unknown justification style'' is returned. +.QW "unknown justification style" +is returned. .SH KEYWORDS center, fill, justification, string diff --git a/doc/GetRelief.3 b/doc/GetRelief.3 index 3ba3b34..d5243fb 100644 --- a/doc/GetRelief.3 +++ b/doc/GetRelief.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetRelief.3,v 1.7 2007/01/05 00:00:49 nijtmans Exp $ +'\" RCS: @(#) $Id: GetRelief.3,v 1.8 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_GetReliefFromObj 3 8.1 Tk "Tk Library Procedures" @@ -71,7 +71,8 @@ return value, so \fBTk_GetRelief\fR is less efficient than \fBTk_NameOfRelief\fR is the logical inverse of \fBTk_GetRelief\fR. Given a relief value it returns the corresponding string (\fBflat\fR, \fBraised\fR, \fBsunken\fR, \fBgroove\fR, \fBsolid\fR, or \fBridge\fR). -If \fIrelief\fR isn't a legal relief value, then ``unknown relief'' +If \fIrelief\fR isn't a legal relief value, then +.QW "unknown relief" is returned. .SH KEYWORDS diff --git a/doc/GetUid.3 b/doc/GetUid.3 index 303dc47..61eca55 100644 --- a/doc/GetUid.3 +++ b/doc/GetUid.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetUid.3,v 1.4 2004/02/17 13:47:22 dkf Exp $ +'\" RCS: @(#) $Id: GetUid.3,v 1.5 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_GetUid 3 "" Tk "Tk Library Procedures" @@ -31,7 +31,8 @@ to \fIstring\fR. Unique identifiers are similar to atoms in Lisp, and are used in Tk to speed up comparisons and searches. A unique identifier (type Tk_Uid) is a string pointer -and may be used anywhere that a variable of type ``char *'' +and may be used anywhere that a variable of type +.QW "char *" could be used. However, there is guaranteed to be exactly one unique identifier for any given string value. If \fBTk_GetUid\fR is called twice, once with string \fIa\fR and once with string diff --git a/doc/GetVRoot.3 b/doc/GetVRoot.3 index 5f8c97e..d32afff 100644 --- a/doc/GetVRoot.3 +++ b/doc/GetVRoot.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetVRoot.3,v 1.3 2004/08/22 15:43:20 dkf Exp $ +'\" RCS: @(#) $Id: GetVRoot.3,v 1.4 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_GetVRootGeometry 3 4.0 Tk "Tk Library Procedures" @@ -34,9 +34,10 @@ Points to word in which to store height of virtual root. .SH DESCRIPTION .PP \fBTk_GetVRootGeometry\fR returns geometry information about the virtual -root window associated with \fItkwin\fR. The ``associated'' virtual -root is the one in which \fItkwin\fR's nearest top-level ancestor (or -\fItkwin\fR itself if it is a top-level window) has +root window associated with \fItkwin\fR. The +.QW associated +virtual root is the one in which \fItkwin\fR's nearest top-level ancestor +(or \fItkwin\fR itself if it is a top-level window) has been reparented by the window manager. This window is identified by a \fB__SWM_ROOT\fR or \fB__WM_ROOT\fR property placed on the top-level window by the window manager. diff --git a/doc/GetVisual.3 b/doc/GetVisual.3 index f4f94c6..4cfe4b6 100644 --- a/doc/GetVisual.3 +++ b/doc/GetVisual.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetVisual.3,v 1.4 2007/01/05 00:00:49 nijtmans Exp $ +'\" RCS: @(#) $Id: GetVisual.3,v 1.5 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_GetVisual 3 4.0 Tk "Tk Library Procedures" @@ -76,8 +76,9 @@ as \fItkwin\fR. Use the visual whose X identifier is \fInumber\fR. .TP 15 \fBbest\fR ?\fIdepth\fR? -Choose the ``best possible'' visual, using the following rules, in -decreasing order of priority: +Choose the +.QW "best possible" +visual, using the following rules, in decreasing order of priority: (a) a visual that has exactly the desired depth is best, followed by a visual with greater depth than requested (but as little extra as possible), followed by a visual with less depth than requested diff --git a/doc/InternAtom.3 b/doc/InternAtom.3 index fbe62b9..8ee83b5 100644 --- a/doc/InternAtom.3 +++ b/doc/InternAtom.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: InternAtom.3,v 1.4 2007/01/05 00:00:49 nijtmans Exp $ +'\" RCS: @(#) $Id: InternAtom.3,v 1.5 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_InternAtom 3 "" Tk "Tk Library Procedures" @@ -44,7 +44,8 @@ by \fBTk_GetAtomName\fR is in Tk's storage: the caller need not free this space when finished with the string, and the caller should not modify the contents of the returned string. If there is no atom \fIatom\fR on \fItkwin\fR's display, -then \fBTk_GetAtomName\fR returns the string ``?bad atom?''. +then \fBTk_GetAtomName\fR returns the string +.QW "?bad atom?" . .PP Tk caches the information returned by \fBTk_InternAtom\fR and \fBTk_GetAtomName\fR diff --git a/doc/Name.3 b/doc/Name.3 index e6cc727..6d1fdbf 100644 --- a/doc/Name.3 +++ b/doc/Name.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Name.3,v 1.5 2007/01/05 00:00:48 nijtmans Exp $ +'\" RCS: @(#) $Id: Name.3,v 1.6 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_Name 3 "" Tk "Tk Library Procedures" @@ -55,9 +55,17 @@ The \fBTk_PathName\fR macro returns a hierarchical name for \fItkwin\fR. Path names have a structure similar to file names in Unix but with dots between elements instead of slashes: the main window for -an application has the path name ``.''; its children have names like -``.a'' and ``.b''; their children have names like ``.a.aa'' and -``.b.bb''; and so on. A window is considered to be a child of +an application has the path name +.QW . ; +its children have names like +.QW .a +and +.QW .b ; +their children have names like +.QW .a.aa +and +.QW .b.bb ; +and so on. A window is considered to be a child of another window for naming purposes if the second window was named as the first window's \fIparent\fR when the first window was created. This is not always the same as the X window hierarchy. For diff --git a/doc/ParseArgv.3 b/doc/ParseArgv.3 index de4feb7..c31bc1b 100644 --- a/doc/ParseArgv.3 +++ b/doc/ParseArgv.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ParseArgv.3,v 1.6 2007/01/05 00:00:48 nijtmans Exp $ +'\" RCS: @(#) $Id: ParseArgv.3,v 1.7 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_ParseArgv 3 "" Tk "Tk Library Procedures" @@ -79,7 +79,10 @@ typedef struct { char *\fIhelp\fR; } Tk_ArgvInfo; .CE -The \fIkey\fR field is a string such as ``\-display'' or ``\-bg'' +The \fIkey\fR field is a string such as +.QW \-display +or +.QW \-bg that is compared with the values in \fIargv\fR. \fIType\fR indicates how to process an argument that matches \fIkey\fR (more on this below). \fISrc\fR and \fIdst\fR are additional @@ -104,11 +107,13 @@ skipped and returned to the caller. .PP Once a matching argument specifier is found, \fBTk_ParseArgv\fR processes the argument according to the \fItype\fR field of the -specifier. The argument that matched \fIkey\fR is called ``the matching -argument'' in the descriptions below. As part of the processing, +specifier. The argument that matched \fIkey\fR is called +.QW "the matching argument" +in the descriptions below. As part of the processing, \fBTk_ParseArgv\fR may also use the next argument in \fIargv\fR -after the matching argument, which is called ``the following -argument''. The legal values for \fItype\fR, and the processing +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 @@ -123,8 +128,11 @@ The matching argument is discarded. .TP \fBTK_ARGV_INT\fR The following argument must contain an -integer string in the format accepted by \fBstrtol\fR (e.g. ``0'' -and ``0x'' prefixes may be used to specify octal or hexadecimal +integer string in the format accepted by \fBstrtol\fR (e.g. +.QW 0 +and +.QW 0x +prefixes may be used to specify octal or hexadecimal 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 @@ -345,7 +353,10 @@ 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 ``prog'', \fIargv\fR[1] will be ``infile'', +\fIargv\fR[0] will be +.QW prog , +\fIargv\fR[1] will be +.QW infile , and \fIargv\fR[2] will be NULL. .SH KEYWORDS diff --git a/doc/RestrictEv.3 b/doc/RestrictEv.3 index abf231f..f5e3252 100644 --- a/doc/RestrictEv.3 +++ b/doc/RestrictEv.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: RestrictEv.3,v 1.3 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: RestrictEv.3,v 1.4 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_RestrictEvents 3 "" Tk "Tk Library Procedures" @@ -71,7 +71,8 @@ bindings with the \fBbind\fR Tcl command or by calling The main place where \fBTk_RestrictEvents\fR must be used is when performing synchronous actions (for example, if you need to wait for a particular event to occur on a particular window but you don't -want to invoke any handlers for any other events). The ``obvious'' +want to invoke any handlers for any other events). The +.QW obvious solution in these situations is to call \fBXNextEvent\fR or \fBXWindowEvent\fR, but these procedures cannot be used because Tk keeps its own event queue that is separate from the X event diff --git a/doc/SetAppName.3 b/doc/SetAppName.3 index 9a93185..2f0b44c 100644 --- a/doc/SetAppName.3 +++ b/doc/SetAppName.3 @@ -5,13 +5,13 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SetAppName.3,v 1.4 2007/01/05 00:00:49 nijtmans Exp $ +'\" RCS: @(#) $Id: SetAppName.3,v 1.5 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_SetAppName 3 4.0 Tk "Tk Library Procedures" .BS .SH NAME -Tk_SetAppName \- Set the name of an application for ``send'' commands +Tk_SetAppName \- Set the name of an application for `send' commands .SH SYNOPSIS .nf \fB#include \fR @@ -37,7 +37,8 @@ display will be able to use the \fBsend\fR command to invoke operations in the application. If \fIname\fR is already in use by some other application on the display, then a new name will be generated by appending -``\fB #2\fR'' to \fIname\fR; if this name is also in use, +.QW "\fB #2\fR" +to \fIname\fR; if this name is also in use, the number will be incremented until an unused name is found. The return value from the procedure is a pointer to the name actually used. diff --git a/doc/SetOptions.3 b/doc/SetOptions.3 index 4e94bfc..6e25930 100644 --- a/doc/SetOptions.3 +++ b/doc/SetOptions.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SetOptions.3,v 1.13 2007/01/05 00:00:49 nijtmans Exp $ +'\" RCS: @(#) $Id: SetOptions.3,v 1.14 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_SetOptions 3 8.1 Tk "Tk Library Procedures" @@ -95,10 +95,12 @@ options are supported, these procedures handle all the details of parsing options and storing their values into a C structure associated with the widget or object. The procedures were designed primarily for widgets in Tk, but they can also be used for other kinds of objects that -have configuration options. In the rest of this manual page ``widget'' will -be used to refer to the object whose options are being managed; in -practice the object may not actually be a widget. The term ``widget -record'' is used to refer to the C-level structure in +have configuration options. In the rest of this manual page +.QW widget +will be used to refer to the object whose options are being managed; in +practice the object may not actually be a widget. The term +.QW "widget record" +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 diff --git a/doc/StrictMotif.3 b/doc/StrictMotif.3 index ab80c33..f7209d3 100644 --- a/doc/StrictMotif.3 +++ b/doc/StrictMotif.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: StrictMotif.3,v 1.2 1998/09/14 18:22:54 stanton Exp $ +'\" RCS: @(#) $Id: StrictMotif.3,v 1.3 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_StrictMotif 3 4.0 Tk "Tk Library Procedures" @@ -30,8 +30,9 @@ variable in the interpreter associated with \fItkwin\fR's application. The value is returned as an integer that is either 0 or 1. 1 means that strict Motif compliance has been requested, so anything that is not part of the Motif specification should be avoided. -0 means that ``Motif-like'' is good enough, and extra features -are welcome. +0 means that +.QW Motif-like +is good enough, and extra features are welcome. .PP This procedure uses a link to the Tcl variable to provide much faster access to the variable's value than could be had by calling diff --git a/doc/Tk_Main.3 b/doc/Tk_Main.3 index aebf8db..3d8c03b 100644 --- a/doc/Tk_Main.3 +++ b/doc/Tk_Main.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Tk_Main.3,v 1.2 1998/09/14 18:22:54 stanton Exp $ +'\" RCS: @(#) $Id: Tk_Main.3,v 1.3 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH Tk_Main 3 4.0 Tk "Tk Library Procedures" @@ -46,7 +46,8 @@ nothing but invoke \fBTk_Main\fR. .PP When it is has finished its own initialization, but before it processes commands, \fBTk_Main\fR calls the procedure given by -the \fIappInitProc\fR argument. This procedure provides a ``hook'' +the \fIappInitProc\fR argument. This procedure provides a +.QW hook for the application to perform its own initialization, such as defining application-specific commands. The procedure must have an interface that matches the type \fBTcl_AppInitProc\fR: diff --git a/doc/bind.n b/doc/bind.n index ae06470..54bce1c 100644 --- a/doc/bind.n +++ b/doc/bind.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: bind.n,v 1.21 2007/10/16 15:11:36 dkf Exp $ +'\" RCS: @(#) $Id: bind.n,v 1.22 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH bind n 8.0 Tk "Tk Built-In Commands" @@ -25,7 +25,9 @@ If all three arguments are specified, \fBbind\fR will arrange for \fIscript\fR (a Tcl script) to be evaluated whenever the event(s) given by \fIsequence\fR occur in the window(s) identified by \fItag\fR. -If \fIscript\fR is prefixed with a ``+'', then it is appended to +If \fIscript\fR is prefixed with a +.QW + , +then it is appended to any existing binding for \fIsequence\fR; otherwise \fIscript\fR replaces any existing binding. If \fIscript\fR is an empty string then the current binding for @@ -267,9 +269,9 @@ A \fBDestroy\fR event is delivered to a window when it is destroyed. .RS .PP -When the \fBDestroy\fR event is delivered -to a widget, it is in a ``half-dead'' state: the widget still exists, -but most operations on it will fail. +When the \fBDestroy\fR event is delivered to a widget, it is in a +.QW half-dead +state: the widget still exists, but most operations on it will fail. .RE .IP "\fBFocusIn\fR, \fBFocusOut\fR" 5 The \fBFocusIn\fR and \fBFocusOut\fR events are generated @@ -280,8 +282,8 @@ and a \fBFocusIn\fR event is sent to the new one. .PP In addition, if the old and new focus windows do not share a common parent, -``virtual crossing'' focus events are sent to the intermediate -windows in the hierarchy. +.QW "virtual crossing" +focus events are sent to the intermediate windows in the hierarchy. Thus a \fBFocusIn\fR event indicates that the target window or one of its descendants has acquired the focus, and a \fBFocusOut\fR event indicates that the focus @@ -301,7 +303,8 @@ events are only delivered to the window owning the grab. .PP In addition, when the pointer moves between two windows, \fBEnter\fR and \fBLeave\fR -``virtual crossing'' events are sent to intermediate windows +.QW "virtual crossing" +events are sent to intermediate windows in the hierarchy in the same manner as for \fBFocusIn\fR and \fBFocusOut\fR events. .RE @@ -364,12 +367,19 @@ is equivalent to \fB\fR. If the event type is \fBKeyPress\fR or \fBKeyRelease\fR, then \fIdetail\fR may be specified in the form of an X keysym. Keysyms are textual specifications for particular keys on the keyboard; -they include all the alphanumeric ASCII characters (e.g. ``a'' is -the keysym for the ASCII character ``a''), plus descriptions for -non-alphanumeric characters (``comma'' is the keysym for the comma +they include all the alphanumeric ASCII characters (e.g. +.QW a +is the keysym for the ASCII character +.QW a ), +plus descriptions for non-alphanumeric characters (e.g. +.QW comma +is the keysym for the comma character), plus descriptions for all the non-ASCII keys on the -keyboard (``Shift_L'' is the keysym for the left shift key, and -``F1'' is the keysym for the F1 function key, if it exists). The +keyboard (e.g. +.QW Shift_L +is the keysym for the left shift key, and +.QW F1 +is the keysym for the F1 function key, if it exists). The complete list of keysyms is not presented here; it is available in other X documentation and may vary from system to system. @@ -530,8 +540,11 @@ the delta. The sign of the value represents the direction the mouse wheel was scrolled. .IP \fB%E\fR 5 The \fIsend_event\fR field from the event. Valid for all event types. -\fB0\fR indicates that this is a ``normal'' event, \fB1\fR indicates -that it is a ``synthetic'' event generated by \fBSendEvent\fR. +\fB0\fR indicates that this is a +.QW normal +event, \fB1\fR indicates that it is a +.QW synthetic +event generated by \fBSendEvent\fR. .IP \fB%K\fR 5 The keysym corresponding to the event, substituted as a textual string. Valid only for \fBKeyPress\fR and \fBKeyRelease\fR events. diff --git a/doc/bindtags.n b/doc/bindtags.n index f82b61b..64c9042 100644 --- a/doc/bindtags.n +++ b/doc/bindtags.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: bindtags.n,v 1.4 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: bindtags.n,v 1.5 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH bindtags n 4.0 Tk "Tk Built-In Commands" @@ -57,8 +57,9 @@ For example, the command .CE reverses the order in which binding scripts will be evaluated for a button named \fB.b\fR so that \fBall\fR bindings are invoked -first, following by bindings for \fB.b\fR's toplevel (``.''), followed by -class bindings, followed by bindings for \fB.b\fR. +first, following by bindings for \fB.b\fR's toplevel (i.e. +.QW \fB.\fR ), +followed by class bindings, followed by bindings for \fB.b\fR. If \fItagList\fR is an empty list then the binding tags for \fIwindow\fR are returned to the default state described above. .PP diff --git a/doc/canvas.n b/doc/canvas.n index b9b2320..aeb322d 100644 --- a/doc/canvas.n +++ b/doc/canvas.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: canvas.n,v 1.26 2007/10/23 15:44:35 dkf Exp $ +'\" RCS: @(#) $Id: canvas.n,v 1.27 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH canvas n 8.3 Tk "Tk Built-In Commands" @@ -28,8 +28,9 @@ canvas \- Create and manipulate canvas widgets .SH "WIDGET-SPECIFIC OPTIONS" .OP \-closeenough closeEnough CloseEnough Specifies a floating-point value indicating how close the mouse cursor -must be to an item before it is considered to be ``inside'' the item. -Defaults to 1.0. +must be to an item before it is considered to be +.QW inside +the item. Defaults to 1.0. .OP \-confine confine Confine Specifies a boolean value that indicates whether or not it should be allowable to set the canvas's view outside the region defined by the @@ -113,7 +114,9 @@ with the first item in the display list being displayed first, followed by the next item in the list, and so on. Items later in the display list obscure those that are earlier in the display list and are sometimes referred to -as being ``on top'' of earlier items. +as being +.QW "on top" +of earlier items. When a new item is created it is placed at the end of the display list, on top of everything else. Widget commands may be used to re-arrange the order of the @@ -136,11 +139,16 @@ canvas widget. Each item may also have any number of \fItags\fR associated with it. A tag is just a string of characters, and it may take any form except that of an integer. -For example, ``x123'' is OK but ``123'' isn't. +For example, +.QW x123 +is OK but +.QW 123 +isn't. The same tag may be associated with many different items. This is commonly done to group items in various interesting ways; for example, all selected items might be given the -tag ``selected''. +tag +.QW selected . .PP The tag \fBall\fR is implicitly associated with every item in the canvas; it may be used to invoke operations on @@ -391,7 +399,9 @@ Selects all the items given by \fItagOrId\fR. \fIpathName \fBbbox \fItagOrId\fR ?\fItagOrId tagOrId ...\fR? Returns a list with four elements giving an approximate bounding box for all the items named by the \fItagOrId\fR arguments. -The list has the form ``\fIx1 y1 x2 y2\fR'' such that the drawn +The list has the form +.QW "\fIx1 y1 x2 y2\fR" +such that the drawn areas of all the named elements are within the region bounded by \fIx1\fR on the left, \fIx2\fR on the right, \fIy1\fR on the top, and \fIy2\fR on the bottom. @@ -414,8 +424,9 @@ on the syntax of \fIsequence\fR and the substitutions performed on \fIcommand\fR before invoking it. If all arguments are specified then a new binding is created, replacing any existing binding for the same \fIsequence\fR and \fItagOrId\fR -(if the first character of \fIcommand\fR is ``+'' then \fIcommand\fR -augments an existing binding rather than replacing it). +(if the first character of \fIcommand\fR is +.QW + +then \fIcommand\fR augments an existing binding rather than replacing it). In this case the return value is an empty string. If \fIcommand\fR is omitted then the command returns the \fIcommand\fR associated with \fItagOrId\fR and \fIsequence\fR (an error occurs @@ -703,7 +714,8 @@ options are supported: \fIVarName\fR must be the name of an array variable that specifies a color mapping to use in the Postscript. Each element of \fIvarName\fR must consist of Postscript -code to set a particular color value (e.g. ``\fB1.0 1.0 0.0 setrgbcolor\fR''). +code to set a particular color value (e.g. +.QW "\fB1.0 1.0 0.0 setrgbcolor\fR" ). When outputting color information in the Postscript, Tk checks to see if there is an element of \fIvarName\fR with the same name as the color. @@ -792,10 +804,12 @@ Defaults to the center of the page. \fIBoolean\fR specifies whether the printed area is to be rotated 90 degrees. In non-rotated output the x-axis of the printed area runs along -the short dimension of the page (``portrait'' orientation); -in rotated output the x-axis runs along the long dimension of the -page (``landscape'' orientation). -Defaults to non-rotated. +the short dimension of the page (i.e. +.QW portrait +orientation); in rotated output the x-axis runs along the long +dimension of the page (i.e. +.QW landscape +orientation). Defaults to non-rotated. .TP \fB\-width \fIsize\fR Specifies the width of the area of the canvas to print. @@ -1376,7 +1390,9 @@ The second element gives the distance along the line from the trailing points of the arrowhead to the tip, and the third element gives the distance from the outside edge of the line to the trailing points. -If this option isn't specified then Tk picks a ``reasonable'' shape. +If this option isn't specified then Tk picks a +.QW reasonable +shape. .TP \fB\-capstyle \fIstyle\fR Specifies the ways in which caps are to be drawn at the endpoints @@ -1557,8 +1573,9 @@ will be approximated with \fInumber\fR line segments. This option is ignored unless the \fB\-smooth\fR option is true or \fBraw\fR. .PP Polygon items are different from other items such as rectangles, ovals -and arcs in that interior points are considered to be ``inside'' a -polygon (e.g. for purposes of the \fBfind closest\fR and +and arcs in that interior points are considered to be +.QW inside +a polygon (e.g. for purposes of the \fBfind closest\fR and \fBfind overlapping\fR widget commands) even if it is not filled. For most other item types, an interior point is considered to be inside the item only if the item diff --git a/doc/checkbutton.n b/doc/checkbutton.n index 1383513..d7c3f8f 100644 --- a/doc/checkbutton.n +++ b/doc/checkbutton.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: checkbutton.n,v 1.13 2007/08/28 15:16:11 dkf Exp $ +'\" RCS: @(#) $Id: checkbutton.n,v 1.14 2007/10/24 14:32:57 dkf Exp $ '\" .so man.macros .TH checkbutton n 4.4 Tk "Tk Built-In Commands" @@ -54,10 +54,12 @@ the Bold, Italic, and Underline checkbuttons on the toolbar of a word-processor, for example. .OP \-offvalue offValue Value Specifies value to store in the button's associated variable whenever -this button is deselected. Defaults to ``0''. +this button is deselected. Defaults to +.QW 0 . .OP \-onvalue onValue Value Specifies value to store in the button's associated variable whenever -this button is selected. Defaults to ``1''. +this button is selected. Defaults to +.QW 1 . .OP \-overrelief overRelief OverRelief Specifies an alternative relief for the checkbutton, to be used when the mouse cursor is over the widget. This option can be used to make @@ -100,7 +102,7 @@ specified. .OP \-tristatevalue tristateValue Value .VS 8.5 Specifies the value that causes the checkbutton to display the multi-value -selection, also known as the tri-state mode. Defaults to ``""'' +selection, also known as the tri-state mode. Defaults to the empty string. .VE 8.5 .OP \-variable variable Variable Specifies name of global variable to set to indicate whether @@ -162,20 +164,30 @@ the indicator is drawn with a tri-state appearance and is in the tri-state mode indicating mixed or multiple values. (This is used when the check box represents the state of multiple items.) The indicator is drawn in a platform dependent manner. Under Unix and -Windows, the background interior of the box is ``grayed''. Under Mac, -the indicator is drawn with a dash mark inside. +Windows, the background interior of the box is +.QW grayed . +Under Mac, the indicator is drawn with a dash mark inside. By default, the name of the variable associated with a checkbutton is the same as the \fIname\fR used to create the checkbutton. -The variable name, and the ``on'', ``off'' and ``tristate'' values stored in -it, may be modified with options on the command line or in the option -database. +The variable name, and the +.QW on , +.QW off +and +.QW tristate +values stored in it, may be modified with options on the command line +or in the option database. Configuration options may also be used to modify the way the indicator is displayed (or whether it is displayed at all). By default a checkbutton is configured to select and deselect itself on alternate button clicks. In addition, each checkbutton monitors its associated variable and automatically selects and deselects itself when the variables value -changes to and from the button's ``on'', ``off'' and ``tristate'' values. +changes to and from the button's +.QW on , +.QW off +and +.QW tristate +values. .VE 8.5 .SH "WIDGET COMMAND" .PP @@ -211,7 +223,8 @@ this case the command returns an empty string. command. .TP \fIpathName \fBdeselect\fR -Deselects the checkbutton and sets the associated variable to its ``off'' +Deselects the checkbutton and sets the associated variable to its +.QW off value. .TP \fIpathName \fBflash\fR @@ -230,7 +243,8 @@ empty string if there is no command associated with the checkbutton. This command is ignored if the checkbutton's state is \fBdisabled\fR. .TP \fIpathName \fBselect\fR -Selects the checkbutton and sets the associated variable to its ``on'' +Selects the checkbutton and sets the associated variable to its +.QW on value. .TP \fIpathName \fBtoggle\fR diff --git a/doc/clipboard.n b/doc/clipboard.n index 0341d62..2847bc5 100644 --- a/doc/clipboard.n +++ b/doc/clipboard.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: clipboard.n,v 1.12 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: clipboard.n,v 1.13 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH clipboard n 8.4 Tk "Tk Built-In Commands" @@ -34,8 +34,9 @@ forms are currently supported: .TP \fBclipboard clear\fR ?\fB\-displayof\fR \fIwindow\fR? Claims ownership of the clipboard on \fIwindow\fR's display and removes -any previous contents. \fIWindow\fR defaults to ``.''. Returns an -empty string. +any previous contents. \fIWindow\fR defaults to +.QW . . +Returns an empty string. .TP \fBclipboard append\fR ?\fB\-displayof\fR \fIwindow\fR? ?\fB\-format\fR \fIformat\fR? ?\fB\-type\fR \fItype\fR? ?\fB\-\|\-\fR? \fIdata\fR Appends \fIdata\fR to the clipboard on \fIwindow\fR's @@ -45,7 +46,9 @@ display. .RS .PP \fIType\fR specifies the form in which the selection is to be returned -(the desired ``target'' for conversion, in ICCCM terminology), and +(the desired +.QW target +for conversion, in ICCCM terminology), and should be an atom name such as STRING or FILE_NAME; see the Inter-Client Communication Conventions Manual for complete details. \fIType\fR defaults to STRING. diff --git a/doc/destroy.n b/doc/destroy.n index ce01326..38b5cd1 100644 --- a/doc/destroy.n +++ b/doc/destroy.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: destroy.n,v 1.3 2004/06/21 14:24:04 dkf Exp $ +'\" RCS: @(#) $Id: destroy.n,v 1.4 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH destroy n "" Tk "Tk Built-In Commands" @@ -21,8 +21,10 @@ destroy \- Destroy one or more windows .PP This command deletes the windows given by the \fIwindow\fR arguments, plus all of their descendants. -If a \fIwindow\fR ``.'' is deleted then the entire application -will be destroyed. +If the \fIwindow\fR +.QW . +is deleted then the entire interpreter's windows +will be destroyed (which may cause the whole application to exit). The \fIwindow\fRs are destroyed in order, and if an error occurs in destroying a window the command aborts without destroying the remaining windows. diff --git a/doc/entry.n b/doc/entry.n index 8f7c4ed..2c55880 100644 --- a/doc/entry.n +++ b/doc/entry.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: entry.n,v 1.16 2006/12/13 23:04:32 hobbs Exp $ +'\" RCS: @(#) $Id: entry.n,v 1.17 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH entry n 8.3 Tk "Tk Built-In Commands" @@ -45,7 +45,9 @@ this option is the empty string, the normal background color is used. If this option is specified, then the true contents of the entry are not displayed in the window. Instead, each character in the entry's value will be displayed as -the first character in the value of this option, such as ``*''. +the first character in the value of this option, such as +.QW * +or a bullet character. This is useful, for example, if the entry is to be used to enter a password. If characters in the entry are selected and copied elsewhere, the @@ -229,11 +231,15 @@ entry window. \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, ``\fB@0\fR'' indicates the left-most character in the -window. +For example, +.QW \fB@0\fR +indicates the left-most character in the window. .LP -Abbreviations may be used for any of the forms above, e.g. ``\fBe\fR'' -or ``\fBsel.f\fR''. In general, out-of-range indices are automatically +Abbreviations may be used for any of the forms above, e.g. +.QW \fBe\fR +or +.QW \fBsel.f\fR . +In general, out-of-range indices are automatically rounded to the nearest legal value. .PP The following commands are possible for entry widgets: @@ -412,9 +418,11 @@ become visible. .PP Tk automatically creates class bindings for entries that give them the following default behavior. -In the descriptions below, ``word'' refers to a contiguous group -of letters, digits, or ``_'' characters, or any single character -other than these. +In the descriptions below, +.QW word +refers to a contiguous group of letters, digits, or +.QW _ +characters, or any single character other than these. .IP [1] Clicking mouse button 1 positions the insertion cursor just before the character underneath the mouse cursor, sets the diff --git a/doc/event.n b/doc/event.n index 5849b85..2aa90ba 100644 --- a/doc/event.n +++ b/doc/event.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: event.n,v 1.12 2005/04/06 21:11:54 dkf Exp $ +'\" RCS: @(#) $Id: event.n,v 1.13 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH event n 8.3 Tk "Tk Built-In Commands" @@ -80,8 +80,9 @@ not defined then an empty string is returned. .SH "EVENT FIELDS" .PP The following options are supported for the \fBevent generate\fR -command. These correspond to the ``%'' expansions -allowed in binding scripts for the \fBbind\fR command. +command. These correspond to the +.QW % +expansions allowed in binding scripts for the \fBbind\fR command. .TP \fB\-above\fI window\fR \fIWindow\fR specifies the \fIabove\fR field for the event, diff --git a/doc/focusNext.n b/doc/focusNext.n index fb326b3..15021ec 100644 --- a/doc/focusNext.n +++ b/doc/focusNext.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: focusNext.n,v 1.2 1998/09/14 18:22:56 stanton Exp $ +'\" RCS: @(#) $Id: focusNext.n,v 1.3 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH tk_focusNext n 4.0 Tk "Tk Built-In Commands" @@ -24,7 +24,9 @@ tk_focusNext, tk_focusPrev, tk_focusFollowsMouse \- Utility procedures for manag .SH DESCRIPTION .PP \fBtk_focusNext\fR is a utility procedure used for keyboard traversal. -It returns the ``next'' window after \fIwindow\fR in focus order. +It returns the +.QW next +window after \fIwindow\fR in focus order. The focus order is determined by the stacking order of windows and the structure of the window hierarchy. Among siblings, the focus order is the same as the stacking order, with the diff --git a/doc/font.n b/doc/font.n index 66c031f..867f11e 100644 --- a/doc/font.n +++ b/doc/font.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: font.n,v 1.15 2007/10/23 14:07:44 das Exp $ +'\" RCS: @(#) $Id: font.n,v 1.16 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH font n 8.0 Tk "Tk Built-In Commands" @@ -84,7 +84,9 @@ Measures the amount of space the string \fItext\fR would use in the given see FONT DESCRIPTIONS below. If the \fIwindow\fR argument is omitted, it defaults to the main window. The return value is the total width in pixels of \fItext\fR, not including the extra pixels used by highly exaggerated -characters such as cursive ``f''. If the string contains newlines or tabs, +characters such as cursive +.QW f . +If the string contains newlines or tabs, those characters are not expanded or treated specially when measuring the string. .TP @@ -118,9 +120,10 @@ font will be substituted automatically. [2] \fIsystemfont\fR . The platform-specific name of a font, interpreted by the graphics server. -This also includes, under X, an XLFD (see [4]) for which a single ``\fB*\fR'' +This also includes, under X, an XLFD (see [4]) for which a single +.QW \fB*\fR character was used to elide more than one field in the middle of the -name. See PLATFORM-SPECIFIC issues for a list of the system fonts. +name. See \fBPLATFORM-SPECIFIC\fR issues for a list of the system fonts. .TP [3] \fIfamily \fR?\fIsize\fR? ?\fIstyle\fR? ?\fIstyle ...\fR? . @@ -142,14 +145,22 @@ underline overstrike\fR . A Unix-centric font name of the form \fI-foundry-family-weight-slant-setwidth-addstyle-pixel-point-resx-resy-spacing-width-charset-encoding\fR. -The ``\fB*\fR'' character may be used to skip individual fields that the -user does not care about. There must be exactly one ``\fB*\fR'' for each -field skipped, except that a ``\fB*\fR'' at the end of the XLFD skips any -remaining fields; the shortest valid XLFD is simply ``\fB*\fR'', signifying +The +.QW \fB*\fR +character may be used to skip individual fields that the +user does not care about. There must be exactly one +.QW \fB*\fR +for each field skipped, except that a +.QW \fB*\fR +at the end of the XLFD skips any +remaining fields; the shortest valid XLFD is simply +.QW \fB*\fR , +signifying all fields as defaults. Any fields that were skipped are given default values. For compatibility, an XLFD always chooses a font of the specified pixel size (not point size); although this interpretation is not strictly -correct, all existing applications using XLFDs assumed that one ``point'' +correct, all existing applications using XLFDs assumed that one +.QW point was in fact one pixel and would display incorrectly (generally larger) if the correct size font were actually used. .TP @@ -173,9 +184,13 @@ an error is generated. The following options are used by the \fBfont metrics\fR command to query font-specific data determined when the font was created. These properties are for the whole font itself and not for individual characters drawn in that -font. In the following definitions, the ``baseline'' of a font is the +font. In the following definitions, the +.QW baseline +of a font is the horizontal line where the bottom of most letters line up; certain letters, -such as lower-case ``g'' stick below the baseline. +such as lower-case +.QW g +stick below the baseline. .TP \fB\-ascent \0\fR . @@ -196,9 +211,13 @@ above the baseline line plus the descent below the baseline. .TP \fB\-fixed \0\fR . -Returns a boolean flag that is ``\fB1\fR'' if this is a fixed-width font, +Returns a boolean flag that is +.QW \fB1\fR +if this is a fixed-width font, where each normal character is the same width as all the other -characters, or is ``\fB0\fR'' if this is a proportionally-spaced font, where +characters, or is +.QW \fB0\fR +if this is a proportionally-spaced font, where individual characters have different widths. The widths of control characters, tab characters, and other non-printing characters are not included when calculating this value. @@ -210,9 +229,13 @@ above: \fB\-family \fIname\fR . The case-insensitive font family name. Tk guarantees to support the font -families named \fBCourier\fR (a monospaced ``typewriter'' font), \fBTimes\fR -(a serifed ``newspaper'' font), and \fBHelvetica\fR (a sans-serif -``European'' font). The most closely matching native font family will +families named \fBCourier\fR (a monospaced +.QW typewriter +font), \fBTimes\fR (a serifed +.QW newspaper +font), and \fBHelvetica\fR (a sans-serif +.QW European +font). The most closely matching native font family will automatically be substituted when one of the above font families is used. 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 diff --git a/doc/grab.n b/doc/grab.n index 7df3745..4375458 100644 --- a/doc/grab.n +++ b/doc/grab.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: grab.n,v 1.4 2004/10/28 10:22:51 dkf Exp $ +'\" RCS: @(#) $Id: grab.n,v 1.5 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH grab n "" Tk "Tk Built-In Commands" @@ -33,7 +33,9 @@ When the pointer is outside \fIwindow\fR's tree, button presses and releases and mouse motion events are reported to \fIwindow\fR, and window entry and window exit events are ignored. -The grab subtree ``owns'' the pointer: +The grab subtree +.QW owns +the pointer: windows outside the grab subtree will be visible on the screen but they will be insensitive until the grab is released. The tree of windows underneath the grab window can include top-level diff --git a/doc/grid.n b/doc/grid.n index 3bf0fbf..f919dea 100644 --- a/doc/grid.n +++ b/doc/grid.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: grid.n,v 1.15 2006/11/15 13:29:17 dkf Exp $ +'\" RCS: @(#) $Id: grid.n,v 1.16 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH grid n 8.5 Tk "Tk Built-In Commands" @@ -187,11 +187,13 @@ slave is managed once more by the grid geometry manager, the initial default settings are used. .TP \fBgrid info \fIslave\fR +. Returns a list whose elements are the current configuration state of the slave given by \fIslave\fR in the same option-value form that might be specified to \fBgrid configure\fR. -The first two elements of the list are ``\fB\-in \fImaster\fR'' where -\fImaster\fR is the slave's master. +The first two elements of the list are +.QW "\fB\-in \fImaster\fR" +where \fImaster\fR is the slave's master. .TP \fBgrid location \fImaster x y\fR Given \fIx\fR and \fIy\fR values in screen units relative to the master window, diff --git a/doc/listbox.n b/doc/listbox.n index 4c76839..03adb56 100644 --- a/doc/listbox.n +++ b/doc/listbox.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: listbox.n,v 1.12 2005/04/06 21:11:54 dkf Exp $ +'\" RCS: @(#) $Id: listbox.n,v 1.13 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH listbox n 8.4 Tk "Tk Built-In Commands" @@ -56,8 +56,9 @@ cannot be modified and is not shown (though selection information is retained). .OP \-width width Width Specifies the desired width for the window in characters. If the font doesn't have a uniform width then the width of the -character ``0'' is used in translating from character units to -screen units. +character +.QW 0 +is used in translating from character units to screen units. If zero or less, then the desired width for the window is made just large enough to hold all the elements in the listbox. .BE diff --git a/doc/loadTk.n b/doc/loadTk.n index 3af7b5c..02911a0 100644 --- a/doc/loadTk.n +++ b/doc/loadTk.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: loadTk.n,v 1.7 2005/01/05 16:40:39 dkf Exp $ +'\" RCS: @(#) $Id: loadTk.n,v 1.8 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH "Safe Tk" n 8.0 Tk "Tk Built-In Commands" @@ -31,19 +31,19 @@ The interpreter must have been created with \fB::safe::interpCreate\fR or have been initialized with \fB::safe::interpInit\fR. The command returns the name of the safe interpreter. If \fB\-use\fR is specified, the window identified by the specified system -dependent identifier \fIwindowId\fR is used to contain the ``.'' +dependent identifier \fIwindowId\fR is used to contain the +.QW . window of the safe interpreter; it can be any valid id, eventually referencing a window belonging to another application. As a convenience, if the window you plan to use is a Tk Window of the application you can use the window name (e.g. \fB.x.y\fR) instead of its window Id (\fB[winfo id .x.y]\fR). -When \fB\-use\fR is not specified, -a new toplevel window is created for the ``.'' window of -the safe interpreter. On X11 if you want the embedded window +When \fB\-use\fR is not specified, a new toplevel window is created for the +.QW . +window of the safe interpreter. On X11 if you want the embedded window to use another display than the default one, specify it with \fB\-display\fR. See the \fBSECURITY ISSUES\fR section below for implementation details. - .SH "SECURITY ISSUES" .PP Please read the \fBsafe\fR manual page for Tcl to learn about the basic @@ -69,10 +69,8 @@ interpreter. .PP On X11, conflicting \fB\-use\fR and \fB\-display\fR are likely to generate a fatal X error. - .SH "SEE ALSO" safe(n), interp(n), library(n), load(n), package(n), source(n), unknown(n) - .SH KEYWORDS alias, auto\-loading, auto_mkindex, load, master interpreter, safe interpreter, slave interpreter, source diff --git a/doc/menu.n b/doc/menu.n index c3b1fde..ec72fa4 100644 --- a/doc/menu.n +++ b/doc/menu.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: menu.n,v 1.16 2007/05/25 22:27:12 dkf Exp $ +'\" RCS: @(#) $Id: menu.n,v 1.17 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH menu n 4.1 Tk "Tk Built-In Commands" @@ -49,9 +49,12 @@ to invoke whenever the menu is torn off. The actual command will consist of the value of this option, followed by a space, followed by the name of the menu window, followed by a space, followed by the name of the name of the torn off menu window. For example, if -the option's is ``\fBa b\fR'' and menu \fB.x.y\fR is torn off to +the option's is +.QW "\fBa b\fR" +and menu \fB.x.y\fR is torn off to create a new menu \fB.x.tearoff1\fR, then the command -``\fBa b .x.y .x.tearoff1\fR'' will be invoked. +.QW "\fBa b .x.y .x.tearoff1\fR" +will be invoked. .OP \-title title Title The string will be used to title the window created when this menu is torn off. If the title is NULL, then the window will have the title @@ -313,7 +316,9 @@ This form may not be abbreviated. Same as \fBend\fR. .TP 12 \fBnone\fR -Indicates ``no entry at all''; this is used most commonly with +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 \fBnone\fR causes nothing to happen in the widget command. @@ -322,8 +327,9 @@ This form may not be abbreviated. \fB@\fInumber\fR In this form, \fInumber\fR is treated as a y-coordinate in the menu's window; the entry closest to that y-coordinate is used. -For example, ``\fB@0\fR'' indicates the top-most entry in the -window. +For example, +.QW \fB@0\fR +indicates the top-most entry in the window. .TP 12 \fIpattern\fR If the index doesn't satisfy one of the above forms then this diff --git a/doc/message.n b/doc/message.n index df0e9fc..681009f 100644 --- a/doc/message.n +++ b/doc/message.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: message.n,v 1.4 2004/08/17 22:37:24 dkf Exp $ +'\" RCS: @(#) $Id: message.n,v 1.5 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH message n 4.0 Tk "Tk Built-In Commands" @@ -99,8 +99,9 @@ characters (ASCII code less than 0x20) and characters not defined in the font are displayed as a four-character sequence \fB\ex\fIhh\fR where \fIhh\fR is the two-digit hexadecimal number corresponding to the character. In the unusual case where the font doesn't contain -all of the characters in ``0123456789abcdef\ex'' then control -characters and undefined characters are not displayed at all. +all of the characters in +.QW 0123456789abcdef\ex +then control characters and undefined characters are not displayed at all. .SH "WIDGET COMMAND" .PP diff --git a/doc/options.n b/doc/options.n index 4522293..872ea9d 100644 --- a/doc/options.n +++ b/doc/options.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: options.n,v 1.11 2005/04/06 21:11:54 dkf Exp $ +'\" RCS: @(#) $Id: options.n,v 1.12 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH options n 4.4 Tk "Tk Built-In Commands" @@ -23,7 +23,9 @@ of the standard options supported by that widget), but if a widget does support an option with one of the names listed below, then the option has exactly the effect described below. .PP -In the descriptions below, ``Command-Line Name'' refers to the +In the descriptions below, +.QW "Command-Line Name" +refers to the switch used in class commands and \fBconfigure\fR widget commands to set this value. For example, if an option's command-line switch is \fB\-foreground\fR and there exists a widget \fB.a.b.c\fR, then the @@ -34,9 +36,11 @@ command may be used to specify the value \fBblack\fR for the option in the widget \fB.a.b.c\fR. Command-line switches may be abbreviated, as long as the abbreviation is unambiguous. -``Database Name'' refers to the option's name in the option database (e.g. -in .Xdefaults files). ``Database Class'' refers to the option's class value -in the option database. +.QW "Database Name" +refers to the option's name in the option database (e.g. +in .Xdefaults files). +.QW "Database Class" +refers to the option's class value in the option database. .OP \-activebackground activeBackground Foreground Specifies background color to use when drawing active elements. An element (a widget or portion of a widget) is active if the @@ -153,12 +157,15 @@ of the 3-D border to draw around the insertion cursor. The value may have any of the forms acceptable to \fBTk_GetPixels\fR. .OP \-insertofftime insertOffTime OffTime Specifies a non-negative integer value indicating the number of -milliseconds the insertion cursor should remain ``off'' in each blink cycle. -If this option is zero then the cursor doesn't blink: it is on -all the time. +milliseconds the insertion cursor should remain +.QW off +in each blink cycle. If this option is zero then the cursor doesn't +blink: it is on all the time. .OP \-insertontime insertOnTime OnTime Specifies a non-negative integer value indicating the number of -milliseconds the insertion cursor should remain ``on'' in each blink cycle. +milliseconds the insertion cursor should remain +.QW on +in each blink cycle. .OP \-insertwidth insertWidth InsertWidth Specifies a value indicating the total width of the insertion cursor. The value may have any of the forms acceptable to \fBTk_GetPixels\fR. @@ -176,7 +183,9 @@ If the value is false, updates are made continuously as the slider is dragged. If the value is true, updates are delayed until the mouse button is released to end the drag; at that point a single notification -is made (the value ``jumps'' rather than changing smoothly). +is made (the value +.QW jumps +rather than changing smoothly). .OP \-justify justify Justify When there are multiple lines of text displayed in a widget, this option determines how the lines line up with each other. @@ -327,7 +336,11 @@ the information just after the last portion that is visible. The command is then passed to the Tcl interpreter for execution. Typically the \fBxScrollCommand\fR option consists of the path name of a scrollbar -widget followed by ``set'', e.g. ``.x.scrollbar set'': this will cause +widget followed by +.QW set , +e.g. +.QW ".x.scrollbar set" : +this will cause the scrollbar to be updated whenever the view in the window changes. If this option is not specified, then no command will be executed. .OP \-yscrollcommand yScrollCommand ScrollCommand diff --git a/doc/pack.n b/doc/pack.n index 81de9c8..5612e8d 100644 --- a/doc/pack.n +++ b/doc/pack.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: pack.n,v 1.7 2004/10/28 12:25:53 dkf Exp $ +'\" RCS: @(#) $Id: pack.n,v 1.8 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH pack n 4.0 Tk "Tk Built-In Commands" @@ -27,14 +27,15 @@ on the \fIoption\fR argument: .TP \fBpack \fIslave \fR?\fIslave ...\fR? ?\fIoptions\fR? If the first argument to \fBpack\fR is a window name (any value -starting with ``.''), then the command is processed in the same -way as \fBpack configure\fR. +starting with +.QW . ), +then the command is processed in the same way as \fBpack configure\fR. .TP \fBpack configure \fIslave \fR?\fIslave ...\fR? ?\fIoptions\fR? The arguments consist of the names of one or more slave windows followed by pairs of arguments that specify how to manage the slaves. -See ``THE PACKER ALGORITHM'' below for details on how the options +See \fBTHE PACKER ALGORITHM\fR below for details on how the options are used by the packer. The following options are supported: .RS @@ -136,13 +137,14 @@ The slaves will no longer be managed by the packer. Returns a list whose elements are the current configuration state of the slave given by \fIslave\fR in the same option-value form that might be specified to \fBpack configure\fR. -The first two elements of the list are ``\fB\-in \fImaster\fR'' where -\fImaster\fR is the slave's master. +The first two elements of the list are +.QW "\fB\-in \fImaster\fR" +where \fImaster\fR is the slave's master. .TP \fBpack propagate \fImaster\fR ?\fIboolean\fR? If \fIboolean\fR has a true boolean value such as \fB1\fR or \fBon\fR then propagation is enabled for \fImaster\fR, which must be a window -name (see ``GEOMETRY PROPAGATION'' below). +name (see \fBGEOMETRY PROPAGATION\fR below). If \fIboolean\fR has a false boolean value then propagation is disabled for \fImaster\fR. In either of these cases an empty string is returned. @@ -184,7 +186,7 @@ For the left or right side the height of the parcel is the height of the cavity and the width is the requested width of the slave plus the \fB\-ipadx\fR and \fB\-padx\fR options. The parcel may be enlarged further because of the \fB\-expand\fR -option (see ``EXPANSION'' below) +option (see \fBEXPANSION\fR below) .IP [2] The packer chooses the dimensions of the slave. The width will normally be the slave's requested width plus diff --git a/doc/palette.n b/doc/palette.n index 3d77282..42a5b0d 100644 --- a/doc/palette.n +++ b/doc/palette.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: palette.n,v 1.2 1998/09/14 18:22:58 stanton Exp $ +'\" RCS: @(#) $Id: palette.n,v 1.3 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH tk_setPalette n 4.0 Tk "Tk Built-In Commands" @@ -66,7 +66,8 @@ from the .Xdefaults file or options specified on the command-line that creates a widget. .PP The procedure \fBtk_bisque\fR is provided for backward compatibility: -it restores the application's colors to the light brown (``bisque'') +it restores the application's colors to the light brown +.PQ bisque color scheme used in Tk 3.6 and earlier versions. .SH KEYWORDS diff --git a/doc/place.n b/doc/place.n index c2fb9de..be62635 100644 --- a/doc/place.n +++ b/doc/place.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: place.n,v 1.7 2004/08/20 10:56:36 dkf Exp $ +'\" RCS: @(#) $Id: place.n,v 1.8 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH place n "" Tk "Tk Built-In Commands" @@ -209,11 +209,14 @@ This feature is useful in at least two situations. First, for complex window layouts it means you can create a hierarchy of subwindows whose only purpose is to assist in the layout of the parent. -The ``real children'' of the parent (i.e. the windows that +The +.QW "real children" +of the parent (i.e. the windows that are significant for the application's user interface) can be children of the parent yet be placed inside the windows of the geometry-management hierarchy. -This means that the path names of the ``real children'' +This means that the path names of the +.QW "real children" don't reflect the geometry-management hierarchy and users can specify options for the real children without being aware of the structure of the geometry-management diff --git a/doc/radiobutton.n b/doc/radiobutton.n index 54307c0..deaeb47 100644 --- a/doc/radiobutton.n +++ b/doc/radiobutton.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: radiobutton.n,v 1.11 2006/12/13 23:04:32 hobbs Exp $ +'\" RCS: @(#) $Id: radiobutton.n,v 1.12 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH radiobutton n 4.4 Tk "Tk Built-In Commands" @@ -95,7 +95,7 @@ specified. .OP \-tristatevalue tristateValue Value .VS 8.5 Specifies the value that causes the radiobutton to display the multi-value -selection, also known as the tri-state mode. Defaults to ``""'' +selection, also known as the tri-state mode. Defaults to the empty string. .VE 8.5 .OP \-value value Value Specifies value to store in the button's associated variable whenever diff --git a/doc/scale.n b/doc/scale.n index c0ce831..c883e6a 100644 --- a/doc/scale.n +++ b/doc/scale.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: scale.n,v 1.6 2004/10/28 12:25:53 dkf Exp $ +'\" RCS: @(#) $Id: scale.n,v 1.7 2007/10/24 14:32:58 dkf Exp $ '\" .so man.macros .TH scale n 4.1 Tk "Tk Built-In Commands" @@ -25,7 +25,8 @@ scale \- Create and manipulate scale widgets .SH "WIDGET-SPECIFIC OPTIONS" .OP \-bigincrement bigIncrement BigIncrement Some interactions with the scale cause its value to change by -``large'' increments; this option specifies the size of the +.QW large +increments; this option specifies the size of the large increments. If specified as 0, the large increments default to 1/10 the range of the scale. .OP \-command command Command diff --git a/doc/selection.n b/doc/selection.n index 9a99426..a254d0d 100644 --- a/doc/selection.n +++ b/doc/selection.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: selection.n,v 1.7 2005/04/06 21:11:54 dkf Exp $ +'\" RCS: @(#) $Id: selection.n,v 1.8 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH selection n 8.1 Tk "Tk Built-In Commands" @@ -37,15 +37,19 @@ so that no window owns the selection anymore. \fISelection\fR specifies the X selection that should be cleared, and should be an atom name such as PRIMARY or CLIPBOARD; see the Inter-Client Communication Conventions Manual for complete details. -\fISelection\fR defaults to PRIMARY and \fIwindow\fR defaults to ``.''. +\fISelection\fR defaults to PRIMARY and \fIwindow\fR defaults to +.QW . . Returns an empty string. .TP \fBselection get\fR ?\fB\-displayof\fR \fIwindow\fR? ?\fB\-selection\fR \fIselection\fR? ?\fB\-type\fR \fItype\fR? Retrieves the value of \fIselection\fR from \fIwindow\fR's display and returns it as a result. \fISelection\fR defaults to PRIMARY and -\fIwindow\fR defaults to ``.''. +\fIwindow\fR defaults to +.QW . . \fIType\fR specifies the form in which the selection is to be returned -(the desired ``target'' for conversion, in ICCCM terminology), and +(the desired +.QW target +for conversion, in ICCCM terminology), and should be an atom name such as STRING or FILE_NAME; see the Inter-Client Communication Conventions Manual for complete details. \fIType\fR defaults to STRING. The selection owner may choose to @@ -117,7 +121,8 @@ The first form of \fBselection own\fR returns the path name of the window in this application that owns \fIselection\fR on the display containing \fIwindow\fR, or an empty string if no window in this application owns the selection. \fISelection\fR defaults to PRIMARY and -\fIwindow\fR defaults to ``.''. +\fIwindow\fR defaults to +.QW . . .PP The second form of \fBselection own\fR causes \fIwindow\fR to become the new owner of \fIselection\fR on \fIwindow\fR's display, returning diff --git a/doc/send.n b/doc/send.n index fc2fe65..c249014 100644 --- a/doc/send.n +++ b/doc/send.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: send.n,v 1.5 2005/04/06 21:11:54 dkf Exp $ +'\" RCS: @(#) $Id: send.n,v 1.6 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH send n 4.0 Tk "Tk Built-In Commands" @@ -30,7 +30,8 @@ contained entirely within the \fIcmd\fR argument. If one or more \fIarg\fRs are present, they are concatenated to form the command to be executed, just as for the \fBeval\fR command. .PP -If the initial arguments of the command begin with ``\-'' +If the initial arguments of the command begin with +.QW \- they are treated as options. The following options are currently defined: .TP @@ -49,7 +50,8 @@ the application's main window. .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 ``\-'' +option is needed only if \fIapp\fR could contain a leading +.QW \- character. .SH "APPLICATION NAMES" diff --git a/doc/spinbox.n b/doc/spinbox.n index 0aa9103..617b4a7 100644 --- a/doc/spinbox.n +++ b/doc/spinbox.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: spinbox.n,v 1.4 2004/08/17 22:37:24 dkf Exp $ +'\" RCS: @(#) $Id: spinbox.n,v 1.5 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH spinbox n 8.4 Tk "Tk Built-In Commands" @@ -265,11 +265,15 @@ spinbox window. \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, ``\fB@0\fR'' indicates the left-most character in the -window. +For example, +.QW \fB@0\fR +indicates the left-most character in the window. .LP -Abbreviations may be used for any of the forms above, e.g. ``\fBe\fR'' -or ``\fBsel.f\fR''. In general, out-of-range indices are automatically +Abbreviations may be used for any of the forms above, e.g. +.QW \fBe\fR +or +.QW \fBsel.f\fR . +In general, out-of-range indices are automatically rounded to the nearest legal value. .PP The following commands are possible for spinbox widgets: @@ -467,9 +471,11 @@ become visible. .PP Tk automatically creates class bindings for spinboxes that give them the following default behavior. -In the descriptions below, ``word'' refers to a contiguous group -of letters, digits, or ``_'' characters, or any single character -other than these. +In the descriptions below, +.QW word +refers to a contiguous group of letters, digits, or +.QW _ +characters, or any single character other than these. .IP [1] Clicking mouse button 1 positions the insertion cursor just before the character underneath the mouse cursor, sets the diff --git a/doc/text.n b/doc/text.n index ce52363..4459e04 100644 --- a/doc/text.n +++ b/doc/text.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: text.n,v 1.45 2007/10/23 15:44:35 dkf Exp $ +'\" RCS: @(#) $Id: text.n,v 1.46 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH text n 8.5 Tk "Tk Built-In Commands" @@ -150,8 +150,9 @@ not. Specifies the desired width for the window in units of characters in the font given by the \fB\-font\fR option. If the font doesn't have a uniform width then the width of the -character ``0'' is used in translating from character units to -screen units. +character +.QW 0 +is used in translating from character units to screen units. .OP \-wrap wrap Wrap Specifies how to handle lines in the text that are too long to be displayed in a single line of the text's window. @@ -410,14 +411,18 @@ submodifier is given, this only examines non-elided characters, otherwise all characters (elided or not) are examined. .PP If more than one modifier is present then they are applied in -left-to-right order. For example, the index ``\fBend \- 1 chars\fR'' +left-to-right order. For example, the index +.QW "\fBend \- 1 chars\fR" refers to the next-to-last character in the text and -``\fBinsert wordstart \- 1 c\fR'' refers to the character just before +.QW "\fBinsert wordstart \- 1 c\fR" +refers to the character just before the first one in the word containing the insertion cursor. Modifiers are applied one by one in this left to right order, and after each step the resulting index is constrained to be a valid index in the text -widget. So, for example, the index ``\fB1.0 -1c +1c\fR'' refers to the -index ``\fB2.0\fR''. +widget. So, for example, the index +.QW "\fB1.0 -1c +1c\fR" +refers to the index +.QW "\fB2.0\fR". .PP Where modifiers result in index changes by display lines, display chars or display indices, and the \fIbase\fR refers to an index inside an @@ -431,7 +436,9 @@ The first form of annotation in text widgets is a tag. A tag is a textual string that is associated with some of the characters in a text. Tags may contain arbitrary characters, but it is probably best to -avoid using the characters `` '' (space), \fB+\fR, or \fB\-\fR: +avoid using the characters +.QW " " +(space), \fB+\fR, or \fB\-\fR: these characters have special meaning in indices, so tags containing them can't be used as indices. There may be any number of tags associated with characters in a @@ -446,7 +453,9 @@ When a tag is defined (by associating it with characters or setting its display options or binding commands to it), it is given a priority higher than any existing tag. The priority order of tags may be redefined using the -``\fIpathName \fBtag raise\fR'' and ``\fIpathName \fBtag lower\fR'' +.QW "\fIpathName \fBtag raise\fR" +and +.QW "\fIpathName \fBtag lower\fR" widget commands. .PP Tags serve three purposes in text widgets. @@ -455,7 +464,9 @@ By default, characters are displayed as determined by the \fB\-background\fR, \fB\-font\fR, and \fB\-foreground\fR options for the text widget. However, display options may be associated with individual tags -using the ``\fIpathName \fBtag configure\fR'' widget command. +using the +.QW "\fIpathName \fBtag configure\fR" +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: @@ -640,8 +651,9 @@ Tcl command will be executed. Tag bindings can be used to give behaviors to ranges of characters; among other things, this allows hypertext-like features to be implemented. -For details, see the description of the ``\fIpathName \fBtag bind\fR'' widget -command below. +For details, see the description of the +.QW "\fIpathName \fBtag bind\fR" +widget command below. .VS 8.5 Tag bindings are shared between all peer widgets (including any bindings for the special \fBsel\fR tag). @@ -671,7 +683,9 @@ remain; it will just have new neighbor characters. In contrast, if the characters containing a tag are deleted then the tag will no longer have an association with characters in the file. -Marks may be manipulated with the ``\fIpathName \fBmark\fR'' widget +Marks may be manipulated with the +.QW "\fIpathName \fBmark\fR" +widget command, and their current locations may be determined by using the mark name as an index in widget commands. .PP @@ -887,7 +901,8 @@ Whenever the \fBsel\fR tag range changes a virtual event \fB<>\fR is generated. .PP The \fBsel\fR tag is automatically defined when a text widget is -created, and it may not be deleted with the ``\fIpathName \fBtag delete\fR'' +created, and it may not be deleted with the +.QW "\fIpathName \fBtag delete\fR" widget command. Furthermore, the \fBselectBackground\fR, \fBselectBorderWidth\fR, and \fBselectForeground\fR options for the text widget are tied to the \fB\-background\fR, @@ -908,8 +923,9 @@ empty) for background windows. Each peer text widget has its own .PP The mark named \fBinsert\fR has special significance in text widgets. It is defined automatically when a text widget is created and it -may not be unset with the ``\fIpathName \fBmark unset\fR'' widget -command. +may not be unset with the +.QW "\fIpathName \fBmark unset\fR" +widget command. The \fBinsert\fR mark represents the position of the insertion cursor, and the insertion cursor will automatically be drawn at this point whenever the text widget has the input focus. @@ -1428,7 +1444,8 @@ This command returns an empty string. \fIpathName \fBmark unset \fImarkName \fR?\fImarkName markName ...\fR? Remove the mark corresponding to each of the \fImarkName\fR arguments. The removed marks will not be usable in indices and will not be -returned by future calls to ``\fIpathName \fBmark names\fR''. +returned by future calls to +.QW "\fIpathName \fBmark names\fR" . This command returns an empty string. .RE .TP @@ -1661,8 +1678,9 @@ on the syntax of \fIsequence\fR and the substitutions performed on \fIscript\fR before invoking it. If all arguments are specified then a new binding is created, replacing any existing binding for the same \fIsequence\fR and \fItagName\fR -(if the first character of \fIscript\fR is ``+'' then \fIscript\fR -augments an existing binding rather than replacing it). +(if the first character of \fIscript\fR is +.QW + +then \fIscript\fR augments an existing binding rather than replacing it). In this case the return value is an empty string. If \fIscript\fR is omitted then the command returns the \fIscript\fR associated with \fItagName\fR and \fIsequence\fR (an error occurs @@ -1747,8 +1765,10 @@ Returns a list whose elements are the names of all the tags that are active at the character position given by \fIindex\fR. If \fIindex\fR is omitted, then the return value will describe all of the tags that exist for the text (this includes all tags -that have been named in a ``\fIpathName \fBtag\fR'' widget -command but haven't been deleted by a ``\fIpathName \fBtag delete\fR'' +that have been named in a +.QW "\fIpathName \fBtag\fR" +widget command but haven't been deleted by a +.QW "\fIpathName \fBtag delete\fR" widget command, even if no characters are currently marked with the tag). The list will be sorted in order from lowest priority to highest @@ -1893,7 +1913,11 @@ This command shifts the view in the window left or right according to .VS 8.5 If \fIwhat\fR is \fBunits\fR or \fBpages\fR then \fInumber\fR must be an integer, otherwise number may be specified in any of the forms acceptable -to \fBTk_GetPixels\fR, such as ``2.0c'' or ``1i'' (the result is rounded +to \fBTk_GetPixels\fR, such as +.QW 2.0c +or +.QW 1i +(the result is rounded to the nearest integer value. If no units are given, pixels are assumed). If \fIwhat\fR is \fBunits\fR, the view adjusts left or right by \fInumber\fR average-width characters on the display; if it is @@ -1946,7 +1970,11 @@ This command adjust the view in the window up or down according to .VS 8.5 If \fIwhat\fR is \fBunits\fR or \fBpages\fR then \fInumber\fR must be an integer, otherwise number may be specified in any of the forms acceptable -to \fBTk_GetPixels\fR, such as ``2.0c'' or ``1i'' (the result is rounded +to \fBTk_GetPixels\fR, such as +.QW 2.0c +or +.QW 1i +(the result is rounded to the nearest integer value. If no units are given, pixels are assumed). If \fIwhat\fR is \fBunits\fR, the view adjusts up or down by \fInumber\fR lines on the display; if it is \fBpages\fR then the view @@ -1991,8 +2019,9 @@ This command used to be used for scrolling, but now it is obsolete. .PP Tk automatically creates class bindings for texts that give them the following default behavior. -In the descriptions below, ``word'' is dependent on the value of -the \fBtcl_wordchars\fR variable. See tclvars(n). +In the descriptions below, +.QW word +is dependent on the value of the \fBtcl_wordchars\fR variable. See tclvars(n). .IP [1] Clicking mouse button 1 positions the insertion cursor just before the character underneath the mouse cursor, sets the diff --git a/doc/tk.n b/doc/tk.n index fe9a78d..027a9fd 100644 --- a/doc/tk.n +++ b/doc/tk.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tk.n,v 1.13 2007/08/28 15:16:11 dkf Exp $ +'\" RCS: @(#) $Id: tk.n,v 1.14 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH tk n 8.4 Tk "Tk Built-In Commands" @@ -35,7 +35,9 @@ commands to communicate with the application). If \fInewName\fR is specified, then the name of the application is changed to \fInewName\fR. If the given name is already in use, then a suffix of the form -``\fB #2\fR'' or ``\fB #3\fR'' is appended in order to make the name unique. +.QW "\fB #2\fR" or +.QW "\fB #3\fR" +is appended in order to make the name unique. The command's result is the name actually chosen. \fInewName\fR should not start with a capital letter. This will interfere with option processing, since names starting with @@ -67,7 +69,9 @@ omitted, it defaults to the main window. If the \fInumber\fR argument is omitted, the current value of the scaling factor is returned. .RS .PP -A ``point'' is a unit of measurement equal to 1/72 inch. A scaling factor +A +.QW point +is a unit of measurement equal to 1/72 inch. A scaling factor of 1.0 corresponds to 1 pixel per point, which is equivalent to a standard 72 dpi monitor. A scaling factor of 1.25 would mean 1.25 pixels per point, which is the setting for a 90 dpi monitor; setting the scaling factor to diff --git a/doc/ttk_button.n b/doc/ttk_button.n index df926c9..c632ca1 100644 --- a/doc/ttk_button.n +++ b/doc/ttk_button.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_button.n,v 1.4 2007/10/23 15:44:35 dkf Exp $ +'\" RCS: @(#) $Id: ttk_button.n,v 1.5 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH ttk_button n 8.5 Tk "Tk Themed Widget" @@ -72,7 +72,9 @@ See \fIttk_widget(n)\fR .OP \-state state State May be set to \fBnormal\fR or \fBdisabled\fR to control the \fBdisabled\fR state bit. -This is a ``write-only'' option: setting it changes the +This is a +.QW write-only +option: setting it changes the widget state, but the \fBstate\fR widget command does not affect the state option. .SH "SEE ALSO" diff --git a/doc/ttk_checkbutton.n b/doc/ttk_checkbutton.n index 018187c..3f59cb7 100644 --- a/doc/ttk_checkbutton.n +++ b/doc/ttk_checkbutton.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_checkbutton.n,v 1.5 2007/10/23 15:44:35 dkf Exp $ +'\" RCS: @(#) $Id: ttk_checkbutton.n,v 1.6 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH ttk_checkbutton n 8.5 Tk "Tk Themed Widget" @@ -61,8 +61,11 @@ the linked \fB\-variable\fR is set to the widget's \fB\-onvalue\fR, and clears it otherwise. The widget sets the \fBalternate\fR state whenever the linked \fB\-variable\fR is unset. -(The \fBalternate\fR state may be used to indicate a ``tri-state'' -or ``indeterminate'' selection.) +(The \fBalternate\fR state may be used to indicate a +.QW tri-state +or +.QW indeterminate +selection.) .SH "SEE ALSO" ttk_widget(n), ttk_radiobutton(n), checkbutton(n) .SH "KEYWORDS" diff --git a/doc/ttk_entry.n b/doc/ttk_entry.n index 5275004..2e3a306 100644 --- a/doc/ttk_entry.n +++ b/doc/ttk_entry.n @@ -7,7 +7,7 @@ '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" '\" SOURCE: entry.n, r1.12 -'\" RCS: @(#) $Id: ttk_entry.n,v 1.4 2007/10/23 15:44:35 dkf Exp $ +'\" RCS: @(#) $Id: ttk_entry.n,v 1.5 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH ttk_entry n 8.5 Tk "Tk Themed Widget" @@ -56,7 +56,9 @@ One of \fBleft\fR, \fBcenter\fR, or \fBright\fR. If this option is specified, then the true contents of the entry are not displayed in the window. Instead, each character in the entry's value will be displayed as -the first character in the value of this option, such as ``*''. +the first character in the value of this option, such as +.QW * +or a bullet character. This is useful, for example, if the entry is to be used to enter a password. If characters in the entry are selected and copied elsewhere, the @@ -114,8 +116,9 @@ to the first character in the string. .IP \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, ``\fB@0\fR'' indicates the left-most character in the -window. +For example, +.QW \fB@0\fR +indicates the left-most character in the window. .IP \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 @@ -131,9 +134,12 @@ Indicates the character just after the last one in the selection. It is an error to use this form if the selection isn't in the entry window. .LP -Abbreviations may be used for any of the forms above, e.g. ``\fBe\fR'' -or ``\fBsel.f\fR''. In general, out-of-range indices are automatically -rounded to the nearest legal value. +Abbreviations may be used for any of the forms above, e.g. +.QW \fBe\fR +or +.QW \fBsel.f\fR . +In general, out-of-range indices are automatically rounded to the nearest +legal value. .SH "WIDGET COMMAND" .PP The following commands are possible for entry widgets: @@ -341,9 +347,11 @@ The standard entry widget invokes validation whenever the linked \fB\-textvariable\fR is modified; the Tk themed entry widget does not. .SH "DEFAULT BINDINGS" The entry widget's default bindings enable the following behavior. -In the descriptions below, ``word'' refers to a contiguous group -of letters, digits, or ``_'' characters, or any single character -other than these. +In the descriptions below, +.QW word +refers to a contiguous group of letters, digits, or +.QW _ +characters, or any single character other than these. .IP \(bu Clicking mouse button 1 positions the insert cursor just before the character underneath the mouse cursor, sets the diff --git a/doc/ttk_radiobutton.n b/doc/ttk_radiobutton.n index 2b4a424..84369ff 100644 --- a/doc/ttk_radiobutton.n +++ b/doc/ttk_radiobutton.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_radiobutton.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_radiobutton.n,v 1.5 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH ttk_radiobutton n 8.5 Tk "Tk Themed Widget" @@ -57,8 +57,11 @@ the linked \fB\-variable\fR is set to the widget's \fB\-value\fR, and clears it otherwise. The widget sets the \fBalternate\fR state whenever the linked \fB\-variable\fR is unset. -(The \fBalternate\fR state may be used to indicate a ``tri-state'' -or ``indeterminate'' selection.) +(The \fBalternate\fR state may be used to indicate a +.QW tri-state +or +.QW indeterminate +selection.) .SH "SEE ALSO" ttk_widget(n), ttk_checkbutton(n), radiobutton(n) .SH "KEYWORDS" diff --git a/doc/ttk_sizegrip.n b/doc/ttk_sizegrip.n index 708674f..6da57f4 100644 --- a/doc/ttk_sizegrip.n +++ b/doc/ttk_sizegrip.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_sizegrip.n,v 1.7 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_sizegrip.n,v 1.8 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH ttk_sizegrip n 8.5 Tk "Tk Themed Widget" @@ -17,43 +17,40 @@ ttk_sizegrip \- Bottom-right corner resize widget .BE .SH DESCRIPTION -A \fBttk::sizegrip\fR widget (also known as a \fIgrow box\fR) -allows the user to resize the containing toplevel window -by pressing and dragging the grip. +A \fBttk::sizegrip\fR widget (also known as a \fIgrow box\fR) allows the user +to resize the containing toplevel window by pressing and dragging the grip. .SO -\-class \-cursor \-state \-style -\-takefocus +\-class \-cursor \-state +\-style \-takefocus .SE .SH "WIDGET COMMAND" -Sizegrip widgets support the standard -\fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR -methods. No other widget methods are used. +Sizegrip widgets support the standard \fBcget\fR, \fBconfigure\fR, +\fBinstate\fR, and \fBstate\fR methods. No other widget methods are used. .SH "PLATFORM-SPECIFIC NOTES" -On Mac OSX, toplevel windows automatically include a built-in -size grip by default. -Adding an \fBttk::sizegrip\fR there is harmless, since -the built-in grip will just mask the widget. +On Mac OSX, toplevel windows automatically include a built-in size grip by +default. Adding an \fBttk::sizegrip\fR there is harmless, since the built-in +grip will just mask the widget. .SH EXAMPLES .PP Using \fBpack\fR: .CS pack [ttk::frame $top.statusbar] -side bottom -fill x -pack [ttk::sizegrip $top.statusbar.grip] -side right -anchor se +pack [\fBttk::sizegrip\fR $top.statusbar.grip] -side right -anchor se .CE .PP Using \fBgrid\fR: .CS -grid [ttk::sizegrip $top.statusbar.grip] \e +grid [\Bttk::sizegrip\fR $top.statusbar.grip] \e -row $lastRow -column $lastColumn -sticky se # ... optional: add vertical scrollbar in $lastColumn, # ... optional: add horizontal scrollbar in $lastRow .CE .SH "BUGS" -If the containing toplevel's position was specified -relative to the right or bottom of the screen -(e.g., \fB[wm geometry ... \fIw\fBx\fIh\fB-\fIx\fB-\fIy\fB]\fR -instead of \fB[wm geometry ... \fIw\fBx\fIh\fB+\fIx\fB+\fIy\fB]\fR), -the sizegrip widget will not resize the window. +If the containing toplevel's position was specified relative to the right or +bottom of the screen (e.g., \fB[wm geometry ... +\fIw\fBx\fIh\fB\-\fIx\fB\-\fIy\fB]\fR instead of \fB[wm geometry ... +\fIw\fBx\fIh\fB+\fIx\fB+\fIy\fB]\fR), the sizegrip widget will not resize the +window. .PP ttk::sizegrip widgets only support "southeast" resizing. .SH "SEE ALSO" diff --git a/doc/ttk_style.n b/doc/ttk_style.n index 7f4237d..20e3a41 100644 --- a/doc/ttk_style.n +++ b/doc/ttk_style.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_style.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_style.n,v 1.5 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH ttk_style n 8.5 Tk "Tk Themed Widget" @@ -18,96 +18,103 @@ ttk_style \- Control overall look and feel of widgets .BS .SH NOTES .PP -This manpage has not been written yet. -Please see the Tcl'2004 conference presentation, -available at http://tktable.sourceforge.net/tile/tile-tcl2004.pdf +This manpage has not been written yet. Please see the Tcl'2004 conference +presentation, available at +http://tktable.sourceforge.net/tile/tile-tcl2004.pdf .BE .SH DEFINITIONS .PP -Each widget is assigned a \fIstyle\fR, -which specifies the set of elements making up the widget -and how they are arranged, along with dynamic and default -settings for element resources. -By default, the style name is the same as the widget's class; -this may be overridden by the \fB-style\fR option. +Each Ttk widget is assigned a \fIstyle\fR, which specifies the set of elements +making up the widget and how they are arranged, along with dynamic and default +settings for element resources. By default, the style name is the same as the +widget's class; this may be overridden by the \fB\-style\fR option. .PP -A \fItheme\fR is a collection of elements and styles -which controls the overall look and feel of an application. +A \fItheme\fR is a collection of elements and styles which controls the +overall look and feel of an application. .SH DESCRIPTION The \fBttk::style\fR command takes the following arguments: .TP -\fBttk::style configure \fIstyle\fR ?\fI-option \fR?\fIvalue option value...\fR? ? +\fBttk::style configure \fIstyle\fR ?\fI\-option \fR?\fIvalue option value...\fR? ? +. Sets the default value of the specified option(s) in \fIstyle\fR. .TP -\fBttk::style map \fIstyle\fR ?\fI-option\fR { \fIstatespec value\fR } ... ? -Sets dynamic values of the specified option(s) in \fIstyle\fR. -Each \fIstatespec / value\fR pair is examined in order; -the value corresponding to the first matching \fIstatespec\fR -is used. +\fBttk::style map \fIstyle\fR ?\fI\-option\fR { \fIstatespec value\fR } ... ? +. +Sets dynamic values of the specified option(s) in \fIstyle\fR. Each +\fIstatespec / value\fR pair is examined in order; the value corresponding to +the first matching \fIstatespec\fR is used. .TP -\fBttk::style lookup \fIstyle\fR \fI-option \fR?\fIstate \fR?\fIdefault\fR?? -Returns the value specified for \fI-option\fR in style \fIstyle\fR -in state \fIstate\fR, using the standard lookup rules for element options. -\fIstate\fR is a list of state names; if omitted, -it defaults to all bits off (the ``normal'' state). -If the \fIdefault\fR argument is present, it is used as a fallback -value in case no specification for \fI-option\fR is found. +\fBttk::style lookup \fIstyle\fR \fI\-option \fR?\fIstate\fR? ?\fIdefault\fR? +. +Returns the value specified for \fI\-option\fR in style \fIstyle\fR in state +\fIstate\fR, using the standard lookup rules for element options. \fIstate\fR +is a list of state names; if omitted, it defaults to all bits off (the +.QW normal +state). If the \fIdefault\fR argument is present, it is used as a +fallback value in case no specification for \fI\-option\fR is found. .\" Otherwise -- signal error? return empty string? Leave unspecified for now. .TP \fBttk::style layout \fIstyle\fR ?\fIlayoutSpec\fR? -Define the widget layout for style \fIstyle\fR. -See "\fBLAYOUTS\fR" below for the format of \fIlayoutSpec\fR. -If \fIlayoutSpec\fR is omitted, return the layout specification -for style \fIstyle\fR. -.TP +. +Define the widget layout for style \fIstyle\fR. See "\fBLAYOUTS\fR" below for +the format of \fIlayoutSpec\fR. If \fIlayoutSpec\fR is omitted, return the +layout specification for style \fIstyle\fR. +.TP \fBttk::style element create\fR \fIelementName\fR \fItype\fR ?\fIargs...\fR? -Creates a new element in the current theme of type \fItype\fR. -The only built-in element type is \fIimage\fR (see \fIimage(n)\fR), -although themes may define other element types -(see \fBTtk_RegisterElementFactory\fR). +. +Creates a new element in the current theme of type \fItype\fR. The only +built-in element type is \fIimage\fR (see \fIttk_image(n)\fR), although themes +may define other element types (see \fBTtk_RegisterElementFactory\fR). .TP \fBttk::style element names\fR +. Returns the list of elements defined in the current theme. .TP \fBttk::style element options \fIelement\fR +. Returns the list of \fIelement\fR's options. .TP -\fBttk::style theme create\fR \fIthemeName\fR ?\fB-parent \fIbasedon\fR? ?\fB-settings \fIscript...\fR ? -Creates a new theme. It is an error if \fIthemeName\fR already exists. -If \fI-parent\fR is specified, the new theme will inherit -styles, elements, and layouts from the parent theme \fIbasedon\fB. -If \fI-settings\fR is present, \fIscript\fR is evaluated in the -context of the new theme as per \fBttk::style theme settings\fR. +\fBttk::style theme create\fR \fIthemeName\fR ?\fB\-parent \fIbasedon\fR? ?\fB\-settings \fIscript...\fR ? +. +Creates a new theme. It is an error if \fIthemeName\fR already exists. If +\fI\-parent\fR is specified, the new theme will inherit styles, elements, and +layouts from the parent theme \fIbasedon\fB. If \fI\-settings\fR is present, +\fIscript\fR is evaluated in the context of the new theme as per \fBttk::style +theme settings\fR. .TP \fBttk::style theme settings \fIthemeName\fR \fIscript\fR -Temporarily sets the current theme to \fIthemeName\fR, -evaluate \fIscript\fR, then restore the previous theme. -Typically \fIscript\fR simply defines styles and elements, -though arbitrary Tcl code may appear. +. +Temporarily sets the current theme to \fIthemeName\fR, evaluate \fIscript\fR, +then restore the previous theme. Typically \fIscript\fR simply defines styles +and elements, though arbitrary Tcl code may appear. .TP \fBttk::style theme names\fR +. Returns a list of the available themes. .TP \fBttk::style theme use\fR \fIthemeName\fR +. Sets the current theme to \fIthemeName\fR, and refreshes all widgets. .SH LAYOUTS -A \fIlayout\fR specifies a list of elements, each followed -by one or more options specifying how to arrange the element. -The layout mechanism uses a simplified version of the \fBpack\fR -geometry manager: given an initial cavity, -each element is allocated a parcel. -Valid options are: +A \fIlayout\fR specifies a list of elements, each followed by one or more +options specifying how to arrange the element. The layout mechanism uses a +simplified version of the \fBpack\fR geometry manager: given an initial +cavity, each element is allocated a parcel. Valid options are: .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. -If omitted, the element occupies the entire cavity. +\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. If omitted, the element occupies the +entire cavity. .TP -\fB-sticky \fI[nswe]\fR -Specifies where the element is placed inside its allocated parcel. +\fB\-sticky \fI[nswe]\fR +. +Specifies where the element is placed inside its allocated parcel. The syntax +is as in the equivalently-named option to the \fBgrid\fR geometry manager. .TP -\fB-children \fI{ sublayout... }\fR +\fB\-children \fI{ sublayout... }\fR +. Specifies a list of elements to place inside the element. .\" Also: -border, -unit, -expand: may go away. .SH EXAMPLE diff --git a/doc/ttk_treeview.n b/doc/ttk_treeview.n index e1b207a..475ed40 100644 --- a/doc/ttk_treeview.n +++ b/doc/ttk_treeview.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_treeview.n,v 1.7 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_treeview.n,v 1.8 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH ttk_treeview n 8.5 Tk "Tk Themed Widget" @@ -40,10 +40,9 @@ Treeview widgets support horizontal and vertical scrolling with the standard \fB\-\fR[\fBxy\fR]\fBscrollcommand\fR options and \fB[xyview\fR widget commands. .SO -\-class \-cursor \-takefocus \-style -\-xscrollcommand \-yscrollcommand +\-class \-cursor \-takefocus +\-style \-xscrollcommand \-yscrollcommand .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-columns columns Columns A list of column identifiers, specifying the number of columns and their @@ -89,7 +88,6 @@ The default is \fBtree headings\fR, i.e., show all elements. \fBNOTE:\fR Column #0 always refers to the tree column, even if \fB\-show tree\fR is not specified. .RE - .SH "WIDGET COMMAND" .TP \fIpathname \fBbbox\fR \fIitem\fR ?\fIcolumn\fR? @@ -439,6 +437,5 @@ Generated just after setting the focus item to \fB\-open false\fR. The \fBfocus\fR and \fBselection\fR widget commands can be used to determine the affected item or items. In Tk 8.5, the affected item is also passed as the \fB\-detail\fR field of the virtual event. - .SH "SEE ALSO" ttk_widget(n), listbox(n), image(n), bind(n) diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n index 3ba3111..6aa4706 100644 --- a/doc/ttk_widget.n +++ b/doc/ttk_widget.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_widget.n,v 1.5 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_widget.n,v 1.6 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH ttk_widget n 8.5 Tk "Tk Themed Widget" @@ -15,7 +15,6 @@ ttk_widget \- Standard options and commands supported by Tk themed widgets .SH DESCRIPTION This manual describes common widget options and commands. - .SH "STANDARD OPTIONS" The following options are supported by all Tk themed widgets: .OP \-class undefined undefined @@ -36,7 +35,6 @@ appended, and which should return \fB0\fR or \fB1\fR), or the empty string. See \fIoptions(n)\fR in the Tk reference manual for the full description. .OP \-style style Style May be used to specify a custom widget style. - .SH "SCROLLABLE WIDGET OPTIONS" .PP The following options are supported by widgets that are controllable by a @@ -54,8 +52,11 @@ second fraction indicates the information just after the last portion that is visible. .PP Typically the \fBxScrollCommand\fR option consists of the path name of a -\fBscrollbar\fR widget followed by ``set'', e.g. ``.x.scrollbar set''. This -will cause the scrollbar to be updated whenever the view in the window +\fBscrollbar\fR widget followed by +.QW set , +e.g. +.QW ".x.scrollbar set" . +This will cause the scrollbar to be updated whenever the view in the window changes. .PP If this option is set to the empty string (the default), then no command is be @@ -64,7 +65,6 @@ executed. .OP \-yscrollcommand yScrollCommand ScrollCommand A command prefix, used to communicate with vertical scrollbars. See the description of \fB\-xscrollcommand\fR above for details. - .SH "LABEL OPTIONS" The following options are supported by labels, buttons, and other button-like widgets: @@ -102,13 +102,13 @@ The default; display the image if present, otherwise the text. If greater than zero, specifies how much space, in character widths, to allocate for the text label. If less than zero, specifies a minimum width. If zero or unspecified, the natural width of the text label is used. - .SH "COMPATIBILITY OPTIONS" .OP \-state state State May be set to \fBnormal\fR or \fBdisabled\fR to control the \fBdisabled\fR -state bit. This is a ``write-only'' option: setting it changes the widget -state, but the \fBstate\fR widget command does not affect the state option. - +state bit. This is a +.QW write-only +option: setting it changes the widget state, but the \fBstate\fR widget +command does not affect the state option. .SH COMMANDS .TP \fIpathName \fBcget\fR \fIoption\fR @@ -160,11 +160,18 @@ include: \fBactive\fR . The mouse cursor is over the widget and pressing a mouse button will cause -some action to occur. (aka "prelight" (Gnome), "hot" (Windows), "hover"). +some action to occur. (aka +.QW "prelight" +(Gnome), +.QW "hot" +(Windows), +.QW "hover" ). .TP \fBdisabled\fR . -Widget is disabled under program control (aka "unavailable", "inactive") +Widget is disabled under program control (aka +.QW "unavailable" , +.QW "inactive" ) .TP \fBfocus\fR . @@ -172,18 +179,25 @@ Widget has keyboard focus. .TP \fBpressed\fR . -Widget is being pressed (aka "armed" in Motif). +Widget is being pressed (aka +.QW "armed" +in Motif). .TP \fBselected\fR . -The widget is "On", "true", or "current" (for things like checkbuttons and -radiobuttons). +The widget is +.QW "On" , +.QW "true" , +or +.QW "current" +(for things like checkbuttons and radiobuttons). .TP \fBbackground\fR . -Windows and the Mac have a notion of an "active" or foreground window. The -\fBbackground\fR state is set for widgets in a background window, and cleared -for those in the foreground window. +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 . @@ -192,8 +206,11 @@ Widget should not allow user modification. \fBalternate\fR . A widget-specific alternate display format. For example, used for checkbuttons -and radiobuttons in the "tristate" or "mixed" state, and for buttons with -\fB\-default active\fR. +and radiobuttons in the +.QW "tristate" +or +.QW "mixed" +state, and for buttons with \fB\-default active\fR. .TP \fBinvalid\fR . @@ -203,7 +220,6 @@ bounds, entry widget value failed validation.) A \fIstate specification\fR or \fIstateSpec\fR is a list of state names, optionally prefixed with an exclamation point (!) indicating that the bit is off. - .SH EXAMPLES .CS set b [ttk::button .b] @@ -217,7 +233,6 @@ $b instate {pressed !disabled} { .b invoke } # Reenable widget: $b state !disabled .CE - .SH "SEE ALSO" ttk_intro(n), style(n) .SH KEYWORDS diff --git a/doc/winfo.n b/doc/winfo.n index 43bb69c..3f2bea4 100644 --- a/doc/winfo.n +++ b/doc/winfo.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: winfo.n,v 1.8 2005/04/06 21:11:54 dkf Exp $ +'\" RCS: @(#) $Id: winfo.n,v 1.9 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH winfo n 4.3 Tk "Tk Built-In Commands" @@ -57,7 +57,9 @@ Returns the class name for \fIwindow\fR. .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 ``known'' to be full if the last +otherwise. The colormap for a window is +.QW known +to be full if the last attempt to allocate a new color on that window failed and this application hasn't freed any colors in the colormap since the failed allocation. @@ -90,7 +92,10 @@ window exists. 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 -to \fBTk_GetScreenMM\fR, such as ``2.0c'' or ``1i''. +to \fBTk_GetScreenMM\fR, such as +.QW 2.0c +or +.QW 1i . The return value may be fractional; for an integer value, use \fBwinfo pixels\fR. .TP @@ -155,7 +160,10 @@ the display of the application's main window. 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 -to \fBTk_GetPixels\fR, such as ``2.0c'' or ``1i''. +to \fBTk_GetPixels\fR, such as +.QW 2.0c +or +.QW 1i . The result is rounded to the nearest integer value; for a fractional result, use \fBwinfo fpixels\fR. .TP @@ -252,7 +260,8 @@ in pixels. 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 -has the form ``\fBX\fImajor\fBR\fIminor vendor vendorVersion\fR'' +has the form +.QW "\fBX\fImajor\fBR\fIminor vendor vendorVersion\fR" where \fImajor\fR and \fIminor\fR are the version and revision numbers provided by the server (e.g., \fBX11R5\fR), \fIvendor\fR is the name of the vendor for the server, and \fIvendorRelease\fR diff --git a/doc/wish.1 b/doc/wish.1 index 08daea5..9de034f 100644 --- a/doc/wish.1 +++ b/doc/wish.1 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: wish.1,v 1.5 2004/09/09 12:17:11 dkf Exp $ +'\" RCS: @(#) $Id: wish.1,v 1.6 2007/10/24 14:32:59 dkf Exp $ '\" .so man.macros .TH wish 1 8.0 Tk "Tk Applications" @@ -70,7 +70,8 @@ arguments, ?\fB-encoding \fIname\fR? ?\fIfileName\fR? specify the name of a script file, and, optionally, the encoding of the text data stored in that script file. A value for \fIfileName\fR is recognized if the appropriate argument -does not start with ``\-''. +does not start with +.QW \- . .PP If there are no arguments, or the arguments do not specify a \fIfileName\fR, then wish reads Tcl commands interactively from standard input. @@ -104,7 +105,8 @@ The name of the application, which is used for purposes such as \fBsend\fR commands, is taken from the \fB\-name\fR option, if it is specified; otherwise it is taken from \fIfileName\fR, if it is specified, or from the command name by which -\fBwish\fR was invoked. In the last two cases, if the name contains a ``/'' +\fBwish\fR was invoked. In the last two cases, if the name contains a +.QW / character, then only the characters after the last slash are used as the application name. .PP @@ -185,16 +187,25 @@ since the backslash at the end of the second line causes the third line to be treated as part of the comment on the second line. .PP The end of a script file may be marked either by the physical end of -the medium, or by the character, '\\032' ('\\u001a', control-Z). +the medium, or by the character, +.QW \e032 +(i.e. +.QW \eu001a , +control-Z). If this character is present in the file, the \fBwish\fR application will read text up to but not including the character. An application that requires this character in the file may encode it as -``\\032'', ``\\x1a'', or ``\\u001a''; or may generate it by use of commands -such as \fBformat\fR or \fBbinary\fR. +.QW \e032 , +.QW \ex1a , +or +.QW \eu001a ; +or may generate it by use of commands such as \fBformat\fR or \fBbinary\fR. .SH PROMPTS .PP When \fBwish\fR is invoked interactively it normally prompts for each -command with ``\fB% \fR''. You can change the prompt by setting the +command with +.QW "\fB% \fR" . +You can change the prompt by setting the variables \fBtcl_prompt1\fR and \fBtcl_prompt2\fR. If variable \fBtcl_prompt1\fR exists then it must consist of a Tcl script to output a prompt; instead of outputting a prompt \fBwish\fR diff --git a/doc/wm.n b/doc/wm.n index f497078..677491a 100644 --- a/doc/wm.n +++ b/doc/wm.n @@ -4,9 +4,9 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: wm.n,v 1.32 2007/10/23 15:44:36 dkf Exp $ -'\" +'\" +'\" RCS: @(#) $Id: wm.n,v 1.33 2007/10/24 14:32:59 dkf Exp $ +'\" .so man.macros .TH wm n 8.5 Tk "Tk Built-In Commands" .BS @@ -112,7 +112,8 @@ Specifies whether this is a topmost window (displays above all other windows). \fB\-transparent\fR Makes the window content area transparent and turns off the window shadow. For the transparency to be effecive, the toplevel background needs to be set to a -color with some alpha, e.g. "systemTransparent". +color with some alpha, such as +.QW systemTransparent . .TP \fB\-fullscreen\fR Places the window in a mode that takes up the entire main screen and hides @@ -125,17 +126,17 @@ and will have no effect under older WMs. .\" See http://www.freedesktop.org/Standards/wm-spec .RS .TP -\fB-topmost\fR +\fB\-topmost\fR Requests that this window should be kept above -all other windows that do not also have the \fB-topmost\fR +all other windows that do not also have the \fB\-topmost\fR attribute set. .TP -\fB-zoomed\fR +\fB\-zoomed\fR Requests that the window should be maximized. This is the same as \fB[wm state zoomed]\fR on Windows and Mac OS X. .TP -\fB-fullscreen\fR -Requests that the window should fill the entire screen +\fB\-fullscreen\fR +Requests that the window should fill the entire screen and have no window decorations. .RE .PP @@ -317,8 +318,8 @@ If \fIbitmap\fR is specified then the command returns an empty string. Otherwise it returns the name of the current icon bitmap associated with \fIwindow\fR, or an empty string if \fIwindow\fR has no icon bitmap. On the Windows operating -system, an additional flag is supported: -\fBwm iconbitmap \fIwindow\fR ?\fB\-default\fR? ?\fIimage\fR?. +system, an additional flag is supported: +\fBwm iconbitmap \fIwindow\fR ?\fB\-default\fR? ?\fIimage\fR?. If the \fB\-default\fR flag is given, the icon is applied to all toplevel windows (existing and future) to which no other specific icon has yet been applied. @@ -405,7 +406,9 @@ current icon window for \fIwindow\fR, or an empty string if there is no icon window currently specified for \fIwindow\fR. 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 ``own'' those events. +to +.QW own +those events. .RS .PP Note: not all window managers support the notion of an icon window. @@ -472,7 +475,8 @@ If \fIwho\fR is specified, then the command returns an empty string. Otherwise it returns \fBuser\fR or \fBprogram\fR to indicate the source of the window's current position, or an empty string if no source has been specified yet. Most window managers interpret -``no source'' as equivalent to \fBprogram\fR. +.QW "no source" +as equivalent to \fBprogram\fR. Tk will automatically set the position source to \fBuser\fR when a \fBwm geometry\fR command is invoked, unless the source has been set explicitly to \fBprogram\fR. @@ -539,7 +543,8 @@ If \fIwho\fR is specified, then the command returns an empty string. Otherwise it returns \fBuser\fR or \fBwindow\fR to indicate the source of the window's current size, or an empty string if no source has been specified yet. Most window managers interpret -``no source'' as equivalent to \fBprogram\fR. +.QW "no source" +as equivalent to \fBprogram\fR. .TP \fBwm stackorder \fIwindow\fR ?\fIisabove|isbelow window\fR? The stackorder command returns a list of toplevel windows @@ -664,7 +669,7 @@ Gridded geometry management is typically invoked by turning on the \fBsetGrid\fR option for a widget; it can also be invoked with the \fBwm grid\fR command or by calling \fBTk_SetGrid\fR. In each of these approaches the particular widget (or sometimes -code in the application as a whole) specifies the relationship between +code in the application as a whole) specifies the relationship between integral grid sizes for the window and pixel sizes. To return to non-gridded geometry management, invoke \fBwm grid\fR with empty argument strings. -- cgit v0.12