diff options
| author | dgp <dgp@users.sourceforge.net> | 2007-10-26 20:13:21 (GMT) |
|---|---|---|
| committer | dgp <dgp@users.sourceforge.net> | 2007-10-26 20:13:21 (GMT) |
| commit | c19dbf2054468ec3004041fef41a4b01a465eb54 (patch) | |
| tree | 8355bd802491be2c1de242e0598914b0bb36fca5 /doc | |
| parent | 7eb434043e09e028ca9af4dc444bcf3dd63b3c10 (diff) | |
| download | tk-c19dbf2054468ec3004041fef41a4b01a465eb54.zip tk-c19dbf2054468ec3004041fef41a4b01a465eb54.tar.gz tk-c19dbf2054468ec3004041fef41a4b01a465eb54.tar.bz2 | |
* doc/*.1: Revert doc changes that broke
* doc/*.3: `make html` so we can get the release
* doc/*.n: out the door.
Diffstat (limited to 'doc')
77 files changed, 1441 insertions, 1732 deletions
diff --git a/doc/3DBorder.3 b/doc/3DBorder.3 index aaea6e8..d0fb7f6 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.8 2007/10/24 14:32:56 dkf Exp $ +'\" RCS: @(#) $Id: 3DBorder.3,v 1.9 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_Alloc3DBorderFromObj 3 8.1 Tk "Tk Library Procedures" @@ -238,9 +238,7 @@ 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 -.QW inside -of the object, and +position of the border relative to the ``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 bb4c6cf..102394f 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.17 2007/10/24 14:32:56 dkf Exp $ +'\" RCS: @(#) $Id: ConfigWidg.3,v 1.18 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_ConfigureWidget 3 4.1 Tk "Tk Library Procedures" @@ -118,10 +118,7 @@ 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 -.QW \-font -or -.QW \-bg , +The \fIargvName\fR field is a string such as ``\-font'' or ``\-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 @@ -165,8 +162,7 @@ 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 -.QW target +\fIwidgRec\fR and \fIoffset\fR will be referred to as the ``target'' in the descriptions below. .PP The \fItype\fR field of each entry in \fIspecs\fR determines what @@ -205,20 +201,10 @@ 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 -.QW true , -.QW yes , -.QW on , -or -.QW 1, +of the values ``true'', ``yes'', ``on'', or ``1'', or an abbreviation of one of these values, means true; -any of the values -.QW false , -.QW no , -.QW off , -or -.QW 0 , -or an abbreviation of one of these values, means false. +any of the values ``false'', ``no'', ``off'', or ``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 @@ -283,11 +269,8 @@ 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. -.QW 0 -and -.QW 0x -prefixes may be used to specify octal or hexadecimal +in the format accepted by \fBstrtol\fR (e.g. ``0'' +and ``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 @@ -343,10 +326,7 @@ 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 -.QW \-background -and -.QW \-bg . +a single configuration option, such as ``\-background'' and ``\-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 689bf7c..0bfeae8 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.4 2007/10/24 14:32:56 dkf Exp $ +'\" RCS: @(#) $Id: CrtErrHdlr.3,v 1.5 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_CreateErrorHandler 3 "" Tk "Tk Library Procedures" @@ -103,8 +103,9 @@ 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 -.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." +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.'' 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 f5f65d6..036203a 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.9 2007/10/24 14:32:56 dkf Exp $ +'\" RCS: @(#) $Id: CrtWindow.3,v 1.10 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_CreateWindow 3 4.2 Tk "Tk Library Procedures" @@ -43,9 +43,8 @@ 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 -.PQ "" -then new window is created as top-level window of \fIparent\fR's screen. +is an empty string (``'') 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 bf01912..1c351e1 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.7 2007/10/24 14:32:56 dkf Exp $ +'\" RCS: @(#) $Id: FontId.3,v 1.8 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_FontId 3 8.0 Tk "Tk Library Procedures" @@ -56,10 +56,8 @@ 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 -.QW reasonable -Postscript printer, the following screen font families should print -correctly: +\fBTcl_DString\fR. Given a ``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 469fc77..cf22d1a 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.7 2007/10/24 14:32:56 dkf Exp $ +'\" RCS: @(#) $Id: GetAnchor.3,v 1.8 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_GetAnchorFromObj 3 8.1 Tk "Tk Library Procedures" @@ -74,8 +74,7 @@ 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 -.QW "unknown anchor position" -is returned. +``unknown anchor position'' is returned. .SH KEYWORDS anchor position diff --git a/doc/GetBitmap.3 b/doc/GetBitmap.3 index f7c04b4..5b24302 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.11 2007/10/24 14:32:56 dkf Exp $ +'\" RCS: @(#) $Id: GetBitmap.3,v 1.12 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_AllocBitmapFromObj 3 8.1 Tk "Tk Library Procedures" @@ -113,8 +113,7 @@ every fourth pixel in every other row. An hourglass symbol. .TP 12 \fBinfo\fR -A large letter -.QW i . +A large letter ``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 83bbeed..5203bf5 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.5 2007/10/24 14:32:56 dkf Exp $ +'\" RCS: @(#) $Id: GetCapStyl.3,v 1.6 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_GetCapStyle 3 "" Tk "Tk Library Procedures" @@ -26,11 +26,8 @@ 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 -.QW butt , -.QW projecting , -or -.QW round . +String containing name of cap style: one of ```butt'', ``projecting'', +or ``round''. .AP int *capPtr out Pointer to location in which to store X cap style corresponding to \fIstring\fR. @@ -60,8 +57,7 @@ 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 -.QW "unknown cap style" -is returned. +``unknown cap style'' is returned. .SH KEYWORDS butt, cap style, projecting, round diff --git a/doc/GetCursor.3 b/doc/GetCursor.3 index 1b229cd..ef94984 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.10 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: GetCursor.3,v 1.11 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_AllocCursorFromObj 3 8.1 Tk "Tk Library Procedures" @@ -93,8 +93,7 @@ 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 -.QW "The X Window System" +or \fBleft_ptr\fR. Appendix B of ``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 8fe81ab..c61dc0f 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.5 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: GetJoinStl.3,v 1.6 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_GetJoinStyle 3 "" Tk "Tk Library Procedures" @@ -26,11 +26,8 @@ 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 -.QW bevel , -.QW miter , -or -.QW round . +String containing name of join style: one of ``bevel'', ``miter'', +or ``round''. .AP int *joinPtr out Pointer to location in which to store X join style corresponding to \fIstring\fR. @@ -59,8 +56,7 @@ 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 -.QW "unknown join style" -is returned. +``unknown join style'' is returned. .SH KEYWORDS bevel, join style, miter, round diff --git a/doc/GetJustify.3 b/doc/GetJustify.3 index 402831a..4752405 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.7 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: GetJustify.3,v 1.8 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_GetJustifyFromObj 3 8.1 Tk "Tk Library Procedures" @@ -29,12 +29,9 @@ 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; one of: -.QW \fBleft\fR , -.QW \fBright\fR , -or -.QW \fBcenter\fR ). -The internal rep will be modified to cache corresponding justify value. +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. .AP "const char" *string in Same as \fIobjPtr\fR except description of justification style is passed as a string. @@ -83,8 +80,7 @@ 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 -.QW "unknown justification style" -is returned. +``unknown justification style'' is returned. .SH KEYWORDS center, fill, justification, string diff --git a/doc/GetRelief.3 b/doc/GetRelief.3 index d5243fb..8531393 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.8 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: GetRelief.3,v 1.9 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_GetReliefFromObj 3 8.1 Tk "Tk Library Procedures" @@ -71,8 +71,7 @@ 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 -.QW "unknown relief" +If \fIrelief\fR isn't a legal relief value, then ``unknown relief'' is returned. .SH KEYWORDS diff --git a/doc/GetUid.3 b/doc/GetUid.3 index 61eca55..36dce3f 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.5 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: GetUid.3,v 1.6 2007/10/26 20:13:22 dgp Exp $ '\" .so man.macros .TH Tk_GetUid 3 "" Tk "Tk Library Procedures" @@ -31,8 +31,7 @@ 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 -.QW "char *" +and may be used anywhere that a variable of type ``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 d32afff..c1517b8 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.4 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: GetVRoot.3,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH Tk_GetVRootGeometry 3 4.0 Tk "Tk Library Procedures" @@ -34,10 +34,9 @@ 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 -.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 +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 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 4cfe4b6..d6be97b 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.5 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: GetVisual.3,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH Tk_GetVisual 3 4.0 Tk "Tk Library Procedures" @@ -76,9 +76,8 @@ as \fItkwin\fR. Use the visual whose X identifier is \fInumber\fR. .TP 15 \fBbest\fR ?\fIdepth\fR? -Choose the -.QW "best possible" -visual, using the following rules, in decreasing order of priority: +Choose the ``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 8ee83b5..01a5853 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.5 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: InternAtom.3,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH Tk_InternAtom 3 "" Tk "Tk Library Procedures" @@ -44,8 +44,7 @@ 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 -.QW "?bad atom?" . +then \fBTk_GetAtomName\fR returns the string ``?bad atom?''. .PP Tk caches the information returned by \fBTk_InternAtom\fR and \fBTk_GetAtomName\fR @@ -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.6 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: Name.3,v 1.7 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH Tk_Name 3 "" Tk "Tk Library Procedures" @@ -55,17 +55,9 @@ 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 -.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 +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 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 c31bc1b..7a881a8 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.7 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: ParseArgv.3,v 1.8 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH Tk_ParseArgv 3 "" Tk "Tk Library Procedures" @@ -79,10 +79,7 @@ typedef struct { char *\fIhelp\fR; } Tk_ArgvInfo; .CE -The \fIkey\fR field is a string such as -.QW \-display -or -.QW \-bg +The \fIkey\fR field is a string such as ``\-display'' or ``\-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 @@ -107,13 +104,11 @@ 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 -.QW "the matching argument" -in the descriptions below. As part of the processing, +specifier. The argument that matched \fIkey\fR is called ``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 -.QW "the following argument" . -The legal values for \fItype\fR, and the processing +after the matching argument, which is called ``the following +argument''. The legal values for \fItype\fR, and the processing that they cause, are as follows: .TP \fBTK_ARGV_END\fR @@ -128,11 +123,8 @@ 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. -.QW 0 -and -.QW 0x -prefixes may be used to specify octal or hexadecimal +integer string in the format accepted by \fBstrtol\fR (e.g. ``0'' +and ``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 @@ -353,10 +345,7 @@ 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 -.QW prog , -\fIargv\fR[1] will be -.QW infile , +\fIargv\fR[0] will be ``prog'', \fIargv\fR[1] will be ``infile'', and \fIargv\fR[2] will be NULL. .SH KEYWORDS diff --git a/doc/RestrictEv.3 b/doc/RestrictEv.3 index f5e3252..99e3f16 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.4 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: RestrictEv.3,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH Tk_RestrictEvents 3 "" Tk "Tk Library Procedures" @@ -71,8 +71,7 @@ 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 -.QW obvious +want to invoke any handlers for any other events). The ``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 2f0b44c..1bc5b61 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.5 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: SetAppName.3,v 1.6 2007/10/26 20:13:23 dgp 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 <tk.h>\fR @@ -37,8 +37,7 @@ 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 -.QW "\fB #2\fR" -to \fIname\fR; if this name is also in use, +``\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 6e25930..27f6f84 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.14 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: SetOptions.3,v 1.15 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH Tk_SetOptions 3 8.1 Tk "Tk Library Procedures" @@ -95,12 +95,10 @@ 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 -.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 +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 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 f7209d3..aff7fcb 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.3 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: StrictMotif.3,v 1.4 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH Tk_StrictMotif 3 4.0 Tk "Tk Library Procedures" @@ -30,9 +30,8 @@ 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 -.QW Motif-like -is good enough, and extra features are welcome. +0 means that ``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 3d8c03b..0f0ba64 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.3 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: Tk_Main.3,v 1.4 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH Tk_Main 3 4.0 Tk "Tk Library Procedures" @@ -46,8 +46,7 @@ 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 -.QW hook +the \fIappInitProc\fR argument. This procedure provides a ``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: @@ -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.23 2007/10/26 12:25:38 dkf Exp $ +'\" RCS: @(#) $Id: bind.n,v 1.24 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH bind n 8.0 Tk "Tk Built-In Commands" @@ -25,9 +25,7 @@ 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 -.QW + , -then it is appended to +If \fIscript\fR is prefixed with a ``+'', 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 @@ -168,7 +166,7 @@ couple non-standard X event types that were added to better support the Macintosh and Windows platforms. Below is a list of all the valid types; where two names appear together, they are synonyms. .DS -.ta 2.5i +2i +.ta \w'ButtonPress, Button\0\0\0'u +\w'KeyPress, Key\0\0\0'u \fBActivate Destroy Map ButtonPress, Button Enter MapRequest ButtonRelease Expose Motion @@ -269,9 +267,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 -.QW 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 ``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 @@ -282,8 +280,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, -.QW "virtual crossing" -focus events are sent to the intermediate windows in the hierarchy. +``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 @@ -303,8 +301,7 @@ 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 -.QW "virtual crossing" -events are sent to intermediate windows +``virtual crossing'' events are sent to intermediate windows in the hierarchy in the same manner as for \fBFocusIn\fR and \fBFocusOut\fR events. .RE @@ -367,19 +364,12 @@ is equivalent to \fB<ButtonPress-1>\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. -.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 +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 character), plus descriptions for all the non-ASCII keys on 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 +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 complete list of keysyms is not presented here; it is available in other X documentation and may vary from system to system. @@ -540,11 +530,8 @@ 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 -.QW normal -event, \fB1\fR indicates that it is a -.QW synthetic -event generated by \fBSendEvent\fR. +\fB0\fR indicates that this is a ``normal'' event, \fB1\fR indicates +that it is a ``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. @@ -712,7 +699,9 @@ pack [label .l -textvariable keysym -padx 2m -pady 1m] set keysym "You pressed %K" } .CE + .SH "SEE ALSO" bgerror(n), bindtags(n), event(n), focus(n), grab(n), keysyms(n) + .SH KEYWORDS binding, event diff --git a/doc/bindtags.n b/doc/bindtags.n index 64c9042..5e563c5 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.5 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: bindtags.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH bindtags n 4.0 Tk "Tk Built-In Commands" @@ -57,9 +57,8 @@ 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 (i.e. -.QW \fB.\fR ), -followed by class bindings, followed by bindings for \fB.b\fR. +first, following by bindings for \fB.b\fR's toplevel (``.''), 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 aeb322d..e253136 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.27 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: canvas.n,v 1.28 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH canvas n 8.3 Tk "Tk Built-In Commands" @@ -28,9 +28,8 @@ 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 -.QW inside -the item. Defaults to 1.0. +must be to an item before it is considered to be ``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 @@ -114,9 +113,7 @@ 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 -.QW "on top" -of earlier items. +as being ``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 @@ -139,16 +136,11 @@ 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, -.QW x123 -is OK but -.QW 123 -isn't. +For example, ``x123'' is OK but ``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 -.QW selected . +tag ``selected''. .PP The tag \fBall\fR is implicitly associated with every item in the canvas; it may be used to invoke operations on @@ -399,9 +391,7 @@ 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 -.QW "\fIx1 y1 x2 y2\fR" -such that the drawn +The list has the form ``\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. @@ -424,9 +414,8 @@ 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 -.QW + -then \fIcommand\fR augments an existing binding rather than replacing it). +(if the first character of \fIcommand\fR is ``+'' 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 @@ -714,8 +703,7 @@ 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. -.QW "\fB1.0 1.0 0.0 setrgbcolor\fR" ). +code to set a particular color value (e.g. ``\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. @@ -804,12 +792,10 @@ 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 (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. +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. .TP \fB\-width \fIsize\fR Specifies the width of the area of the canvas to print. @@ -1040,6 +1026,7 @@ the coordinates of the item. .PP Many items share a common set of options. These options are explained here, and then referred to be each widget type for brevity. +.PP .TP \fB\-dash \fIpattern\fR .TP @@ -1170,7 +1157,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.PP +.br The following standard options are supported by arcs: .CS \-dash @@ -1240,7 +1227,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.PP +.br The following standard options are supported by bitmaps: .CS \-state @@ -1304,7 +1291,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.PP +.br The following standard options are supported by images: .CS \-state @@ -1349,7 +1336,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.PP +.br The following standard options are supported by lines: .CS \-dash @@ -1390,9 +1377,7 @@ 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 -.QW reasonable -shape. +If this option isn't specified then Tk picks a ``reasonable'' shape. .TP \fB\-capstyle \fIstyle\fR Specifies the ways in which caps are to be drawn at the endpoints @@ -1461,7 +1446,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.PP +.br The following standard options are supported by ovals: .CS \-dash @@ -1508,7 +1493,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.PP +.br The following standard options are supported by polygons: .CS \-dash @@ -1573,9 +1558,8 @@ 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 -.QW inside -a polygon (e.g. for purposes of the \fBfind closest\fR and +and arcs in that interior points are considered to be ``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 @@ -1601,7 +1585,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.PP +.br The following standard options are supported by rectangles: .CS \-dash @@ -1649,7 +1633,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.PP +.br The following standard options are supported by text items: .CS \-fill @@ -1730,7 +1714,7 @@ pairs, each of which sets one of the configuration options for the item. These same \fIoption\fR\-\fIvalue\fR pairs may be used in \fBitemconfigure\fR widget commands to change the item's configuration. -.PP +.br The following standard options are supported by window items: .CS \-state diff --git a/doc/checkbutton.n b/doc/checkbutton.n index d7c3f8f..4c2aceb 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.14 2007/10/24 14:32:57 dkf Exp $ +'\" RCS: @(#) $Id: checkbutton.n,v 1.15 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH checkbutton n 4.4 Tk "Tk Built-In Commands" @@ -54,12 +54,10 @@ 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 -.QW 0 . +this button is deselected. Defaults to ``0''. .OP \-onvalue onValue Value Specifies value to store in the button's associated variable whenever -this button is selected. Defaults to -.QW 1 . +this button is selected. Defaults to ``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 @@ -102,7 +100,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 the empty string. +selection, also known as the tri-state mode. Defaults to ``""'' .VE 8.5 .OP \-variable variable Variable Specifies name of global variable to set to indicate whether @@ -164,30 +162,20 @@ 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 -.QW grayed . -Under Mac, the indicator is drawn with a dash mark inside. +Windows, the background interior of the box is ``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 -.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. +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. 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 -.QW on , -.QW off -and -.QW tristate -values. +changes to and from the button's ``on'', ``off'' and ``tristate'' values. .VE 8.5 .SH "WIDGET COMMAND" .PP @@ -223,8 +211,7 @@ this case the command returns an empty string. command. .TP \fIpathName \fBdeselect\fR -Deselects the checkbutton and sets the associated variable to its -.QW off +Deselects the checkbutton and sets the associated variable to its ``off'' value. .TP \fIpathName \fBflash\fR @@ -243,8 +230,7 @@ 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 -.QW on +Selects the checkbutton and sets the associated variable to its ``on'' value. .TP \fIpathName \fBtoggle\fR diff --git a/doc/chooseDirectory.n b/doc/chooseDirectory.n index e0e2d90..a606d15 100644 --- a/doc/chooseDirectory.n +++ b/doc/chooseDirectory.n @@ -2,7 +2,7 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: chooseDirectory.n,v 1.5 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: chooseDirectory.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH tk_chooseDirectory n 8.3 Tk "Tk Built-In Commands" @@ -45,7 +45,7 @@ this parameter is true, then the user may only select directories that already exist. The default value is \fIfalse\fR. .SH EXAMPLE .CS -set dir [\fBtk_chooseDirectory\fR \e +set dir [\fBtk_chooseDirectory\fR \\ \-initialdir ~ \-title "Choose a directory"] if {$dir eq ""} { label .l -text "No directory selected" diff --git a/doc/clipboard.n b/doc/clipboard.n index 2847bc5..8222130 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.13 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: clipboard.n,v 1.14 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH clipboard n 8.4 Tk "Tk Built-In Commands" @@ -34,9 +34,8 @@ 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 -.QW . . -Returns an empty string. +any previous contents. \fIWindow\fR defaults to ``.''. 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 @@ -46,9 +45,7 @@ display. .RS .PP \fIType\fR specifies the form in which the selection is to be returned -(the desired -.QW target -for conversion, in ICCCM terminology), and +(the desired ``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. @@ -128,7 +125,7 @@ pack $c $c create text 150 30 -text "cut and paste me" bind $c <<Cut>> { \fBclipboard clear\fR - \fBclipboard append -type\fR TkCanvasItem \e + \fBclipboard append -type\fR TkCanvasItem \\ [getItemConfig %W current] # Delete because this is cut, not copy. %W delete current diff --git a/doc/destroy.n b/doc/destroy.n index 38b5cd1..8aac2c0 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.4 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: destroy.n,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH destroy n "" Tk "Tk Built-In Commands" @@ -21,10 +21,8 @@ destroy \- Destroy one or more windows .PP This command deletes the windows given by the \fIwindow\fR arguments, plus all of their descendants. -If the \fIwindow\fR -.QW . -is deleted then the entire interpreter's windows -will be destroyed (which may cause the whole application to exit). +If a \fIwindow\fR ``.'' is deleted then the entire application +will be destroyed. 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/dialog.n b/doc/dialog.n index 9b7effa..fa908ef 100644 --- a/doc/dialog.n +++ b/doc/dialog.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: dialog.n,v 1.4 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: dialog.n,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH tk_dialog n 4.1 Tk "Tk Built-In Commands" @@ -62,7 +62,7 @@ grab. This prevents the user from interacting with the application in any way except to invoke the dialog box. .SH EXAMPLE .CS -set reply [\fBtk_dialog\fR .foo "The Title" "Do you want to say yes?" \e +set reply [\fBtk_dialog\fR .foo "The Title" "Do you want to say yes?" \\ questhead 0 Yes No "I'm not sure"] .CE diff --git a/doc/entry.n b/doc/entry.n index 2c55880..72aeec8 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.17 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: entry.n,v 1.18 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH entry n 8.3 Tk "Tk Built-In Commands" @@ -45,9 +45,7 @@ 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 -.QW * -or a bullet character. +the first character in the value of this option, such as ``*''. 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 @@ -231,15 +229,11 @@ 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, -.QW \fB@0\fR -indicates the left-most character in the window. +For example, ``\fB@0\fR'' indicates the left-most character in the +window. .LP -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 +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. .PP The following commands are possible for entry widgets: @@ -418,11 +412,9 @@ become visible. .PP Tk automatically creates class bindings for entries that give them the following default behavior. -In the descriptions below, -.QW word -refers to a contiguous group of letters, digits, or -.QW _ -characters, or any single character other than these. +In the descriptions below, ``word'' refers to a contiguous group +of letters, digits, or ``_'' 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 2aa90ba..bf895e3 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.13 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: event.n,v 1.14 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH event n 8.3 Tk "Tk Built-In Commands" @@ -80,9 +80,8 @@ 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 -.QW % -expansions allowed in binding scripts for the \fBbind\fR command. +command. These correspond to the ``%'' 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 15021ec..5c49860 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.3 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: focusNext.n,v 1.4 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH tk_focusNext n 4.0 Tk "Tk Built-In Commands" @@ -24,9 +24,7 @@ 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 -.QW next -window after \fIwindow\fR in focus order. +It returns the ``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 @@ -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.16 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: font.n,v 1.17 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH font n 8.0 Tk "Tk Built-In Commands" @@ -84,9 +84,7 @@ 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 -.QW f . -If the string contains newlines or tabs, +characters such as cursive ``f''. If the string contains newlines or tabs, those characters are not expanded or treated specially when measuring the string. .TP @@ -120,10 +118,9 @@ 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 -.QW \fB*\fR +This also includes, under X, an XLFD (see [4]) for which a single ``\fB*\fR'' character was used to elide more than one field in the middle of the -name. See \fBPLATFORM-SPECIFIC\fR issues for a list of the system fonts. +name. See PLATFORM-SPECIFIC issues for a list of the system fonts. .TP [3] \fIfamily \fR?\fIsize\fR? ?\fIstyle\fR? ?\fIstyle ...\fR? . @@ -145,22 +142,14 @@ 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 -.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 +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 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 -.QW point +correct, all existing applications using XLFDs assumed that one ``point'' was in fact one pixel and would display incorrectly (generally larger) if the correct size font were actually used. .TP @@ -184,13 +173,9 @@ 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 -.QW baseline -of a font is the +font. In the following definitions, the ``baseline'' of a font is the horizontal line where the bottom of most letters line up; certain letters, -such as lower-case -.QW g -stick below the baseline. +such as lower-case ``g'' stick below the baseline. .TP \fB\-ascent \0\fR . @@ -211,13 +196,9 @@ above the baseline line plus the descent below the baseline. .TP \fB\-fixed \0\fR . -Returns a boolean flag that is -.QW \fB1\fR -if this is a fixed-width font, +Returns a boolean flag that is ``\fB1\fR'' if this is a fixed-width font, where each normal character is the same width as all the other -characters, or is -.QW \fB0\fR -if this is a proportionally-spaced font, where +characters, or is ``\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. @@ -229,13 +210,9 @@ above: \fB\-family \fIname\fR . The case-insensitive font family name. Tk guarantees to support the font -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 +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 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 @@ -284,92 +261,26 @@ font should be underlined. The default value for underline is \fBfalse\fR. The value is a boolean flag that specifies whether a horizontal line should be drawn through the middle of characters in this font. The default value for overstrike is \fBfalse\fR. -.SH "STANDARD FONTS" +.SH "PLATFORM-SPECIFIC ISSUES" .LP -The following named fonts are supported on all systems, and default to values -that match appropriate system defaults. -.TP -\fBTkDefaultFont\fR -. -This font is the default for all GUI items not otherwise specified. -.TP -\fBTkTextFont\fR -. -This font should be used for user text in entry widgets, listboxes etc. -.TP -\fBTkFixedFont\fR -. -This font is the standard fixed-width font. -.TP -\fBTkMenuFont\fR -. -This font is used for menu items. -.TP -\fBTkHeadingFont\fR -. -This font should be used for column headings in lists and tables. -.TP -\fBTkCaptionFont\fR -. -This font should be used for window and dialog caption bars. -.TP -\fBTkSmallCaptionFont\fR -. -This font should be used for captions on contained windows or tool dialogs. -.TP -\fBTkIconFont\fR -. -This font should be used for icon captions. -.TP -\fBTkTooltipFont\fR -. -This font should be used for tooltip windows (transient information windows). -.LP -It is \fInot\fR advised to change these fonts, as they may be modified by Tk -itself in response to system changes. Instead, make a copy of the font and -modify that. -.SS "PLATFORM-SPECIFIC FONTS" -.LP -The following system fonts are supported: +The following named system fonts are supported: .RS .TP -\fBX Windows\fR +X Windows: All valid X font names, including those listed by xlsfonts(1), are available. .TP -\fBMS Windows\fR +MS Windows: .DS .ta 3c 6c \fBsystem ansi device systemfixed ansifixed oemfixed\fR .DE .TP -\fBMac OS X\fR +Mac OS X: .DS .ta 3c 6c \fBsystem application menu\fR .DE -Additionally, the following named fonts provide access to the Aqua theme fonts: -.DS -\fBsystemSystemFont -systemEmphasizedSystemFont -systemSmallSystemFont -systemSmallEmphasizedSystemFont -systemApplicationFont -systemLabelFont -systemViewsFont -systemMenuTitleFont -systemMenuItemFont -systemMenuItemMarkFont -systemMenuItemCmdKeyFont -systemWindowTitleFont -systemPushButtonFont -systemUtilityWindowTitleFont -systemAlertHeaderFont -systemToolbarFont -systemMiniSystemFont -systemDetailSystemFont -systemDetailEmphasizedSystemFont\fR -.DE .RE .SH EXAMPLE Fill a text widget with lots of font demonstrators, one for every font @@ -380,7 +291,7 @@ set count 0 set tabwidth 0 foreach family [lsort -dictionary [\fBfont families\fR]] { .t tag configure f[incr count] -font [list $family 10] - .t insert end ${family}:\\t {} \e + .t insert end ${family}:\\t {} \\ "This is a simple sampler\\n" f$count set w [\fBfont measure\fR [.t cget -font] ${family}:] if {$w+5 > $tabwidth} { diff --git a/doc/getOpenFile.n b/doc/getOpenFile.n index f28fbb1..5475c89 100644 --- a/doc/getOpenFile.n +++ b/doc/getOpenFile.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: getOpenFile.n,v 1.17 2007/10/25 21:44:22 hobbs Exp $ +'\" RCS: @(#) $Id: getOpenFile.n,v 1.18 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH tk_getOpenFile n 4.2 Tk "Tk Built-In Commands" @@ -13,10 +13,9 @@ .SH NAME tk_getOpenFile, tk_getSaveFile \- pop up a dialog box for the user to select a file to open or save. .SH SYNOPSIS -.nf \fBtk_getOpenFile \fR?\fIoption value ...\fR? +.br \fBtk_getSaveFile \fR?\fIoption value ...\fR? -.fi .BE .SH DESCRIPTION @@ -88,16 +87,6 @@ dialog is displayed on top of its parent window. \fB\-title\fR \fItitleString\fR Specifies a string to display as the title of the dialog box. If this option is not specified, then a default title is displayed. -.TP -\fB\-typevariable\fR \fIvariableName\fR -The variable \fIvariableName\fR is used to preselect which filter is -used from \fIfilterList\fR when the dialog box is opened and is -updated when the dialog box is closed, to the last selected -filter. The variable is read once at the beginning to select the -appropriate filter. If the variable does not exist, or it's value does -not match any filter typename, or is empty (\fB{}\fR), the dialog box -will revert to the default behavior of selecting the first filter in -the list. If the dialog is canceled, the variable is not modified. .PP If the user selects a file, both \fBtk_getOpenFile\fR and \fBtk_getSaveFile\fR return the full pathname of this file. If the @@ -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.5 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: grab.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH grab n "" Tk "Tk Built-In Commands" @@ -33,9 +33,7 @@ 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 -.QW owns -the pointer: +The grab subtree ``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 @@ -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.16 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: grid.n,v 1.17 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH grid n 8.5 Tk "Tk Built-In Commands" @@ -187,13 +187,11 @@ 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 -.QW "\fB\-in \fImaster\fR" -where \fImaster\fR is the slave's master. +The first two elements of the list are ``\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/labelframe.n b/doc/labelframe.n index 07a2647..09ec0b9 100644 --- a/doc/labelframe.n +++ b/doc/labelframe.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: labelframe.n,v 1.4 2007/10/22 14:33:13 dkf Exp $ +'\" RCS: @(#) $Id: labelframe.n,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH labelframe n 8.4 Tk "Tk Built-In Commands" @@ -143,9 +143,9 @@ This shows how to build part of a GUI for a hamburger vendor. The the kinds of things that the choices are being made over. .PP .CS -grid [\fBlabelframe\fR .burger -text "Burger"] \e +grid [\fBlabelframe\fR .burger -text "Burger"] \\ [\fBlabelframe\fR .bun -text "Bun"] -sticky news -grid [\fBlabelframe\fR .cheese -text "Cheese Option"] \e +grid [\fBlabelframe\fR .cheese -text "Cheese Option"] \\ [\fBlabelframe\fR .pickle -text "Pickle Option"] -sticky news foreach {type name val} { burger Beef beef @@ -168,7 +168,7 @@ foreach {type name val} { pickle Onions onion pickle Chili chili } { - set w [radiobutton .$type.$val -text $name -anchor w \e + set w [radiobutton .$type.$val -text $name -anchor w \\ -variable $type -value $val] pack $w -side top -fill x } diff --git a/doc/listbox.n b/doc/listbox.n index 03adb56..8577d2a 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.13 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: listbox.n,v 1.14 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH listbox n 8.4 Tk "Tk Built-In Commands" @@ -56,9 +56,8 @@ 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 -.QW 0 -is used in translating from character units to screen units. +character ``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 02911a0..edc9a60 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.8 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: loadTk.n,v 1.9 2007/10/26 20:13:23 dgp 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 -.QW . +dependent identifier \fIwindowId\fR is used to contain the ``.'' 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 -.QW . -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 ``.'' 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,8 +69,10 @@ 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 @@ -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.17 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: menu.n,v 1.18 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH menu n 4.1 Tk "Tk Built-In Commands" @@ -49,12 +49,9 @@ 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 -.QW "\fBa b\fR" -and menu \fB.x.y\fR is torn off to +the option's is ``\fBa b\fR'' and menu \fB.x.y\fR is torn off to create a new menu \fB.x.tearoff1\fR, then the command -.QW "\fBa b .x.y .x.tearoff1\fR" -will be invoked. +``\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 @@ -316,9 +313,7 @@ This form may not be abbreviated. Same as \fBend\fR. .TP 12 \fBnone\fR -Indicates -.QW "no entry at all" ; -this is used most commonly with +Indicates ``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. @@ -327,9 +322,8 @@ 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, -.QW \fB@0\fR -indicates the top-most entry in the window. +For example, ``\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 681009f..2a7c1e9 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.5 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: message.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH message n 4.0 Tk "Tk Built-In Commands" @@ -99,9 +99,8 @@ 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 -.QW 0123456789abcdef\ex -then control characters and undefined characters are not displayed at all. +all of the characters in ``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 872ea9d..9eeed16 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.12 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: options.n,v 1.13 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH options n 4.4 Tk "Tk Built-In Commands" @@ -23,9 +23,7 @@ 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, -.QW "Command-Line Name" -refers to the +In the descriptions below, ``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 @@ -36,11 +34,9 @@ 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. -.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. +``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. .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 @@ -157,15 +153,12 @@ 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 -.QW 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 ``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 -.QW on -in each blink cycle. +milliseconds the insertion cursor should remain ``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. @@ -183,9 +176,7 @@ 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 -.QW jumps -rather than changing smoothly). +is made (the value ``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. @@ -336,11 +327,7 @@ 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 -.QW set , -e.g. -.QW ".x.scrollbar set" : -this will cause +widget followed by ``set'', e.g. ``.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 @@ -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.8 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: pack.n,v 1.9 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH pack n 4.0 Tk "Tk Built-In Commands" @@ -27,15 +27,14 @@ 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 -.QW . ), -then the command is processed in the same way as \fBpack configure\fR. +starting with ``.''), 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 \fBTHE PACKER ALGORITHM\fR below for details on how the options +See ``THE PACKER ALGORITHM'' below for details on how the options are used by the packer. The following options are supported: .RS @@ -137,14 +136,13 @@ 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 -.QW "\fB\-in \fImaster\fR" -where \fImaster\fR is the slave's master. +The first two elements of the list are ``\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 \fBGEOMETRY PROPAGATION\fR below). +name (see ``GEOMETRY PROPAGATION'' 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. @@ -186,7 +184,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 \fBEXPANSION\fR below) +option (see ``EXPANSION'' 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 42a5b0d..17fc41c 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.3 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: palette.n,v 1.4 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH tk_setPalette n 4.0 Tk "Tk Built-In Commands" @@ -66,8 +66,7 @@ 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 -.PQ bisque +it restores the application's colors to the light brown (``bisque'') color scheme used in Tk 3.6 and earlier versions. .SH KEYWORDS diff --git a/doc/place.n b/doc/place.n index be62635..6bd4562 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.8 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: place.n,v 1.9 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH place n "" Tk "Tk Built-In Commands" @@ -209,14 +209,11 @@ 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 -.QW "real children" -of the parent (i.e. the windows that +The ``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 -.QW "real children" +This means that the path names of the ``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 deaeb47..05d5509 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.12 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: radiobutton.n,v 1.13 2007/10/26 20:13:23 dgp 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 the empty string. +selection, also known as the tri-state mode. Defaults to ``""'' .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 c883e6a..95e62d9 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.7 2007/10/24 14:32:58 dkf Exp $ +'\" RCS: @(#) $Id: scale.n,v 1.8 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH scale n 4.1 Tk "Tk Built-In Commands" @@ -25,8 +25,7 @@ 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 -.QW large -increments; this option specifies the size of the +``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 a254d0d..30e2001 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.8 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: selection.n,v 1.9 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH selection n 8.1 Tk "Tk Built-In Commands" @@ -37,19 +37,15 @@ 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 -.QW . . +\fISelection\fR defaults to PRIMARY and \fIwindow\fR defaults to ``.''. 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 -.QW . . +\fIwindow\fR defaults to ``.''. \fIType\fR specifies the form in which the selection is to be returned -(the desired -.QW target -for conversion, in ICCCM terminology), and +(the desired ``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 @@ -121,8 +117,7 @@ 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 -.QW . . +\fIwindow\fR defaults to ``.''. .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 @@ -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.6 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: send.n,v 1.7 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH send n 4.0 Tk "Tk Built-In Commands" @@ -30,8 +30,7 @@ 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 -.QW \- +If the initial arguments of the command begin with ``\-'' they are treated as options. The following options are currently defined: .TP @@ -50,8 +49,7 @@ 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 -.QW \- +option is needed only if \fIapp\fR could contain a leading ``\-'' character. .SH "APPLICATION NAMES" diff --git a/doc/spinbox.n b/doc/spinbox.n index 617b4a7..93438ca 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.5 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: spinbox.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH spinbox n 8.4 Tk "Tk Built-In Commands" @@ -265,15 +265,11 @@ 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, -.QW \fB@0\fR -indicates the left-most character in the window. +For example, ``\fB@0\fR'' indicates the left-most character in the +window. .LP -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 +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. .PP The following commands are possible for spinbox widgets: @@ -471,11 +467,9 @@ become visible. .PP Tk automatically creates class bindings for spinboxes that give them the following default behavior. -In the descriptions below, -.QW word -refers to a contiguous group of letters, digits, or -.QW _ -characters, or any single character other than these. +In the descriptions below, ``word'' refers to a contiguous group +of letters, digits, or ``_'' 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 @@ -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.46 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: text.n,v 1.47 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH text n 8.5 Tk "Tk Built-In Commands" @@ -150,9 +150,8 @@ 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 -.QW 0 -is used in translating from character units to screen units. +character ``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. @@ -411,18 +410,14 @@ 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 -.QW "\fBend \- 1 chars\fR" +left-to-right order. For example, the index ``\fBend \- 1 chars\fR'' refers to the next-to-last character in the text and -.QW "\fBinsert wordstart \- 1 c\fR" -refers to the character just before +``\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 -.QW "\fB1.0 -1c +1c\fR" -refers to the index -.QW "\fB2.0\fR". +widget. So, for example, the index ``\fB1.0 -1c +1c\fR'' refers to the +index ``\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 @@ -436,9 +431,7 @@ 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 -.QW " " -(space), \fB+\fR, or \fB\-\fR: +avoid using the characters `` '' (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 @@ -453,9 +446,7 @@ 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 -.QW "\fIpathName \fBtag raise\fR" -and -.QW "\fIpathName \fBtag lower\fR" +``\fIpathName \fBtag raise\fR'' and ``\fIpathName \fBtag lower\fR'' widget commands. .PP Tags serve three purposes in text widgets. @@ -464,9 +455,7 @@ 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 -.QW "\fIpathName \fBtag configure\fR" -widget command. +using the ``\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: @@ -651,9 +640,8 @@ 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 -.QW "\fIpathName \fBtag bind\fR" -widget command below. +For details, see the description of the ``\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). @@ -683,9 +671,7 @@ 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 -.QW "\fIpathName \fBmark\fR" -widget +Marks may be manipulated with the ``\fIpathName \fBmark\fR'' widget command, and their current locations may be determined by using the mark name as an index in widget commands. .PP @@ -901,8 +887,7 @@ Whenever the \fBsel\fR tag range changes a virtual event \fB<<Selection>>\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 -.QW "\fIpathName \fBtag delete\fR" +created, and it may not be deleted with the ``\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, @@ -923,9 +908,8 @@ 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 -.QW "\fIpathName \fBmark unset\fR" -widget command. +may not be unset with the ``\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. @@ -1444,8 +1428,7 @@ 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 -.QW "\fIpathName \fBmark names\fR" . +returned by future calls to ``\fIpathName \fBmark names\fR''. This command returns an empty string. .RE .TP @@ -1475,13 +1458,11 @@ arguments, and the section on \fIpathName \fBdelete\fR for an explanation of the handling of the indices. If \fIindex2\fR corresponds to an index earlier in the text than \fIindex1\fR, an error will be generated. -.RS -.PP +.br The deletion and insertion are arranged so that no unnecessary scrolling of the window or movement of insertion cursor occurs. In addition the undo/redo stack are correctly modified, if undo operations are active in the text widget. The command returns an empty string. -.RE .VE 8.5 .TP \fIpathName \fBscan\fR \fIoption args\fR @@ -1678,9 +1659,8 @@ 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 -.QW + -then \fIscript\fR augments an existing binding rather than replacing it). +(if the first character of \fIscript\fR is ``+'' 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 @@ -1765,10 +1745,8 @@ 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 -.QW "\fIpathName \fBtag\fR" -widget command but haven't been deleted by a -.QW "\fIpathName \fBtag delete\fR" +that have been named in a ``\fIpathName \fBtag\fR'' widget +command but haven't been deleted by a ``\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 @@ -1913,11 +1891,7 @@ 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 -.QW 2.0c -or -.QW 1i -(the result is rounded +to \fBTk_GetPixels\fR, such as ``2.0c'' or ``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 @@ -1970,11 +1944,7 @@ 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 -.QW 2.0c -or -.QW 1i -(the result is rounded +to \fBTk_GetPixels\fR, such as ``2.0c'' or ``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 @@ -2019,9 +1989,8 @@ 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, -.QW word -is dependent on the value of the \fBtcl_wordchars\fR variable. See tclvars(n). +In the descriptions below, ``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 @@ -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.14 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: tk.n,v 1.15 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH tk n 8.4 Tk "Tk Built-In Commands" @@ -35,9 +35,7 @@ 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 -.QW "\fB #2\fR" or -.QW "\fB #3\fR" -is appended in order to make the name unique. +``\fB #2\fR'' or ``\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 @@ -69,9 +67,7 @@ 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 -.QW point -is a unit of measurement equal to 1/72 inch. A scaling factor +A ``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 c632ca1..1c6159a 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.5 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: ttk_button.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_button n 8.5 Tk "Tk Themed Widget" @@ -20,11 +20,11 @@ ttk_button \- Widget that issues a command when pressed A \fBttk::button\fR widget displays a textual label and/or image, and evaluates a command when pressed. .SO -\-class \-compound \-cursor -\-image \-state \-style -\-takefocus \-text \-textvariable -\-underline \-width +\-class \-compound \-cursor \-image +\-state \-style \-takefocus \-text +\-textvariable \-underline \-width .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command A script to evaluate when the widget is invoked. @@ -36,11 +36,9 @@ In a dialog box, one button may be designated the "default" button \fBnormal\fR means that it may become the default button, and \fBdisabled\fR means that it is not defaultable. The default is \fBnormal\fR. -.RS -.PP +.br Depending on the theme, the default button may be displayed with an extra highlight ring, or with a different border color. -.RE .OP \-width width Width If greater than zero, specifies how much space, in character widths, to allocate for the text label. @@ -48,13 +46,14 @@ If less than zero, specifies a minimum width. If zero or unspecified, the natural width of the text label is used. Note that some themes may specify a non-zero \fB-width\fR in the style. -.\" Not documented -- may go away -.\" .OP \-padding padding Padding -.\" .OP \-foreground foreground Foreground -.\" .OP \-font font Font -.\" .OP \-anchor anchor Anchor -.\" .OP \-padding padding Padding -.\" .OP \-relief relief Relief +'\" Not documented -- may go away +'\" .OP \-padding padding Padding +'\" .OP \-foreground foreground Foreground +'\" .OP \-font font Font +'\" .OP \-anchor anchor Anchor +'\" .OP \-padding padding Padding +'\" .OP \-relief relief Relief + .SH "WIDGET COMMAND" .TP \fIpathName \fBinvoke\fR @@ -68,16 +67,17 @@ Invokes the command associated with the button. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? See \fIttk_widget(n)\fR + .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 -.QW write-only -option: setting it changes the +This is a ``write-only'' option: setting it changes the widget state, but the \fBstate\fR widget command does not affect the state option. + .SH "SEE ALSO" ttk_widget(n), button(n) + .SH "KEYWORDS" widget, button, default, command diff --git a/doc/ttk_checkbutton.n b/doc/ttk_checkbutton.n index 3f59cb7..eb5fd6c 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.6 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: ttk_checkbutton.n,v 1.7 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_checkbutton n 8.5 Tk "Tk Themed Widget" @@ -21,23 +21,24 @@ A \fBttk::checkbutton\fR widget is used to show or change a setting. It has two states, selected and deselected. The state of the checkbutton may be linked to a Tcl variable. .SO -\-class \-compound \-cursor -\-image \-state \-style -\-takefocus \-text \-textvariable -\-underline \-width +\-class \-compound \-cursor \-image +\-state \-style \-takefocus \-text +\-textvariable \-underline \-width .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command A Tcl script to execute whenever the widget is invoked. .OP \-offvalue offValue OffValue -The value to store in the associated \fB\-variable\fR +The value to store in the associated \fI-variable\fR when the widget is deselected. Defaults to \fB0\fR. .OP \-onvalue onValue OnValue -The value to store in the associated \fB\-variable\fR +The value to store in the associated \fI-variable\fR when the widget is selected. Defaults to \fB1\fR. .OP \-variable variable Variable The name of a global variable whose value is linked to the widget. Defaults to the widget pathname if not specified. + .SH "WIDGET COMMAND" In addition to the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR @@ -46,27 +47,27 @@ widget commands: .TP \fIpathname\fR invoke Toggles between the selected and deselected states -and evaluates the associated \fB\-command\fR. -If the widget is currently selected, sets the \fB\-variable\fR -to the \fB\-offvalue\fR and deselects the widget; -otherwise, sets the \fB\-variable\fR to the \fB\-onvalue\fR -Returns the result of the \fB\-command\fR. +and evaluates the associated \fI-command\fR. +If the widget is currently selected, sets the \fI-variable\fR +to the \fI-offvalue\fR and deselects the widget; +otherwise, sets the \fI-variable\fR to the \fI-onvalue\fR +Returns the result of the \fI-command\fR. .\" Missing: select, deselect, toggle .\" Are these useful? They don't invoke the -command .\" Missing: flash. This is definitely not useful. + .SH "WIDGET STATES" The widget does not respond to user input if the \fBdisabled\fR state is set. The widget sets the \fBselected\fR state whenever -the linked \fB\-variable\fR is set to the widget's \fB\-onvalue\fR, +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 -.QW tri-state -or -.QW indeterminate -selection.) +linked \fB-variable\fR is unset. +(The \fBalternate\fR state may be used to indicate a ``tri-state'' +or ``indeterminate'' selection.) + .SH "SEE ALSO" ttk_widget(n), ttk_radiobutton(n), checkbutton(n) + .SH "KEYWORDS" widget, button, toggle, check, option diff --git a/doc/ttk_combobox.n b/doc/ttk_combobox.n index d6baf8d..3ba499a 100644 --- a/doc/ttk_combobox.n +++ b/doc/ttk_combobox.n @@ -3,8 +3,8 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: ttk_combobox.n,v 1.7 2007/10/23 15:44:35 dkf Exp $ +'\" +'\" RCS: @(#) $Id: ttk_combobox.n,v 1.8 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_combobox n 8.5 Tk "Tk Themed Widget" @@ -18,91 +18,94 @@ ttk_combobox \- text field with popdown selection list .SH DESCRIPTION A \fBttk::combobox\fR combines a text field with a pop-down list of values; -the user may select the value of the text field from among the values in the -list. +the user may select the value of the text field from among the +values in the list. .SO -\-class \-cursor \-takefocus -\-style +\-class \-cursor \-takefocus \-style .SE .\" ALSO: Other entry widget options + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-exportselection exportSelection ExportSelection -Boolean value. If set, the widget selection is linked to the X selection. +Boolean value. +If set, the widget selection is linked to the X selection. .OP \-justify justify Justify -Specifies how the text is aligned within the widget. One of \fBleft\fR, -\fBcenter\fR, or \fBright\fR. +Specifies how the text is aligned within the widget. +One of \fBleft\fR, \fBcenter\fR, or \fBright\fR. .OP \-height height Height Specifies the height of the pop-down listbox, in rows. .OP \-postcommand postCommand PostCommand -A Tcl script to evaluate immediately before displaying the listbox. The -\fB\-postcommand\fR script may specify the \fB\-values\fR to display. +A Tcl script to evaluate immediately before displaying the listbox. +The \fB-postcommand\fR script may specify the \fB-values\fR to display. .OP \-state state State -One of \fBnormal\fR, \fBreadonly\fR, or \fBdisabled\fR. In the \fBreadonly\fR -state, the value may not be edited directly, and the user can only select one -of the \fB\-values\fR from the dropdown list. In the \fBnormal\fR state, the -text field is directly editable. In the \fBdisabled\fR state, no interaction -is possible. +One of \fBnormal\fR, \fBreadonly\fR, or \fBdisabled\fR. +In the \fBreadonly\fR state, +the value may not be edited directly, and +the user can only select one of the \fB-values\fR from the +dropdown list. +In the \fBnormal\fR state, +the text field is directly editable. +In the \fBdisabled\fR state, no interaction is possible. .OP \-textvariable textVariable TextVariable -Specifies the name of a variable whose value is linked to the widget value. -Whenever the variable changes value the widget value is updated, and vice -versa. +Specifies the name of a variable whose value is linked +to the widget value. +Whenever the variable changes value the widget value is updated, +and vice versa. .OP \-values values Values Specifies the list of values to display in the drop-down listbox. .OP \-width width Width Specifies an integer value indicating the desired width of the entry window, in average-size characters of the widget's font. .BE + .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR -. -Returns the current value of the specified \fIoption\fR. See -\fIttk_widget(n)\fR. +Returns the current value of the specified \fIoption\fR. +See \fIttk_widget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -. -Modify or query widget options. See \fIttk_widget(n)\fR. +Modify or query widget options. +See \fIttk_widget(n)\fR. .TP \fIpathName \fBcurrent\fR ?\fInewIndex\fR? -. -If \fInewIndex\fR is supplied, sets the combobox value to the element at -position \fInewIndex\fR in the list of \fB\-values\fR. Otherwise, returns the -index of the current value in the list of \fB\-values\fR or \fB\-1\fR if the -current value does not appear in the list. +If \fInewIndex\fR is supplied, sets the combobox value +to the element at position \fInewIndex\fR in the list of \fB-values\fR. +Otherwise, returns the index of the current value in the list of \fB-values\fR +or \fB-1\fR if the current value does not appear in the list. .TP \fIpathName \fBget\fR -. Returns the current value of the combobox. .TP \fIpathName \fBidentify \fIx y\fR -. -Returns the name of the element at position \fIx\fR, \fIy\fR, or the empty -string if the coordinates are outside the window. +Returns the name of the element at position \fIx\fR, \fIy\fR, +or the empty string if the coordinates are outside the window. .TP \fIpathName \fBinstate \fIstateSpec\fR ?\fIscript\fR? -. -Test the widget state. See \fIttk_widget(n)\fR. +Test the widget state. +See \fIttk_widget(n)\fR. .TP \fIpathName \fBset\fR \fIvalue\fR -. Sets the value of the combobox to \fIvalue\fR. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -. -Modify or query the widget state. See \fIttk_widget(n)\fR. +Modify or query the widget state. +See \fIttk_widget(n)\fR. .PP -The combobox widget also supports the following \fIttk::entry\fR widget -commands (see \fIttk_entry(n)\fR for details): +The combobox widget also supports the following \fIttk::entry\fR +widget commands (see \fIttk_entry(n)\fR for details): .DS .ta 5.5c 11c bbox delete icursor index insert selection xview .DE + .SH "VIRTUAL EVENTS" -The combobox widget generates a \fB<<ComboboxSelected>>\fR virtual event when -the user selects an element from the list of values. This event is generated -after the listbox is unposted. +The combobox widget generates a \fB<<ComboboxSelected>>\fR virtual event +when the user selects an element from the list of values. +This event is generated after the listbox is unposted. + .SH "SEE ALSO" ttk_widget(n), ttk_entry(n) .SH KEYWORDS diff --git a/doc/ttk_entry.n b/doc/ttk_entry.n index 2e3a306..6df1d82 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.5 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: ttk_entry.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_entry n 8.5 Tk "Tk Themed Widget" @@ -24,13 +24,14 @@ ttk_entry \- Editable text field widget An \fBttk::entry\fR widget displays a one-line text string and allows that string to be edited by the user. The value of the string may be linked to a Tcl variable -with the \fB\-textvariable\fR option. +with the \fB-textvariable\fR option. Entry widgets support horizontal scrolling with the -standard \fB\-xscrollcommand\fR option and \fBxview\fR widget command. +standard \fB-xscrollcommand\fR option and \fBxview\fR widget command. .SO -\-class \-cursor \-style -\-takefocus \-xscrollcommand +\-class \-cursor \-style \-takefocus +\-xscrollcommand .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-exportselection exportSelection ExportSelection A boolean value specifying whether or not @@ -56,9 +57,7 @@ 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 -.QW * -or a bullet character. +the first character in the value of this option, such as ``*''. 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 @@ -89,6 +88,8 @@ Specifies an integer value indicating the desired width of the entry window, in average-size characters of the widget's font. .\" Not in ttk: If the value is less than or equal to zero, the widget picks a .\" Not in ttk: size just large enough to hold its current text. +.BE + .SH NOTES A portion of the entry may be selected as described below. If an entry is exporting its selection (see the \fBexportSelection\fR @@ -106,6 +107,7 @@ may be used to change the view in the window. Entries use the standard \fBxScrollCommand\fR mechanism for interacting with scrollbars (see the description of the \fBxScrollCommand\fR option for details). + .SH "INDICES" Many of the \fBentry\fR widget commands take one or more indices as arguments. An index specifies a particular character in the entry's @@ -116,9 +118,8 @@ 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, -.QW \fB@0\fR -indicates the left-most character in the window. +For example, ``\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 @@ -134,12 +135,10 @@ 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. -.QW \fBe\fR -or -.QW \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. ``\fBe\fR'' +or ``\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: @@ -221,7 +220,7 @@ See \fIttk_widget(n)\fR. .TP \fIpathName \fBvalidate\fR Force revalidation, independent of the conditions specified -by the \fB\-validate\fR option. +by the \fB-validate\fR option. Returns 0 if validation fails, 1 if it succeeds. Sets or clears the \fBinvalid\fR state accordingly. .TP @@ -263,18 +262,19 @@ If \fInumber\fR is negative then characters farther to the left become visible; if it is positive then characters farther to the right become visible. .RE + .SH VALIDATION -The \fB\-validate\fR, \fB\-validatecommand\fR, and \fB\-invalidcommand\fR +The \fB-validate\fR, \fB-validatecommand\fR, and \fB-invalidcommand\fR options are used to enable entry widget validation. .SS "VALIDATION MODES" There are two main validation modes: \fIprevalidation\fR, -in which the \fB\-validatecommand\fR is evaluated prior to each edit +in which the \fB-validatecommand\fR is evaluated prior to each edit and the return value is used to determine whether to accept or reject the change; -and \fIrevalidation\fR, in which the \fB\-validatecommand\fR is +and \fIrevalidation\fR, in which the \fB-validatecommand\fR is evaluated to determine whether the current value is valid. .PP -The \fB\-validate\fR option determines when validation occurs; +The \fB-validate\fR option determines when validation occurs; it may be set to any of the following values: .IP \fBnone\fR Default. This means validation will only occur when @@ -293,22 +293,22 @@ The entry is revalidated when the entry loses focus. .IP \fBall\fR Validation is performed for all above conditions. .PP -The \fB\-invalidcommand\fR is evaluated whenever -the \fB\-validatecommand\fR returns a false value. +The \fB-invalidcommand\fR is evaluated whenever +the \fB-validatecommand\fR returns a false value. .PP -The \fB\-validatecommand\fR and \fB\-invalidcommand\fR +The \fB-validatecommand\fR and \fB-invalidcommand\fR may modify the entry widget's value via the widget \fBinsert\fR or \fBdelete\fR commands, -or by setting the linked \fB\-textvariable\fR. +or by setting the linked \fB-textvariable\fR. If either does so during prevalidation, then the edit is rejected -regardless of the value returned by the \fB\-validatecommand\fR. +regardless of the value returned by the \fB-validatecommand\fR. .PP -If \fB\-validatecommand\fR is empty (the default), +If \fB-validatecommand\fR is empty (the default), validation always succeeds. .SS "VALIDATION SCRIPT SUBSTITUTIONS" It is possible to perform percent substitutions on the -\fB\-validatecommand\fR and \fBinvalidCommand\fR, +\fB-validatecommand\fR and \fBinvalidCommand\fR, just as in a \fBbind\fR script. The following substitutions are recognized: .IP \fB%d\fR @@ -325,7 +325,7 @@ The current value of entry prior to editing. .IP \fB%S\fR The text string being inserted/deleted, if any, {} otherwise. .IP \fB%v\fR -The current value of the \fB\-validate\fR option. +The current value of the \fB-validate\fR option. .IP \fB%V\fR The validation condition that triggered the callback (\fBkey\fR, \fBfocusin\fR, \fBfocusout\fR, or \fBforced\fR). @@ -334,24 +334,23 @@ The name of the entry widget. .SS "DIFFERENCES FROM TK ENTRY WIDGET VALIDATION" .IP \(bu The standard Tk entry widget automatically disables validation -(by setting \fB\-validate\fR to \fBnone\fR) -if the \fB\-validatecommand\fR or \fB\-invalidcommand\fR modifies +(by setting \fB-validate\fR to \fBnone\fR) +if the \fB-validatecommand\fR or \fB-invalidcommand\fR modifies the entry's value. The Tk themed entry widget only disables validation if one -of the validation scripts raises an error, or if \fB\-validatecommand\fR +of the validation scripts raises an error, or if \fB-validatecommand\fR does not return a valid boolean value. (Thus, it is not necessary to reenable validation after modifying the entry value in a validation script). .IP \(bu The standard entry widget invokes validation whenever the linked -\fB\-textvariable\fR is modified; the Tk themed entry widget does not. +\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, -.QW word -refers to a contiguous group of letters, digits, or -.QW _ -characters, or any single character other than these. +In the descriptions below, ``word'' refers to a contiguous group +of letters, digits, or ``_'' 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 @@ -426,6 +425,7 @@ Control-d deletes the character to the right of the insert cursor. .IP \(bu Control-k deletes all the characters to the right of the insertion cursor. + .SH "WIDGET STATES" In the \fBdisabled\fR state, the entry cannot be edited and the text cannot be selected. @@ -436,7 +436,7 @@ the entry cannot be edited The \fBdisabled\fR state is the same as \fBreadonly\fR, and in addition text cannot be selected. .PP -Note that changes to the linked \fB\-textvariable\fR will +Note that changes to the linked \fB-textvariable\fR will still be reflected in the entry, even if it is disabled or readonly. .PP Typically, the text is "grayed-out" in the \fBdisabled\fR state, @@ -444,7 +444,9 @@ and a different background is used in the \fBreadonly\fR state. .PP The entry widget sets the \fBinvalid\fR state if revalidation fails, and clears it whenever validation succeeds. + .SH "SEE ALSO" ttk_widget(n), entry(n) + .SH KEYWORDS entry, widget, text field diff --git a/doc/ttk_frame.n b/doc/ttk_frame.n index 32be4d5..9363c14 100644 --- a/doc/ttk_frame.n +++ b/doc/ttk_frame.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_frame.n,v 1.4 2007/10/23 15:44:35 dkf Exp $ +'\" RCS: @(#) $Id: ttk_frame.n,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_frame n 8.5 Tk "Tk Themed Widget" @@ -20,35 +20,39 @@ ttk_frame \- Simple container widget A \fBttk::frame\fR widget is a container, used to group other widgets together. .SO -\-class \-cursor \-takefocus -\-style +\-class \-cursor \-takefocus \-style .SE + .SH "WIDGET-SPECIFIC OPTIONS" -.OP \-borderwidth borderWidth BorderWidth +.OP -borderwidth borderWidth BorderWidth The desired width of the widget border. Defaults to 0. -.OP \-relief relief Relief +.OP -relief relief Relief One of the standard Tk border styles: \fBflat\fR, \fBgroove\fR, \fBraised\fR, \fBridge\fR, \fBsolid\fR, or \fBsunken\fR. Defaults to \fBflat\fR. -.OP \-padding padding Padding +.OP -padding padding Padding Additional padding to include inside the border. -.OP \-width width Width +.OP -width width Width If specified, the widget's requested width in pixels. -.OP \-height height Height +.OP -height height Height If specified, the widget's requested height in pixels. + .SH "WIDGET COMMAND" Supports the standard widget commands \fBconfigure\fR, \fBcget\fR, \fBinstate\fR, and \fBstate\fR; see \fIttk_widget(n)\fR. + .SH "NOTES" Note that if the \fBpack\fR, \fBgrid\fR, or other geometry managers are used to manage the children of the \fBframe\fR, by the GM's requested size will normally take precedence -over the \fBframe\fR widget's \fB\-width\fR and \fB\-height\fR options. +over the \fBframe\fR widget's \fB-width\fR and \fB-height\fR options. [\fBpack propagate\fR] and [\fBgrid propagate\fR] can be used to change this. + .SH "SEE ALSO" ttk_widget(n), ttk_labelframe(n), frame(n) + .SH "KEYWORDS" widget, frame, container diff --git a/doc/ttk_image.n b/doc/ttk_image.n index 6eebf64..61effb9 100644 --- a/doc/ttk_image.n +++ b/doc/ttk_image.n @@ -3,9 +3,9 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: ttk_image.n,v 1.8 2007/10/23 15:44:36 dkf Exp $ -'\" +'\" +'\" RCS: @(#) $Id: ttk_image.n,v 1.9 2007/10/26 20:13:23 dgp Exp $ +'\" .so man.macros .TH ttk_image n 8.5 Tk "Tk Themed Widget" .BS @@ -16,58 +16,63 @@ ttk_image \- Define an element based on an image .BE .SH DESCRIPTION -The \fIimage\fR element factory creates a new element in the current theme -whose visual appearance is determined by Tk images. \fIimageSpec\fP is a list -of one or more elements. The first element is the default image name. The rest -of the list is a sequence of \fIstatespec / value\fR pairs specifying other -images to use when the element is in a particular state or combination of -states. +The \fIimage\fR element factory creates a new element +in the current theme whose visual appearance is determined +by Tk images. +\fIimageSpec\fP is a list of one or more elements. +The first element is the default image name. +The rest of the list is a sequence of \fIstatespec / value\fR +pairs specifying other images to use when the element is +in a particular state or combination of states. + .SH OPTIONS Valid \fIoptions\fR are: .TP -\fB\-border\fR \fIpadding\fR -. -\fIpadding\fR is a list of up to four integers, specifying the left, top, -right, and bottom borders, respectively. See \fBIMAGE STRETCHING\fR, below. +\fB-border\fR \fIpadding\fR +\fIpadding\fR is a list of up to four integers, specifying +the left, top, right, and bottom borders, respectively. +See \fBIMAGE STRETCHING\fR, below. .TP -\fB\-height \fIheight\fR -. -Specifies a minimum height for the element. If less than zero, the base -image's height is used as a default. +\fB-height \fIheight\fR +Specifies a minimum height for the element. +If less than zero, the base image's height is used as a default. .TP -\fB\-padding\fR \fIpadding\fR -. -Specifies the element's interior padding. Defaults to \fI\-border\fR if not -specified. +\fB-padding\fR \fIpadding\fR +Specifies the element's interior padding. Defaults to +\fI-border\fR if not specified. .TP -\fB\-sticky\fR \fIspec\fR -. -Specifies how the image is placed within the final parcel. \fIspec\fR contains -zero or more characters "n", "s", "w", or "e". +\fB-sticky\fR \fIspec\fR +Specifies how the image is placed within the final parcel. +\fIspec\fR contains zero or more characters "n", "s", "w", or "e". .TP -\fB\-width \fIwidth\fR -. -Specifies a minimum width for the element. If less than zero, the base image's -width is used as a default. +\fB-width \fIwidth\fR +Specifies a minimum width for the element. +If less than zero, the base image's width is used as a default. + .SH "IMAGE STRETCHING" -If the element's allocated parcel is larger than the image, the image will be -placed in the parcel based on the \fB\-sticky\fR option. If the image needs to -stretch horizontally (i.e., \fB\-sticky ew\fR) or vertically (\fB\-sticky -ns\fR), subregions of the image are replicated to fill the parcel based on the -\fB\-border\fR option. The \fB\-border\fR divides the image into 9 regions: -four fixed corners, top and left edges (which may be tiled horizontally), left -and right edges (which may be tiled vertically), and the central area (which -may be tiled in both directions). +If the element's allocated parcel is larger than the image, +the image will be placed in the parcel based on the \fB-sticky\fR option. +If the image needs to stretch horizontally (i.e., \fB-sticky ew\fR) +or vertically (\fB-sticky ns\fR), +subregions of the image are replicated to fill the parcel +based on the \fB-border\fR option. +The \fB-border\fR divides the image into 9 regions: +four fixed corners, top and left edges (which may be tiled horizontally), +left and right edges (which may be tiled vertically), +and the central area (which may be tiled in both directions). + .SH "EXAMPLE" .CS set img1 [image create photo -file button.png] set img2 [image create photo -file button-pressed.png] set img3 [image create photo -file button-active.png] style element create Button.button image \e - [list $img1 pressed $img2 active $img3] \e - -border {2 4} -sticky we + [list $img1 pressed $img2 active $img3] \e + -border {2 4} -sticky we .CE + .SH "SEE ALSO" image(n), photo(n) + .SH KEYWORDS pixmap theme, image diff --git a/doc/ttk_intro.n b/doc/ttk_intro.n index 4a96e66..064cc7a 100644 --- a/doc/ttk_intro.n +++ b/doc/ttk_intro.n @@ -3,9 +3,9 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: ttk_intro.n,v 1.5 2007/10/23 15:44:36 dkf Exp $ -'\" +'\" +'\" RCS: @(#) $Id: ttk_intro.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ +'\" .so man.macros .TH ttk_intro n 8.5 Tk "Tk Themed Widget" .BS @@ -14,15 +14,20 @@ ttk_intro \- Introduction to the Tk theme engine .BE .SH "OVERVIEW" -The Tk themed widget set is based on a revised and enhanced version of TIP #48 -(http://tip.tcl.tk/48) specified style engine. The main concepts are described -below. The basic idea is to separate, to the extent possible, the code -implementing a widget's behavior from the code implementing its appearance. -Widget class bindings are primarily responsible for maintaining the widget -state and invoking callbacks; all aspects of the widgets appearance is +The Tk themed widget set is based on a revised and enhanced version +of TIP #48 (http://tip.tcl.tk/48) specified style engine. +The main concepts are described below. +The basic idea is to separate, to the extent possible, +the code implementing a widget's behavior from +the code implementing its appearance. +Widget class bindings are primarily responsible for +maintaining the widget state and invoking callbacks; +all aspects of the widgets appearance is + .SH "THEMES" -A \fItheme\fR is a collection of elements and styles that determine the look -and feel of the widget set. Themes can be used to: +A \fItheme\fR is a collection of elements and styles +that determine the look and feel of the widget set. +Themes can be used to: .IP \(bu Isolate platform differences (X11 vs. classic Windows vs. XP vs. Aqua ...) .IP \(bu @@ -35,23 +40,28 @@ Application suite "branding" Blend in with the rest of the desktop (Gnome, KDE, Java) .IP \(bu And, of course: eye candy. + .SH "ELEMENTS" -An \fIelement\fR displays an individual part of a widget. For example, a -vertical scrollbar widget contains \fBuparrow\fR, \fBdownarrow\fR, -\fBtrough\fR and \fBslider\fR elements. +An \fIelement\fR displays an individual part of a widget. +For example, a vertical scrollbar widget contains \fBuparrow\fR, +\fBdownarrow\fR, \fBtrough\fR and \fBslider\fR elements. .PP -Element names use a recursive dotted notation. For example, \fBuparrow\fR -identifies a generic arrow element, and \fBScrollbar.arrow\fR and -\fBCombobox.uparrow\fR identify widget-specific elements. When looking for an -element, the style engine looks for the specific name first, and if an element -of that name is not found it looks for generic elements by stripping off +Element names use a recursive dotted notation. +For example, \fBuparrow\fR identifies a generic arrow element, +and \fBScrollbar.arrow\fR and \fBCombobox.uparrow\fR identify +widget-specific elements. +When looking for an element, the style engine looks for +the specific name first, and if an element of that name is +not found it looks for generic elements by stripping off successive leading components of the element name. .PP -Like widgets, elements have \fIoptions\fR which specify what to display and -how to display it. For example, the \fBtext\fR element (which displays a text -string) has \fB\-text\fR, \fB\-font\fR, \fB\-foreground\fR, -\fB\-background\fR, \fB\-underline\fR, and \fB\-width\fR options. The value of -an element resource is taken from: +Like widgets, elements have \fIoptions\fR which +specify what to display and how to display it. +For example, the \fBtext\fR element +(which displays a text string) has +\fB-text\fR, \fB-font\fR, \fB-foreground\fR, \fB-background\fR, +\fB-underline\fR, and \fB-width\fR options. +The value of an element resource is taken from: .IP \(bu A dynamic setting specified by \fBstyle map\fR and the current state; .IP \(bu @@ -61,84 +71,99 @@ The default setting specified by \fBstyle default\fR; or .IP \(bu The element's built-in default value for the resource. .SH "LAYOUTS" -A \fIlayout\fR specifies which elements make up a widget and how they are -arranged. The layout engine uses a simplified version of the \fBpack\fR -algorithm: starting with an initial cavity equal to the size of the widget, -elements are allocated a parcel within the cavity along the side specified by -the \fB\-side\fR option, and placed within the parcel according to the -\fB\-sticky\fR option. For example, the layout for a horizontal scrollbar: +A \fIlayout\fR specifies which elements make up a widget +and how they are arranged. +The layout engine uses a simplified version of the \fBpack\fR +algorithm: starting with an initial cavity equal to the size +of the widget, elements are allocated a parcel within the cavity along +the side specified by the \fB-side\fR option, +and placed within the parcel according to the \fB-sticky\fR +option. +For example, the layout for a horizontal scrollbar .CS style layout Horizontal.TScrollbar { Scrollbar.trough -children { - Scrollbar.leftarrow -side left -sticky w - Scrollbar.rightarrow -side right -sticky e - Scrollbar.thumb -side left -expand true -sticky ew + Scrollbar.leftarrow -side left -sticky w + Scrollbar.rightarrow -side right -sticky e + Scrollbar.thumb -side left -expand true -sticky ew } } .CE -By default, the layout for a widget is the same as its class name. Some -widgets may override this (for example, the \fBscrollbar\fR widget chooses -different layouts based on the \fB\-orient\fR option). +By default, the layout for a widget is the same as its class name. +Some widgets may override this (for example, the \fBscrollbar\fR +widget chooses different layouts based on the \fB-orient\fR option). + .SH "STATES" -In standard Tk, many widgets have a \fB\-state\fR option which (in most cases) -is either \fBnormal\fR or \fBdisabled\fR. Some widgets support additional -states, such as the \fBentry\fR widget which has a \fBreadonly\fR state and -the various flavors of buttons which have \fBactive\fR state. +In standard Tk, many widgets have a \fB-state\fR option +which (in most cases) is either \fBnormal\fR or \fBdisabled\fR. +Some widgets support additional states, such +as the \fBentry\fR widget which has a \fBreadonly\fR state +and the various flavors of buttons which have \fBactive\fR state. .PP -The themed Tk widgets generalizes this idea: every widget has a bitmap of -independent state flags. Widget state flags include \fBactive\fR, -\fBdisabled\fR, \fBpressed\fR, \fBfocus\fR, etc., (see \fIttk_widget(n)\fR for -the full list of state flags). +The themed Tk widgets generalizes this idea: +every widget has a bitmap of independent state flags. +Widget state flags include \fBactive\fR, \fBdisabled\fR, +\fBpressed\fR, \fBfocus\fR, etc., +(see \fIttk_widget(n)\fR for the full list of state flags). .PP -Instead of a \fB\-state\fR option, every widget now has a \fBstate\fR widget -command which is used to set or query the state. A \fIstate specification\fR -is a list of symbolic state names indicating which bits are set, each -optionally prefixed with an exclamation point indicating that the bit is -cleared instead. +Instead of a \fB-state\fR option, every widget now has +a \fBstate\fR widget command which is used to set or query +the state. +A \fIstate specification\fR is a list of symbolic state names +indicating which bits are set, each optionally prefixed with an +exclamation point indicating that the bit is cleared instead. .PP -For example, the class bindings for the \fBttk::button\fR widget are: +For example, the class bindings for the \fBtbutton\fR +widget are: .CS -bind TButton <Enter> { %W state active } -bind TButton <Leave> { %W state !active } -bind TButton <ButtonPress-1> { %W state pressed } -bind TButton <Button1-Leave> { %W state !pressed } -bind TButton <Button1-Enter> { %W state pressed } -bind TButton <ButtonRelease-1> \e +bind TButton <Enter> { %W state active } +bind TButton <Leave> { %W state !active } +bind TButton <ButtonPress-1> { %W state pressed } +bind TButton <Button1-Leave> { %W state !pressed } +bind TButton <Button1-Enter> { %W state pressed } +bind TButton <ButtonRelease-1> \e { %W instate {pressed} { %W state !pressed ; %W invoke } } .CE -This specifies that the widget becomes \fBactive\fR when the pointer enters -the widget, and inactive when it leaves. Similarly it becomes \fBpressed\fR -when the mouse button is pressed, and \fB!pressed\fR on the ButtonRelease -event. In addition, the button unpresses if pointer is dragged outside the -widget while Button-1 is held down, and represses if it's dragged back in. -Finally, when the mouse button is released, the widget's \fB\-command\fR is -invoked, but only if the button is currently in the \fBpressed\fR state. (The -actual bindings are a little more complicated than the above, but not by -much). +This specifies that the widget becomes \fBactive\fR when +the pointer enters the widget, and inactive when it leaves. +Similarly it becomes \fBpressed\fR when the mouse button is pressed, +and \fB!pressed\fR on the ButtonRelease event. +In addition, the button unpresses if +pointer is dragged outside the widget while Button-1 is held down, +and represses if it's dragged back in. +Finally, when the mouse button is released, the widget's +\fB-command\fR is invoked, but only if the button is currently +in the \fBpressed\fR state. +(The actual bindings are a little more complicated than the above, +but not by much). .PP -\fINote to self: rewrite that paragraph. It's horrible.\fR +\fINote to self: rewrite that paragraph. It's horrible.\fR + .SH "STYLES" -Each widget is associated with a \fIstyle\fR, which specifies values for -element resources. Style names use a recursive dotted notation like layouts -and elements; by default, widgets use the class name to look up a style in the -current theme. For example: +Each widget is associated with a \fIstyle\fR, +which specifies values for element resources. +Style names use a recursive dotted notation like layouts and elements; +by default, widgets use the class name to look up a style in the current theme. +For example: .CS style default TButton \e - -background #d9d9d9 \e - -foreground black \e - -relief raised \e - ; + -background #d9d9d9 \e + -foreground black \e + -relief raised \e + ; .CE -Many elements are displayed differently depending on the widget state. For -example, buttons have a different background when they are active, a different -foreground when disabled, and a different relief when pressed. The \fBstyle -map\fR command specifies dynamic resources for a particular style: +Many elements are displayed differently depending on the widget state. +For example, buttons have a different background when they are active, +a different foreground when disabled, and a different relief when pressed. +The \fBstyle map\fR command specifies dynamic resources +for a particular style: .CS style map TButton \e - -background [list disabled #d9d9d9 active #ececec] \e - -foreground [list disabled #a3a3a3] \e - -relief [list {pressed !disabled} sunken] \e - ; + -background [list disabled #d9d9d9 active #ececec] \e + -foreground [list disabled #a3a3a3] \e + -relief [list {pressed !disabled} sunken] \e + ; .CE + .SH "SEE ALSO" ttk_widget(n), ttk_style(n) diff --git a/doc/ttk_label.n b/doc/ttk_label.n index 8acb3b2..c980023 100644 --- a/doc/ttk_label.n +++ b/doc/ttk_label.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_label.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_label.n,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_label n 8.5 Tk "Tk Themed Widget" @@ -21,18 +21,18 @@ A \fBttk::label\fR widget displays a textual label and/or image. The label may be linked to a Tcl variable to automatically change the displayed text. .SO -\-class \-compound \-cursor -\-image \-style \-takefocus -\-text \-textvariable \-underline -\-width +\-class \-compound \-cursor \-image +\-style \-takefocus \-text \-textvariable +\-underline \-width .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-anchor anchor Anchor Specifies how the information in the widget is positioned relative to the inner margins. Legal values are \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR, \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, and \fBcenter\fR. -See also \fB\-justify\fR. +See also \fB-justify\fR. .OP \-background frameColor FrameColor The widget's background color. If unspecified, the theme default is used. @@ -45,7 +45,7 @@ If unspecified, the theme default is used. If there are multiple lines of text, specifies how the lines are laid out relative to one another. One of \fBleft\fR, \fBcenter\fR, or \fBright\fR. -See also \fB\-anchor\fR. +See also \fB-anchor\fR. .OP \-padding padding Padding Specifies the amount of extra space to allocate for the widget. The padding is a list of up to four length specifications @@ -62,13 +62,14 @@ Valid values are and \fBsunken\fR. .OP \-text text Text Specifies a text string to be displayed inside the widget -(unless overridden by \fB\-textvariable\fR). +(unless overridden by \fB-textvariable\fR). .OP \-wraplength wrapLength WrapLength Specifies the maximum line length (in pixels). If this option is less than or equal to zero, then automatic wrapping is not performed; otherwise the text is split into lines such that no line is longer than the specified value. + .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR @@ -79,5 +80,6 @@ than the specified value. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? See \fIttk_widget(n)\fR + .SH "SEE ALSO" ttk_widget(n), label(n) diff --git a/doc/ttk_labelframe.n b/doc/ttk_labelframe.n index 531d9c8..c9f1163 100644 --- a/doc/ttk_labelframe.n +++ b/doc/ttk_labelframe.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_labelframe.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_labelframe.n,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_labelframe n 8.5 Tk "Tk Themed Widget" @@ -21,28 +21,28 @@ A \fBttk::labelframe\fR widget is a container used to group other widgets together. It has an optional label, which may be a plain text string or another widget. .SO -\-class \-cursor \-takefocus -\-style +\-class \-cursor \-takefocus \-style .SE + .SH "WIDGET-SPECIFIC OPTIONS" -.\" XXX: Currently included, but may go away: -.\" XXX: .OP -borderwidth borderWidth BorderWidth -.\" XXX: The desired width of the widget border. Default is theme-dependent. -.\" XXX: .OP -relief relief Relief -.\" XXX: One of the standard Tk border styles: -.\" XXX: \fBflat\fR, \fBgroove\fR, \fBraised\fR, \fBridge\fR, -.\" XXX: \fBsolid\fR, or \fBsunken\fR. -.\" XXX: Default is theme-dependent. +'\" XXX: Currently included, but may go away: +'\" XXX: .OP -borderwidth borderWidth BorderWidth +'\" XXX: The desired width of the widget border. Default is theme-dependent. +'\" XXX: .OP -relief relief Relief +'\" XXX: One of the standard Tk border styles: +'\" XXX: \fBflat\fR, \fBgroove\fR, \fBraised\fR, \fBridge\fR, +'\" XXX: \fBsolid\fR, or \fBsunken\fR. +'\" XXX: Default is theme-dependent. .OP -labelanchor labelAnchor LabelAnchor Specifies where to place the label. Allowed values are (clockwise from the top upper left corner): \fBnw\fR, \fBn\fR, \fBne\fR, \fBen\fR, \fBe\fR, \fBes\fR, \fBse\fR, \fBs\fR,\fBsw\fR, \fBws\fR, \fBw\fR and \fBwn\fR. The default value is theme-dependent. -.\" Alternate explanation: The first character must be one of n, s, e, or w -.\" and specifies which side the label should be placed on; -.\" the remaining characters specify how the label is aligned on that side. -.\" NOTE: Now allows other values as well; leave this undocumented for now +'\" Alternate explanation: The first character must be one of n, s, e, or w +'\" and specifies which side the label should be placed on; +'\" the remaining characters specify how the label is aligned on that side. +'\" NOTE: Now allows other values as well; leave this undocumented for now .OP -text text Text Specifies the text of the label. .OP -underline underline Underline @@ -55,21 +55,23 @@ sets the keyboard focus to the first child of the \fBttk::labelframe\fR widget. Additional padding to include inside the border. .OP -labelwidget labelWidget LabelWidget The name of a widget to use for the label. -If set, overrides the \fB\-text\fR option. -The \fB\-labelwidget\fR must be a child of the \fBlabelframe\fR widget +If set, overrides the \fB-text\fR option. +The \fB-labelwidget\fR must be a child of the \fBlabelframe\fR widget or one of the \fBlabelframe\fR's ancestors, and must belong to the same top-level widget as the \fBlabelframe\fR. .OP -width width Width If specified, the widget's requested width in pixels. .OP -height height Height If specified, the widget's requested height in pixels. -(See \fIttk_frame(n)\fR for further notes on \fB\-width\fR and -\fB\-height\fR). +(See \fIttk_frame(n)\fR for further notes on \fB-width\fR and \fB-height\fR). + .SH "WIDGET COMMAND" Supports the standard widget commands \fBconfigure\fR, \fBcget\fR, \fBinstate\fR, and \fBstate\fR; see \fIttk_widget(n)\fR. + .SH "SEE ALSO" ttk_widget(n), ttk_frame(n), labelframe(n) + .SH "KEYWORDS" widget, frame, container, label, groupbox diff --git a/doc/ttk_menubutton.n b/doc/ttk_menubutton.n index bc57388..4796e0a 100644 --- a/doc/ttk_menubutton.n +++ b/doc/ttk_menubutton.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_menubutton.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_menubutton.n,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_menubutton n 8.5 Tk "Tk Themed Widget" @@ -20,11 +20,11 @@ ttk_menubutton \- Widget that pops down a menu when pressed A \fBttk::menubutton\fR widget displays a textual label and/or image, and displays a menu when pressed. .SO -\-class \-compound \-cursor -\-image \-state \-style -\-takefocus \-text \-textvariable -\-underline \-width +\-class \-compound \-cursor \-image +\-state \-style \-takefocus \-text +\-textvariable \-underline \-width .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-direction direction Direction Specifies where the menu is to be popped up relative @@ -39,11 +39,14 @@ menubutton. .\" not documented: may go away: .\" .OP \-anchor anchor Anchor .\" .OP \-padding padding Pad + .SH "WIDGET COMMAND" Menubutton widgets support the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR methods. No other widget methods are used. + .SH "SEE ALSO" ttk_widget(n), menu(n), menubutton(n) + .SH "KEYWORDS" widget, button, menu diff --git a/doc/ttk_notebook.n b/doc/ttk_notebook.n index a677443..b407f05 100644 --- a/doc/ttk_notebook.n +++ b/doc/ttk_notebook.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_notebook.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_notebook.n,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_notebook n 8.5 Tk "Tk Themed Widget" @@ -13,161 +13,170 @@ .SH NAME ttk_notebook \- Multi-paned container widget .SH SYNOPSIS -.nf \fBttk::notebook\fR \fIpathName \fR?\fIoptions\fR? - +.br \fIpathName \fBadd\fR \fIpathName\fR.\fIsubwindow\fR ?\fIoptions...\fR? \fIpathName \fBinsert\fR \fIindex\fR \fIpathName\fR.\fIsubwindow\fR ?\fIoptions...\fR? -.fi .BE .SH DESCRIPTION -A \fBttk::notebook\fR widget manages a collection of subpanes and displays a -single one at a time. Each pane is associated with a tab, which the user may -select to change the currently-displayed pane. +A \fBttk::notebook\fR widget manages a collection of subpanes +and displays a single one at a time. +Each pane is associated with a tab, which the user +may select to change the currently-displayed pane. .SO -\-class \-cursor \-style -\-takefocus +\-class \-cursor \-takefocus \-style .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-height height Height -If present and greater than zero, specifies the desired height of the pane -area (not including internal padding or tabs). Otherwise, the maximum height -of all panes is used. +If present and greater than zero, +specifies the desired height of the pane area +(not including internal padding or tabs). +Otherwise, the maximum height of all panes is used. .OP \-padding padding Padding -Specifies the amount of extra space to add around the outside of the notebook. -The padding is a list of up to four length specifications \fIleft top right -bottom\fR. If fewer than four elements are specified, \fIbottom\fR defaults to -\fItop\fR, \fIright\fR defaults to \fIleft\fR, and \fItop\fR defaults to -\fIleft\fR. +Specifies the amount of extra space to add around the outside +of the notebook. +The padding is a list of up to four length specifications +\fIleft top right bottom\fR. +If fewer than four elements are specified, +\fIbottom\fR defaults to \fItop\fR, +\fIright\fR defaults to \fIleft\fR, and +\fItop\fR defaults to \fIleft\fR. .OP \-width width Width -If present and greater than zero, specifies the desired width of the pane area -(not including internal padding). Otherwise, the maximum width of all panes is -used. +If present and greater than zero, +specifies the desired width of the pane area +(not including internal padding). +Otherwise, the maximum width of all panes is used. .SH "TAB OPTIONS" The following options may be specified for individual notebook panes: .OP \-state state State -Either \fBnormal\fR, \fBdisabled\fR or \fBhidden\fR. If \fBdisabled\fR, then -the tab is not selectable. If \fBhidden\fR, then the tab is not shown. +Either \fBnormal\fR, \fBdisabled\fR or \fBhidden\fR. +If \fBdisabled\fR, then the tab is not selectable. If \fBhidden\fR, +then the tab is not shown. .OP \-sticky sticky Sticky -Specifies how the child pane is positioned within the pane area. Value is a -string containing zero or more of the characters \fBn, s, e,\fR or \fBw\fR. -Each letter refers to a side (north, south, east, or west) that the child -window will "stick" to, as per the \fBgrid\fR geometry manager. +Specifies how the child pane is positioned within the pane area. +Value is a string containing zero or more of the characters +\fBn, s, e,\fR or \fBw\fR. +Each letter refers to a side (north, south, east, or west) +that the child window will "stick" to, +as per the \fBgrid\fR geometry manager. .OP \-padding padding Padding Specifies the amount of extra space to add between the notebook and this pane. -Syntax is the same as for the widget \fB\-padding\fR option. +Syntax is the same as for the widget \fB-padding\fR option. .OP \-text text Text Specifies a string to be displayed in the tab. .OP \-image image Image -Specifies an image to display in the tab, which must have been created with -the \fBimage create\fR command. +Specifies an image to display in the tab, +which must have been created with the \fBimage create\fR command. .OP \-compound compound Compound -Specifies how to display the image relative to the text, in the case both -\fB\-text\fR and \fB\-image\fR are present. See \fIlabel(n)\fR for legal -values. +Specifies how to display the image relative to the text, +in the case both \fB-text\fR and \fB-image\fR are present. +See \fIlabel(n)\fR for legal values. .OP \-underline underline Underline -Specifies the integer index (0-based) of a character to underline in the text -string. The underlined character is used for mnemonic activation if -\fBttk::notebook::enableTraversal\fR is called. +Specifies the integer index (0-based) of a character to underline +in the text string. +The underlined character is used for mnemonic activation +if \fBttk::notebook::enableTraversal\fR is called. + .SH "WIDGET COMMAND" .TP \fIpathname \fBadd \fIchild\fR ?\fIoptions...\fR? -. -Adds a new tab to the notebook. When the tab is selected, the \fIchild\fR -window will be displayed. \fIchild\fR must be a direct child of the notebook -window. See \fBTAB OPTIONS\fR for the list of available \fIoptions\fR. +Adds a new tab to the notebook. +When the tab is selected, the \fIchild\fR window +will be displayed. +\fIchild\fR must be a direct child of the notebook window. +See \fBTAB OPTIONS\fR for the list of available \fIoptions\fR. .TP \fIpathname \fBconfigure\fR ?\fIoptions\fR? -. See \fIttk_widget(n)\fR. .TP \fIpathname \fBcget\fR \fIoption\fR -. See \fIttk_widget(n)\fR. .TP \fIpathname \fBforget\fR \fItabid\fR -. -Removes the tab specified by \fItabid\fR, unmaps and unmanages the associated -child window. +Removes the tab specified by \fItabid\fR, +unmaps and unmanages the associated child window. .TP \fIpathname \fBindex\fR \fItabid\fR -. -Returns the numeric index of the tab specified by \fItabid\fR, or the total -number of tabs if \fItabid\fR is the string "\fBend\fR". +Returns the numeric index of the tab specified by \fItabid\fR, +or the total number of tabs if \fItabid\fR is the string "\fBend\fR". .TP \fIpathname \fBinsert\fR \fIpos\fR \fIsubwindow\fR \fIoptions...\fR -. -Inserts a pane at the specified position. \fIpos\fR is either the string -\fBend\fR, an integer index, or the name of a managed subwindow. If -\fIsubwindow\fR is already managed by the notebook, moves it to the specified -position. See \fBTAB OPTIONS\fR for the list of available options. +Inserts a pane at the specified position. +\fIpos\fR is either the string \fBend\fR, an integer index, +or the name of a managed subwindow. +If \fIsubwindow\fR is already managed by the notebook, +moves it to the specified position. +See \fBTAB OPTIONS\fR for the list of available options. .TP \fIpathname \fBinstate\fR \fIstatespec \fR?\fIscript...\fR? -. See \fIttk_widget(n)\fR. .TP \fIpathname \fBselect\fR ?\fItabid\fR? -. -Selects the specified tab. The associated child pane will be displayed, and -the previously-selected pane (if different) is unmapped. If \fItabid\fR is -omitted, returns the widget name of the currently selected pane. +Selects the specified tab. The associated child pane will be displayed, +and the previously-selected pane (if different) is unmapped. +If \fItabid\fR is omitted, returns the widget name of the +currently selected pane. .TP \fIpathname \fBstate\fR ?\fIstatespec\fR? -. See \fIttk_widget(n)\fR. .TP -\fIpathname \fBtab\fR \fItabid\fR ?\fI\-options \fR?\fIvalue ...\fR -. -Query or modify the options of the specific tab. If no \fI\-option\fR is -specified, returns a dictionary of the tab option values. If one -\fI\-option\fR is specified, returns the value of that \fIoption\fR. -Otherwise, sets the \fI\-option\fRs to the corresponding \fIvalue\fRs. See -\fBTAB OPTIONS\fR for the available options. +\fIpathname \fBtab\fR \fItabid\fR ?\fI-options \fR?\fIvalue ...\fR +Query or modify the options of the specific tab. +If no \fI-option\fR is specified, returns a dictionary of the tab option values. +If one \fI-option\fR is specified, returns the value of that \fIoption\fR. +Otherwise, sets the \fI-option\fRs to the corresponding \fIvalue\fRs. +See \fBTAB OPTIONS\fR for the available options. .TP \fIpathname \fBtabs\fR -. Returns a list of all windows managed by the widget. .\" Perhaps "panes" is a better name for this command? + .SH "KEYBOARD TRAVERSAL" -To enable keyboard traversal for a toplevel window containing a notebook -widget \fI$nb\fR, call: +To enable keyboard traversal for a toplevel window +containing a notebook widget \fI$nb\fR, call: .CS ttk::notebook::enableTraversal $nb .CE .PP -This will extend the bindings for the toplevel widget containing the notebook -as follows: +This will extend the bindings for the toplevel widget +containing the notebook as follows: .IP \(bu \fBControl-Tab\fR selects the tab following the currently selected one. .IP \(bu \fBShift-Control-Tab\fR selects the tab preceding the currently selected one. .IP \(bu -\fBAlt-K\fR, where \fBK\fR is the mnemonic (underlined) character of any tab, -will select that tab. +\fBAlt-K\fR, where \fBK\fR is the mnemonic (underlined) character +of any tab, will select that tab. .PP Multiple notebooks in a single toplevel may be enabled for traversal, -including nested notebooks. However, notebook traversal only works properly if -all panes are direct children of the notebook. +including nested notebooks. +However, notebook traversal only works properly if all panes +are direct children of the notebook. + .SH "TAB IDENTIFIERS" -The \fItabid\fR argument to the above commands may take any of the following -forms: +The \fItabid\fR argument to the above commands may take +any of the following forms: .IP \(bu An integer between zero and the number of tabs; .IP \(bu The name of a child pane window; .IP \(bu -A positional specification of the form "@\fIx\fR,\fIy\fR", which identifies -the tab +A positional specification of the form "@\fIx\fR,\fIy\fR", +which identifies the tab .IP \(bu -The literal string "\fBcurrent\fR", which identifies the currently-selected -tab; or: +The literal string "\fBcurrent\fR", +which identifies the currently-selected tab; or: .IP \(bu -The literal string "\fBend\fR", which returns the number of tabs (only valid -for "\fIpathname \fBindex\fR"). +The literal string "\fBend\fR", +which returns the number of tabs +(only valid for "\fIpathname \fBindex\fR"). + .SH "VIRTUAL EVENTS" -The notebook widget generates a \fB<<NotebookTabChanged>>\fR virtual event -after a new tab is selected. +The notebook widget generates a \fB<<NotebookTabChanged>>\fR +virtual event after a new tab is selected. + .SH "EXAMPLE" .CS notebook .nb @@ -176,7 +185,9 @@ notebook .nb \.nb select .nb.f2 ttk::notebook::enableTraversal .nb .CE + .SH "SEE ALSO" ttk_widget(n), grid(n) + .SH "KEYWORDS" pane, tab diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n index e9befb6..b0adaa6 100644 --- a/doc/ttk_panedwindow.n +++ b/doc/ttk_panedwindow.n @@ -3,9 +3,9 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: ttk_panedwindow.n,v 1.8 2007/10/23 15:44:36 dkf Exp $ -'\" +'\" +'\" RCS: @(#) $Id: ttk_panedwindow.n,v 1.9 2007/10/26 20:13:23 dgp Exp $ +'\" .so man.macros .TH ttk_panedwindow n 8.5 Tk "Tk Themed Widget" .BS @@ -15,7 +15,7 @@ ttk_panedwindow \- Multi-pane container window .SH SYNOPSIS .nf \fBttk::panedwindow\fR \fIpathName \fR?\fIoptions\fR? - +.br \fIpathName \fBadd\fR \fIpathName.subwindow\fR ?\fIoptions...\fR? \fIpathName \fBinsert\fR \fIindex\fR \fIpathName.subwindow\fR ?\fIoptions...\fR? .fi @@ -23,79 +23,81 @@ ttk_panedwindow \- Multi-pane container window .SH DESCRIPTION A \fBttk::panedwindow\fR widget displays a number of subwindows, stacked -either vertically or horizontally. The user may adjust the relative sizes of -the subwindows by dragging the sash between panes. +either vertically or horizontally. The user may adjust the relative sizes +of the subwindows by dragging the sash between panes. .SO -\-class \-cursor \-style -\-takefocus +\-class \-cursor \-takefocus \-style .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient -Specifies the orientation of the window. If \fBvertical\fR, subpanes are -stacked top-to-bottom; if \fBhorizontal\fR, subpanes are stacked -left-to-right. +Specifies the orientation of the window. +If \fBvertical\fR, subpanes are stacked top-to-bottom; +if \fBhorizontal\fR, subpanes are stacked left-to-right. .OP \-width width Width -If present and greater than zero, specifies the desired width of the widget in -pixels. Otherwise, the requested width is determined by the width of the -managed windows. +If present and greater than zero, +specifies the desired width of the widget in pixels. +Otherwise, the requested width is determined by the width +of the managed windows. .OP \-height height Height -If present and greater than zero, specifies the desired height of the widget -in pixels. Otherwise, the requested height is determined by the height of the -managed windows. +If present and greater than zero, +specifies the desired height of the widget in pixels. +Otherwise, the requested height is determined by the height +of the managed windows. + .SH "PANE OPTIONS" The following options may be specified for each pane: .OP \-weight weight Weight -An integer specifying the relative stretchability of the pane. When the paned -window is resized, the extra space is added or subtracted to each pane -proportionally to its \fB\-weight\fR. +An integer specifying the relative stretchability of the pane. +When the paned window is resized, the extra space is added +or subtracted to each pane proportionally to its \fB-weight\fR. + .SH "WIDGET COMMAND" -Supports the standard \fBconfigure\fR, \fBcget\fR, \fBstate\fR, and -\fBinstate\fR commands; see \fIttk_widget(n)\fR for details. Additional -commands: +Supports the standard \fBconfigure\fR, \fBcget\fR, \fBstate\fR, +and \fBinstate\fR commands; see \fIttk_widget(n)\fR for details. +Additional commands: .TP \fIpathname \fBadd\fR \fIsubwindow\fR \fIoptions...\fR -. -Adds a new pane to the window. \fIsubwindow\fR must be a direct child of the -paned window \fIpathname\fR. See \fBPANE OPTIONS\fR for the list of available -options. +Adds a new pane to the window. +\fIsubwindow\fR must be a direct child of the paned window \fIpathname\fR. +See \fBPANE OPTIONS\fR for the list of available options. .TP \fIpathname \fBforget\fR \fIpane\fR -. -Removes the specified subpane from the widget. \fIpane\fR is either an integer -index or the name of a managed subwindow. +Removes the specified subpane from the widget. +\fIpane\fR is either an integer index or the name of a managed subwindow. .TP \fIpathname \fBinsert\fR \fIpos\fR \fIsubwindow\fR \fIoptions...\fR -. -Inserts a pane at the specified position. \fIpos\fR is either the string -\fBend\fR, an integer index, or the name of a managed subwindow. If -\fIsubwindow\fR is already managed by the paned window, moves it to the -specified position. See \fBPANE OPTIONS\fR for the list of available options. +Inserts a pane at the specified position. +\fIpos\fR is either the string \fBend\fR, an integer index, +or the name of a managed subwindow. +If \fIsubwindow\fR is already managed by the paned window, +moves it to the specified position. +See \fBPANE OPTIONS\fR for the list of available options. .TP \fIpathname \fBpane\fR \fIpane -option \fR?\fIvalue \fR?\fI-option value...\fR -. -Query or modify the options of the specified \fIpane\fR, where \fIpane\fR is -either an integer index or the name of a managed subwindow. If no -\fI\-option\fR is specified, returns a dictionary of the pane option values. -If one \fI\-option\fR is specified, returns the value of that \fIoption\fR. -Otherwise, sets the \fI\-option\fRs to the corresponding \fIvalue\fRs. +Query or modify the options of the specified \fIpane\fR, +where \fIpane\fR is either an integer index or the name of a managed subwindow. +If no \fI-option\fR is specified, returns a dictionary of the pane +option values. +If one \fI-option\fR is specified, returns the value of that \fIoption\fR. +Otherwise, sets the \fI-option\fRs to the corresponding \fIvalue\fRs. .TP \fIpathname\fR \fBsashpos\fR \fIindex\fR ?\fInewpos\fR? -. -If \fInewpos\fR is unspecified, returns the current position of sash number -\fIindex\fR. If \fInewpos\fR is specified, sets the position of sash number -\fIindex\fR, with the aim of making \fInewpos\fR its new position. May adjust -the positions of adjacent sashes to ensure that positions are monotonically -increasing. Sash positions are further constrained to be between 0 and the -total size of the widget; these may mean that the actual new sash position is -not what was requested. +If \fInewpos\fR is specified, sets the position +of sash number \fIindex\fR. +May adjust the positions of adjacent sashes +to ensure that positions are monotonically increasing. +Sash positions are further constrained to be between 0 +and the total size of the widget. .\" Full story: "total size" is either the -height (resp -width), .\" or the actual window height (resp actual window width), .\" depending on which changed most recently. Returns the new position of sash number \fIindex\fR. +.\" Full story: new position may be different than the requested position. .TP \fIpathname\fR \fBidentify\fR \fIx y\fR -. -Returns the index of the sash at point \fIx,y\fR, or the empty string if -\fIx,y\fR is not over a sash. +Returns the index of the sash at point \fIx,y\fR, +or the empty string if \fIx,y\fR is not over a sash. + .SH "SEE ALSO" ttk_widget(n), ttk_notebook(n), panedwindow(n) diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n index d5baec6..43bdb11 100644 --- a/doc/ttk_progressbar.n +++ b/doc/ttk_progressbar.n @@ -3,9 +3,9 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: ttk_progressbar.n,v 1.5 2007/10/23 15:44:36 dkf Exp $ -'\" +'\" +'\" RCS: @(#) $Id: ttk_progressbar.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ +'\" .so man.macros .TH ttk_progressbar n 8.5 Tk "Tk Themed Widget" .BS @@ -17,73 +17,73 @@ ttk_progressbar \- Provide progress feedback .BE .SH DESCRIPTION -A \fBttk::progressbar\fR widget shows the status of a long-running operation. -They can operate in two modes: \fIdeterminate\fR mode shows the amount -completed relative to the total amount of work to be done, and +A \fBttk::progressbar\fR widget shows the status of a long-running +operation. They can operate in two modes: \fIdeterminate\fR mode shows the +amount completed relative to the total amount of work to be done, and \fIindeterminate\fR mode provides an animated display to let the user know that something is happening. .SO -\-class \-cursor \-style -\-takefocus +\-class \-cursor \-takefocus \-style .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient -One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the -progress bar. +One of \fBhorizontal\fR or \fBvertical\fR. +Specifies the orientation of the progress bar. .OP \-length length Length -Specifies the length of the long axis of the progress bar (width if -horizontal, height if vertical). +Specifies the length of the long axis of the progress bar +(width if horizontal, height if vertical). .OP \-mode mode Mode One of \fBdeterminate\fR or \fBindeterminate\fR. .OP \-maximum maximum Maximum -A floating point number specifying the maximum \fB\-value\fR. Defaults to 100. +A floating point number specifying the maximum \fB-value\fR. +Defaults to 100. .OP \-value value Value -The current value of the progress bar. In \fIdeterminate\fR mode, this -represents the amount of work completed. In \fIindeterminate\fR mode, it is -interpreted modulo \fB\-maximum\fR; that is, the progress bar completes one -"cycle" when the \fB\-value\fR increases by \fB\-maximum\fR. +The current value of the progress bar. +In \fIdeterminate\fR mode, this represents the amount of work completed. +In \fIindeterminate\fR mode, it is interpreted modulo \fB-maximum\fR; +that is, the progress bar completes one "cycle" when +the \fB-value\fR increases by \fB-maximum\fR. .OP \-variable variable Variable -The name of a Tcl variable which is linked to the \fB\-value\fR. If specified, -the \fB\-value\fR of the progress bar is automatically set to the value of the -variable whenever the latter is modified. +The name of a Tcl variable which is linked to the \fB-value\fR. +If specified, the \fB-value\fR of the progress bar is +automatically set to the value of the variable whenever +the latter is modified. .OP \-phase phase Phase -Read-only option. The widget periodically increments the value of this option -whenever the \fB\-value\fR is greater than 0 and, in \fIdeterminate\fR mode, -less than \fB\-maximum\fR. This option may be used by the current theme to -provide additional animation effects. +Read-only option. +The widget periodically increments the value of this option +whenever the \fB-value\fR is greater than 0 and, +in \fIdeterminate\fR mode, less than \fB-maximum\fR. +This option may be used by the current theme +to provide additional animation effects. + .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR -. -Returns the current value of the specified \fIoption\fR; see -\fIttk_widget(n)\fR. +Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -. Modify or query widget options; see \fIttk_widget(n)\fR. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? -. Test the widget state; see \fIttk_widget(n)\fR. .TP \fIpathName \fBstart\fR ?\fIinterval\fR? -. -Begin autoincrement mode: schedules a recurring timer event that calls -\fBstep\fR every \fIinterval\fR milliseconds. If omitted, \fIinterval\fR -defaults to 50 milliseconds (20 steps/second). +Begin autoincrement mode: +schedules a recurring timer event that calls \fBstep\fR +every \fIinterval\fR milliseconds. +If omitted, \fIinterval\fR defaults to 50 milliseconds (20 steps/second). .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -. Modify or query the widget state; see \fIttk_widget(n)\fR. .TP \fIpathName \fBstep\fR ?\fIamount\fR? -. -Increments the \fB\-value\fR by \fIamount\fR. \fIamount\fR defaults to 1.0 if -omitted. +Increments the \fB-value\fR by \fIamount\fR. +\fIamount\fR defaults to 1.0 if omitted. .TP \fIpathName \fBstop\fR -. -Stop autoincrement mode: cancels any recurring timer event initiated by -\fIpathName \fBstart\fR. +Stop autoincrement mode: +cancels any recurring timer event initiated by \fIpathName \fBstart\fR. + .SH "SEE ALSO" ttk_widget(n) diff --git a/doc/ttk_radiobutton.n b/doc/ttk_radiobutton.n index 84369ff..0a1e01e 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.5 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: ttk_radiobutton.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_radiobutton n 8.5 Tk "Tk Themed Widget" @@ -23,20 +23,21 @@ Radiobuttons are linked to a Tcl variable, and have an associated value; when a radiobutton is clicked, it sets the variable to its associated value. .SO -\-class \-compound \-cursor -\-image \-state \-style -\-takefocus \-text \-textvariable -\-underline \-width +\-class \-compound \-cursor \-image +\-state \-style \-takefocus \-text +\-textvariable \-underline \-width .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command A Tcl script to evaluate whenever the widget is invoked. .OP \-value Value Value -The value to store in the associated \fB\-variable\fR +The value to store in the associated \fI-variable\fR when the widget is selected. .OP \-variable variable Variable The name of a global variable whose value is linked to the widget. Default value is \fB::selectedButton\fR. + .SH "WIDGET COMMAND" In addition to the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR @@ -44,25 +45,25 @@ commands, radiobuttons support the following additional widget commands: .TP \fIpathname\fR invoke -Sets the \fB\-variable\fR to the \fB\-value\fR, selects the widget, -and evaluates the associated \fB\-command\fR. -Returns the result of the \fB\-command\fR, or the empty -string if no \fB\-command\fR is specified. +Sets the \fI-variable\fR to the \fI-value\fR, selects the widget, +and evaluates the associated \fI-command\fR. +Returns the result of the \fI-command\fR, or the empty +string if no \fI-command\fR is specified. .\" Missing: select, deselect. Useful? .\" Missing: flash. This is definitely not useful. + .SH "WIDGET STATES" The widget does not respond to user input if the \fBdisabled\fR state is set. The widget sets the \fBselected\fR state whenever -the linked \fB\-variable\fR is set to the widget's \fB\-value\fR, +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 -.QW tri-state -or -.QW indeterminate -selection.) +linked \fB-variable\fR is unset. +(The \fBalternate\fR state may be used to indicate a ``tri-state'' +or ``indeterminate'' selection.) + .SH "SEE ALSO" ttk_widget(n), ttk_checkbutton(n), radiobutton(n) + .SH "KEYWORDS" widget, button, option diff --git a/doc/ttk_scrollbar.n b/doc/ttk_scrollbar.n index 6de1d66..dca1779 100644 --- a/doc/ttk_scrollbar.n +++ b/doc/ttk_scrollbar.n @@ -6,7 +6,7 @@ '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" '\" SOURCE: tk/doc/scrollbar.n, r1.4 -'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.5 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_scrollbar n 8.5 Tk "Tk Themed Widget" @@ -19,145 +19,149 @@ ttk_scrollbar \- Control the viewport of a scrollable widget .BE .SH DESCRIPTION -\fBttk::scrollbar\fR widgets are typically linked to an associated window that -displays a document of some sort, such as a file being edited or a drawing. A -scrollbar displays a \fIthumb\fR in the middle portion of the scrollbar, whose -position and size provides information about the portion of the document -visible in the associated window. The thumb may be dragged by the user to -control the visible region. Depending on the theme, two or more arrow buttons -may also be present; these are used to scroll the visible region in discrete -units. +\fBttk::scrollbar\fR widgets are typically linked to an associated window +that displays a document of some sort, such as a file being edited or a +drawing. +A scrollbar displays a \fIthumb\fR in the middle portion of the scrollbar, +whose position and size provides information about the portion of the +document visible in the associated window. +The thumb may be dragged by the user to control the visible region. +Depending on the theme, two or more arrow buttons may also be present; +these are used to scroll the visible region in discrete units. .SO -\-class \-cursor \-style -\-takefocus +\-class \-cursor \-style \-takefocus .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-command command Command -A Tcl script prefix to evaluate to change the view in the widget associated -with the scrollbar. Additional arguments are appended to the value of this -option, as described in \fBSCROLLING COMMANDS\fR below, whenever the user -requests a view change by manipulating the scrollbar. -.RS -.PP -This option typically consists of a two-element list, containing the name of a -scrollable widget followed by either \fBxview\fR (for horizontal scrollbars) +A Tcl script prefix to evaluate +to change the view in the widget associated with the scrollbar. +Additional arguments are appended to the value of this option, +as described in \fBSCROLLING COMMANDS\fR below, +whenever the user requests a view change by manipulating the scrollbar. +.br +This option typically consists of a two-element list, +containing the name of a scrollable widget followed by +either \fBxview\fR (for horizontal scrollbars) or \fByview\fR (for vertical scrollbars). -.RE .OP \-orient orient Orient -One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the -scrollbar. +One of \fBhorizontal\fR or \fBvertical\fR. +Specifies the orientation of the scrollbar. .BE + .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR -. -Returns the current value of the specified \fIoption\fR; see -\fIttk_widget(n)\fR. +Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -. Modify or query widget options; see \fIttk_widget(n)\fR. .TP \fIpathName \fBget\fR -. -Returns the scrollbar settings in the form of a list whose elements are the -arguments to the most recent \fBset\fR widget command. +Returns the scrollbar settings in the form of a list whose +elements are the arguments to the most recent \fBset\fR widget command. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? -. Test the widget state; see \fIttk_widget(n)\fR. .TP \fIpathName \fBset\fR \fIfirst last\fR -. -This command is normally invoked by the scrollbar's associated widget from an -\fB\-xscrollcommand\fR or \fB\-yscrollcommand\fR callback. Specifies the -visible range to be displayed. \fIfirst\fR and \fIlast\fR are real fractions -between 0 and 1. +This command is normally invoked by the scrollbar's associated widget +from an \fB-xscrollcommand\fR or \fB-yscrollcommand\fR callback. +Specifies the visible range to be displayed. +\fIfirst\fR and \fIlast\fR are real fractions between 0 and 1. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -. Modify or query the widget state; see \fIttk_widget(n)\fR. + .SH "INTERNAL COMMANDS" -The following widget commands are used internally by the TScrollbar widget -class bindings. +The following widget commands are used internally +by the TScrollbar widget class bindings. .TP \fIpathName \fBdelta \fIdeltaX deltaY\fR -. -Returns a real number indicating the fractional change in the scrollbar -setting that corresponds to a given change in thumb position. For example, if -the scrollbar is horizontal, the result indicates how much the scrollbar -setting must change to move the thumb \fIdeltaX\fR pixels to the right -(\fIdeltaY\fR is ignored in this case). If the scrollbar is vertical, the -result indicates how much the scrollbar setting must change to move the thumb -\fIdeltaY\fR pixels down. The arguments and the result may be zero or -negative. +Returns a real number indicating the fractional change in +the scrollbar setting that corresponds to a given change +in thumb position. For example, if the scrollbar is horizontal, +the result indicates how much the scrollbar setting must change +to move the thumb \fIdeltaX\fR pixels to the right (\fIdeltaY\fR is +ignored in this case). +If the scrollbar is vertical, the result indicates how much the +scrollbar setting must change to move the thumb \fIdeltaY\fR pixels +down. The arguments and the result may be zero or negative. .TP \fIpathName \fBfraction \fIx y\fR -. -Returns a real number between 0 and 1 indicating where the point given by -\fIx\fR and \fIy\fR lies in the trough area of the scrollbar, where 0.0 -corresponds to the top or left of the trough and 1.0 corresponds to the bottom -or right. \fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar -widget. If \fIx\fR and \fIy\fR refer to a point outside the trough, the -closest point in the trough is used. +Returns a real number between 0 and 1 indicating where the point +given by \fIx\fR and \fIy\fR lies in the trough area of the scrollbar, +where 0.0 corresponds to the top or left of the trough +and 1.0 corresponds to the bottom or right. +\fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar +widget. +If \fIx\fR and \fIy\fR refer to a point outside the trough, the closest +point in the trough is used. .TP \fIpathName \fBidentify\fR \fIx y\fR -. -Returns the name of the element under the point given by \fIx\fR and \fIy\fR, -or an empty string if the point does not lie in any element of the scrollbar. +Returns the name of the element under the point given +by \fIx\fR and \fIy\fR, or an empty string if the point does +not lie in any element of the scrollbar. \fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar widget. + .SH "SCROLLING COMMANDS" -When the user interacts with the scrollbar, for example by dragging the thumb, -the scrollbar notifies the associated widget that it must change its view. -The scrollbar makes the notification by evaluating a Tcl command generated -from the scrollbar's \fB\-command\fR option. The command may take any of the -following forms. In each case, \fIprefix\fR is the contents of the +When the user interacts with the scrollbar, for example by dragging +the thumb, the scrollbar notifies the associated widget that it +must change its view. +The scrollbar makes the notification by evaluating a Tcl command +generated from the scrollbar's \fB\-command\fR option. +The command may take any of the following forms. +In each case, \fIprefix\fR is the contents of the \fB\-command\fR option, which usually has a form like \fB.t yview\fR .TP \fIprefix \fBmoveto \fIfraction\fR -. -\fIFraction\fR is a real number between 0 and 1. The widget should adjust its -view so that the point given by \fIfraction\fR appears at the beginning of the -widget. If \fIfraction\fR is 0 it refers to the beginning of the document. 1.0 -refers to the end of the document, 0.333 refers to a point one-third of the -way through the document, and so on. +\fIFraction\fR is a real number between 0 and 1. +The widget should adjust its view so that the point given +by \fIfraction\fR appears at the beginning of the widget. +If \fIfraction\fR is 0 it refers to the beginning of the +document. 1.0 refers to the end of the document, 0.333 +refers to a point one-third of the way through the document, +and so on. .TP \fIprefix \fBscroll \fInumber \fBunits\fR -. -The widget should adjust its view by \fInumber\fR units. The units are defined -in whatever way makes sense for the widget, such as characters or lines in a -text widget. \fINumber\fR is either 1, which means one unit should scroll off -the top or left of the window, or \-1, which means that one unit should scroll -off the bottom or right of the window. +The widget should adjust its view by \fInumber\fR units. +The units are defined in whatever way makes sense for the widget, +such as characters or lines in a text widget. +\fINumber\fR is either 1, which means one unit should scroll off +the top or left of the window, or \-1, which means that one unit +should scroll off the bottom or right of the window. .TP \fIprefix \fBscroll \fInumber \fBpages\fR -. -The widget should adjust its view by \fInumber\fR pages. It is up to the -widget to define the meaning of a page; typically it is slightly less than -what fits in the window, so that there is a slight overlap between the old and -new views. \fINumber\fR is either 1, which means the next page should become -visible, or \-1, which means that the previous page should become visible. +The widget should adjust its view by \fInumber\fR pages. +It is up to the widget to define the meaning of a page; typically +it is slightly less than what fits in the window, so that there +is a slight overlap between the old and new views. +\fINumber\fR is either 1, which means the next page should +become visible, or \-1, which means that the previous page should +become visible. + .SH "WIDGET STATES" -The scrollbar automatically sets the \fBdisabled\fR state bit when the entire -range is visible (range is 0.0 to 1.0), and clears it otherwise. It also sets -the \fBactive\fR and \fBpressed\fR state flags of individual elements, based -on the position and state of the mouse pointer. +The scrollbar automatically sets the \fBdisabled\fR state bit. +when the entire range is visible (range is 0.0 to 1.0), +and clears it otherwise. +It also sets the \fBactive\fR and \fBpressed\fR state flags +of individual elements, based on the position and state of the mouse pointer. + .SH EXAMPLE .CS set f [frame .f] -ttk::scrollbar $f.hsb -orient horizontal \e - -command [list $f.t xview] -ttk::scrollbar $f.vsb -orient vertical \e - -command [list $f.t yview] -text $f.t -xscrollcommand [list $f.hsb set] \e - -yscrollcommand [list $f.vsb set] +ttk::scrollbar $f.hsb -orient horizontal -command [list $f.t xview] +ttk::scrollbar $f.vsb -orient vertical -command [list $f.t yview] +text $f.t -xscrollcommand [list $f.hsb set] -yscrollcommand [list $f.vsb set] grid $f.t -row 0 -column 0 -sticky nsew grid $f.vsb -row 0 -column 1 -sticky nsew grid $f.hsb -row 1 -column 0 -sticky nsew grid columnconfigure $f 0 -weight 1 grid rowconfigure $f 0 -weight 1 .CE + .SH "SEE ALSO" ttk_widget(n), scrollbar(n) + .SH KEYWORDS scrollbar, widget diff --git a/doc/ttk_separator.n b/doc/ttk_separator.n index 6c6f7fc..33fe8c9 100644 --- a/doc/ttk_separator.n +++ b/doc/ttk_separator.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_separator.n,v 1.4 2007/10/23 15:44:36 dkf Exp $ +'\" RCS: @(#) $Id: ttk_separator.n,v 1.5 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_separator n 8.5 Tk "Tk Themed Widget" @@ -20,18 +20,22 @@ ttk_separator \- Separator bar A \fBttk::separator\fR widget displays a horizontal or vertical separator bar. .SO -\-class \-cursor \-state -\-style \-takefocus +\-class \-cursor \-state \-style +\-takefocus .SE + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the separator. + .SH "WIDGET COMMAND" Separator widgets support the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR methods. No other widget methods are used. + .SH "SEE ALSO" ttk_widget(n) + .SH "KEYWORDS" widget, separator diff --git a/doc/ttk_sizegrip.n b/doc/ttk_sizegrip.n index b48c7fb..7d04964 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.9 2007/10/26 12:25:38 dkf Exp $ +'\" RCS: @(#) $Id: ttk_sizegrip.n,v 1.10 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_sizegrip n 8.5 Tk "Tk Themed Widget" @@ -17,43 +17,48 @@ 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 +# Using pack: pack [ttk::frame $top.statusbar] -side bottom -fill x -pack [\fBttk::sizegrip\fR $top.statusbar.grip] -side right -anchor se -.CE -.PP -Using \fBgrid\fR: -.CS -grid [\fBttk::sizegrip\fR $top.statusbar.grip] \e - -row $lastRow -column $lastColumn -sticky se +pack [ttk::sizegrip $top.statusbar.grip] -side right -anchor se + +# Using grid: +grid [ttk::sizegrip $top.statusbar.grip] \ + -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" ttk_widget(n) + .SH "KEYWORDS" widget, sizegrip, grow box diff --git a/doc/ttk_style.n b/doc/ttk_style.n index 20e3a41..81d862e 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.5 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: ttk_style.n,v 1.6 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH ttk_style n 8.5 Tk "Tk Themed Widget" @@ -15,111 +15,104 @@ ttk_style \- Control overall look and feel of widgets \fBttk::style\fR \fIoption\fR ?\fIargs\fR? .BE -.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 -.BE +This manpage has not been written yet. +Please see the Tcl'2004 conference presentation, +available at http://tktable.sourceforge.net/tile/tile-tcl2004.pdf .SH DEFINITIONS .PP -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. +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. .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 -.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. +\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. .\" 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 \fIttk_image(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 \fIimage(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. The syntax -is as in the equivalently-named option to the \fBgrid\fR geometry manager. +\fB-sticky \fI[nswe]\fR +Specifies where the element is placed inside its allocated parcel. .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 +.PP +For example: .CS -\fBttk::style\fR layout Horizontal.TScrollbar { +ttk::style layout Horizontal.TScrollbar { Scrollbar.trough -children { Scrollbar.leftarrow -side left Scrollbar.rightarrow -side right @@ -127,7 +120,9 @@ Specifies a list of elements to place inside the element. } } .CE + .SH "SEE ALSO" ttk_intro(n), ttk_widget(n), photo(n) + .SH KEYWORDS style, theme, appearance diff --git a/doc/ttk_treeview.n b/doc/ttk_treeview.n index 475ed40..142e113 100644 --- a/doc/ttk_treeview.n +++ b/doc/ttk_treeview.n @@ -3,9 +3,9 @@ '\" '\" 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.8 2007/10/24 14:32:59 dkf Exp $ -'\" +'\" +'\" RCS: @(#) $Id: ttk_treeview.n,v 1.9 2007/10/26 20:13:23 dgp Exp $ +'\" .so man.macros .TH ttk_treeview n 8.5 Tk "Tk Themed Widget" .\" Use _ instead of :: as the name becomes a filename on install @@ -17,377 +17,358 @@ ttk_treeview \- hierarchical multicolumn data display widget .SH DESCRIPTION The \fBttk::treeview\fR widget displays a hierarchical collection of items. -Each item has a textual label, an optional image, and an optional list of data -values. The data values are displayed in successive columns after the tree -label. +Each item has a textual label, an optional image, +and an optional list of data values. +The data values are displayed in successive columns after +the tree label. .PP -The order in which data values are displayed may be controlled by setting the -\fB\-displaycolumns\fR widget option. The tree widget can also display column -headings. Columns may be accessed by number or by symbolic names listed in the -\fB\-columns\fR widget option; see \fBCOLUMN IDENTIFIERS\fR. +The order in which data values are displayed may be controlled +by setting the \fB-displaycolumns\fR widget option. +The tree widget can also display column headings. +Columns may be accessed by number or by symbolic names +listed in the \fB-columns\fR widget option; +see \fBCOLUMN IDENTIFIERS\fR. .PP -Each item is identified by a unique name. The widget will generate item IDs if -they are not supplied by the caller. There is a distinguished root item, named -\fB{}\fR. The root item itself is not displayed; its children appear at the -top level of the hierarchy. +Each item is identified by a unique name. +The widget will generate item IDs if they are not supplied by the caller. +There is a distinguished root item, named \fB{}\fR. +The root item itself is not displayed; +its children appear at the top level of the hierarchy. .PP -Each item also has a list of \fItags\fR, which can be used to associate event -bindings with individual items and control the appearance of the item. +Each item also has a list of \fItags\fR, +which can be used to associate event bindings with individual items +and control the appearance of the item. .\" .PP .\" @@@HERE: describe selection, focus item .PP -Treeview widgets support horizontal and vertical scrolling with the standard -\fB\-\fR[\fBxy\fR]\fBscrollcommand\fR options and \fB[xyview\fR widget -commands. +Treeview widgets support horizontal and vertical scrolling with the +standard \fB-[xy]scrollcommand\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 -names. +A list of column identifiers, +specifying the number of columns and their names. .\"X: This is a read-only option; it may only be set when the widget is created. .OP \-displaycolumns displayColumns DisplayColumns -A list of column identifiers (either symbolic names or integer indices) -specifying which data columns are displayed and the order in which they -appear, or the string \fB#all\fP. -.RS -.PP +A list of column identifiers +(either symbolic names or integer indices) +specifying which data columns are displayed +and the order in which they appear, +or the string \fB#all\fP. +.br If set to \fB#all\fP (the default), all columns are shown in the order given. -.RE .OP \-height height Height -Specifies the number of rows which should be visible. Note: the requested -width is determined from the sum of the column widths. +Specifies the number of rows which should be visible. +Note: +the requested width is determined from the sum of the column widths. .OP \-padding padding Padding -Specifies the internal padding for the widget. The padding is a list of up to -four length specifications; see \fBTtk_GetPaddingFromObj()\fR for details. +Specifies the internal padding for the widget. +The padding is a list of up to four length specifications; +see \fBTtk_GetPaddingFromObj()\fR for details. .OP \-selectmode selectMode SelectMode -Controls how the built-in class bindings manage the selection. One of -\fBextended\fR, \fBbrowse\fR, or \fBnone\fR. -.RS -.PP -If set to \fBextended\fR (the default), multiple items may be selected. If -\fBbrowse\fR, only a single item will be selected at a time. If \fBnone\fR, -the selection will not be changed. -.PP -Note that application code and tag bindings can set the selection however they -wish, regardless of the value of \fB\-selectmode\fR. -.RE +Controls how the built-in class bindings manage the selection. +One of \fBextended\fR, \fBbrowse\fR, or \fBnone\fR. +.br +If set to \fBextended\fR (the default), multiple items may be selected. +If \fBbrowse\fR, only a single item will be selected at a time. +If \fBnone\fR, the selection will not be changed. +.br +Note that application code and tag bindings can set the selection +however they wish, regardless of the value of \fB-selectmode\fR. .OP \-show show Show -A list containing zero or more of the following values, specifying which -elements of the tree to display. +A list containing zero or more of the following values, specifying +which elements of the tree to display. .RS .IP \fBtree\fR -Display tree labels in column #0. +Display tree labels in column #0. .IP \fBheadings\fR Display the heading row. .PP The default is \fBtree headings\fR, i.e., show all elements. .PP -\fBNOTE:\fR Column #0 always refers to the tree column, even if \fB\-show -tree\fR is not specified. +\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? -. -Returns the bounding box (relative to the treeview widget's window) of the -specified \fIitem\fR in the form \fIx y width height\fR. If \fIcolumn\fR is -specified, returns the bounding box of that cell. If the \fIitem\fR is not -visible (i.e., if it is a descendant of a closed item or is scrolled -offscreen), returns the empty list. +Returns the bounding box (relative to the treeview widget's window) +of the specified \fIitem\fR +in the form \fIx y width height\fR. +If \fIcolumn\fR is specified, returns the bounding box of that cell. +If the \fIitem\fR is not visible +(i.e., if it is a descendant of a closed item or is scrolled offscreen), +returns the empty list. .TP \fIpathname \fBcget\fR \fIoption\fR -. -Returns the current value of the specified \fIoption\fR; see -\fIttk_widget(n)\fR. +Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR. .TP \fIpathname \fBchildren\fR \fIitem\fR ?\fInewchildren\fR? -. -If \fInewchildren\fR is not specified, returns the list of children belonging -to \fIitem\fR. -.RS -.PP -If \fInewchildren\fR is specified, replaces \fIitem\fR's child list with -\fInewchildren\fR. Items in the old child list not present in the new child -list are detached from the tree. None of the items in \fInewchildren\fR may be -an ancestor of \fIitem\fR. -.RE -.TP -\fIpathname \fBcolumn\fR \fIcolumn\fR ?\fI\-option \fR?\fIvalue \-option value...\fR? -. -Query or modify the options for the specified \fIcolumn\fR. If no -\fI\-option\fR is specified, returns a dictionary of option/value pairs. If a -single \fI\-option\fR is specified, returns the value of that option. -Otherwise, the options are updated with the specified values. The following -options may be set on each column: +If \fInewchildren\fR is not specified, +returns the list of children belonging to \fIitem\fR. +.br +If \fInewchildren\fR is specified, replaces \fIitem\fR's child list +with \fInewchildren\fR. +Items in the old child list not present in the new child list +are detached from the tree. +None of the items in \fInewchildren\fR may be an ancestor +of \fIitem\fR. +.TP +\fIpathname \fBcolumn\fR \fIcolumn\fR ?\fI-option \fR?\fIvalue -option value...\fR? +Query or modify the options for the specified \fIcolumn\fR. +If no \fI-option\fR is specified, +returns a dictionary of option/value pairs. +If a single \fI-option\fR is specified, +returns the value of that option. +Otherwise, the options are updated with the specified values. +The following options may be set on each column: .RS .TP -\fB\-id \fIname\fR -. -The column name. This is a read-only option. For example, [\fI$pathname -\fBcolumn #\fIn \fB\-id\fR] returns the data column associated with data -column #\fIn\fR. -.TP -\fB\-anchor\fR -. -Specifies how the text in this column should be aligned with respect to the -cell. One of \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR, \fBs\fR, \fBsw\fR, \fBw\fR, -\fBnw\fR, or \fBcenter\fR. -.TP -\fB\-minwidth\fR -. -The minimum width of the column in pixels. The treeview widget will not make -the column any smaller than \fB\-minwidth\fR when the widget is resized or the -user drags a column separator. -.TP -\fB\-stretch\fR -. -Specifies whether or not the column's width should be adjusted when the widget -is resized. -.TP -\fB\-width \fIw\fR -. -The width of the column in pixels. Default is something reasonable, probably -200 or so. +\fB-id \fIname\fR +The column name. This is a read-only option. +For example, [\fI$pathname \fBcolumn #\fIn \fB-id\fR] +returns the data column associated with data column #\fIn\fR. +.TP +\fB-anchor\fR +Specifies how the text in this column should be aligned +with respect to the cell. One of +\fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR, +\fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR. +.TP +\fB-minwidth\fR +The minimum width of the column in pixels. +The treeview widget will not make the column any smaller than +\fB-minwidth\fR when the widget is resized or the user drags a +column separator. +.TP +\fB-stretch\fR +Specifies whether or not the column's width should be adjusted +when the widget is resized. +.TP +\fB-width \fIw\fR +The width of the column in pixels. Default is something reasonable, +probably 200 or so. .PP Use \fIpathname column #0\fR to configure the tree column. .RE .TP \fIpathname \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -. Modify or query widget options; see \fIttk_widget(n)\fR. .TP \fIpathname \fBdelete\fR \fIitemList\fR -. -Deletes each of the items in \fIitemList\fR and all of their descendants. The -root item may not be deleted. See also: \fBdetach\fR. +Deletes each of the items in \fIitemList\fR and all of their descendants. +The root item may not be deleted. +See also: \fBdetach\fR. .TP \fIpathname \fBdetach\fR \fIitemList\fR -. -Unlinks all of the specified items in \fIitemList\fR from the tree. The items -and all of their descendants are still present and may be reinserted at -another point in the tree but will not be displayed. The root item may not be -detached. See also: \fBdelete\fR. +Unlinks all of the specified items in \fIitemList\fR from the tree. +The items and all of their descendants are still present +and may be reinserted at another point in the tree +but will not be displayed. +The root item may not be detached. +See also: \fBdelete\fR. .TP \fIpathname \fBexists \fIitem\fR -. -Returns 1 if the specified \fIitem\fR is present in the tree, 0 otherwise. +Returns 1 if the specified \fIitem\fR is present in the tree, +0 otherwise. .TP \fIpathname \fBfocus \fR?\fIitem\fR? -. -If \fIitem\fR is specified, sets the focus item to \fIitem\fR. Otherwise, -returns the current focus item, or \fB{}\fR if there is none. +If \fIitem\fR is specified, sets the focus item to \fIitem\fR. +Otherwise, returns the current focus item, or \fB{}\fR if there is none. .\" Need: way to clear the focus item. {} works for this... -.TP -\fIpathname \fBheading\fR \fIcolumn\fR ?\fI\-option \fR?\fIvalue \-option value...\fR? -. -Query or modify the heading options for the specified \fIcolumn\fR. Valid -options are: +.TP +\fIpathname \fBheading\fR \fIcolumn\fR ?\fI-option \fR?\fIvalue -option value...\fR? +Query or modify the heading options for the specified \fIcolumn\fR. +Valid options are: .RS .TP -\fB\-text \fItext\fR -. +\fB-text \fItext\fR The text to display in the column heading. .TP -\fB\-image \fIimageName\fR -. +\fB-image \fIimageName\fR Specifies an image to display to the right of the column heading. .TP -\fB\-anchor \fIanchor\fR -. -Specifies how the heading text should be aligned. One of the standard Tk -anchor values. +\fB-anchor \fIanchor\fR +Specifies how the heading text should be aligned. +One of the standard Tk anchor values. .TP -\fB\-command \fIscript\fR -. +\fB-command \fIscript\fR A script to evaluate when the heading label is pressed. .PP Use \fIpathname heading #0\fR to configure the tree column heading. .RE .TP \fIpathname \fBidentify \fIcomponent x y\fR -. -Returns a description of the specified \fIcomponent\fR under the point given -by \fIx\fR and \fIy\fR, or the empty string if no such \fIcomponent\fR is -present at that position. The following subcommands are supported: +Returns a description of the specified \fIcomponent\fR +under the point given by \fIx\fR and \fIy\fR, +or the empty string if no such \fIcomponent\fR is present at that position. +The following subcommands are supported: .RS .TP \fIpathname \fBidentify row\fR \fIx y\fR -. Returns the item ID of the item at position \fIy\fR. .TP \fIpathname \fBidentify column\fR \fIx y\fR -. -Returns the data column identifier of the cell at position \fIx\fR. The tree -column has ID \fB#0\fR. +Returns the data column identifier of the cell at position \fIx\fR. +The tree column has ID \fB#0\fR. .PP -See \fBCOLUMN IDENTIFIERS\fR for a discussion of display columns and data -columns. +See \fBCOLUMN IDENTIFIERS\fR for a discussion of display columns +and data columns. .RE .TP \fIpathname \fBindex \fIitem\fR -. Returns the integer index of \fIitem\fR within its parent's list of children. .TP -\fIpathname \fBinsert\fR \fIparent\fR \fIindex\fR ?\fB\-id \fIid\fR? \fIoptions...\fR -. -Creates a new item. \fIparent\fR is the item ID of the parent item, or the -empty string \fB{}\fR to create a new top-level item. \fIindex\fR is an -integer, or the value \fBend\fR, specifying where in the list of -\fIparent\fR's children to insert the new item. If \fIindex\fR is less than or -equal to zero, the new node is inserted at the beginning; if \fIindex\fR is -greater than or equal to the current number of children, it is inserted at the -end. If \fB\-id\fR is specified, it is used as the item identifier; \fIid\fR -must not already exist in the tree. Otherwise, a new unique identifier is -generated. -.RS -.PP -\fIpathname \fBinsert\fR returns the item identifier of the newly created -item. See \fBITEM OPTIONS\fR for the list of available options. -.RE +\fIpathname \fBinsert\fR \fIparent\fR \fIindex\fR ?\fB-id \fIid\fR? \fIoptions...\fR +Creates a new item. +\fIparent\fR is the item ID of the parent item, +or the empty string \fB{}\fR +to create a new top-level item. +\fIindex\fR is an integer, or the value \fBend\fR, specifying where in the +list of \fIparent\fR's children to insert the new item. +If \fIindex\fR is less than or equal to zero, +the new node is inserted at the beginning; +if \fIindex\fR is greater than or equal to the current number of children, +it is inserted at the end. +If \fB-id\fR is specified, it is used as the item identifier; +\fIid\fR must not already exist in the tree. +Otherwise, a new unique identifier is generated. +.br +\fIpathname \fBinsert\fR returns the item identifier of the +newly created item. +See \fBITEM OPTIONS\fR for the list of available options. .TP \fIpathname \fBinstate \fIstatespec\fR ?\fIscript\fR? -. Test the widget state; see \fIttk_widget(n)\fR. .TP -\fIpathname \fBitem\fR \fIitem\fR ?\fI\-option \fR?\fIvalue \-option value...\fR? -. -Query or modify the options for the specified \fIitem\fR. If no \fI\-option\fR -is specified, returns a dictionary of option/value pairs. If a single -\fI\-option\fR is specified, returns the value of that option. Otherwise, the -item's options are updated with the specified values. See \fBITEM OPTIONS\fR -for the list of available options. +\fIpathname \fBitem\fR \fIitem\fR ?\fI-option \fR?\fIvalue -option value...\fR? +Query or modify the options for the specified \fIitem\fR. +If no \fI-option\fR is specified, +returns a dictionary of option/value pairs. +If a single \fI-option\fR is specified, +returns the value of that option. +Otherwise, the item's options are updated with the specified values. +See \fBITEM OPTIONS\fR for the list of available options. .TP \fIpathname \fBmove \fIitem parent index\fR -. Moves \fIitem\fR to position \fIindex\fR in \fIparent\fR's list of children. It is illegal to move an item under one of its descendants. -.RS -.PP -If \fIindex\fR is less than or equal to zero, \fIitem\fR is moved to the -beginning; if greater than or equal to the number of children, it's moved to -the end. -.RE -.TP +.br +If \fIindex\fR is less than or equal to zero, \fIitem\fR is moved +to the beginning; if greater than or equal to the number of children, +it's moved to the end. +.TP \fIpathname \fBnext \fIitem\fR -. -Returns the identifier of \fIitem\fR's next sibling, or \fB{}\fR if \fIitem\fR -is the last child of its parent. +Returns the identifier of \fIitem\fR's next sibling, +or \fB{}\fR if \fIitem\fR is the last child of its parent. .TP \fIpathname \fBparent \fIitem\fR -. -Returns the ID of the parent of \fIitem\fR, or \fB{}\fR if \fIitem\fR is at -the top level of the hierarchy. -.TP +Returns the ID of the parent of \fIitem\fR, +or \fB{}\fR if \fIitem\fR is at the top level of the hierarchy. +.TP \fIpathname \fBprev \fIitem\fR -. -Returns the identifier of \fIitem\fR's previous sibling, or \fB{}\fR if -\fIitem\fR is the first child of its parent. +Returns the identifier of \fIitem\fR's previous sibling, +or \fB{}\fR if \fIitem\fR is the first child of its parent. .TP \fIpathname \fBsee\fR \fIitem\fR -. -Ensure that \fIitem\fR is visible: sets all of \fIitem\fR's ancestors to -\fB\-open true\fR, and scrolls the widget if necessary so that \fIitem\fR is +Ensure that \fIitem\fR is visible: +sets all of \fIitem\fR's ancestors to \fB-open true\fR, +and scrolls the widget if necessary so that \fIitem\fR is within the visible portion of the tree. .TP \fIpathname \fBselection\fR ?\fIselop\fR \fIitemList\fR? -. If \fIselop\fR is not specified, returns the list of selected items. Otherwise, \fIselop\fR is one of the following: .RS .TP \fIpathname \fBselection set \fIitemList\fR -. \fIitemList\fR becomes the new selection. .TP \fIpathname \fBselection add \fIitemList\fR -. Add \fIitemList\fR to the selection .TP \fIpathname \fBselection remove \fIitemList\fR -. Remove \fIitemList\fR from the selection .TP \fIpathname \fBselection toggle \fIitemList\fR -. Toggle the selection state of each item in \fIitemList\fR. .RE .TP \fIpathname \fBset\fR \fIitem\fR ?\fIcolumn\fR ?\fIvalue\fR?? -. -With one argument, returns a dictionary of column/value pairs for the -specified \fIitem\fR. With two arguments, returns the current value of the -specified \fIcolumn\fR. With three arguments, sets the value of column -\fIcolumn\fR in item \fIitem\fR to the specified \fIvalue\fR. See also -\fBCOLUMN IDENTIFIERS\fR. +With one argument, returns a dictionary of column/value pairs +for the specified \fIitem\fR. +With two arguments, returns the current value of the specified \fIcolumn\fR. +With three arguments, sets the value of column \fIcolumn\fR +in item \fIitem\fR to the specified \fIvalue\fR. +See also \fBCOLUMN IDENTIFIERS\fR. .TP \fIpathname \fBstate\fR ?\fIstateSpec\fR? -. Modify or query the widget state; see \fIttk_widget(n)\fR. .TP \fIpathName \fBtag \fIargs...\fR -. .RS .TP \fIpathName \fBtag bind \fItagName \fR?\fIsequence \fR?\fIscript\fR?? -. -Add a Tk binding script for the event sequence \fIsequence\fR to the tag -\fItagName\fR. When an X event is delivered to an item, binding scripts for -each of the item's \fB\-tags\fR are evaluated in order as per -\fIbindtags(n)\fR. -.RS -.PP -\fB<KeyPress>\fR, \fB<KeyRelease>\fR, and virtual events are sent to the focus -item. \fB<ButtonPress>\fR, \fB<ButtonRelease>\fR, and \fB<Motion>\fR events -are sent to the item under the mouse pointer. No other event types are -supported. -.PP -The binding \fIscript\fR undergoes \fB%\fR-substitutions before evaluation; -see \fBbind(n)\fR for details. -.RE +Add a Tk binding script for the event sequence \fIsequence\fR +to the tag \fItagName\fR. When an X event is delivered to an item, +binding scripts for each of the item's \fB-tags\fR are evaluated +in order as per \fIbindtags(n)\fR. +.br +\fB<KeyPress>\fR, \fB<KeyRelease>\fR, and virtual events +are sent to the focus item. +\fB<ButtonPress>\fR, \fB<ButtonRelease>\fR, and \fB<Motion>\fR events +are sent to the item under the mouse pointer. +No other event types are supported. +.br +The binding \fIscript\fR undergoes \fB%\fR-substitutions before +evaluation; see \fBbind(n)\fR for details. .TP \fIpathName \fBtag configure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -. -Query or modify the options for the specified \fItagName\fR. If one or more -\fIoption/value\fR pairs are specified, sets the value of those options for -the specified tag. If a single \fIoption\fR is specified, returns the value of -that option (or the empty string if the option has not been specified for -\fItagName\fR). With no additional arguments, returns a dictionary of the -option settings for \fItagName\fR. See \fBTAG OPTIONS\fR for the list of -available options. +Query or modify the options for the specified \fItagName\fR. +If one or more \fIoption/value\fR pairs are specified, +sets the value of those options for the specified tag. +If a single \fIoption\fR is specified, +returns the value of that option +(or the empty string if the option has not been specified for \fItagName\fR). +With no additional arguments, +returns a dictionary of the option settings for \fItagName\fR. +See \fBTAG OPTIONS\fR for the list of available options. .RE .TP \fIpathName \fBxview \fIargs\fR -. Standard command for horizontal scrolling; see \fIwidget(n)\fR. .TP \fIpathName \fByview \fIargs\fR -. Standard command for vertical scrolling; see \fIttk_widget(n)\fR. + .PP .SH "ITEM OPTIONS" -The following item options may be specified for items in the \fBinsert\fR and -\fBitem\fR widget commands. +The following item options may be specified for items +in the \fBinsert\fR and \fBitem\fR widget commands. .OP \-text text Text The textual label to display for the item. .OP \-image image Image A Tk image, displayed to the left of the label. .OP \-values values Values The list of values associated with the item. -.RS -.PP -Each item should have the same number of values as the \fB\-columns\fR widget -option. If there are fewer values than columns, the remaining values are -assumed empty. If there are more values than columns, the extra values are -ignored. -.RE +.br +Each item should have the same number of values as +the \fB-columns\fR widget option. +If there are fewer values than columns, +the remaining values are assumed empty. +If there are more values than columns, +the extra values are ignored. .OP \-open open Open -A boolean value indicating whether the item's children should be displayed -(\fB\-open true\fR) or hidden (\fB\-open false\fR). +A boolean value indicating whether the item's children +should be displayed (\fB-open true\fR) or hidden (\fB-open false\fR). .OP \-tags tags Tags -A list of tags associated with this item. +A list of tags associated with this item. .SH "TAG OPTIONS" The following options may be specified on tags: .IP \-foreground @@ -400,42 +381,47 @@ Specifies the font to use when drawing text. .\" ??? Maybe: .IP \-padding .\" ??? Maybe: .IP \-text .IP \-image -Specifies the item image, in case the item's \fB\-image\fR option is empty. +Specifies the item image, in case the item's \fB-image\fR option is empty. .PP \fI(@@@ TODO: sort out order of precedence for options)\fR + .SH "COLUMN IDENTIFIERS" Column identifiers take any of the following forms: .IP \(bu -A symbolic name from the list of \fB\-columns\fR. +A symbolic name from the list of \fB-columns\fR. .IP \(bu An integer \fIn\fR, specifying the \fIn\fRth data column. .IP \(bu -A string of the form \fB#\fIn\fR, where \fIn\fR is an integer, specifying the -\fIn\fRth display column. +A string of the form \fB#\fIn\fR, where \fIn\fR is an integer, +specifying the \fIn\fRth display column. .PP -\fBNOTE:\fR Item \fB\-values\fR may be displayed in a different order than the -order in which they are stored. +\fBNOTE:\fR +Item \fB-values\fR may be displayed in a different order than +the order in which they are stored. .PP -\fBNOTE:\fR Column #0 always refers to the tree column, even if \fB\-show -tree\fR is not specified. +\fBNOTE:\fR Column #0 always refers to the tree column, +even if \fB-show tree\fR is not specified. .PP -A \fIdata column number\fR is an index into an item's \fB\-values\fR list; a -\fIdisplay column number\fR is the column number in the tree where the values -are displayed. Tree labels are displayed in column #0. If -\fB\-displaycolumns\fR is not set, then data column \fIn\fR is displayed in -display column \fB#\fIn+1\fR. Again, \fBcolumn #0 always refers to the tree -column\fR. +A \fIdata column number\fR is an index into an item's \fB-values\fR list; +a \fIdisplay column number\fR is the column number in the tree +where the values are displayed. +Tree labels are displayed in column #0. +If \fB-displaycolumns\fR is not set, +then data column \fIn\fR is displayed in display column \fB#\fIn+1\fR. +Again, \fBcolumn #0 always refers to the tree column\fR. .SH "VIRTUAL EVENTS" The treeview widget generates the following virtual events. -.IP \fB<<TreeviewSelect>>\fR +.IP <<TreeviewSelect>> Generated whenever the selection changes. -.IP \fB<<TreeviewOpen>>\fR -Generated just before setting the focus item to \fB\-open true\fR. -.IP \fB<<TreeviewClose>>\fR -Generated just after setting the focus item to \fB\-open false\fR. +.IP <<TreeviewOpen>> +Generated just before setting the focus item to \fB-open true\fR. +.IP <<TreeviewClose>> +Generated just after setting the focus item to \fB-open false\fR. .PP -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. +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 83f9ce5..b2e2e0b 100644 --- a/doc/ttk_widget.n +++ b/doc/ttk_widget.n @@ -1,11 +1,11 @@ '\" '\" Copyright (c) 2004 Joe English -'\" +'\" '\" 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.7 2007/10/26 12:25:38 dkf Exp $ -'\" +'\" +'\" RCS: @(#) $Id: ttk_widget.n,v 1.8 2007/10/26 20:13:23 dgp Exp $ +'\" .so man.macros .TH ttk_widget n 8.5 Tk "Tk Themed Widget" .BS @@ -15,225 +15,220 @@ 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 -Specifies the window class. The class is used when querying the option -database for the window's other options, to determine the default bindtags for -the window, and to select the widget's default layout and style. This is a -read-only option: it may only be specified when the window is created, and may -not be changed with the \fBconfigure\fR widget command. +Specifies the window class. +The class is used when querying the option database +for the window's other options, to determine the default +bindtags for the window, and to select the widget's default +layout and style. +This is a read-only option: +it may only be specified when the window is created, +and may not be changed with the \fBconfigure\fR widget command. .OP \-cursor cursor Cursor -Specifies the mouse cursor to be used for the widget. See \fBTk_GetCursor\fR -and \fIcursors(n)\fR in the Tk reference manual for the legal values. If set -to the empty string (the default), the cursor is inherited from the parent -widget. +Specifies the mouse cursor to be used for the widget. +See \fBTk_GetCursor\fR and \fIcursors(n)\fR in the Tk reference manual +for the legal values. +If set to the empty string (the default), +the cursor is inherited from the parent widget. .OP \-takefocus takeFocus TakeFocus -Determines whether the window accepts the focus during keyboard traversal. -Either \fB0\fR, \fB1\fR, a command prefix (to which the widget path is -appended, and which should return \fB0\fR or \fB1\fR), or the empty string. +Determines whether the window accepts the focus during keyboard traversal. +Either \fB0\fR, \fB1\fR, a command prefix (to which the widget path +is 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 -scrollbar. See \fIscrollbar(n)\fR for more information +The following options are supported by widgets that +are controllable by a scrollbar. +See \fIscrollbar(n)\fR for more information .OP \-xscrollcommand xScrollCommand ScrollCommand A command prefix, used to communicate with horizontal scrollbars. -.RS -.PP -When the view in the widget's window changes, the widget will generate a Tcl -command by concatenating the scroll command and two numbers. Each of the -numbers is a fraction between 0 and 1 indicating a position in the document; 0 -indicates the beginning, and 1 indicates the end. The first fraction indicates -the first information in the widget that is visible in the window, and the -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 -.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 -executed. -.RE +.br +When the view in the widget's window changes, the widget will +generate a Tcl command by concatenating the scroll command and +two numbers. +Each of the numbers is a fraction between 0 and 1 indicating +a position in the document; 0 indicates the beginning, +and 1 indicates the end. +The first fraction indicates the first information in the widget +that is visible in the window, and the second fraction indicates +the information just after the last portion that is visible. +.br +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 changes. +.br +If this option is set to the empty string (the default), +then no command is be executed. .OP \-yscrollcommand yScrollCommand ScrollCommand -A command prefix, used to communicate with vertical scrollbars. See the -description of \fB\-xscrollcommand\fR above for details. +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: +The following options are supported by labels, buttons, +and other button-like widgets: .OP \-text text Text -Specifies a text string to be displayed inside the widget (unless overridden -by \fB\-textvariable\fR). +Specifies a text string to be displayed inside the widget +(unless overridden by \fB-textvariable\fR). .OP \-textvariable textVariable Variable -Specifies the name of variable whose value will be used in place of the -\fB\-text\fR resource. +Specifies the name of variable whose value will be used +in place of the \fB-text\fR resource. .OP \-underline underline Underline -If set, specifies the integer index (0-based) of a character to underline in -the text string. The underlined character is used for mnemonic activation. +If set, specifies the integer index (0-based) of a character to underline +in the text string. +The underlined character is used for mnemonic activation. .OP \-image image Image -Specifies an image to display. This is a list of 1 or more elements. The first -element is the default image name. The rest of the list is a sequence of -\fIstatespec / value\fR pairs as per \fBstyle map\fR, specifying different -images to use when the widget is in a particular state or combination of -states. All images in the list should have the same size. +Specifies an image to display. +This is a list of 1 or more elements. +The first element is the default image name. +The rest of the list is a sequence of \fIstatespec / value\fR pairs +as per \fBstyle map\fR, specifying different images to use when +the widget is in a particular state or combination of states. +All images in the list should have the same size. .OP \-compound compound Compound -Specifies how to display the image relative to the text, in the case both -\fB\-text\fR and \fB\-image\fR are present. Valid values are: +Specifies how to display the image relative to the text, +in the case both \fB-text\fR and \fB-image\fR are present. +Valid values are: .RS -.IP \fBtext\fR +.IP text Display text only. -.IP \fBimage\fR +.IP image Display image only. -.IP \fBcenter\fR +.IP center Display text centered on top of image. -.IP "\fBtop\fR, \fBbottom\fR, \fBleft\fR, \fBright\fR" +.IP top +.IP bottom +.IP left +.IP right Display image above, below, left of, or right of the text, respectively. -.IP \fBnone\fR +.IP none The default; display the image if present, otherwise the text. .RE .OP \-width width Width -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. +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 -.QW write-only -option: setting it changes the widget state, but the \fBstate\fR widget -command does not affect the state option. +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. + .SH COMMANDS .TP \fIpathName \fBcget\fR \fIoption\fR -. -Returns the current value of the configuration option given by \fIoption\fR. +Returns the current value of the configuration option given +by \fIoption\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -. -Query or modify the configuration options of the widget. If one or more -\fIoption\-value\fR pairs are specified, then the command modifies the given -widget option(s) to have the given value(s); in this case the command returns -an empty string. If \fIoption\fR is specified with no \fIvalue\fR, then the -command returns a list describing the named option: the elements of the list -are the option name, database name, database class, default value, and current -value. +Query or modify the configuration options of the widget. +If one or more \fIoption\-value\fR pairs are specified, +then the command modifies the given widget option(s) +to have the given value(s); +in this case the command returns an empty string. +If \fIoption\fR is specified with no \fIvalue\fR, +then the command returns a list describing the named option: +the elements of the list are the +option name, database name, database class, default value, +and current value. .\" Note: Ttk widgets don't use TK_OPTION_SYNONYM. -If no \fIoption\fR is specified, returns a list describing all of the -available options for \fIpathName\fR. -.TP +If no \fIoption\fR is specified, returns a list describing all of +the available options for \fIpathName\fR. +.TP \fIpathName \fBinstate\fR \fIstatespec\fR ?\fIscript\fR? -. -Test the widget's state. If \fIscript\fR is not specified, returns 1 if the -widget state matches \fIstatespec\fR and 0 otherwise. If \fIscript\fR is -specified, equivalent to -.RS +Test the widget's state. +If \fIscript\fR is not specified, returns 1 if +the widget state matches \fIstatespec\fR and 0 otherwise. +If \fIscript\fR is specified, equivalent to .CS if {[\fIpathName\fR instate \fIstateSpec\fR]} \fIscript\fR .CE -.RE -.TP +.TP \fIpathName \fBstate\fR ?\fIstateSpec\fR -. -Modify or inquire widget state. If \fIstateSpec\fR is present, sets the widget -state: for each flag in \fIstateSpec\fR, sets the corresponding flag or clears -it if prefixed by an exclamation point. Returns a new state spec indicating -which flags were changed: -.RS +Modify or inquire widget state. +If \fIstateSpec\fR is present, sets the widget state: +for each flag in \fIstateSpec\fR, sets the corresponding flag +or clears it if prefixed by an exclamation point. +Returns a new state spec indicating which flags were changed: .CS set changes [\fIpathName \fRstate \fIspec\fR] \fIpathName \fRstate $changes .CE -will restore \fIpathName\fR to the original state. If \fIstateSpec\fR is not -specified, returns a list of the currently-enabled state flags. -.RE +will restore \fIpathName\fR to the original state. +If \fIstateSpec\fR is not specified, +returns a list of the currently-enabled state flags. .SH "WIDGET STATES" -The widget state is a bitmap of independent state flags. Widget state flags -include: +The widget state is a bitmap of independent state flags. +Widget state flags include: .TP \fBactive\fR -. -The mouse cursor is over the widget and pressing a mouse button will cause -some action to occur. (aka -.QW "prelight" -(Gnome), -.QW "hot" -(Windows), -.QW "hover" ). +The mouse cursor is over the widget +and pressing a mouse button will cause some action to occur. +(aka "prelight" (Gnome), "hot" (Windows), "hover"). .TP \fBdisabled\fR -. -Widget is disabled under program control (aka -.QW "unavailable" , -.QW "inactive" ) +Widget is disabled under program control +(aka "unavailable", "inactive") .TP \fBfocus\fR -. -Widget has keyboard focus. +Widget has keyboard focus .TP \fBpressed\fR -. -Widget is being pressed (aka -.QW "armed" -in Motif). +Widget is being pressed (aka "armed" in Motif). .TP \fBselected\fR -. -The widget is -.QW "On" , -.QW "true" , -or -.QW "current" -(for things like checkbuttons and radiobuttons). +"On", "true", or "current" for things like checkbuttons and radiobuttons. .TP \fBbackground\fR -. -Windows and the Mac have a notion of an -.QW "active" -or foreground window. The \fBbackground\fR state is set for widgets in a -background window, and cleared for those in the foreground window. +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. .TP \fBreadonly\fR -. Widget should not allow user modification. .TP \fBalternate\fR -. -A widget-specific alternate display format. For example, used for checkbuttons -and radiobuttons in the -.QW "tristate" -or -.QW "mixed" -state, and for buttons with \fB\-default active\fR. +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. .TP \fBinvalid\fR -. -The widget's value is invalid. (Potential uses: scale widget value out of -bounds, entry widget value failed validation.) +The widget's value is invalid. +(Potential uses: scale widget value out of bounds, +entry widget value failed validation.) .PP -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. +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] # Disable the widget: -$b state disabled +$b state disabled # Invoke the widget only if it is currently pressed and enabled: -$b instate {pressed !disabled} { .b invoke } +$b instate {pressed !disabled} { .b invoke } # Reenable widget: -$b state !disabled +$b state !disabled .CE + .SH "SEE ALSO" ttk_intro(n), style(n) + .SH KEYWORDS state, configure, option diff --git a/doc/winfo.n b/doc/winfo.n index 3f2bea4..0c624e7 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.9 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: winfo.n,v 1.10 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH winfo n 4.3 Tk "Tk Built-In Commands" @@ -57,9 +57,7 @@ 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 -.QW known -to be full if the last +otherwise. The colormap for a window is ``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. @@ -92,10 +90,7 @@ 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 -.QW 2.0c -or -.QW 1i . +to \fBTk_GetScreenMM\fR, such as ``2.0c'' or ``1i''. The return value may be fractional; for an integer value, use \fBwinfo pixels\fR. .TP @@ -160,10 +155,7 @@ 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 -.QW 2.0c -or -.QW 1i . +to \fBTk_GetPixels\fR, such as ``2.0c'' or ``1i''. The result is rounded to the nearest integer value; for a fractional result, use \fBwinfo fpixels\fR. .TP @@ -260,8 +252,7 @@ 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 -.QW "\fBX\fImajor\fBR\fIminor vendor vendorVersion\fR" +has the form ``\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 @@ -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.6 2007/10/24 14:32:59 dkf Exp $ +'\" RCS: @(#) $Id: wish.1,v 1.7 2007/10/26 20:13:23 dgp Exp $ '\" .so man.macros .TH wish 1 8.0 Tk "Tk Applications" @@ -70,8 +70,7 @@ 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 -.QW \- . +does not start with ``\-''. .PP If there are no arguments, or the arguments do not specify a \fIfileName\fR, then wish reads Tcl commands interactively from standard input. @@ -105,8 +104,7 @@ 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 -.QW / +\fBwish\fR was invoked. In the last two cases, if the name contains a ``/'' character, then only the characters after the last slash are used as the application name. .PP @@ -187,25 +185,16 @@ 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, -.QW \e032 -(i.e. -.QW \eu001a , -control-Z). +the medium, or by the character, '\\032' ('\\u001a', 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 -.QW \e032 , -.QW \ex1a , -or -.QW \eu001a ; -or may generate it by use of commands such as \fBformat\fR or \fBbinary\fR. +``\\032'', ``\\x1a'', or ``\\u001a''; 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 -.QW "\fB% \fR" . -You can change the prompt by setting the +command with ``\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 @@ -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.33 2007/10/24 14:32:59 dkf Exp $ -'\" +'\" +'\" RCS: @(#) $Id: wm.n,v 1.34 2007/10/26 20:13:23 dgp Exp $ +'\" .so man.macros .TH wm n 8.5 Tk "Tk Built-In Commands" .BS @@ -112,8 +112,7 @@ 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, such as -.QW systemTransparent . +color with some alpha, e.g. "systemTransparent". .TP \fB\-fullscreen\fR Places the window in a mode that takes up the entire main screen and hides @@ -126,17 +125,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 @@ -221,14 +220,11 @@ The focus model defaults to \fBpassive\fR, and Tk's \fBfocus\fR command assumes a passive model of focusing. .TP \fBwm forget \fIwindow\fR -.VS 8.5 The \fIwindow\fR will be unmapped from the screen and will no longer be managed by \fBwm\fR. Windows created with the \fBtoplevel\fR command will be treated like \fBframe\fR windows once they are no -longer managed by \fBwm\fR, however, the \-menu configuration will be -remembered and the menus will return once the widget is managed again. See -\fBGEOMETRY MANAGEMENT\fR below for more details. -.VE 8.5 +longer managed by \fBwm\fR, however, the -menu configuration will be +remembered and the menus will return once the widget is managed again. .TP \fBwm frame \fIwindow\fR If \fIwindow\fR has been reparented by the window manager into a @@ -248,7 +244,7 @@ the form \fB=\fIwidth\fBx\fIheight\fB\(+-\fIx\fB\(+-\fIy\fR, where any of \fB=\fR, \fIwidth\fBx\fIheight\fR, or \fB\(+-\fIx\fB\(+-\fIy\fR may be omitted. \fIWidth\fR and \fIheight\fR are positive integers specifying the desired dimensions of \fIwindow\fR. If \fIwindow\fR -is gridded (see \fBGRIDDED GEOMETRY MANAGEMENT\fR below) then the dimensions +is gridded (see GRIDDED GEOMETRY MANAGEMENT below) then the dimensions are specified in grid units; otherwise they are specified in pixel units. \fIX\fR and \fIy\fR specify the desired location of \fIwindow\fR on the screen, in pixels. @@ -318,8 +314,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. @@ -406,20 +402,12 @@ 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 -.QW own -those events. -.RS -.PP +to ``own'' those events. Note: not all window managers support the notion of an icon window. -.RE .TP \fBwm manage \fIwidget\fR -.VS 8.5 The \fIwidget\fR specified will become a stand alone top-level window. The -window will be decorated with the window managers title bar, etc. See -\fBGEOMETRY MANAGEMENT\fR below for more details. -.VE 8.5 +window will be decorated with the window managers title bar, etc. .TP \fBwm maxsize \fIwindow\fR ?\fIwidth height\fR? If \fIwidth\fR and \fIheight\fR are specified, they give @@ -475,8 +463,7 @@ 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 -.QW "no source" -as equivalent to \fBprogram\fR. +``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. @@ -543,8 +530,7 @@ 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 -.QW "no source" -as equivalent to \fBprogram\fR. +``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 @@ -630,7 +616,6 @@ well as manual resizes and the \fBwm geometry\fR command. You can also use the command \fBwm resizable\fR to completely disable interactive resizing in one or both dimensions. .PP -.VS 8.5 The \fBwm manage\fR and \fBwm forget\fR commands may be used to perform undocking and docking of windows. After a widget is managed by \fBwm manage\fR command, all other \fBwm\fR subcommands may be used @@ -645,7 +630,6 @@ that have their top-level widget changed via a \fBwm manage\fR or \fBwm forget\fR command, must be redone to adjust any top-level widget path in the bindtags. Bindtags that have not been customized do not have to be redone. -.VE 8.5 .SH "GRIDDED GEOMETRY MANAGEMENT" .PP Gridded geometry management occurs when one of the widgets of an @@ -669,7 +653,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. |