diff options
Diffstat (limited to 'doc')
175 files changed, 727 insertions, 802 deletions
diff --git a/doc/3DBorder.3 b/doc/3DBorder.3 index f693b5d..ba0881b 100644 --- a/doc/3DBorder.3 +++ b/doc/3DBorder.3 @@ -5,8 +5,6 @@ '\" 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.13 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_Alloc3DBorderFromObj 3 8.1 Tk "Tk Library Procedures" .BS diff --git a/doc/AddOption.3 b/doc/AddOption.3 index 882d23b..fe6107b 100644 --- a/doc/AddOption.3 +++ b/doc/AddOption.3 @@ -1,9 +1,6 @@ '\" '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. -'\" -'\" RCS: @(#) $Id: AddOption.3,v 1.7 2008/06/30 22:57:00 dkf Exp $ -'\" '\" .so man.macros .TH Tk_AddOption 3 "" Tk "Tk Library Procedures" diff --git a/doc/BindTable.3 b/doc/BindTable.3 index 90b8ee0..24f8af5 100644 --- a/doc/BindTable.3 +++ b/doc/BindTable.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: BindTable.3,v 1.8 2010/05/10 20:58:19 nijtmans Exp $ -'\" .so man.macros .TH Tk_CreateBindingTable 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/CanvPsY.3 b/doc/CanvPsY.3 index 10f9f08..342ddb3 100644 --- a/doc/CanvPsY.3 +++ b/doc/CanvPsY.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CanvPsY.3,v 1.9 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_CanvasPs 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/CanvTkwin.3 b/doc/CanvTkwin.3 index 4ea6620..1ddaa6b 100644 --- a/doc/CanvTkwin.3 +++ b/doc/CanvTkwin.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CanvTkwin.3,v 1.10 2010/02/17 19:21:17 nijtmans Exp $ -'\" .so man.macros .TH Tk_CanvasTkwin 3 4.1 Tk "Tk Library Procedures" .BS diff --git a/doc/CanvTxtInfo.3 b/doc/CanvTxtInfo.3 index 81080dd..fbfa913 100644 --- a/doc/CanvTxtInfo.3 +++ b/doc/CanvTxtInfo.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CanvTxtInfo.3,v 1.6 2008/06/30 22:57:00 dkf Exp $ -'\" .so man.macros .TH Tk_CanvasTextInfo 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/Clipboard.3 b/doc/Clipboard.3 index f7ab6f3..f3e8fec 100644 --- a/doc/Clipboard.3 +++ b/doc/Clipboard.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Clipboard.3,v 1.7 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_ClipboardClear 3 4.0 Tk "Tk Library Procedures" .BS @@ -73,7 +71,7 @@ this application). .PP \fBTk_ClipboardClear\fR may invoke callbacks, including arbitrary Tcl scripts, as a result of losing the CLIPBOARD selection, so -any calling function should take care to be reentrant at the point +any calling function should take care to be re-entrant at the point \fBTk_ClipboardClear\fR is invoked. .SH KEYWORDS append, clipboard, clear, format, type diff --git a/doc/ClrSelect.3 b/doc/ClrSelect.3 index a470390..545e63c 100644 --- a/doc/ClrSelect.3 +++ b/doc/ClrSelect.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ClrSelect.3,v 1.4 2008/07/08 22:40:50 patthoyts Exp $ -'\" .so man.macros .TH Tk_ClearSelection 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/ConfigWidg.3 b/doc/ConfigWidg.3 index 1dd5b6e..9b83898 100644 --- a/doc/ConfigWidg.3 +++ b/doc/ConfigWidg.3 @@ -5,8 +5,6 @@ '\" 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.25 2010/02/17 19:21:17 nijtmans Exp $ -'\" .so man.macros .TH Tk_ConfigureWidget 3 4.1 Tk "Tk Library Procedures" .BS diff --git a/doc/ConfigWind.3 b/doc/ConfigWind.3 index 1bc5a23..f19512a 100644 --- a/doc/ConfigWind.3 +++ b/doc/ConfigWind.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ConfigWind.3,v 1.4 2007/12/13 15:23:42 dgp Exp $ -'\" .so man.macros .TH Tk_ConfigureWindow 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/CoordToWin.3 b/doc/CoordToWin.3 index 5e8996c..4e4eb66 100644 --- a/doc/CoordToWin.3 +++ b/doc/CoordToWin.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CoordToWin.3,v 1.4 2008/07/08 22:40:50 patthoyts Exp $ -'\" .so man.macros .TH Tk_CoordsToWindow 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/CrtCmHdlr.3 b/doc/CrtCmHdlr.3 index fbe6a95..05616fb 100644 --- a/doc/CrtCmHdlr.3 +++ b/doc/CrtCmHdlr.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtCmHdlr.3,v 1.5 2008/06/30 22:57:00 dkf Exp $ -'\" .so man.macros .TH Tk_CreateClientMessageHandler 3 "8.4" Tk "Tk Library Procedures" .BS diff --git a/doc/CrtConsoleChan.3 b/doc/CrtConsoleChan.3 index e9e4189..65feab7 100644 --- a/doc/CrtConsoleChan.3 +++ b/doc/CrtConsoleChan.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtConsoleChan.3,v 1.3 2007/12/13 15:23:42 dgp Exp $ -'\" .so man.macros .TH Tk_InitConsoleChannels 3 8.5 Tk "Tk Library Procedures" .BS diff --git a/doc/CrtErrHdlr.3 b/doc/CrtErrHdlr.3 index 8f5ff62..acbd9f6 100644 --- a/doc/CrtErrHdlr.3 +++ b/doc/CrtErrHdlr.3 @@ -5,8 +5,6 @@ '\" 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.8 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_CreateErrorHandler 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/CrtGenHdlr.3 b/doc/CrtGenHdlr.3 index 004e01a..68a2cd8 100644 --- a/doc/CrtGenHdlr.3 +++ b/doc/CrtGenHdlr.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtGenHdlr.3,v 1.5 2008/07/08 22:40:50 patthoyts Exp $ -'\" .so man.macros .TH Tk_CreateGenericHandler 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/CrtImgType.3 b/doc/CrtImgType.3 index 2505272..d93f4b4 100644 --- a/doc/CrtImgType.3 +++ b/doc/CrtImgType.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtImgType.3,v 1.16 2008/11/12 00:15:26 nijtmans Exp $ -'\" .so man.macros .TH Tk_CreateImageType 3 8.5 Tk "Tk Library Procedures" .BS diff --git a/doc/CrtItemType.3 b/doc/CrtItemType.3 index d97717d..bc034a7 100644 --- a/doc/CrtItemType.3 +++ b/doc/CrtItemType.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtItemType.3,v 1.16 2010/02/17 19:21:17 nijtmans Exp $ -'\" .so man.macros .TH Tk_CreateItemType 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/CrtPhImgFmt.3 b/doc/CrtPhImgFmt.3 index 6c535a6..68c9c56 100644 --- a/doc/CrtPhImgFmt.3 +++ b/doc/CrtPhImgFmt.3 @@ -9,8 +9,6 @@ '\" Department of Computer Science, '\" Australian National University. '\" -'\" RCS: @(#) $Id: CrtPhImgFmt.3,v 1.12 2008/11/09 23:16:56 nijtmans Exp $ -'\" .so man.macros .TH Tk_CreatePhotoImageFormat 3 8.5 Tk "Tk Library Procedures" .BS diff --git a/doc/CrtSelHdlr.3 b/doc/CrtSelHdlr.3 index 9b0a466..b7758df 100644 --- a/doc/CrtSelHdlr.3 +++ b/doc/CrtSelHdlr.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtSelHdlr.3,v 1.6 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_CreateSelHandler 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/CrtWindow.3 b/doc/CrtWindow.3 index 66188b1..43d323b 100644 --- a/doc/CrtWindow.3 +++ b/doc/CrtWindow.3 @@ -5,8 +5,6 @@ '\" 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.14 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_CreateWindow 3 4.2 Tk "Tk Library Procedures" .BS @@ -88,7 +86,7 @@ which would in turn be a child of the menu bar window. A dialog box might have the application's main window as its parent. .PP \fBTk_CreateAnonymousWindow\fR differs from \fBTk_CreateWindow\fR in -that it creates an unnamed window. This window will be manipulable +that it creates an unnamed window. This window will be manipulatable only using C interfaces, and will not be visible to Tcl scripts. Both interior windows and top-level windows may be created with \fBTk_CreateAnonymousWindow\fR. diff --git a/doc/DeleteImg.3 b/doc/DeleteImg.3 index 4e40926..5cde9e7 100644 --- a/doc/DeleteImg.3 +++ b/doc/DeleteImg.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: DeleteImg.3,v 1.5 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_DeleteImage 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/DrawFocHlt.3 b/doc/DrawFocHlt.3 index a3dffed..cfe5ddd 100644 --- a/doc/DrawFocHlt.3 +++ b/doc/DrawFocHlt.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: DrawFocHlt.3,v 1.5 2008/07/08 22:40:50 patthoyts Exp $ -'\" .so man.macros .TH Tk_DrawFocusHighlight 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/EventHndlr.3 b/doc/EventHndlr.3 index 36ac475..8da777d 100644 --- a/doc/EventHndlr.3 +++ b/doc/EventHndlr.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: EventHndlr.3,v 1.7 2008/07/08 22:40:50 patthoyts Exp $ -'\" .so man.macros .TH Tk_CreateEventHandler 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/FindPhoto.3 b/doc/FindPhoto.3 index 8d5932f..950d208 100644 --- a/doc/FindPhoto.3 +++ b/doc/FindPhoto.3 @@ -9,8 +9,6 @@ '\" Department of Computer Science, '\" Australian National University. '\" -'\" RCS: @(#) $Id: FindPhoto.3,v 1.11 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_FindPhoto 3 8.0 Tk "Tk Library Procedures" .BS diff --git a/doc/FontId.3 b/doc/FontId.3 index 8375cb4..69991fd 100644 --- a/doc/FontId.3 +++ b/doc/FontId.3 @@ -4,8 +4,6 @@ '\" 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.12 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_FontId 3 8.0 Tk "Tk Library Procedures" .BS diff --git a/doc/FreeXId.3 b/doc/FreeXId.3 index 906483f..eb1da96 100644 --- a/doc/FreeXId.3 +++ b/doc/FreeXId.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: FreeXId.3,v 1.6 2007/12/13 15:23:43 dgp Exp $ -'\" .so man.macros .TH Tk_FreeXId 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/GeomReq.3 b/doc/GeomReq.3 index ab2223a..ed447b9 100644 --- a/doc/GeomReq.3 +++ b/doc/GeomReq.3 @@ -5,9 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" -'\" RCS: @(#) $Id: GeomReq.3,v 1.5 2008/07/08 22:40:50 patthoyts Exp $ -'\" .so man.macros .TH Tk_GeometryRequest 3 "8.4" Tk "Tk Library Procedures" .BS diff --git a/doc/GetAnchor.3 b/doc/GetAnchor.3 index 1a1de90..2ed7627 100644 --- a/doc/GetAnchor.3 +++ b/doc/GetAnchor.3 @@ -5,8 +5,6 @@ '\" 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.11 2009/07/26 19:50:50 dkf Exp $ -'\" .so man.macros .TH Tk_GetAnchorFromObj 3 8.1 Tk "Tk Library Procedures" .BS diff --git a/doc/GetBitmap.3 b/doc/GetBitmap.3 index 8370012..d5482f6 100644 --- a/doc/GetBitmap.3 +++ b/doc/GetBitmap.3 @@ -5,8 +5,6 @@ '\" 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.18 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_AllocBitmapFromObj 3 8.1 Tk "Tk Library Procedures" .BS diff --git a/doc/GetCapStyl.3 b/doc/GetCapStyl.3 index 12efa6b..3c9dbb0 100644 --- a/doc/GetCapStyl.3 +++ b/doc/GetCapStyl.3 @@ -5,8 +5,6 @@ '\" 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.11 2009/07/26 19:44:31 dkf Exp $ -'\" .so man.macros .TH Tk_GetCapStyle 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/GetClrmap.3 b/doc/GetClrmap.3 index cfb84d9..13ad9b2 100644 --- a/doc/GetClrmap.3 +++ b/doc/GetClrmap.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetClrmap.3,v 1.7 2008/03/19 15:34:41 dkf Exp $ -'\" .so man.macros .TH Tk_GetColormap 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/GetColor.3 b/doc/GetColor.3 index 33c8420..5b7a553 100644 --- a/doc/GetColor.3 +++ b/doc/GetColor.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetColor.3,v 1.9 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_AllocColorFromObj 3 8.1 Tk "Tk Library Procedures" .BS @@ -88,8 +86,9 @@ to use to display the color. Each \fIR\fR, \fIG\fR, or \fIB\fR represents a single hexadecimal digit. The four forms permit colors to be specified with 4-bit, 8-bit, 12-bit or 16-bit values. When fewer than 16 bits are provided for each color, they represent -the most significant bits of the color. For example, #3a7 is the -same as #3000a0007000. +the most significant bits of the color, while the lower unfilled +bits will be repeatedly replicated from the available higher bits. +For example, #3a7 is the same as #3333aaaa7777. .PP \fBTk_AllocColorFromObj\fR returns a pointer to an XColor structure; the structure indicates the exact intensities of diff --git a/doc/GetCursor.3 b/doc/GetCursor.3 index f4833e7..3946105 100644 --- a/doc/GetCursor.3 +++ b/doc/GetCursor.3 @@ -5,8 +5,6 @@ '\" 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.15 2008/11/05 22:58:29 nijtmans Exp $ -'\" .so man.macros .TH Tk_AllocCursorFromObj 3 8.1 Tk "Tk Library Procedures" .BS diff --git a/doc/GetDash.3 b/doc/GetDash.3 index 67b0830..a0a4c81 100644 --- a/doc/GetDash.3 +++ b/doc/GetDash.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetDash.3,v 1.9 2010/01/12 15:38:49 dkf Exp $ -'\" .so man.macros .TH Tk_GetDash 3 8.3 Tk "Tk Library Procedures" .BS diff --git a/doc/GetFont.3 b/doc/GetFont.3 index 741ad93..572b94f 100644 --- a/doc/GetFont.3 +++ b/doc/GetFont.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetFont.3,v 1.12 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_AllocFontFromObj 3 8.1 Tk "Tk Library Procedures" .BS diff --git a/doc/GetGC.3 b/doc/GetGC.3 index c2b61b9..4c6f9ff 100644 --- a/doc/GetGC.3 +++ b/doc/GetGC.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetGC.3,v 1.4 2008/07/08 22:40:50 patthoyts Exp $ -'\" .so man.macros .TH Tk_GetGC 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/GetHINSTANCE.3 b/doc/GetHINSTANCE.3 index 10fd8a3..07c9ddd 100644 --- a/doc/GetHINSTANCE.3 +++ b/doc/GetHINSTANCE.3 @@ -2,8 +2,6 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: GetHINSTANCE.3,v 1.4 2009/11/19 22:48:32 nijtmans Exp $ -'\" .so man.macros .TH Tk_GetHISTANCE 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/GetHWND.3 b/doc/GetHWND.3 index 7356f89..c78df98 100644 --- a/doc/GetHWND.3 +++ b/doc/GetHWND.3 @@ -2,9 +2,6 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: GetHWND.3,v 1.6 2008/07/08 22:40:50 patthoyts Exp $ -'\" -'\" .so man.macros .TH HWND 3 8.0 Tk "Tk Library Procedures" .BS diff --git a/doc/GetImage.3 b/doc/GetImage.3 index a6fc19d..59232aa 100644 --- a/doc/GetImage.3 +++ b/doc/GetImage.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetImage.3,v 1.11 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_GetImage 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/GetJoinStl.3 b/doc/GetJoinStl.3 index 67d5e0c..5e527de 100644 --- a/doc/GetJoinStl.3 +++ b/doc/GetJoinStl.3 @@ -5,8 +5,6 @@ '\" 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.11 2009/07/26 19:43:05 dkf Exp $ -'\" .so man.macros .TH Tk_GetJoinStyle 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/GetJustify.3 b/doc/GetJustify.3 index 66f735a..e9d59e9 100644 --- a/doc/GetJustify.3 +++ b/doc/GetJustify.3 @@ -5,8 +5,6 @@ '\" 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.12 2009/07/26 19:45:52 dkf Exp $ -'\" .so man.macros .TH Tk_GetJustifyFromObj 3 8.1 Tk "Tk Library Procedures" .BS diff --git a/doc/GetOption.3 b/doc/GetOption.3 index 3ccd8b3..4e13b9b 100644 --- a/doc/GetOption.3 +++ b/doc/GetOption.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetOption.3,v 1.5 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_GetOption 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/GetPixels.3 b/doc/GetPixels.3 index a3e7cb0..287e734 100644 --- a/doc/GetPixels.3 +++ b/doc/GetPixels.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetPixels.3,v 1.9 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_GetPixelsFromObj 3 8.1 Tk "Tk Library Procedures" .BS @@ -86,7 +84,7 @@ value in \fIobjPtr\fR, which speeds up future calls to \fBTk_GetPixels\fR is identical to \fBTk_GetPixelsFromObj\fR except that the screen distance is specified with a string instead of an object. This prevents \fBTk_GetPixels\fR from caching the -return value, so \fBTk_GetAnchor\fR is less efficient than +return value, so \fBTk_GetPixels\fR is less efficient than \fBTk_GetPixelsFromObj\fR. .PP \fBTk_GetMMFromObj\fR and \fBTk_GetScreenMM\fR are similar to diff --git a/doc/GetPixmap.3 b/doc/GetPixmap.3 index 93460c0..63d7d62 100644 --- a/doc/GetPixmap.3 +++ b/doc/GetPixmap.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetPixmap.3,v 1.4 2008/07/08 22:40:50 patthoyts Exp $ -'\" .so man.macros .TH Tk_GetPixmap 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/GetRelief.3 b/doc/GetRelief.3 index 2344c46..858c128 100644 --- a/doc/GetRelief.3 +++ b/doc/GetRelief.3 @@ -5,8 +5,6 @@ '\" 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.12 2009/07/26 19:52:47 dkf Exp $ -'\" .so man.macros .TH Tk_GetReliefFromObj 3 8.1 Tk "Tk Library Procedures" .BS diff --git a/doc/GetRootCrd.3 b/doc/GetRootCrd.3 index 7245d38..7c46b5f 100644 --- a/doc/GetRootCrd.3 +++ b/doc/GetRootCrd.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetRootCrd.3,v 1.4 2007/12/13 15:23:43 dgp Exp $ -'\" .so man.macros .TH Tk_GetRootCoords 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/GetScroll.3 b/doc/GetScroll.3 index b5bb7f8..9c10450 100644 --- a/doc/GetScroll.3 +++ b/doc/GetScroll.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetScroll.3,v 1.9 2009/07/27 20:02:15 dkf Exp $ -'\" .so man.macros .TH Tk_GetScrollInfo 3 8.0 Tk "Tk Library Procedures" .BS diff --git a/doc/GetSelect.3 b/doc/GetSelect.3 index 9cdc1bd..63f655a 100644 --- a/doc/GetSelect.3 +++ b/doc/GetSelect.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetSelect.3,v 1.7 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_GetSelection 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/GetUid.3 b/doc/GetUid.3 index 08a6f03..677bbaa 100644 --- a/doc/GetUid.3 +++ b/doc/GetUid.3 @@ -5,8 +5,6 @@ '\" 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.9 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_GetUid 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/GetVRoot.3 b/doc/GetVRoot.3 index 672d949..7311e3b 100644 --- a/doc/GetVRoot.3 +++ b/doc/GetVRoot.3 @@ -5,8 +5,6 @@ '\" 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.8 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_GetVRootGeometry 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/GetVisual.3 b/doc/GetVisual.3 index a859e7a..8e022c0 100644 --- a/doc/GetVisual.3 +++ b/doc/GetVisual.3 @@ -5,8 +5,6 @@ '\" 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.9 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_GetVisual 3 4.0 Tk "Tk Library Procedures" .BS @@ -2,8 +2,6 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: Grab.3,v 1.4 2008/07/08 22:40:50 patthoyts Exp $ -'\" .so man.macros .TH Tk_Grab 3 "" Tk "Tk Library Procedures" .BS @@ -52,7 +50,7 @@ receive pointer- or keyboard-related events until the next call to Tk_Ungrab. If a previous grab was in effect within the application, then it is replaced with a new one. .PP -\fBTcl_Ungrab\fR releases a grab on the mouse pointer and keyboard, if +\fBTk_Ungrab\fR releases a grab on the mouse pointer and keyboard, if there is one set on the window given by \fItkwin\fR. Once a grab is released, pointer and keyboard events will start being delivered to other windows again. diff --git a/doc/HWNDToWindow.3 b/doc/HWNDToWindow.3 index 8fdf4a2..684a4e7 100644 --- a/doc/HWNDToWindow.3 +++ b/doc/HWNDToWindow.3 @@ -2,8 +2,6 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: HWNDToWindow.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ -'\" .so man.macros .TH Tk_HWNDToWindow 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/HandleEvent.3 b/doc/HandleEvent.3 index f313907..7824c5c 100644 --- a/doc/HandleEvent.3 +++ b/doc/HandleEvent.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: HandleEvent.3,v 1.7 2010/01/02 11:07:56 dkf Exp $ -'\" .so man.macros .TH Tk_HandleEvent 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/IdToWindow.3 b/doc/IdToWindow.3 index f6e2486..e04c290 100644 --- a/doc/IdToWindow.3 +++ b/doc/IdToWindow.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: IdToWindow.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ -'\" .so man.macros .TH Tk_IdToWindow 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/ImgChanged.3 b/doc/ImgChanged.3 index 7344c53..55b24d4 100644 --- a/doc/ImgChanged.3 +++ b/doc/ImgChanged.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ImgChanged.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ -'\" .so man.macros .TH Tk_ImageChanged 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/Inactive.3 b/doc/Inactive.3 index ff92175..825fd8b 100644 --- a/doc/Inactive.3 +++ b/doc/Inactive.3 @@ -2,8 +2,6 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: Inactive.3,v 1.4 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_GetUserInactiveTime 3 8.5 Tk "Tk Library Procedures" .BS diff --git a/doc/InternAtom.3 b/doc/InternAtom.3 index 5800ff0..37a6c3c 100644 --- a/doc/InternAtom.3 +++ b/doc/InternAtom.3 @@ -5,8 +5,6 @@ '\" 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.10 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_InternAtom 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/MainLoop.3 b/doc/MainLoop.3 index d3129e0..ae38d6c 100644 --- a/doc/MainLoop.3 +++ b/doc/MainLoop.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: MainLoop.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ -'\" .so man.macros .TH Tk_MainLoop 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/MainWin.3 b/doc/MainWin.3 index 14860d5..536679a 100644 --- a/doc/MainWin.3 +++ b/doc/MainWin.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: MainWin.3,v 1.7 2009/05/05 09:22:15 dkf Exp $ -'\" .so man.macros .TH Tk_MainWindow 3 7.0 Tk "Tk Library Procedures" .BS diff --git a/doc/MaintGeom.3 b/doc/MaintGeom.3 index 0027064..13e35fe 100644 --- a/doc/MaintGeom.3 +++ b/doc/MaintGeom.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: MaintGeom.3,v 1.6 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_MaintainGeometry 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/ManageGeom.3 b/doc/ManageGeom.3 index 272a220..2c6c534 100644 --- a/doc/ManageGeom.3 +++ b/doc/ManageGeom.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ManageGeom.3,v 1.7 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_ManageGeometry 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/MapWindow.3 b/doc/MapWindow.3 index a0094ae..f876d24 100644 --- a/doc/MapWindow.3 +++ b/doc/MapWindow.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: MapWindow.3,v 1.7 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_MapWindow 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/MeasureChar.3 b/doc/MeasureChar.3 index 5a9b5ed..c8164f3 100644 --- a/doc/MeasureChar.3 +++ b/doc/MeasureChar.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: MeasureChar.3,v 1.10 2008/02/04 09:53:24 dkf Exp $ -'\" .so man.macros .TH Tk_MeasureChars 3 8.1 Tk "Tk Library Procedures" .BS diff --git a/doc/MoveToplev.3 b/doc/MoveToplev.3 index 50d5aa7..4cd39e2 100644 --- a/doc/MoveToplev.3 +++ b/doc/MoveToplev.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: MoveToplev.3,v 1.5 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_MoveToplevelWindow 3 "" Tk "Tk Library Procedures" .BS @@ -5,8 +5,6 @@ '\" 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.11 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_Name 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/NameOfImg.3 b/doc/NameOfImg.3 index cc35f68..5461262 100644 --- a/doc/NameOfImg.3 +++ b/doc/NameOfImg.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: NameOfImg.3,v 1.5 2008/06/30 22:57:01 dkf Exp $ -'\" .so man.macros .TH Tk_NameOfImage 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/OwnSelect.3 b/doc/OwnSelect.3 index 83b5b25..b0da542 100644 --- a/doc/OwnSelect.3 +++ b/doc/OwnSelect.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: OwnSelect.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ -'\" .so man.macros .TH Tk_OwnSelection 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/ParseArgv.3 b/doc/ParseArgv.3 index b24a3f6..1681305 100644 --- a/doc/ParseArgv.3 +++ b/doc/ParseArgv.3 @@ -5,8 +5,6 @@ '\" 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.13 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_ParseArgv 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/QWinEvent.3 b/doc/QWinEvent.3 index 7066d49..f98d29b 100644 --- a/doc/QWinEvent.3 +++ b/doc/QWinEvent.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: QWinEvent.3,v 1.6 2010/01/02 11:07:56 dkf Exp $ -'\" .so man.macros .TH Tk_QueueWindowEvent 3 7.5 Tk "Tk Library Procedures" .BS diff --git a/doc/Restack.3 b/doc/Restack.3 index cda9284..49876b0 100644 --- a/doc/Restack.3 +++ b/doc/Restack.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Restack.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ -'\" .so man.macros .TH Tk_RestackWindow 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/RestrictEv.3 b/doc/RestrictEv.3 index ad59124..d208955 100644 --- a/doc/RestrictEv.3 +++ b/doc/RestrictEv.3 @@ -5,8 +5,6 @@ '\" 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.9 2010/05/11 12:12:50 nijtmans Exp $ -'\" .so man.macros .TH Tk_RestrictEvents 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/SetAppName.3 b/doc/SetAppName.3 index 4182ed0..60ac14f 100644 --- a/doc/SetAppName.3 +++ b/doc/SetAppName.3 @@ -5,8 +5,6 @@ '\" 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.9 2008/06/30 22:57:02 dkf Exp $ -'\" .so man.macros .TH Tk_SetAppName 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/SetCaret.3 b/doc/SetCaret.3 index e01c89d..5fd4f1f 100644 --- a/doc/SetCaret.3 +++ b/doc/SetCaret.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SetCaret.3,v 1.3 2008/07/08 22:40:51 patthoyts Exp $ -'\" .so man.macros .TH Tk_SetCaretPos 3 8.4 Tk "Tk Library Procedures" .BS diff --git a/doc/SetClass.3 b/doc/SetClass.3 index 2fb095f..46f3c1b 100644 --- a/doc/SetClass.3 +++ b/doc/SetClass.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SetClass.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ -'\" .so man.macros .TH Tk_SetClass 3 "" Tk "Tk Library Procedures" .BS diff --git a/doc/SetClassProcs.3 b/doc/SetClassProcs.3 index 23567c3..e0398f5 100644 --- a/doc/SetClassProcs.3 +++ b/doc/SetClassProcs.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SetClassProcs.3,v 1.6 2010/01/10 20:27:25 nijtmans Exp $ -'\" .so man.macros .TH Tk_SetClassProcs 3 8.4 Tk "Tk Library Procedures" .BS diff --git a/doc/SetGrid.3 b/doc/SetGrid.3 index 57efb97..5fe4509 100644 --- a/doc/SetGrid.3 +++ b/doc/SetGrid.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SetGrid.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ -'\" .so man.macros .TH Tk_SetGrid 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/SetOptions.3 b/doc/SetOptions.3 index 20098cc..1851f1f 100644 --- a/doc/SetOptions.3 +++ b/doc/SetOptions.3 @@ -4,8 +4,6 @@ '\" 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.18 2008/06/30 22:57:02 dkf Exp $ -'\" .so man.macros .TH Tk_SetOptions 3 8.1 Tk "Tk Library Procedures" .BS @@ -261,7 +259,7 @@ typedef struct { int \fIobjOffset\fR; int \fIinternalOffset\fR; int \fIflags\fR; - ClientData \fIclientData\fR; + const void *\fIclientData\fR; int \fItypeMask\fR; } \fBTk_OptionSpec\fR; .CE @@ -440,10 +438,9 @@ from \fBTcl_GetStringFromObj\fR. \fBTK_OPTION_SYNONYM\fR This type is used to provide alternative names for an option (for example, \fB\-bg\fR is often used as a synonym for \fB\-background\fR). -The \fBclientData\fR field is a (char *) pointer that gives -the name of another option in the same table. Whenever the -synonym option is used, the information from the other option -will be used instead. +The \fBclientData\fR field is a string that gives the name of another +option in the same table. Whenever the synonym option is used, the +information from the other option will be used instead. .TP \fBTK_OPTION_WINDOW\fR The value must be a window path name. The internal form is a @@ -521,31 +518,31 @@ typedef struct Tk_ObjCustomOption { } \fBTk_ObjCustomOption\fR; typedef int \fBTk_CustomOptionSetProc\fR( - ClientData \fIclientData\fR, - Tcl_Interp *\fIinterp\fR, - Tk_Window \fItkwin\fR, - Tcl_Obj **\fIvaluePtr\fR, - char *\fIrecordPtr\fR, - int \fIinternalOffset\fR, - char *\fIsaveInternalPtr\fR, - int \fIflags\fR); + ClientData \fIclientData\fR, + Tcl_Interp *\fIinterp\fR, + Tk_Window \fItkwin\fR, + Tcl_Obj **\fIvaluePtr\fR, + char *\fIrecordPtr\fR, + int \fIinternalOffset\fR, + char *\fIsaveInternalPtr\fR, + int \fIflags\fR); typedef Tcl_Obj *\fBTk_CustomOptionGetProc\fR( - ClientData \fIclientData\fR, - Tk_Window \fItkwin\fR, - char *\fIrecordPtr\fR, - int \fIinternalOffset\fR); + ClientData \fIclientData\fR, + Tk_Window \fItkwin\fR, + char *\fIrecordPtr\fR, + int \fIinternalOffset\fR); typedef void \fBTk_CustomOptionRestoreProc\fR( - ClientData \fIclientData\fR, - Tk_Window \fItkwin\fR, - char *\fIinternalPtr\fR, - char *\fIsaveInternalPtr\fR); + ClientData \fIclientData\fR, + Tk_Window \fItkwin\fR, + char *\fIinternalPtr\fR, + char *\fIsaveInternalPtr\fR); typedef void \fBTk_CustomOptionFreeProc\fR( - ClientData \fIclientData\fR, - Tk_Window \fItkwin\fR, - char *\fIinternalPtr\fR); + ClientData \fIclientData\fR, + Tk_Window \fItkwin\fR, + char *\fIinternalPtr\fR); .CE .PP The Tk_ObjCustomOption structure contains six fields: a name diff --git a/doc/SetVisual.3 b/doc/SetVisual.3 index 5698bad..e902ed4 100644 --- a/doc/SetVisual.3 +++ b/doc/SetVisual.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: SetVisual.3,v 1.5 2008/06/30 22:57:02 dkf Exp $ -'\" .so man.macros .TH Tk_SetWindowVisual 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/StrictMotif.3 b/doc/StrictMotif.3 index 0623467..4e898fd 100644 --- a/doc/StrictMotif.3 +++ b/doc/StrictMotif.3 @@ -4,8 +4,6 @@ '\" 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.7 2008/06/30 22:57:02 dkf Exp $ -'\" .so man.macros .TH Tk_StrictMotif 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/TextLayout.3 b/doc/TextLayout.3 index 7d2f5c5..706eaf5 100644 --- a/doc/TextLayout.3 +++ b/doc/TextLayout.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: TextLayout.3,v 1.13 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_ComputeTextLayout 3 8.1 Tk "Tk Library Procedures" .BS diff --git a/doc/TkInitStubs.3 b/doc/TkInitStubs.3 index 02cb4df..cc1bb36 100644 --- a/doc/TkInitStubs.3 +++ b/doc/TkInitStubs.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: TkInitStubs.3,v 1.10 2010/01/04 22:06:47 patthoyts Exp $ -'\" .so man.macros .TH Tk_InitStubs 3 8.4 Tk "Tk Library Procedures" .BS @@ -36,7 +34,7 @@ as \fIversion\fR. The Tcl stubs mechanism defines a way to dynamically bind extensions to a particular Tcl implementation at run time. the stubs mechanism requires no changes to applications -incoporating Tcl/Tk interpreters. Only developers creating +incorporating Tcl/Tk interpreters. Only developers creating C-based Tcl/Tk extensions need to take steps to use the stubs mechanism with their extensions. See the \fBTcl_InitStubs\fR page for more information. diff --git a/doc/Tk_Init.3 b/doc/Tk_Init.3 index 95cf483..cf93e58 100644 --- a/doc/Tk_Init.3 +++ b/doc/Tk_Init.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Tk_Init.3,v 1.8 2009/05/04 09:12:33 dkf Exp $ -'\" .so man.macros .TH Tk_Init 3 8.0 Tk "Tk Library Procedures" .BS diff --git a/doc/Tk_Main.3 b/doc/Tk_Main.3 index c853d84..5db887b 100644 --- a/doc/Tk_Main.3 +++ b/doc/Tk_Main.3 @@ -5,8 +5,6 @@ '\" 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.10 2010/10/11 21:50:46 nijtmans Exp $ -'\" .so man.macros .TH Tk_Main 3 4.0 Tk "Tk Library Procedures" .BS diff --git a/doc/WindowId.3 b/doc/WindowId.3 index 61a1a04..30f80a3 100644 --- a/doc/WindowId.3 +++ b/doc/WindowId.3 @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: WindowId.3,v 1.14 2008/06/30 22:57:02 dkf Exp $ -'\" .so man.macros .TH Tk_WindowId 3 "8.4" Tk "Tk Library Procedures" .BS @@ -6,8 +6,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: bell.n,v 1.7 2008/09/23 13:36:36 dkf Exp $ -'\" .so man.macros .TH bell n 8.4 Tk "Tk Built-In Commands" .BS @@ -6,8 +6,6 @@ '\" 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.32 2009/01/03 00:05:19 ferrieux Exp $ -'\" .so man.macros .TH bind n 8.0 Tk "Tk Built-In Commands" .BS diff --git a/doc/bindtags.n b/doc/bindtags.n index 1cdb21a..74bd638 100644 --- a/doc/bindtags.n +++ b/doc/bindtags.n @@ -5,8 +5,6 @@ '\" 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.10 2008/09/23 13:36:36 dkf Exp $ -'\" .so man.macros .TH bindtags n 4.0 Tk "Tk Built-In Commands" .BS diff --git a/doc/bitmap.n b/doc/bitmap.n index 36a58b4..968e6ea 100644 --- a/doc/bitmap.n +++ b/doc/bitmap.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: bitmap.n,v 1.6 2010/01/13 15:56:22 dkf Exp $ -'\" .so man.macros .TH bitmap n 4.0 Tk "Tk Built-In Commands" .BS @@ -23,8 +23,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: busy.n,v 1.3 2008/12/27 18:41:18 jenglish Exp $ -'\" .so man.macros .TH busy n "" Tk "Tk Built-In Commands" .BS @@ -54,8 +52,8 @@ a configurable busy cursor. There are many times in applications where you want to temporarily restrict what actions the user can take. For example, an application could have a .QW Run -button that when pressed causes some processing to occur. But while the -application is busy processing, you probably don't want the the user to be +button that when pressed causes some processing to occur. However, while the +application is busy processing, you probably don't want the user to be able to click the .QW Run button again. You may also want restrict the user from other tasks such as @@ -69,7 +67,7 @@ etc.\0are ignored by the widget. You can set a special cursor (like a watch) that overrides the widget's normal cursor, providing feedback that the application (widget) is temporarily busy. .PP -When a widget is made busy, the widget and all of its descendents will ignore +When a widget is made busy, the widget and all of its descendants will ignore events. It's easy to make an entire panel of widgets busy. You can simply make the toplevel widget (such as .QW . ) diff --git a/doc/button.n b/doc/button.n index 0089118..d4f1af3 100644 --- a/doc/button.n +++ b/doc/button.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: button.n,v 1.19 2008/09/23 13:36:36 dkf Exp $ -'\" .so man.macros .TH button n 4.4 Tk "Tk Built-In Commands" .BS @@ -59,14 +57,14 @@ The empty string is the default value. .OP \-state state State Specifies one of three states for the button: \fBnormal\fR, \fBactive\fR, or \fBdisabled\fR. In normal state the button is displayed using the -\fBforeground\fR and \fBbackground\fR options. The active state is +\fB\-foreground\fR and \fB\-background\fR options. The active state is typically used when the pointer is over the button. In active state -the button is displayed using the \fBactiveForeground\fR and -\fBactiveBackground\fR options. Disabled state means that the button +the button is displayed using the \fB\-activeforeground\fR and +\fB\-activebackground\fR options. Disabled state means that the button should be insensitive: the default bindings will refuse to activate the widget and will ignore mouse button presses. -In this state the \fBdisabledForeground\fR and -\fBbackground\fR options determine how the button is displayed. +In this state the \fB\-disabledforeground\fR and +\fB\-background\fR options determine how the button is displayed. .OP \-width width Width Specifies a desired width for the button. If an image or bitmap is being displayed in the button then the value is in @@ -93,12 +91,12 @@ there must not exist a window named \fIpathName\fR, but A button is a widget that displays a textual string, bitmap or image. If text is displayed, it must all be in a single font, but it can occupy multiple lines on the screen (if it contains newlines -or if wrapping occurs because of the \fBwrapLength\fR option) and +or if wrapping occurs because of the \fB\-wraplength\fR option) and one of the characters may optionally be underlined using the -\fBunderline\fR option. +\fB\-underline\fR option. It can display itself in either of three different ways, according to -the \fBstate\fR option; +the \fB\-state\fR option; it can be made to appear raised, sunken, or flat; and it can be made to flash. When a user invokes the button (by pressing mouse button 1 with the cursor over the @@ -190,18 +188,18 @@ This is the classic Tk demonstration: .PP .CS - \fBbutton\fR .b \-text "Hello, World!" \-command exit - pack .b +\fBbutton\fR .b \-text "Hello, World!" \-command exit +pack .b .CE .PP This example demonstrates how to handle button accelerators: .PP .CS - \fBbutton\fR .b1 \-text Hello \-underline 0 - \fBbutton\fR .b2 \-text World \-underline 0 - bind . <Key\-h> {.b1 flash; .b1 invoke} - bind . <Key\-w> {.b2 flash; .b2 invoke} - pack .b1 .b2 +\fBbutton\fR .b1 \-text Hello \-underline 0 +\fBbutton\fR .b2 \-text World \-underline 0 +bind . <Key\-h> {.b1 flash; .b1 invoke} +bind . <Key\-w> {.b2 flash; .b2 invoke} +pack .b1 .b2 .CE .SH "SEE ALSO" ttk::button(n) diff --git a/doc/canvas.n b/doc/canvas.n index 1406189..9eb0ec0 100644 --- a/doc/canvas.n +++ b/doc/canvas.n @@ -5,8 +5,6 @@ '\" '\" 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.46 2010/01/13 09:34:17 dkf Exp $ '\" .so man.macros .TH canvas n 8.3 Tk "Tk Built-In Commands" @@ -1407,9 +1405,9 @@ The following extra options are supported for bitmaps: .TP \fB\-background \fIcolor\fR .TP -\fB\-activebackground \fIbitmap\fR +\fB\-activebackground \fIcolor\fR .TP -\fB\-disabledbackground \fIbitmap\fR +\fB\-disabledbackground \fIcolor\fR Specifies the color to use for each of the bitmap's .QW 0 valued pixels in its normal, active and disabled states. @@ -1429,9 +1427,9 @@ disabled states. .TP \fB\-foreground \fIcolor\fR .TP -\fB\-activeforeground \fIbitmap\fR +\fB\-activeforeground \fIcolor\fR .TP -\fB\-disabledforeground \fIbitmap\fR +\fB\-disabledforeground \fIcolor\fR Specifies the color to use for each of the bitmap's .QW 1 valued pixels in its normal, active and disabled states. diff --git a/doc/checkbutton.n b/doc/checkbutton.n index d39d466..4d06c68 100644 --- a/doc/checkbutton.n +++ b/doc/checkbutton.n @@ -5,8 +5,6 @@ '\" 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.21 2008/09/23 13:36:37 dkf Exp $ -'\" .so man.macros .TH checkbutton n 4.4 Tk "Tk Built-In Commands" .BS @@ -40,7 +38,7 @@ If this option is not specified, the button's desired height is computed from the size of the image or bitmap or text being displayed in it. .OP \-indicatoron indicatorOn IndicatorOn Specifies whether or not the indicator should be drawn. Must be a -proper boolean value. If false, the \fBrelief\fR option is +proper boolean value. If false, the \fB\-relief\fR option is ignored and the widget's relief is always sunken if the widget is selected and raised otherwise. .OP \-offrelief offRelief OffRelief @@ -81,25 +79,25 @@ whenever the widget is selected. If specified as an empty string then no special color is used for displaying when the widget is selected. .OP \-selectimage selectImage SelectImage -Specifies an image to display (in place of the \fBimage\fR option) +Specifies an image to display (in place of the \fB\-image\fR option) when the checkbutton is selected. -This option is ignored unless the \fBimage\fR option has been +This option is ignored unless the \fB\-image\fR option has been specified. .OP \-state state State Specifies one of three states for the checkbutton: \fBnormal\fR, \fBactive\fR, or \fBdisabled\fR. In normal state the checkbutton is displayed using the -\fBforeground\fR and \fBbackground\fR options. The active state is +\fB\-foreground\fR and \fB\-background\fR options. The active state is typically used when the pointer is over the checkbutton. In active state -the checkbutton is displayed using the \fBactiveForeground\fR and -\fBactiveBackground\fR options. Disabled state means that the checkbutton +the checkbutton is displayed using the \fB\-activeforeground\fR and +\fB\-activebackground\fR options. Disabled state means that the checkbutton should be insensitive: the default bindings will refuse to activate the widget and will ignore mouse button presses. -In this state the \fBdisabledForeground\fR and -\fBbackground\fR options determine how the checkbutton is displayed. +In this state the \fB\-disabledforeground\fR and +\fB\-background\fR options determine how the checkbutton is displayed. .OP \-tristateimage tristateImage TristateImage -Specifies an image to display (in place of the \fBimage\fR option) +Specifies an image to display (in place of the \fB\-image\fR option) when the checkbutton is in tri-state mode. -This option is ignored unless the \fBimage\fR option has been +This option is ignored unless the \fB\-image\fR option has been specified. .OP \-tristatevalue tristateValue Value Specifies the value that causes the checkbutton to display the multi-value @@ -136,13 +134,13 @@ that displays a textual string, bitmap or image and a square called an \fIindicator\fR. If text is displayed, it must all be in a single font, but it can occupy multiple lines on the screen (if it contains newlines -or if wrapping occurs because of the \fBwrapLength\fR option) and +or if wrapping occurs because of the \fB\-wraplength\fR option) and one of the characters may optionally be underlined using the -\fBunderline\fR option. +\fB\-underline\fR option. A checkbutton has all of the behavior of a simple button, including the following: it can display itself in either of three different -ways, according to the \fBstate\fR option; +ways, according to the \fB\-state\fR option; it can be made to appear raised, sunken, or flat; it can be made to flash; and it invokes a Tcl command whenever mouse button 1 is clicked over the @@ -266,7 +264,8 @@ invoked, if there is one). .IP [3] When a checkbutton has the input focus, the space key causes the checkbutton to be invoked. Under Windows, there are additional key bindings; plus -(+) and equal (=) select the button, and minus (\-) deselects the button. +(\fB+\fR) and equal (\fB=\fR) select the button, and minus (\fB\-\fR) +deselects the button. .PP If the checkbutton's state is \fBdisabled\fR then none of the above actions occur: the checkbutton is completely non-responsive. @@ -278,12 +277,12 @@ individual widgets or by redefining the class bindings. This example shows a group of uncoupled checkbuttons. .PP .CS - labelframe .lbl \-text "Steps:" - \fBcheckbutton\fR .c1 \-text Lights \-variable lights - \fBcheckbutton\fR .c2 \-text Cameras \-variable cameras - \fBcheckbutton\fR .c3 \-text Action! \-variable action - pack .c1 .c2 .c3 \-in .lbl - pack .lbl +labelframe .lbl \-text "Steps:" +\fBcheckbutton\fR .c1 \-text Lights \-variable lights +\fBcheckbutton\fR .c2 \-text Cameras \-variable cameras +\fBcheckbutton\fR .c3 \-text Action! \-variable action +pack .c1 .c2 .c3 \-in .lbl +pack .lbl .CE .SH "SEE ALSO" button(n), options(n), radiobutton(n), ttk::checkbutton(n) diff --git a/doc/chooseColor.n b/doc/chooseColor.n index d4dddcd..645b9c1 100644 --- a/doc/chooseColor.n +++ b/doc/chooseColor.n @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: chooseColor.n,v 1.7 2008/09/23 13:36:37 dkf Exp $ -'\" .so man.macros .TH tk_chooseColor n 4.2 Tk "Tk Built-In Commands" .BS diff --git a/doc/chooseDirectory.n b/doc/chooseDirectory.n index 9060845..2d96825 100644 --- a/doc/chooseDirectory.n +++ b/doc/chooseDirectory.n @@ -2,8 +2,6 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: chooseDirectory.n,v 1.13 2008/09/23 13:36:37 dkf Exp $ -'\" .so man.macros .TH tk_chooseDirectory n 8.3 Tk "Tk Built-In Commands" .BS diff --git a/doc/clipboard.n b/doc/clipboard.n index b897b65..c987b38 100644 --- a/doc/clipboard.n +++ b/doc/clipboard.n @@ -5,8 +5,6 @@ '\" 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.20 2010/03/04 13:32:20 dkf Exp $ -'\" .so man.macros .TH clipboard n 8.4 Tk "Tk Built-In Commands" .BS @@ -90,7 +88,7 @@ Retrieve data from the clipboard on \fIwindow\fR's display. the data is to be returned and should be an atom name such as \fBSTRING\fR or \fBFILE_NAME\fR. \fIType\fR defaults to \fBSTRING\fR. This command is equivalent to -.QW "\fBselection\fR \fBget \-selection CLIPBOARD\fR" . +.QW "\fBselection get\fR \fB\-selection CLIPBOARD\fR" . .RS .PP Note that on modern X11 systems, the most useful type to retrieve for diff --git a/doc/colors.n b/doc/colors.n index b4ad921..80567c3 100644 --- a/doc/colors.n +++ b/doc/colors.n @@ -4,7 +4,6 @@ '\" Copyright (c) 2006-2007 Daniel A. Steffen <das@users.sourceforge.net> '\" Copyright (c) 2008 Donal K. Fellows '\" -'\" RCS: @(#) $Id: colors.n,v 1.11 2008/09/23 13:36:37 dkf Exp $ '\" '\" .so man.macros diff --git a/doc/console.n b/doc/console.n index 2fccb41..fa9463d 100644 --- a/doc/console.n +++ b/doc/console.n @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: console.n,v 1.13 2008/09/23 13:36:38 dkf Exp $ -'\" .so man.macros .TH console n 8.4 Tk "Tk Built-In Commands" .BS @@ -27,7 +25,7 @@ the Tk library. Except for TkAqua, this command is not available when Tk is loaded into a tclsh interpreter with .QW "\fBpackage require Tk\fR" , as a conventional terminal is expected to be present in that case. -In TkAqua, this command is ony available when stdin is \fB/dev/null\fR +In TkAqua, this command is only available when stdin is \fB/dev/null\fR (as is the case e.g. when the application embedding Tk is started from the Mac OS X Finder). .PP diff --git a/doc/cursors.n b/doc/cursors.n index f2fca99..57b1399 100644 --- a/doc/cursors.n +++ b/doc/cursors.n @@ -4,9 +4,6 @@ '\" '\" Copyright (c) 2006-2007 Daniel A. Steffen <das@users.sourceforge.net> '\" -'\" RCS: @(#) $Id: cursors.n,v 1.11 2009/06/29 14:35:01 das Exp $ -'\" -'\" .so man.macros .TH cursors n 8.3 Tk "Tk Built-In Commands" .BS diff --git a/doc/destroy.n b/doc/destroy.n index de8aca9..ee56754 100644 --- a/doc/destroy.n +++ b/doc/destroy.n @@ -5,8 +5,6 @@ '\" 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.9 2008/09/23 13:36:39 dkf Exp $ -'\" .so man.macros .TH destroy n "" Tk "Tk Built-In Commands" .BS diff --git a/doc/dialog.n b/doc/dialog.n index b8c939c..bd40321 100644 --- a/doc/dialog.n +++ b/doc/dialog.n @@ -5,8 +5,6 @@ '\" 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.9 2008/09/23 13:36:39 dkf Exp $ -'\" .so man.macros .TH tk_dialog n 4.1 Tk "Tk Built-In Commands" .BS @@ -32,7 +30,8 @@ Text to appear in the window manager's title bar for the dialog. Message to appear in the top portion of the dialog box. .TP \fIbitmap\fR -If non-empty, specifies a bitmap to display in the top portion of +If non-empty, specifies a bitmap (in a form suitable for Tk_GetBitmap) +to display in the top portion of the dialog, to the left of the text. If this is an empty string then no bitmap is displayed in the dialog. .TP diff --git a/doc/entry.n b/doc/entry.n index 46b1aa4..b115268 100644 --- a/doc/entry.n +++ b/doc/entry.n @@ -6,8 +6,6 @@ '\" 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.24 2008/09/23 13:36:39 dkf Exp $ -'\" .so man.macros .TH entry n 8.3 Tk "Tk Built-In Commands" .BS @@ -34,9 +32,9 @@ this option is the empty string, the normal background color is used. Specifies the foreground color to use when the entry is disabled. If this option is the empty string, the normal foreground color is used. .OP "\-invalidcommand or \-invcmd" invalidCommand InvalidCommand -Specifies a script to eval when \fBvalidateCommand\fR returns 0. +Specifies a script to eval when \fB\-validatecommand\fR returns 0. Setting it to {} disables this feature (the default). The best use -of this option is to set it to \fIbell\fR. See \fBValidation\fR +of this option is to set it to \fIbell\fR. See \fBVALIDATION\fR below for more information. .OP \-readonlybackground readonlyBackground ReadonlyBackground Specifies the background color to use when the entry is readonly. If @@ -66,15 +64,15 @@ be displayed in a different color, depending on the values of the Specifies the mode in which validation should operate: \fBnone\fR, \fBfocus\fR, \fBfocusin\fR, \fBfocusout\fR, \fBkey\fR, or \fBall\fR. It defaults to \fBnone\fR. When you want validation, you must explicitly -state which mode you wish to use. See \fBValidation\fR below for more. +state which mode you wish to use. See \fBVALIDATION\fR below for more. .OP "\-validatecommand or \-vcmd" validateCommand ValidateCommand Specifies a script to eval when you want to validate the input into the entry widget. Setting it to {} disables this feature (the default). This command must return a valid Tcl boolean value. If it returns 0 (or the valid Tcl boolean equivalent) then it means you reject the new edition -and it will not occur and the \fBinvalidCommand\fR will be evaluated if it +and it will not occur and the \fB\-invalidcommand\fR will be evaluated if it is set. If it returns 1, then the new edition occurs. -See \fBValidation\fR below for more information. +See \fBVALIDATION\fR below for more information. .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. @@ -98,7 +96,7 @@ allows that string to be edited using widget commands described below, which are typically bound to keystrokes and mouse actions. When first created, an entry's string is empty. A portion of the entry may be selected as described below. -If an entry is exporting its selection (see the \fBexportSelection\fR +If an entry is exporting its selection (see the \fB\-exportselection\fR option), then it will observe the standard X11 protocols for handling the selection; entry selections are available as type \fBSTRING\fR. Entries also observe the standard Tk rules for dealing with the @@ -110,31 +108,31 @@ Entries are capable of displaying strings that are too long to fit entirely within the widget's window. In this case, only a portion of the string will be displayed; commands described below 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 +the standard \fB\-xscrollcommand\fR mechanism for interacting with +scrollbars (see the description of the \fB\-xscrollcommand\fR option for details). They also support scanning, as described below. .SH VALIDATION .PP -Validation works by setting the \fBvalidateCommand\fR -option to a script which will be evaluated according to the \fBvalidate\fR -option as follows: +Validation works by setting the \fB\-validatecommand\fR option to a +script (\fIvalidateCommand\fR) which will be evaluated according to +the \fB\-validate\fR option as follows: .PP .IP \fBnone\fR 10 Default. This means no validation will occur. .IP \fBfocus\fR 10 -\fBvalidateCommand\fR will be called when the entry receives or +\fIvalidateCommand\fR will be called when the entry receives or loses focus. .IP \fBfocusin\fR 10 -\fBvalidateCommand\fR will be called when the entry receives focus. +\fIvalidateCommand\fR will be called when the entry receives focus. .IP \fBfocusout\fR 10 -\fBvalidateCommand\fR will be called when the entry loses focus. +\fIvalidateCommand\fR will be called when the entry loses focus. .IP \fBkey\fR 10 -\fBvalidateCommand\fR will be called when the entry is edited. +\fIvalidateCommand\fR will be called when the entry is edited. .IP \fBall\fR 10 -\fBvalidateCommand\fR will be called for all above conditions. +\fIvalidateCommand\fR will be called for all above conditions. .PP -It is possible to perform percent substitutions on the \fBvalidateCommand\fR -and \fBinvalidCommand\fR, +It is possible to perform percent substitutions on the value of the +\fB\-validatecommand\fR and \fB\-invalidcommand\fR options, just as you would in a \fBbind\fR script. The following substitutions are recognized: .PP @@ -159,32 +157,32 @@ The type of validation that triggered the callback .IP \fB%W\fR 5 The name of the entry widget. .PP -In general, the \fBtextVariable\fR and \fBvalidateCommand\fR can be +In general, the \fB\-textvariable\fR and \fB\-validatecommand\fR options can be dangerous to mix. Any problems have been overcome so that using the -\fBvalidateCommand\fR will not interfere with the traditional behavior of -the entry widget. Using the \fBtextVariable\fR for read-only purposes will +\fB\-validatecommand\fR will not interfere with the traditional behavior of +the entry widget. Using the \fB\-textvariable\fR for read-only purposes will never cause problems. The danger comes when you try set the -\fBtextVariable\fR to something that the \fBvalidateCommand\fR would not -accept, which causes \fBvalidate\fR to become \fInone\fR (the -\fBinvalidCommand\fR will not be triggered). The same happens -when an error occurs evaluating the \fBvalidateCommand\fR. +\fB\-textvariable\fR to something that the \fB\-validatecommand\fR would not +accept, which causes \fB\-validate\fR to become \fInone\fR (the +\fB\-invalidcommand\fR will not be triggered). The same happens +when an error occurs evaluating the \fB\-validatecommand\fR. .PP -Primarily, an error will occur when the \fBvalidateCommand\fR or -\fBinvalidCommand\fR encounters an error in its script while evaluating or -\fBvalidateCommand\fR does not return a valid Tcl boolean value. The -\fBvalidate\fR option will also set itself to \fBnone\fR when you edit the -entry widget from within either the \fBvalidateCommand\fR or the -\fBinvalidCommand\fR. Such editions will override the one that was being +Primarily, an error will occur when the \fB\-validatecommand\fR or +\fB\-invalidcommand\fR encounters an error in its script while evaluating or +\fB\-validatecommand\fR does not return a valid Tcl boolean value. The +\fB\-validate\fR option will also set itself to \fBnone\fR when you edit the +entry widget from within either the \fB\-validatecommand\fR or the +\fB\-invalidcommand\fR. Such editions will override the one that was being validated. If you wish to edit the entry widget (for example set it to {}) -during validation and still have the \fBvalidate\fR option set, you should +during validation and still have the \fB\-validate\fR option set, you should include the command .CS after idle {%W config \-validate %v} .CE -in the \fBvalidateCommand\fR or \fBinvalidCommand\fR (whichever one you +in the \fB\-validatecommand\fR or \fB\-invalidcommand\fR (whichever one you were editing the entry widget from). It is also recommended to not set an -associated \fBtextVariable\fR during validation, as that can cause the -entry widget to become out of sync with the \fBtextVariable\fR. +associated \fB\-textvariable\fR during validation, as that can cause the +entry widget to become out of sync with the \fB\-textvariable\fR. .SH "WIDGET COMMAND" .PP The \fBentry\fR command creates a new Tcl command whose @@ -371,9 +369,9 @@ Returns an empty string. .RE .TP \fIpathName \fBvalidate\fR -This command is used to force an evaluation of the \fBvalidateCommand\fR -independent of the conditions specified by the \fBvalidate\fR option. -This is done by temporarily setting the \fBvalidate\fR option to \fBall\fR. +This command is used to force an evaluation of the \fB\-validatecommand\fR +independent of the conditions specified by the \fB\-validate\fR option. +This is done by temporarily setting the \fB\-validate\fR option to \fBall\fR. It returns 0 or 1. .TP \fIpathName \fBxview \fIargs\fR diff --git a/doc/event.n b/doc/event.n index c47a5fc..52cb992 100644 --- a/doc/event.n +++ b/doc/event.n @@ -5,8 +5,6 @@ '\" 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.23 2010/01/06 18:37:36 dkf Exp $ -'\" .so man.macros .TH event n 8.3 Tk "Tk Built-In Commands" .BS @@ -78,7 +76,7 @@ defined for the given virtual event; if the virtual event is not defined then an empty string is returned. .RS .PP -Note that virtual events that that are not bound to physical event +Note that virtual events that are not bound to physical event sequences are \fInot\fR returned by \fBevent info\fR. .RE .SH "EVENT FIELDS" @@ -375,6 +373,16 @@ selected contents. Move to the next item (i.e., visible character) in the current widget while deselecting any selected contents. .TP +\fB<<NextLine>>\fR +. +Move to the next line in the current widget while deselecting any selected +contents. +.TP +\fB<<NextPara>>\fR +. +Move to the next paragraph in the current widget while deselecting any +selected contents. +.TP \fB<<NextWord>>\fR . Move to the next group of items (i.e., visible word) in the current widget @@ -393,6 +401,16 @@ event has meaningful \fB%x\fR and \fB%y\fR substitutions). Move to the previous item (i.e., visible character) in the current widget while deselecting any selected contents. .TP +\fB<<PrevLine>>\fR +. +Move to the previous line in the current widget while deselecting any selected +contents. +.TP +\fB<<PrevPara>>\fR +. +Move to the previous paragraph in the current widget while deselecting any +selected contents. +.TP \fB<<PrevWindow>>\fR Traverse to the previous window. .TP @@ -404,6 +422,10 @@ while deselecting any selected contents. \fB<<Redo>>\fR Redo one undone action. .TP +\fB<<SelectAll>>\fR +. +Set the range of selected contents to the complete widget. +.TP \fB<<SelectLineEnd>>\fR . Move to the end of the line in the current widget while extending the range @@ -419,22 +441,51 @@ of selected contents. Move to the next item (i.e., visible character) in the current widget while extending the range of selected contents. .TP +\fB<<SelectNextLine>>\fR +. +Move to the next line in the current widget while extending the range of +selected contents. +.TP +\fB<<SelectNextPara>>\fR +. +Move to the next paragraph in the current widget while extending the range +of selected contents. +.TP \fB<<SelectNextWord>>\fR . Move to the next group of items (i.e., visible word) in the current widget while extending the range of selected contents. .TP +\fB<<SelectNone>>\fR +. +Reset the range of selected contents to be empty. +.TP \fB<<SelectPrevChar>>\fR . Move to the previous item (i.e., visible character) in the current widget while extending the range of selected contents. .TP +\fB<<SelectPrevLine>>\fR +. +Move to the previous line in the current widget while extending the range of +selected contents. +.TP +\fB<<SelectPrevPara>>\fR +. +Move to the previous paragraph in the current widget while extending the +range of selected contents. +.TP \fB<<SelectPrevWord>>\fR . Move to the previous group of items (i.e., visible word) in the current widget while extending the range of selected contents. .TP +\fB<<ToggleSelection>>\fR +. +Toggle the selection. +.TP \fB<<Undo>>\fR +. Undo the last action. .SH EXAMPLES .SS "MAPPING KEYS TO VIRTUAL EVENTS" diff --git a/doc/focus.n b/doc/focus.n index 4fbe875..576db30 100644 --- a/doc/focus.n +++ b/doc/focus.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: focus.n,v 1.8 2008/09/23 13:36:39 dkf Exp $ -'\" .so man.macros .TH focus n 4.0 Tk "Tk Built-In Commands" .BS diff --git a/doc/focusNext.n b/doc/focusNext.n index a376e54..cef5ce2 100644 --- a/doc/focusNext.n +++ b/doc/focusNext.n @@ -5,8 +5,6 @@ '\" 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.8 2008/09/23 13:36:39 dkf Exp $ -'\" .so man.macros .TH tk_focusNext n 4.0 Tk "Tk Built-In Commands" .BS @@ -5,8 +5,6 @@ '\" 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.24 2008/09/23 13:36:39 dkf Exp $ -'\" .so man.macros .TH font n 8.0 Tk "Tk Built-In Commands" .BS @@ -28,7 +26,7 @@ first argument. The following forms are currently supported: Returns information about the actual attributes that are obtained when \fIfont\fR is used on \fIwindow\fR's display; the actual attributes obtained may differ from the attributes requested due to platform-dependent -limitations, such as the availability of font families and pointsizes. +limitations, such as the availability of font families and point sizes. \fIfont\fR is a font description; see \fBFONT DESCRIPTIONS\fR below. If the \fIwindow\fR argument is omitted, it defaults to the main window. If \fIoption\fR is specified, returns the value of that attribute; if it is @@ -55,7 +53,7 @@ possible attributes. .RS .PP Note that on Aqua/Mac OS X, the system fonts (see -\fBPLATFORM-SPECIFIC FONTS\fR below) may not be actually altered because they +\fBPLATFORM SPECIFIC FONTS\fR below) may not be actually altered because they are implemented by the system theme. To achieve the effect of modification, use \fBfont actual\fR to get their configuration and \fBfont create\fR to synthesize a copy of the font which can be modified. @@ -112,7 +110,7 @@ below for a list of the possible metrics. .TP \fBfont names\fR The return value is a list of all the named fonts that are currently defined. -.SH "FONT DESCRIPTION" +.SH "FONT DESCRIPTIONS" .PP The following formats are accepted as a font description anywhere \fIfont\fR is specified as an argument above; these same forms are also @@ -133,7 +131,7 @@ 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 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 \fBPLATFORM SPECIFIC FONTS\fR for a list of the system fonts. .TP [3] \fIfamily \fR?\fIsize\fR? ?\fIstyle\fR? ?\fIstyle ...\fR? . @@ -340,7 +338,7 @@ This font should be used for tooltip windows (transient information windows). 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. -.SH "PLATFORM-SPECIFIC FONTS" +.SH "PLATFORM SPECIFIC FONTS" .PP The following system fonts are supported: .TP diff --git a/doc/fontchooser.n b/doc/fontchooser.n index 6e3a766..65c3128 100644 --- a/doc/fontchooser.n +++ b/doc/fontchooser.n @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: fontchooser.n,v 1.1 2008/12/10 05:02:40 das Exp $ -'\" .so man.macros .TH fontchooser n "" Tk "Tk Built-In Commands" .BS @@ -120,7 +118,7 @@ with the focus. The recommended practice is to set font dialog \fB\-font\fR and \fB\-command\fR configuration options in per\-widget \fB<FocusIn>\fR handlers (and if necessary to unset them \- i.e. set to the empty string \- in corresponding \fB<FocusOut>\fR handlers). This is particularly important for -implementors of library code using the font selection dialog, to avoid +implementers of library code using the font selection dialog, to avoid conflicting with application code that may also want to use the dialog. .PP Because the font selection dialog is application-global, in the presence of diff --git a/doc/frame.n b/doc/frame.n index 8c27ce9..6bf4a1b 100644 --- a/doc/frame.n +++ b/doc/frame.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: frame.n,v 1.11 2008/09/23 13:36:39 dkf Exp $ -'\" .so man.macros .TH frame n 8.4 Tk "Tk Built-In Commands" .BS @@ -22,7 +20,7 @@ frame \- Create and manipulate frame widgets .SE .SH "WIDGET-SPECIFIC OPTIONS" .OP \-background background Background -This option is the same as the standard \fBbackground\fR option +This option is the same as the standard \fB\-background\fR option except that its value may also be specified as an empty string. In this case, the widget will display no background or border, and no colors will be consumed from its colormap for its background @@ -32,7 +30,7 @@ Specifies a class for the window. This class will be used when querying the option database for the window's other options, and it will also be used later for other purposes such as bindings. -The \fBclass\fR option may not be changed with the \fBconfigure\fR +The \fB\-class\fR option may not be changed with the \fBconfigure\fR widget command. .OP \-colormap colormap Colormap Specifies a colormap to use for the window. @@ -41,7 +39,7 @@ created for the window and its children, or the name of another window (which must be on the same screen and have the same visual as \fIpathName\fR), in which case the new window will use the colormap from the specified window. -If the \fBcolormap\fR option is not specified, the new window +If the \fB\-colormap\fR option is not specified, the new window uses the same colormap as its parent. This option may not be changed with the \fBconfigure\fR widget command. @@ -54,7 +52,7 @@ things like geometry requests. The window should not have any children of its own in this application. This option may not be changed with the \fBconfigure\fR widget command. -Note that \fB-borderwidth\R, \fB-padx\fR and \fB-pady\R are ignored when +Note that \fB\-borderwidth\fR, \fB\-padx\fR and \fB\-pady\fR are ignored when configured as a container since a container has no border. .OP \-height height Height Specifies the desired height for the window in any of the forms @@ -69,7 +67,7 @@ Specifies visual information for the new window in any of the forms accepted by \fBTk_GetVisual\fR. If this option is not specified, the new window will use the same visual as its parent. -The \fBvisual\fR option may not be modified with the \fBconfigure\fR +The \fB\-visual\fR option may not be modified with the \fBconfigure\fR widget command. .OP \-width width Width Specifies the desired width for the window in any of the forms diff --git a/doc/getOpenFile.n b/doc/getOpenFile.n index f378c44..8274259 100644 --- a/doc/getOpenFile.n +++ b/doc/getOpenFile.n @@ -4,8 +4,6 @@ '\" 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.26 2009/10/22 10:12:57 dkf Exp $ -'\" .so man.macros .TH tk_getOpenFile n 4.2 Tk "Tk Built-In Commands" .BS @@ -37,6 +35,12 @@ whether the existing file should be overwritten or not. The following \fIoption\-value\fR pairs are possible as command line arguments to these two commands: .TP +\fB\-confirmoverwrite\fR \fIboolean\fR +Configures how the Save dialog reacts when the selected file already +exists, and saving would overwrite it. A true value requests a +confirmation dialog be presented to the user. A false value requests +that the overwrite take place without confirmation. Default value is true. +.TP \fB\-defaultextension\fR \fIextension\fR . Specifies a string that will be appended to the filename if the user @@ -178,9 +182,9 @@ set types { {{GIF Files} {} GIFF} {{All Files} * } } -set filename [tk_getOpenFile \-filetypes $types] +set filename [\fBtk_getOpenFile\fR \-filetypes $types] -if {$filename != ""} { +if {$filename ne ""} { # Open the file ... } .CE @@ -5,8 +5,6 @@ '\" 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.11 2008/10/18 14:22:21 dkf Exp $ -'\" .so man.macros .TH grab n "" Tk "Tk Built-In Commands" .BS @@ -4,8 +4,6 @@ '\" 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.23 2009/07/11 07:25:32 dkf Exp $ -'\" .so man.macros .TH grid n 8.5 Tk "Tk Built-In Commands" .BS @@ -184,7 +182,7 @@ east, or west) that the slave will .QW stick to. If both \fBn\fR and \fBs\fR (or \fBe\fR and \fBw\fR) are specified, the slave will be stretched to fill the entire -height (or width) of its cavity. The \fBsticky\fR option subsumes the +height (or width) of its cavity. The \fB\-sticky\fR option subsumes the combination of \fB\-anchor\fR and \fB\-fill\fR that is used by \fBpack\fR. The default is .QW "" , @@ -284,8 +282,8 @@ values are retained. . Returns the size of the grid (in columns then rows) for \fImaster\fR. The size is determined either by the \fIslave\fR occupying the largest -row or column, or the largest column or row with a \fBminsize\fR, -\fBweight\fR, or \fBpad\fR that is non-zero. +row or column, or the largest column or row with a \fB\-minsize\fR, +\fB\-weight\fR, or \fB\-pad\fR that is non-zero. .TP \fBgrid slaves \fImaster\fR ?\fI\-option value\fR? . @@ -303,7 +301,7 @@ added, or removed without the need to explicitly specify row and column information. When no column or row information is specified for a \fIslave\fR, default values are chosen for -\fBcolumn\fR, \fBrow\fR, \fBcolumnspan\fR and \fBrowspan\fR +\fB\-column\fR, \fB\-row\fR, \fB\-columnspan\fR and \fB\-rowspan\fR at the time the \fIslave\fR is managed. The values are chosen based upon the current layout of the grid, the position of the \fIslave\fR relative to other \fIslave\fRs in the same grid command, and the presence @@ -313,8 +311,8 @@ command where \fIslave\fR names are normally expected. .TP \fB\-\fR . -This increases the columnspan of the \fIslave\fR to the left. Several -\fB\-\fR's in a row will successively increase the columnspan. A \fB\-\fR +This increases the \fB\-columnspan\fR of the \fIslave\fR to the left. Several +\fB\-\fR's in a row will successively increase the number of columns spanned. A \fB\-\fR may not follow a \fB^\fR or a \fBx\fR, nor may it be the first \fIslave\fR argument to \fBgrid configure\fR. .TP @@ -325,7 +323,7 @@ the \fIslave\fR on the right. .TP \fB^\fR . -This extends the \fBrowspan\fR of the \fIslave\fR above the \fB^\fR's +This extends the \fB\-rowspan\fR of the \fIslave\fR above the \fB^\fR's in the grid. The number of \fB^\fR's in a row must match the number of columns spanned by the \fIslave\fR above it. .RE @@ -342,12 +340,12 @@ For the final step, each slave is positioned in its row(s) and column(s) based on the setting of its \fIsticky\fR flag. .PP To compute the minimum size of a layout, the grid geometry manager -first looks at all slaves whose columnspan and rowspan values are one, +first looks at all slaves whose \fB\-columnspan\fR and \fB\-rowspan\fR values are one, and computes the nominal size of each row or column to be either the \fIminsize\fR for that row or column, or the sum of the \fIpad\fRding plus the size of the largest slave, whichever is greater. After that the rows or columns in each uniform group adapt to each other. Then -the slaves whose rowspans or columnspans are greater than one are +the slaves whose row-spans or column-spans are greater than one are examined. If a group of rows or columns need to be increased in size in order to accommodate these slaves, then extra space is added to each row or column in the group according to its \fIweight\fR. For each diff --git a/doc/image.n b/doc/image.n index 68729bd..ef547b9 100644 --- a/doc/image.n +++ b/doc/image.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: image.n,v 1.11 2008/09/23 13:36:40 dkf Exp $ -'\" .so man.macros .TH image n 4.0 Tk "Tk Built-In Commands" .BS diff --git a/doc/keysyms.n b/doc/keysyms.n index 2fbf260..e85da8c 100644 --- a/doc/keysyms.n +++ b/doc/keysyms.n @@ -1,9 +1,6 @@ '\" '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. -'\" -'\" RCS: @(#) $Id: keysyms.n,v 1.8 2010/01/13 15:59:33 dkf Exp $ -'\" '\" .so man.macros .TH keysyms n 8.3 Tk "Tk Built-In Commands" diff --git a/doc/label.n b/doc/label.n index 64a7075..e445ebb 100644 --- a/doc/label.n +++ b/doc/label.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: label.n,v 1.14 2008/09/23 13:36:41 dkf Exp $ -'\" .so man.macros .TH label n 4.0 Tk "Tk Built-In Commands" .BS @@ -36,10 +34,10 @@ from the size of the image or bitmap or text being displayed in it. .OP \-state state State Specifies one of three states for the label: \fBnormal\fR, \fBactive\fR, or \fBdisabled\fR. In normal state the button is displayed using the -\fBforeground\fR and \fBbackground\fR options. In active state -the label is displayed using the \fBactiveForeground\fR and -\fBactiveBackground\fR options. In the disabled state the -\fBdisabledForeground\fR and \fBbackground\fR options determine how +\fB\-foreground\fR and \fB\-background\fR options. In active state +the label is displayed using the \fB\-activeforeground\fR and +\fB\-activebackground\fR options. In the disabled state the +\fB\-disabledforeground\fR and \fB\-background\fR options determine how the button is displayed. .OP \-width width Width Specifies a desired width for the label. @@ -65,9 +63,9 @@ there must not exist a window named \fIpathName\fR, but A label is a widget that displays a textual string, bitmap or image. If text is displayed, it must all be in a single font, but it can occupy multiple lines on the screen (if it contains newlines -or if wrapping occurs because of the \fBwrapLength\fR option) and +or if wrapping occurs because of the \fB\-wraplength\fR option) and one of the characters may optionally be underlined using the -\fBunderline\fR option. +\fB\-underline\fR option. The label can be manipulated in a few simple ways, such as changing its relief or text, using the commands described below. .SH "WIDGET COMMAND" @@ -115,7 +113,7 @@ labels are not intended to be interactive. \fBlabel\fR .l \-text "Left\enHand\enSide" \fBlabel\fR .r \-text "Right\enHand\enSide" text .mid -\.mid insert end "This layout is like Java's BorderLayout" +\&.mid insert end "This layout is like Java's BorderLayout" # Lay them out pack .t \-side top \-fill x pack .b \-side bottom \-fill x diff --git a/doc/labelframe.n b/doc/labelframe.n index 84be637..2bb865d 100644 --- a/doc/labelframe.n +++ b/doc/labelframe.n @@ -5,8 +5,6 @@ '\" 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.10 2008/09/23 13:36:41 dkf Exp $ -'\" .so man.macros .TH labelframe n 8.4 Tk "Tk Built-In Commands" .BS @@ -23,7 +21,7 @@ labelframe \- Create and manipulate labelframe widgets .SE .SH "WIDGET-SPECIFIC OPTIONS" .OP \-background background Background -This option is the same as the standard \fBbackground\fR option +This option is the same as the standard \fB\-background\fR option except that its value may also be specified as an empty string. In this case, the widget will display no background or border, and no colors will be consumed from its colormap for its background @@ -33,7 +31,7 @@ Specifies a class for the window. This class will be used when querying the option database for the window's other options, and it will also be used later for other purposes such as bindings. -The \fBclass\fR option may not be changed with the \fBconfigure\fR +The \fB\-class\fR option may not be changed with the \fBconfigure\fR widget command. .OP \-colormap colormap Colormap Specifies a colormap to use for the window. @@ -42,7 +40,7 @@ created for the window and its children, or the name of another window (which must be on the same screen and have the same visual as \fIpathName\fR), in which case the new window will use the colormap from the specified window. -If the \fBcolormap\fR option is not specified, the new window +If the \fB\-colormap\fR option is not specified, the new window uses the same colormap as its parent. This option may not be changed with the \fBconfigure\fR widget command. @@ -68,7 +66,7 @@ Specifies visual information for the new window in any of the forms accepted by \fBTk_GetVisual\fR. If this option is not specified, the new window will use the same visual as its parent. -The \fBvisual\fR option may not be modified with the \fBconfigure\fR +The \fB\-visual\fR option may not be modified with the \fBconfigure\fR widget command. .OP \-width width Width Specifies the desired width for the window in any of the forms diff --git a/doc/listbox.n b/doc/listbox.n index ae6f828..709b702 100644 --- a/doc/listbox.n +++ b/doc/listbox.n @@ -5,8 +5,6 @@ '\" 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.22 2009/11/02 00:40:08 dkf Exp $ -'\" .so man.macros .TH listbox n 8.4 Tk "Tk Built-In Commands" .BS @@ -77,7 +75,7 @@ When first created, a new listbox has no elements. Elements may be added or deleted using widget commands described below. In addition, one or more elements may be selected as described below. -If a listbox is exporting its selection (see \fBexportSelection\fR +If a listbox is exporting its selection (see \fB\-exportselection\fR option), then it will observe the standard X11 protocols for handling the selection. Listbox selections are available as type \fBSTRING\fR; @@ -87,8 +85,8 @@ newlines separating the elements. It is not necessary for all the elements to be displayed in the listbox window at once; commands described below may be used to change the view in the window. Listboxes allow -scrolling in both directions using the standard \fBxScrollCommand\fR -and \fByScrollCommand\fR options. +scrolling in both directions using the standard \fB\-xscrollcommand\fR +and \fB\-yscrollcommand\fR options. They also support scanning, as described below. .SH "INDICES" .PP @@ -98,20 +96,24 @@ An index specifies a particular element of the listbox, in any of the following ways: .TP 12 \fInumber\fR +. Specifies the element as a numerical index, where 0 corresponds to the first element in the listbox. .TP 12 \fBactive\fR +. Indicates the element that has the location cursor. This element will be displayed as specified by \fB\-activestyle\fR when the listbox has the keyboard focus, and it is specified with the \fBactivate\fR widget command. .TP 12 \fBanchor\fR +. Indicates the anchor point for the selection, which is set with the \fBselection anchor\fR widget command. .TP 12 \fBend\fR +. Indicates the end of the listbox. For most commands this refers to the last element in the listbox, but for a few commands such as \fBindex\fR and \fBinsert\fR @@ -140,6 +142,7 @@ determine the exact behavior of the command. The following commands are possible for listbox widgets: .TP \fIpathName \fBactivate\fR \fIindex\fR +. Sets the active element to the one indicated by \fIindex\fR. If \fIindex\fR is outside the range of elements in the listbox then the closest element is activated. @@ -148,6 +151,7 @@ widget has the input focus, and its index may be retrieved with the index \fBactive\fR. .TP \fIpathName \fBbbox\fR \fIindex\fR +. Returns a list of four numbers describing the bounding box of the text in the element given by \fIindex\fR. The first two elements of the list give the x and y coordinates @@ -162,12 +166,14 @@ partially visible, the result gives the full area of the element, including any parts that are not visible. .TP \fIpathName \fBcget\fR \fIoption\fR +. Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBlistbox\fR command. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? +. Query or modify the configuration options of the widget. If no \fIoption\fR is specified, returns a list describing all of the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for @@ -182,18 +188,21 @@ this case the command returns an empty string. command. .TP \fIpathName \fBcurselection\fR +. Returns a list containing the numerical indices of all of the elements in the listbox that are currently selected. If there are no elements selected in the listbox then an empty string is returned. .TP \fIpathName \fBdelete \fIfirst \fR?\fIlast\fR? +. Deletes one or more elements of the listbox. \fIFirst\fR and \fIlast\fR are indices specifying the first and last elements in the range to delete. If \fIlast\fR is not specified it defaults to \fIfirst\fR, i.e. a single element is deleted. .TP \fIpathName \fBget \fIfirst\fR ?\fIlast\fR? +. If \fIlast\fR is omitted, returns the contents of the listbox element indicated by \fIfirst\fR, or an empty string if \fIfirst\fR refers to a non-existent element. @@ -204,22 +213,26 @@ Both \fIfirst\fR and \fIlast\fR may have any of the standard forms for indices. .TP \fIpathName \fBindex \fIindex\fR +. Returns the integer index value that corresponds to \fIindex\fR. If \fIindex\fR is \fBend\fR the return value is a count of the number of elements in the listbox (not the index of the last element). .TP \fIpathName \fBinsert \fIindex \fR?\fIelement element ...\fR? +. Inserts zero or more new elements in the list just before the element given by \fIindex\fR. If \fIindex\fR is specified as \fBend\fR then the new elements are added to the end of the list. Returns an empty string. .TP \fIpathName \fBitemcget \fIindex option\fR +. Returns the current value of the item configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted -by the \fBlistbox itemconfigure\fR command. +by the \fBitemconfigure\fR command. .TP \fIpathName \fBitemconfigure \fIindex\fR ?\fIoption\fR? ?\fIvalue\fR? ?\fIoption value ...\fR? +. Query or modify the configuration options of an item in the listbox. If no \fIoption\fR is specified, returns a list describing all of the available options for the item (see \fBTk_ConfigureInfo\fR for @@ -234,40 +247,48 @@ are currently supported for items: .RS .TP \fB\-background \fIcolor\fR +. \fIColor\fR specifies the background color to use when displaying the item. It may have any of the forms accepted by \fBTk_GetColor\fR. .TP \fB\-foreground \fIcolor\fR +. \fIColor\fR specifies the foreground color to use when displaying the item. It may have any of the forms accepted by \fBTk_GetColor\fR. .TP \fB\-selectbackground \fIcolor\fR +. \fIcolor\fR specifies the background color to use when displaying the item while it is selected. It may have any of the forms accepted by \fBTk_GetColor\fR. .TP \fB\-selectforeground \fIcolor\fR +. \fIcolor\fR specifies the foreground color to use when displaying the item while it is selected. It may have any of the forms accepted by \fBTk_GetColor\fR. .RE .TP \fIpathName \fBnearest \fIy\fR +. Given a y-coordinate within the listbox window, this command returns the index of the (visible) listbox element nearest to that y-coordinate. .TP \fIpathName \fBscan\fR \fIoption args\fR +. This command is used to implement scanning on listboxes. It has two forms, depending on \fIoption\fR: .RS .TP \fIpathName \fBscan mark \fIx y\fR +. Records \fIx\fR and \fIy\fR and the current view in the listbox window; used in conjunction with later \fBscan dragto\fR commands. Typically this command is associated with a mouse button press in the widget. It returns an empty string. .TP \fIpathName \fBscan dragto \fIx y\fR. +. This command computes the difference between its \fIx\fR and \fIy\fR arguments and the \fIx\fR and \fIy\fR arguments to the last \fBscan mark\fR command for the widget. @@ -279,6 +300,7 @@ value is an empty string. .RE .TP \fIpathName \fBsee \fIindex\fR +. Adjust the view in the listbox so that the element given by \fIindex\fR is visible. If the element is already visible then the command has no effect; @@ -287,11 +309,13 @@ scrolls to bring the element into view at the edge; otherwise the listbox scrolls to center the element. .TP \fIpathName \fBselection \fIoption arg\fR +. This command is used to adjust the selection within a listbox. It has several forms, depending on \fIoption\fR: .RS .TP \fIpathName \fBselection anchor \fIindex\fR +. Sets the selection anchor to the element given by \fIindex\fR. If \fIindex\fR refers to a non-existent element, then the closest element is used. @@ -301,32 +325,38 @@ The index \fBanchor\fR may be used to refer to the anchor element. .TP \fIpathName \fBselection clear \fIfirst \fR?\fIlast\fR? +. If any of the elements between \fIfirst\fR and \fIlast\fR (inclusive) are selected, they are deselected. The selection state is not changed for elements outside this range. .TP \fIpathName \fBselection includes \fIindex\fR +. Returns 1 if the element indicated by \fIindex\fR is currently selected, 0 if it is not. .TP \fIpathName \fBselection set \fIfirst \fR?\fIlast\fR? +. Selects all of the elements in the range between \fIfirst\fR and \fIlast\fR, inclusive, without affecting the selection state of elements outside that range. .RE .TP \fIpathName \fBsize\fR +. Returns a decimal string indicating the total number of elements in the listbox. .TP -\fIpathName \fBxview \fIargs\fR +\fIpathName \fBxview \fR?\fIargs\fR +. This command is used to query and change the horizontal position of the information in the widget's window. It can take any of the following forms: .RS .TP \fIpathName \fBxview\fR +. Returns a list containing two elements. Each element is a real fraction between 0 and 1; together they describe the horizontal span that is visible in the window. @@ -336,17 +366,20 @@ in the window, and 40% of the text is off-screen to the right. These are the same values passed to scrollbars via the \fB\-xscrollcommand\fR option. .TP -\fIpathName \fBxview\fR \fIindex\fR +\fIpathName \fBxview \fIindex\fR +. Adjusts the view in the window so that the character position given by \fIindex\fR is displayed at the left edge of the window. Character positions are defined by the width of the character \fB0\fR. .TP \fIpathName \fBxview moveto\fI fraction\fR +. Adjusts the view in the window so that \fIfraction\fR of the total width of the listbox text is off-screen to the left. \fIfraction\fR must be a fraction between 0 and 1. .TP \fIpathName \fBxview scroll \fInumber what\fR +. This command shifts the view in the window left or right according to \fInumber\fR and \fIwhat\fR. \fINumber\fR must be an integer. @@ -361,7 +394,8 @@ become visible; if it is positive then characters farther to the right become visible. .RE .TP -\fIpathName \fByview \fI?args\fR? +\fIpathName \fByview \fR?\fIargs\fR? +. This command is used to query and change the vertical position of the text in the widget's window. It can take any of the following forms: @@ -378,11 +412,13 @@ the last one in the window, relative to the listbox as a whole. These are the same values passed to scrollbars via the \fB\-yscrollcommand\fR option. .TP -\fIpathName \fByview\fR \fIindex\fR +\fIpathName \fByview \fIindex\fR +. Adjusts the view in the window so that the element given by \fIindex\fR is displayed at the top of the window. .TP \fIpathName \fByview moveto\fI fraction\fR +. Adjusts the view in the window so that the element given by \fIfraction\fR appears at the top of the window. \fIFraction\fR is a fraction between 0 and 1; 0 indicates the first @@ -390,6 +426,7 @@ element in the listbox, 0.33 indicates the element one-third the way through the listbox, and so on. .TP \fIpathName \fByview scroll \fInumber what\fR +. This command adjusts the view in the window up or down according to \fInumber\fR and \fIwhat\fR. \fINumber\fR must be an integer. @@ -405,7 +442,7 @@ become visible. .PP Tk automatically creates class bindings for listboxes that give them Motif-like behavior. Much of the behavior of a listbox is determined -by its \fBselectMode\fR option, which selects one of four ways +by its \fB\-selectmode\fR option, which selects one of four ways of dealing with the selection. .PP If the selection mode is \fBsingle\fR or \fBbrowse\fR, at most one diff --git a/doc/loadTk.n b/doc/loadTk.n index 06f7336..6d4b070 100644 --- a/doc/loadTk.n +++ b/doc/loadTk.n @@ -4,8 +4,6 @@ '\" 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.16 2010/01/14 14:00:39 dkf Exp $ -'\" .so man.macros .TH "Safe Tk" n 8.0 Tk "Tk Built-In Commands" .BS diff --git a/doc/lower.n b/doc/lower.n index b81ddfb..0d8f252 100644 --- a/doc/lower.n +++ b/doc/lower.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: lower.n,v 1.5 2008/09/23 13:36:42 dkf Exp $ -'\" .so man.macros .TH lower n 3.3 Tk "Tk Built-In Commands" .BS @@ -29,6 +27,10 @@ In this case the \fBlower\fR command will insert \fIwindow\fR into the stacking order just below \fIbelowThis\fR (or the ancestor of \fIbelowThis\fR that is a sibling of \fIwindow\fR); this could end up either raising or lowering \fIwindow\fR. +.PP +All \fBtoplevel\fR windows may be restacked with respect to each +other, whatever their relative path names, but the window manager is +not obligated to strictly honor requests to restack. .SH "SEE ALSO" raise .SH KEYWORDS @@ -5,8 +5,6 @@ '\" 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.33 2010/01/10 20:38:54 dkf Exp $ -'\" .so man.macros .TH menu n 4.1 Tk "Tk Built-In Commands" .BS @@ -209,7 +207,7 @@ supported on Windows. .SS "TEAR-OFF ENTRIES" .PP A tear-off entry appears at the top of the menu if enabled with the -\fBtearOff\fR option. It is not like other menu entries in that +\fB\-tearoff\fR option. It is not like other menu entries in that it cannot be created with the \fBadd\fR widget command and cannot be deleted with the \fBdelete\fR widget command. When a tear-off entry is created it appears as a dashed line at @@ -238,12 +236,12 @@ Certain menus in a menubar will be treated specially. On the Macintosh, access to the special Application, Window and Help menus is provided. On Windows, access to the Windows System menu in each window is provided. On X Windows, a special right-justified help menu may be provided if -Motif menu compatibility is enabled. In all -cases, these menus must be created with the command name of the menubar -menu concatenated with the special name. So for a menubar named -\.menubar, on the Macintosh, the special menus would be .menubar.apple, -\.menubar.window and .menubar.help; on Windows, the special menu would be -\.menubar.system; on X Windows, the help menu would be .menubar.help. +Motif menu compatibility is enabled. In all cases, these menus must be +created with the command name of the menubar menu concatenated with the +special name. So for a menubar named .menubar, on the Macintosh, the +special menus would be .menubar.apple, .menubar.window and .menubar.help; +on Windows, the special menu would be .menubar.system; on X Windows, +the help menu would be .menubar.help. .PP When Tk sees a .menubar.apple menu as the first menu in a menubar on the Macintosh, that menu's contents make up the first items of the @@ -352,7 +350,7 @@ indicates the top-most entry in the window. If the index does not satisfy one of the above forms then this form is used. \fIPattern\fR is pattern-matched against the label of each entry in the menu, in order from the top down, until a -matching entry is found. The rules of \fBTcl_StringMatch\fR +matching entry is found. The rules of \fBstring match\fR are used. .PP The following widget commands are possible for menu widgets: @@ -376,14 +374,14 @@ are present, they specify the options listed in the \fBMENU ENTRY OPTIONS\fR section below. The \fBadd\fR widget command returns an empty string. .TP -\fIpathName \fBcget\fR \fIoption\fR +\fIpathName \fBcget \fIoption\fR . Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBmenu\fR command. .TP -\fIpathName\fR \fBclone\fR \fInewPathname\fR ?\fIcloneType\fR? +\fIpathName \fBclone \fInewPathname\fR ?\fIcloneType\fR? . Makes a clone of the current menu named \fInewPathName\fR. This clone is a menu in its own right, but any changes to the clone are @@ -413,9 +411,9 @@ Delete all of the menu entries between \fIindex1\fR and \fIindex2\fR inclusive. If \fIindex2\fR is omitted then it defaults to \fIindex1\fR. Attempts to delete a tear-off menu entry are ignored (instead, you -should change the \fBtearOff\fR option to remove the tear-off entry). +should change the \fB\-tearoff\fR option to remove the tear-off entry). .TP -\fIpathName \fBentrycget\fR \fIindex option\fR +\fIpathName \fBentrycget \fIindex option\fR . Returns the current value of a configuration option for the entry given by \fIindex\fR. @@ -467,7 +465,7 @@ Arrange for the menu to be displayed on the screen at the root-window coordinates given by \fIx\fR and \fIy\fR. These coordinates are adjusted if necessary to guarantee that the entire menu is visible on the screen. This command normally returns an empty string. -If the \fBpostCommand\fR option has been specified, then its value is +If the \fB\-postcommand\fR option has been specified, then its value is executed as a Tcl script before posting the menu and the result of that script is returned as the result of the \fBpost\fR widget command. @@ -515,7 +513,7 @@ supported by all entry types. Specifies a background color to use for displaying this entry when it is active. If this option is specified as an empty string (the default), then the -\fBactiveBackground\fR option for the overall menu is used. +\fB\-activebackground\fR option for the overall menu is used. If the \fBtk_strictMotif\fR variable has been set to request strict Motif compliance, then this option is ignored and the \fB\-background\fR option is used in its place. @@ -526,7 +524,7 @@ This option is not available for separator or tear-off entries. Specifies a foreground color to use for displaying this entry when it is active. If this option is specified as an empty string (the default), then the -\fBactiveForeground\fR option for the overall menu is used. +\fB\-activeforeground\fR option for the overall menu is used. This option is not available for separator or tear-off entries. .TP \fB\-accelerator \fIvalue\fR @@ -541,7 +539,7 @@ is not available for separator or tear-off entries. Specifies a background color to use for displaying this entry when it is in the normal state (neither active nor disabled). If this option is specified as an empty string (the default), then the -\fBbackground\fR option for the overall menu is used. +\fB\-background\fR option for the overall menu is used. This option is not available for separator or tear-off entries. .TP \fB\-bitmap \fIvalue\fR @@ -584,7 +582,7 @@ options. Specifies the font to use when drawing the label or accelerator string in this entry. If this option is specified as an empty string (the default) then -the \fBfont\fR option for the overall menu is used. +the \fB\-font\fR option for the overall menu is used. This option is not available for separator or tear-off entries. .TP \fB\-foreground \fIvalue\fR @@ -592,7 +590,7 @@ This option is not available for separator or tear-off entries. Specifies a foreground color to use for displaying this entry when it is in the normal state (neither active nor disabled). If this option is specified as an empty string (the default), then the -\fBforeground\fR option for the overall menu is used. +\fB\-foreground\fR option for the overall menu is used. This option is not available for separator or tear-off entries. .TP \fB\-hidemargin \fIvalue\fR @@ -647,7 +645,7 @@ store in the entry's associated variable when the entry is selected. Available only for checkbutton and radiobutton entries. Specifies the color to display in the indicator when the entry is selected. -If the value is an empty string (the default) then the \fBselectColor\fR +If the value is an empty string (the default) then the \fB\-selectcolor\fR option for the menu determines the indicator color. .TP \fB\-selectimage \fIvalue\fR @@ -664,17 +662,17 @@ been specified. . Specifies one of three states for the entry: \fBnormal\fR, \fBactive\fR, or \fBdisabled\fR. In normal state the entry is displayed using the -\fBforeground\fR option for the menu and the \fBbackground\fR +\fB\-foreground\fR option for the menu and the \fB\-background\fR option from the entry or the menu. The active state is typically used when the pointer is over the entry. -In active state the entry is displayed using the \fBactiveForeground\fR -option for the menu along with the \fBactivebackground\fR option from +In active state the entry is displayed using the \fB\-activeforeground\fR +option for the menu along with the \fB\-activebackground\fR option from the entry. Disabled state means that the entry should be insensitive: the default bindings will refuse to activate or invoke the entry. In this state the entry is displayed according to the -\fBdisabledForeground\fR option for the menu and the -\fBbackground\fR option from the entry. +\fB\-disabledforeground\fR option for the menu and the +\fB\-background\fR option from the entry. This option is not available for separator entries. .TP \fB\-underline \fIvalue\fR diff --git a/doc/menubar.n b/doc/menubar.n index 16509d7..0f6dd83 100644 --- a/doc/menubar.n +++ b/doc/menubar.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: menubar.n,v 1.6 2008/09/23 13:36:42 dkf Exp $ -'\" .so man.macros .TH tk_menuBar n "" Tk "Tk Built-In Commands" .BS diff --git a/doc/menubutton.n b/doc/menubutton.n index c619240..c8b0958 100644 --- a/doc/menubutton.n +++ b/doc/menubutton.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: menubutton.n,v 1.12 2008/09/23 13:36:42 dkf Exp $ -'\" .so man.macros .TH menubutton n 4.0 Tk "Tk Built-In Commands" .BS @@ -55,12 +53,12 @@ Specifies one of three states for the menubutton: \fBnormal\fR, \fBactive\fR, or \fBdisabled\fR. In normal state the menubutton is displayed using the \fBforeground\fR and \fBbackground\fR options. The active state is typically used when the pointer is over the menubutton. In active state -the menubutton is displayed using the \fBactiveForeground\fR and -\fBactiveBackground\fR options. Disabled state means that the menubutton +the menubutton is displayed using the \fB\-activeforeground\fR and +\fB\-activebackground\fR options. Disabled state means that the menubutton should be insensitive: the default bindings will refuse to activate the widget and will ignore mouse button presses. -In this state the \fBdisabledForeground\fR and -\fBbackground\fR options determine how the button is displayed. +In this state the \fB\-disabledforeground\fR and +\fB\-background\fR options determine how the button is displayed. .OP \-width width Width Specifies a desired width for the menubutton. If an image or bitmap is being displayed in the menubutton then the value is in @@ -86,9 +84,9 @@ A menubutton is a widget that displays a textual string, bitmap, or image and is associated with a menu widget. If text is displayed, it must all be in a single font, but it can occupy multiple lines on the screen (if it contains newlines -or if wrapping occurs because of the \fBwrapLength\fR option) and +or if wrapping occurs because of the \fB\-wraplength\fR option) and one of the characters may optionally be underlined using the -\fBunderline\fR option. In normal usage, pressing +\fB\-underline\fR option. In normal usage, pressing mouse button 1 over the menubutton causes the associated menu to be posted just underneath the menubutton. If the mouse is moved over the menu before releasing the mouse button, the button release @@ -119,7 +117,7 @@ operations on the widget. It has the following general form: determine the exact behavior of the command. The following commands are possible for menubutton widgets: .TP -\fIpathName \fBcget\fR \fIoption\fR +\fIpathName \fBcget \fIoption\fR Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBmenubutton\fR @@ -170,7 +168,7 @@ When a menubutton is posted, its associated menu claims the input focus to allow keyboard traversal of the menu and its submenus. See the \fBmenu\fR manual entry for details on these bindings. .IP [7] -If the \fBunderline\fR option has been specified for a menubutton +If the \fB\-underline\fR option has been specified for a menubutton then keyboard traversal may be used to post the menubutton: Alt+\fIx\fR, where \fIx\fR is the underlined character (or its lower-case or upper-case equivalent), may be typed in any window diff --git a/doc/message.n b/doc/message.n index 48ef249..61be2f0 100644 --- a/doc/message.n +++ b/doc/message.n @@ -5,8 +5,6 @@ '\" 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.11 2008/09/23 13:36:45 dkf Exp $ -'\" .so man.macros .TH message n 4.0 Tk "Tk Built-In Commands" .BS @@ -30,37 +28,37 @@ aspect ratio for the text. The aspect ratio is specified as be as wide as it is tall, 200 means the text should be twice as wide as it is tall, 50 means the text should be twice as tall as it is wide, and so on. -Used to choose line length for text if \fBwidth\fR option +Used to choose line length for text if \fB\-width\fR option is not specified. Defaults to 150. .OP \-justify justify Justify Specifies how to justify lines of text. Must be one of \fBleft\fR, \fBcenter\fR, or \fBright\fR. Defaults to \fBleft\fR. -This option works together with the \fBanchor\fR, \fBaspect\fR, -\fBpadX\fR, \fBpadY\fR, and \fBwidth\fR options to provide a variety +This option works together with the \fB\-anchor\fR, \fB\-aspect\fR, +\fB\-padx\fR, \fB\-pady\fR, and \fB\-width\fR options to provide a variety of arrangements of the text within the window. -The \fBaspect\fR and \fBwidth\fR options determine the amount of +The \fB\-aspect\fR and \fB\-width\fR options determine the amount of screen space needed to display the text. -The \fBanchor\fR, \fBpadX\fR, and \fBpadY\fR options determine where this +The \fB\-anchor\fR, \fB\-padx\fR, and \fB\-pady\fR options determine where this rectangular area is displayed within the widget's window, and the -\fBjustify\fR option determines how each line is displayed within that +\fB\-justify\fR option determines how each line is displayed within that rectangular region. -For example, suppose \fBanchor\fR is \fBe\fR and \fBjustify\fR is +For example, suppose \fB\-anchor\fR is \fBe\fR and \fB\-justify\fR is \fBleft\fR, and that the message window is much larger than needed for the text. The text will be displayed so that the left edges of all the lines -line up and the right edge of the longest line is \fBpadX\fR from +line up and the right edge of the longest line is \fB\-padx\fR from the right side of the window; the entire text block will be centered in the vertical span of the window. .OP \-width width Width Specifies the length of lines in the window. The value may have any of the forms acceptable to \fBTk_GetPixels\fR. -If this option has a value greater than zero then the \fBaspect\fR -option is ignored and the \fBwidth\fR option determines the line +If this option has a value greater than zero then the \fB\-aspect\fR +option is ignored and the \fB\-width\fR option determines the line length. If this option has a value less than or equal to zero, then -the \fBaspect\fR option determines the line length. +the \fB\-aspect\fR option determines the line length. .BE .SH DESCRIPTION .PP @@ -113,7 +111,7 @@ operations on the widget. It has the following general form: determine the exact behavior of the command. The following commands are possible for message widgets: .TP -\fIpathName \fBcget\fR \fIoption\fR +\fIpathName \fBcget \fIoption\fR Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBmessage\fR diff --git a/doc/messageBox.n b/doc/messageBox.n index d956f7e..db24f76 100644 --- a/doc/messageBox.n +++ b/doc/messageBox.n @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: messageBox.n,v 1.13 2009/04/04 16:18:37 dkf Exp $ -'\" .so man.macros .TH tk_messageBox n 4.2 Tk "Tk Built-In Commands" .BS diff --git a/doc/option.n b/doc/option.n index cd83ca5..4b9a5a7 100644 --- a/doc/option.n +++ b/doc/option.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: option.n,v 1.11 2010/01/10 20:38:54 dkf Exp $ -'\" .so man.macros .TH option n "" Tk "Tk Built-In Commands" .BS diff --git a/doc/optionMenu.n b/doc/optionMenu.n index ccf9440..1c01eb0 100644 --- a/doc/optionMenu.n +++ b/doc/optionMenu.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: optionMenu.n,v 1.8 2008/09/23 13:36:45 dkf Exp $ -'\" .so man.macros .TH tk_optionMenu n 4.0 Tk "Tk Built-In Commands" .BS diff --git a/doc/options.n b/doc/options.n index ef3ba8c..456e1fd 100644 --- a/doc/options.n +++ b/doc/options.n @@ -5,8 +5,6 @@ '\" 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.18 2008/09/23 13:36:45 dkf Exp $ -'\" .so man.macros .TH options n 4.4 Tk "Tk Built-In Commands" .BS @@ -74,18 +72,18 @@ widget. Specifies a bitmap to display in the widget, in any of the forms acceptable to \fBTk_GetBitmap\fR. The exact way in which the bitmap is displayed may be affected by -other options such as \fBanchor\fR or \fBjustify\fR. +other options such as \fB\-anchor\fR or \fB\-justify\fR. Typically, if this option is specified then it overrides other options that specify a textual value to display in the widget -but this is controlled by the \fBcompound\fR option; -the \fBbitmap\fR option may be reset to an empty string to re-enable +but this is controlled by the \fB\-compound\fR option; +the \fB\-bitmap\fR option may be reset to an empty string to re-enable a text display. -In widgets that support both \fBbitmap\fR and \fBimage\fR options, -\fBimage\fR will usually override \fBbitmap\fR. +In widgets that support both \fB\-bitmap\fR and \fB\-image\fR options, +\fB\-image\fR will usually override \fB\-bitmap\fR. .OP "\-borderwidth or \-bd" borderWidth BorderWidth Specifies a non-negative value indicating the width of the 3-D border to draw around the outside of the widget (if such a -border is being drawn; the \fBrelief\fR option typically determines +border is being drawn; the \fB\-relief\fR option typically determines this). The value may also be used when drawing 3-D effects in the interior of the widget. The value may have any of the forms acceptable to \fBTk_GetPixels\fR. @@ -141,10 +139,10 @@ If the value is zero, no focus highlight is drawn around the widget. .OP \-image image Image Specifies an image to display in the widget, which must have been created with the \fBimage create\fR command. -Typically, if the \fBimage\fR option is specified then it overrides other +Typically, if the \fB\-image\fR option is specified then it overrides other options that specify a bitmap or textual value to display in the -widget, though this is controlled by the \fBcompound\fR option; -the \fBimage\fR option may be reset to an empty string to re-enable +widget, though this is controlled by the \fB\-compound\fR option; +the \fB\-image\fR option may be reset to an empty string to re-enable a bitmap or text display. .OP \-insertbackground insertBackground Foreground Specifies the color to use as background in the area covered by the @@ -171,8 +169,8 @@ in each blink cycle. Specifies a value indicating the total width of the insertion cursor. The value may have any of the forms acceptable to \fBTk_GetPixels\fR. If a border has been specified for the insertion -cursor (using the \fBinsertBorderWidth\fR option), the border -will be drawn inside the width specified by the \fBinsertWidth\fR +cursor (using the \fB\-insertborderwidth\fR option), the border +will be drawn inside the width specified by the \fB\-insertwidth\fR option. .OP \-jump jump Jump For widgets with a slider that can be dragged to adjust a value, @@ -237,7 +235,7 @@ Specifies the number of milliseconds a button or key must be held down before it begins to auto-repeat. Used, for example, on the up- and down-arrows in scrollbars. .OP \-repeatinterval repeatInterval RepeatInterval -Used in conjunction with \fBrepeatDelay\fR: once auto-repeat +Used in conjunction with \fB\-repeatdelay\fR: once auto-repeat begins, this option determines the number of milliseconds between auto-repeats. .OP \-selectbackground selectBackground Foreground @@ -257,7 +255,7 @@ This option is typically used in text widgets, where the information in the widget has a natural size (the size of a character) and it makes sense for the window's dimensions to be integral numbers of these units. These natural window sizes form a grid. -If the \fBsetGrid\fR option is set to true then the widget will +If the \fB\-setgrid\fR option is set to true then the widget will communicate with the window manager so that when the user interactively resizes the top-level window that contains the widget, the dimensions of the window will be displayed to the user in grid units and the window @@ -268,7 +266,7 @@ entry for more details. Determines whether the window accepts the focus during keyboard traversal (e.g., Tab and Shift-Tab). Before setting the focus to a window, the traversal scripts -consult the value of the \fBtakeFocus\fR option. +consult the value of the \fB\-takefocus\fR option. A value of \fB0\fR means that the window should be skipped entirely during keyboard traversal. \fB1\fR means that the window should receive the input @@ -291,14 +289,14 @@ redefine the keyboard traversal scripts. .OP \-text text Text Specifies a string to be displayed inside the widget. The way in which the string is displayed depends on the particular widget and may be -determined by other options, such as \fBanchor\fR or \fBjustify\fR. +determined by other options, such as \fB\-anchor\fR or \fB\-justify\fR. .OP \-textvariable textVariable Variable Specifies the name of a global variable. The value of the variable is a text string to be displayed inside the widget; if the variable value changes then the widget will automatically update itself to reflect the new value. The way in which the string is displayed in the widget depends on the particular widget and may be determined by other options, such as -\fBanchor\fR or \fBjustify\fR. +\fB\-anchor\fR or \fB\-justify\fR. .OP \-troughcolor troughColor Background Specifies the color to use for the rectangular trough areas in widgets such as scrollbars and scales. This option is ignored for @@ -336,7 +334,7 @@ that is visible in the window, and the second fraction indicates 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 +\fB\-xscrollcommand\fR option consists of the path name of a scrollbar widget followed by .QW set , e.g. @@ -347,9 +345,9 @@ If this option is not specified, then no command will be executed. .OP \-yscrollcommand yScrollCommand ScrollCommand Specifies the prefix for a command used to communicate with vertical scrollbars. This option is treated in the same way as the -\fBxScrollCommand\fR option, except that it is used for vertical +\fB\-xscrollcommand\fR option, except that it is used for vertical scrollbars and is provided by widgets that support vertical scrolling. -See the description of \fBxScrollCommand\fR for details +See the description of \fB\-xscrollcommand\fR for details on how this option is used. .SH "SEE ALSO" colors, cursors, font diff --git a/doc/pack-old.n b/doc/pack-old.n index 63672e8..a027b1f 100644 --- a/doc/pack-old.n +++ b/doc/pack-old.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: pack-old.n,v 1.7 2008/09/23 13:36:45 dkf Exp $ -'\" .so man.macros .TH pack-old n 4.0 Tk "Tk Built-In Commands" .BS @@ -5,8 +5,6 @@ '\" 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.13 2008/09/23 13:36:45 dkf Exp $ -'\" .so man.macros .TH pack n 4.0 Tk "Tk Built-In Commands" .BS @@ -268,7 +266,7 @@ label .b \-text "This widget is at the bottom" \-bg green label .l \-text "Left\enHand\enSide" label .r \-text "Right\enHand\enSide" text .mid -\.mid insert end "This layout is like Java's BorderLayout" +\&.mid insert end "This layout is like Java's BorderLayout" # Lay them out \fBpack\fR .t \-side top \-fill x \fBpack\fR .b \-side bottom \-fill x diff --git a/doc/palette.n b/doc/palette.n index c50ca38..d654959 100644 --- a/doc/palette.n +++ b/doc/palette.n @@ -4,8 +4,6 @@ '\" 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.10 2008/09/23 13:36:45 dkf Exp $ -'\" .so man.macros .TH tk_setPalette n 4.0 Tk "Tk Built-In Commands" .BS diff --git a/doc/panedwindow.n b/doc/panedwindow.n index 654c59d..17d5730 100644 --- a/doc/panedwindow.n +++ b/doc/panedwindow.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: panedwindow.n,v 1.16 2008/09/23 13:36:45 dkf Exp $ -'\" .so man.macros .TH panedwindow n 8.4 Tk "Tk Built-In Commands" .BS @@ -83,7 +81,8 @@ the panedwindow widget's path name. \fIOption\fR and the \fIarg\fRs determine the exact behavior of the command. The following commands are possible for panedwindow widgets: .TP -\fIpathName \fBadd \fIwindow ?window ...? ?option value ...?\fR +\fIpathName \fBadd \fIwindow \fR?\fIwindow ...\fR? ?\fIoption value ...\fR? +. Add one or more windows to the panedwindow, each in a separate pane. The arguments consist of the names of one or more windows followed by pairs of arguments that specify how to manage the windows. @@ -91,11 +90,13 @@ followed by pairs of arguments that specify how to manage the windows. \fBconfigure\fR subcommand. .TP \fIpathName \fBcget \fIoption\fR +. Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBpanedwindow\fR command. .TP -\fIpathName \fBconfigure \fI?option? ?value option value ...?\fR +\fIpathName \fBconfigure \fR?\fIoption\fR? ?\fIvalue option value ...\fR? +. Query or modify the configuration options of the widget. If no \fIoption\fR is specified, returns a list describing all of the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for @@ -108,11 +109,13 @@ modifies the given widget option(s) to have the given value(s); in this case the command returns an empty string. \fIOption\fR may have any of the values accepted by the \fBpanedwindow\fR command. .TP -\fIpathName \fBforget \fIwindow ?window ...?\fR +\fIpathName \fBforget \fIwindow \fR?\fIwindow ...\fR? +. Remove the pane containing \fIwindow\fR from the panedwindow. All geometry management options for \fIwindow\fR will be forgotten. .TP \fIpathName \fBidentify \fIx y\fR +. Identify the panedwindow component underneath the point given by \fIx\fR and \fIy\fR, in window coordinates. If the point is over a sash or a sash handle, the result is a two element list containing the @@ -120,53 +123,63 @@ index of the sash or handle, and a word indicating whether it is over a sash or a handle, such as {0 sash} or {2 handle}. If the point is over any other part of the panedwindow, the result is an empty list. .TP -\fIpathName \fBproxy \fI?args?\fR +\fIpathName \fBproxy \fR?\fIargs\fR? +. This command is used to query and change the position of the sash proxy, used for rubberband-style pane resizing. It can take any of the following forms: .RS .TP \fIpathName \fBproxy coord\fR +. Return a list containing the x and y coordinates of the most recent proxy location. .TP \fIpathName \fBproxy forget\fR +. Remove the proxy from the display. .TP \fIpathName \fBproxy place \fIx y\fR +. Place the proxy at the given \fIx\fR and \fIy\fR coordinates. .RE .TP -\fIpathName \fBsash \fI?args?\fR +\fIpathName \fBsash \fR?\fIargs\fR? This command is used to query and change the position of sashes in the panedwindow. It can take any of the following forms: .RS .TP \fIpathName \fBsash coord \fIindex\fR +. Return the current x and y coordinate pair for the sash given by \fIindex\fR. \fIIndex\fR must be an integer between 0 and 1 less than the number of panes in the panedwindow. The coordinates given are those of the top left corner of the region containing the sash. .TP \fIpathName \fBsash dragto \fIindex x y\fR +. This command computes the difference between the given coordinates and the coordinates given to the last \fBsash mark\fR command for the given sash. It then moves that sash the computed difference. The return value is the empty string. .TP \fIpathName \fBsash mark \fIindex x y\fR +. Records \fIx\fR and \fIy\fR for the sash given by \fIindex\fR; used in conjunction with later \fBsash dragto\fR commands to move the sash. .TP \fIpathName \fBsash place \fIindex x y\fR +. Place the sash given by \fIindex\fR at the given coordinates. .RE .TP \fIpathName \fBpanecget \fIwindow option\fR +. Query a management option for \fIwindow\fR. \fIOption\fR may be any value allowed by the \fBpaneconfigure\fR subcommand. .TP -\fIpathName \fBpaneconfigure \fIwindow ?option? ?value option value ...?\fR +\fIpathName \fBpaneconfigure \fIwindow \fR?\fIoption\fR? ?\fIvalue option value ...\fR? +. Query or modify the management options for \fIwindow\fR. If no \fIoption\fR is specified, returns a list describing all of the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for @@ -181,14 +194,17 @@ are supported: .RS .TP \fB\-after \fIwindow\fR +. Insert the window after the window specified. \fIwindow\fR should be the name of a window already managed by \fIpathName\fR. .TP \fB\-before \fIwindow\fR +. Insert the window before the window specified. \fIwindow\fR should be the name of a window already managed by \fIpathName\fR. .TP \fB\-height \fIsize\fR +. Specify a height for the window. The height will be the outer dimension of the window including its border, if any. If \fIsize\fR is an empty string, or if \fB\-height\fR is not specified, then the @@ -197,11 +213,13 @@ height may later be adjusted by the movement of sashes in the panedwindow. \fISize\fR may be any value accepted by \fBTk_GetPixels\fR. .TP \fB\-hide \fIboolean\fR +. Controls the visibility of a pane. When the \fIboolean\fR is true (according to \fBTcl_GetBoolean\fR) the pane will not be visible, but it will still be maintained in the list of panes. .TP \fB\-minsize \fIn\fR +. Specifies that the size of the window cannot be made less than \fIn\fR. This constraint only affects the size of the widget in the paned dimension \(em the x dimension for horizontal panedwindows, the y @@ -209,16 +227,19 @@ dimension for vertical panedwindows. May be any value accepted by \fBTk_GetPixels\fR. .TP \fB\-padx \fIn\fR +. Specifies a non-negative value indicating how much extra space to leave on each side of the window in the X-direction. The value may have any of the forms accepted by \fBTk_GetPixels\fR. .TP \fB\-pady \fIn\fR +. Specifies a non-negative value indicating how much extra space to leave on each side of the window in the Y-direction. The value may have any of the forms accepted by \fBTk_GetPixels\fR. .TP \fB\-sticky \fIstyle\fR +. If a window's pane is larger than the requested dimensions of the window, this option may be used to position (or stretch) the window within its pane. \fIStyle\fR is a string that contains zero or more @@ -232,6 +253,7 @@ are specified, the window will be stretched to fill the entire height (or width) of its cavity. .TP \fB\-stretch \fIwhen\fR +. Controls how extra space is allocated to each of the panes. \fIWhen\fR is one of \fBalways\fR, \fBfirst\fR, \fBlast\fR, \fBmiddle\fR, and \fBnever\fR. @@ -243,24 +265,30 @@ definition: .RS .TP \fBalways\fR +. This pane will always stretch. .TP \fBfirst\fR +. Only if this pane is the first pane (left-most or top-most) will it stretch. .TP \fBlast\fR +. Only if this pane is the last pane (right-most or bottom-most) will it stretch. This is the default value. .TP \fBmiddle\fR +. Only if this pane is not the first or last pane will it stretch. .TP \fBnever\fR +. This pane will never stretch. .RE .TP \fB\-width \fIsize\fR +. Specify a width for the window. The width will be the outer dimension of the window including its border, if any. If \fIsize\fR is an empty string, or if \fB\-width\fR is not specified, then the @@ -270,6 +298,7 @@ panedwindow. \fISize\fR may be any value accepted by \fBTk_GetPixels\fR. .RE .TP \fIpathName \fBpanes\fR +. Returns an ordered list of the widgets managed by \fIpathName\fR. .SH "RESIZING PANES" .PP diff --git a/doc/photo.n b/doc/photo.n index 81bffb0..f54dc2e 100644 --- a/doc/photo.n +++ b/doc/photo.n @@ -9,8 +9,6 @@ '\" Department of Computer Science, '\" Australian National University. '\" -'\" RCS: @(#) $Id: photo.n,v 1.29 2010/04/09 14:45:35 nijtmans Exp $ -'\" .so man.macros .TH photo n 4.0 Tk "Tk Built-In Commands" .BS @@ -250,9 +248,14 @@ the specified color. Specifies the name of the image file format handler to be used. Specifically, this subcommand searches for the first handler whose name matches an initial substring of -\fIformat-name\fR and which has the capability to read this image data. -If this option is not given, this subcommand uses the first -handler that has the capability to read the image data. +\fIformat-name\fR and which has the capability to write a string +containing this image data. +If this option is not given, this subcommand uses a format that +consists of a list (one element per row) of lists (one element per +pixel/column) of colors in +.QW \fB#\fIrrggbb\fR +format (where \fIrr\fR is a pair of hexadecimal digits for the red +channel, \fIgg\fR for green, and \fIbb\fR for blue). .TP \fB\-from \fIx1 y1 x2 y2\fR . diff --git a/doc/place.n b/doc/place.n index 5f65305..af1ea43 100644 --- a/doc/place.n +++ b/doc/place.n @@ -5,8 +5,6 @@ '\" 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.13 2008/09/23 13:36:46 dkf Exp $ -'\" .so man.macros .TH place n "" Tk "Tk Built-In Commands" .BS diff --git a/doc/popup.n b/doc/popup.n index a13eb7d..2dea83f 100644 --- a/doc/popup.n +++ b/doc/popup.n @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: popup.n,v 1.7 2008/09/23 13:36:46 dkf Exp $ -'\" .so man.macros .TH tk_popup n 4.0 Tk "Tk Built-In Commands" .BS diff --git a/doc/radiobutton.n b/doc/radiobutton.n index 6a7bb05..983b43e 100644 --- a/doc/radiobutton.n +++ b/doc/radiobutton.n @@ -5,8 +5,6 @@ '\" 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.18 2008/09/23 13:36:54 dkf Exp $ -'\" .so man.macros .TH radiobutton n 4.4 Tk "Tk Built-In Commands" .BS @@ -40,16 +38,16 @@ If this option is not specified, the button's desired height is computed from the size of the image or bitmap or text being displayed in it. .OP \-indicatoron indicatorOn IndicatorOn Specifies whether or not the indicator should be drawn. Must be a -proper boolean value. If false, the \fBrelief\fR option is +proper boolean value. If false, the \fB\-relief\fR option is ignored and the widget's relief is always sunken if the widget is selected and raised otherwise. .OP \-selectcolor selectColor Background Specifies a background color to use when the button is selected. -If \fBindicatorOn\fR is true then the color applies to the indicator. +If \fB\-indicatoron\fR is true then the color applies to the indicator. Under Windows, this color is used as the background for the indicator regardless of the select state. -If \fBindicatorOn\fR is false, this color is used as the background -for the entire widget, in place of \fBbackground\fR or \fBactiveBackground\fR, +If \fB\-indicatoron\fR is false, this color is used as the background +for the entire widget, in place of \fB\-background\fR or \fB\-activeBackground\fR, whenever the widget is selected. If specified as an empty string then no special color is used for displaying when the widget is selected. @@ -74,25 +72,25 @@ raised\fR. If the value of this option is the empty string, then no alternative relief is used when the mouse cursor is over the radiobutton. The empty string is the default value. .OP \-selectimage selectImage SelectImage -Specifies an image to display (in place of the \fBimage\fR option) +Specifies an image to display (in place of the \fB\-image\fR option) when the radiobutton is selected. -This option is ignored unless the \fBimage\fR option has been +This option is ignored unless the \fB\-image\fR option has been specified. .OP \-state state State Specifies one of three states for the radiobutton: \fBnormal\fR, \fBactive\fR, or \fBdisabled\fR. In normal state the radiobutton is displayed using the -\fBforeground\fR and \fBbackground\fR options. The active state is +\fB\-foreground\fR and \fB\-background\fR options. The active state is typically used when the pointer is over the radiobutton. In active state -the radiobutton is displayed using the \fBactiveForeground\fR and -\fBactiveBackground\fR options. Disabled state means that the radiobutton +the radiobutton is displayed using the \fB\-activeforeground\fR and +\fB\-activebackground\fR options. Disabled state means that the radiobutton should be insensitive: the default bindings will refuse to activate the widget and will ignore mouse button presses. -In this state the \fBdisabledForeground\fR and -\fBbackground\fR options determine how the radiobutton is displayed. +In this state the \fB\-disabledforeground\fR and +\fB\-background\fR options determine how the radiobutton is displayed. .OP \-tristateimage tristateImage TristateImage -Specifies an image to display (in place of the \fBimage\fR option) +Specifies an image to display (in place of the \fB\-image\fR option) when the radiobutton is selected. -This option is ignored unless the \fBimage\fR option has been +This option is ignored unless the \fB\-image\fR option has been specified. .OP \-tristatevalue tristateValue Value Specifies the value that causes the radiobutton to display the multi-value @@ -131,11 +129,11 @@ A radiobutton is a widget that displays a textual string, bitmap or image and a diamond or circle called an \fIindicator\fR. If text is displayed, it must all be in a single font, but it can occupy multiple lines on the screen (if it contains newlines -or if wrapping occurs because of the \fBwrapLength\fR option) and +or if wrapping occurs because of the \fB\-wraplength\fR option) and one of the characters may optionally be underlined using the -\fBunderline\fR option. A radiobutton has +\fB\-underline\fR option. A radiobutton has all of the behavior of a simple button: it can display itself in either -of three different ways, according to the \fBstate\fR option; +of three different ways, according to the \fB\-state\fR option; it can be made to appear raised, sunken, or flat; it can be made to flash; and it invokes a Tcl command whenever mouse button 1 is clicked over the @@ -158,7 +156,7 @@ When a radiobutton is selected it sets the value of the variable to indicate that fact; each radiobutton also monitors the value of the variable and automatically selects and deselects itself when the variable's value changes. -If the variable's value matches the \fBtristateValue\fR, then the radiobutton +If the variable's value matches the \fB\-tristatevalue\fR, then the radiobutton is drawn using the tri-state mode. This mode is used to indicate mixed or multiple values. (This is used when the radiobutton represents the state of multiple items.) @@ -186,12 +184,14 @@ determine the exact behavior of the command. The following commands are possible for radiobutton widgets: .TP \fIpathName \fBcget\fR \fIoption\fR +. Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBradiobutton\fR command. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? +. Query or modify the configuration options of the widget. If no \fIoption\fR is specified, returns a list describing all of the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for @@ -206,12 +206,14 @@ this case the command returns an empty string. command. .TP \fIpathName \fBdeselect\fR +. Deselects the radiobutton and sets the associated variable to an empty string. If this radiobutton was not currently selected, the command has no effect. .TP \fIpathName \fBflash\fR +. Flashes the radiobutton. This is accomplished by redisplaying the radiobutton several times, alternating between active and normal colors. At the end of the flash the radiobutton is left in the same normal/active @@ -219,6 +221,7 @@ state as when the command was invoked. This command is ignored if the radiobutton's state is \fBdisabled\fR. .TP \fIpathName \fBinvoke\fR +. Does just what would have happened if the user invoked the radiobutton with the mouse: selects the button and invokes its associated Tcl command, if there is one. @@ -227,6 +230,7 @@ empty string if there is no command associated with the radiobutton. This command is ignored if the radiobutton's state is \fBdisabled\fR. .TP \fIpathName \fBselect\fR +. Selects the radiobutton and sets the associated variable to the value corresponding to this widget. .SH BINDINGS diff --git a/doc/raise.n b/doc/raise.n index 261fd2a..b2856c1 100644 --- a/doc/raise.n +++ b/doc/raise.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: raise.n,v 1.7 2008/09/23 13:36:54 dkf Exp $ -'\" .so man.macros .TH raise n 3.3 Tk "Tk Built-In Commands" .BS @@ -29,6 +27,10 @@ In this case the \fBraise\fR command will insert \fIwindow\fR into the stacking order just above \fIaboveThis\fR (or the ancestor of \fIaboveThis\fR that is a sibling of \fIwindow\fR); this could end up either raising or lowering \fIwindow\fR. +.PP +All \fBtoplevel\fR windows may be restacked with respect to each +other, whatever their relative path names, but the window manager is +not obligated to strictly honor requests to restack. .SH EXAMPLE .PP Make a button appear to be in a sibling frame that was created after diff --git a/doc/scale.n b/doc/scale.n index d040d6a..c8e722a 100644 --- a/doc/scale.n +++ b/doc/scale.n @@ -5,8 +5,6 @@ '\" 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.12 2008/09/23 13:36:54 dkf Exp $ -'\" .so man.macros .TH scale n 4.1 Tk "Tk Built-In Commands" .BS @@ -76,7 +74,7 @@ Specifies one of three states for the scale: \fBnormal\fR, If the scale is disabled then the value may not be changed and the scale will not activate. If the scale is active, the slider is displayed using the color -specified by the \fBactiveBackground\fR option. +specified by the \fB\-activebackground\fR option. .OP \-tickinterval tickInterval TickInterval Must be a real value. Determines the spacing between numerical @@ -85,7 +83,7 @@ If 0, no tick marks will be displayed. .OP \-to to To Specifies a real value corresponding to the right or bottom end of the scale. -This value may be either less than or greater than the \fBfrom\fR option. +This value may be either less than or greater than the \fB\-from\fR option. .OP \-variable variable Variable Specifies the name of a global variable to link to the scale. Whenever the value of the variable changes, the scale will update to reflect this @@ -113,16 +111,16 @@ there must not exist a window named \fIpathName\fR, but .PP A scale is a widget that displays a rectangular \fItrough\fR and a small \fIslider\fR. The trough corresponds to a range -of real values (determined by the \fBfrom\fR, \fBto\fR, and -\fBresolution\fR options), +of real values (determined by the \fB\-from\fR, \fB\-to\fR, and +\fB\-resolution\fR options), and the position of the slider selects a particular real value. The slider's position (and hence the scale's value) may be adjusted with the mouse or keyboard as described in the \fBBINDINGS\fR section below. Whenever the scale's value is changed, a Tcl -command is invoked (using the \fBcommand\fR option) to notify +command is invoked (using the \fB\-command\fR option) to notify other interested widgets of the change. In addition, the value -of the scale can be linked to a Tcl variable (using the \fBvariable\fR +of the scale can be linked to a Tcl variable (using the \fB\-variable\fR option), so that changes in either are reflected in the other. .PP Three annotations may be displayed in a scale widget: a label @@ -147,12 +145,14 @@ determine the exact behavior of the command. The following commands are possible for scale widgets: .TP \fIpathName \fBcget\fR \fIoption\fR +. Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBscale\fR command. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? +. Query or modify the configuration options of the widget. If no \fIoption\fR is specified, returns a list describing all of the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for @@ -167,12 +167,14 @@ this case the command returns an empty string. command. .TP \fIpathName \fBcoords \fR?\fIvalue\fR? +. Returns a list whose elements are the x and y coordinates of the point along the centerline of the trough that corresponds to \fIvalue\fR. If \fIvalue\fR is omitted then the scale's current value is used. .TP \fIpathName \fBget\fR ?\fIx y\fR? +. If \fIx\fR and \fIy\fR are omitted, returns the current value of the scale. If \fIx\fR and \fIy\fR are specified, they give pixel coordinates within the widget; the command returns @@ -180,7 +182,8 @@ the scale value corresponding to the given pixel. Only one of \fIx\fR or \fIy\fR is used: for horizontal scales \fIy\fR is ignored, and for vertical scales \fIx\fR is ignored. .TP -\fIpathName \fBidentify\fR \fIx y\fR +\fIpathName \fBidentify \fIx y\fR +. Returns a string indicating what part of the scale lies under the coordinates given by \fIx\fR and \fIy\fR. A return value of \fBslider\fR means that the point is over @@ -191,7 +194,8 @@ of the slider below or to the right of the slider. If the point is not over one of these elements, an empty string is returned. .TP -\fIpathName \fBset\fR \fIvalue\fR +\fIpathName \fBset \fIvalue\fR +. This command is invoked to change the current value of the scale, and hence the position at which the slider is displayed. \fIValue\fR gives the new value for the scale. @@ -204,7 +208,7 @@ Where the behavior is different for vertical and horizontal scales, the horizontal behavior is described in parentheses. .IP [1] If button 1 is pressed in the trough, the scale's value will -be incremented or decremented by the value of the \fBresolution\fR +be incremented or decremented by the value of the \fB\-resolution\fR option so that the slider moves in the direction of the cursor. If the button is held down, the action auto-repeats. .IP [2] @@ -220,26 +224,28 @@ position. If the mouse is dragged with button 2 down, the scale's value changes with the drag. .IP [5] The Up and Left keys move the slider up (left) by the value -of the \fBresolution\fR option. +of the \fB\-resolution\fR option. .IP [6] The Down and Right keys move the slider down (right) by the value -of the \fBresolution\fR option. +of the \fB\-resolution\fR option. .IP [7] Control-Up and Control-Left move the slider up (left) by the -value of the \fBbigIncrement\fR option. +value of the \fB\-bigincrement\fR option. .IP [8] Control-Down and Control-Right move the slider down (right) by the -value of the \fBbigIncrement\fR option. +value of the \fB\-bigincrement\fR option. .IP [9] Home moves the slider to the top (left) end of its range. .IP [10] End moves the slider to the bottom (right) end of its range. .PP -If the scale is disabled using the \fBstate\fR option then +If the scale is disabled using the \fB\-state\fR option then none of the above bindings have any effect. .PP The behavior of scales can be changed by defining new bindings for individual widgets or by redefining the class bindings. +.SH "SEE ALSO" +ttk::scale(n) .SH KEYWORDS scale, slider, trough, widget '\" Local Variables: diff --git a/doc/scrollbar.n b/doc/scrollbar.n index 4ca32d8..74fb977 100644 --- a/doc/scrollbar.n +++ b/doc/scrollbar.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: scrollbar.n,v 1.12 2008/09/23 13:36:54 dkf Exp $ -'\" .so man.macros .TH scrollbar n 4.1 Tk "Tk Built-In Commands" .BS @@ -44,7 +42,7 @@ as described in \fBSCROLLING COMMANDS\fR below. Specifies the width of borders drawn around the internal elements of the scrollbar (the two arrows and the slider). The value may have any of the forms acceptable to \fBTk_GetPixels\fR. -If this value is less than zero, the value of the \fBborderWidth\fR +If this value is less than zero, the value of the \fB\-borderwidth\fR option is used in its place. .OP \-width width Width Specifies the desired narrow dimension of the scrollbar window, @@ -112,9 +110,10 @@ determine the exact behavior of the command. The following commands are possible for scrollbar widgets: .TP \fIpathName \fBactivate \fR?\fIelement\fR? +. Marks the element indicated by \fIelement\fR as active, which -causes it to be displayed as specified by the \fBactiveBackground\fR -and \fBactiveRelief\fR options. +causes it to be displayed as specified by the \fB\-activebackground\fR +and \fB\-activerelief\fR options. The only element values understood by this command are \fBarrow1\fR, \fBslider\fR, or \fBarrow2\fR. If any other value is specified then no element of the scrollbar @@ -123,13 +122,15 @@ If \fIelement\fR is not specified, the command returns the name of the element that is currently active, or an empty string if no element is active. .TP -\fIpathName \fBcget\fR \fIoption\fR +\fIpathName \fBcget \fIoption\fR +. Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBscrollbar\fR command. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? +. Query or modify the configuration options of the widget. If no \fIoption\fR is specified, returns a list describing all of the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for @@ -144,6 +145,7 @@ this case the command returns an empty string. command. .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 slider position. For example, if the scrollbar is horizontal, @@ -155,6 +157,7 @@ scrollbar setting must change to move the slider \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. The value 0 corresponds to the top or left of the trough, the @@ -166,17 +169,20 @@ If \fIx\fR and \fIy\fR refer to a point outside the trough, the closest point in the trough is used. .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. .TP -\fIpathName \fBidentify\fR \fIx y\fR +\fIpathName \fBidentify \fIx y\fR +. Returns the name of the element under the point given by \fIx\fR and \fIy\fR (such as \fBarrow1\fR), or an empty string if the point does not lie in any element of the scrollbar. \fIX\fR and \fIy\fR must be pixel coordinates relative to the scrollbar widget. .TP -\fIpathName \fBset\fR \fIfirst last\fR +\fIpathName \fBset \fIfirst last\fR +. This command is invoked by the scrollbar's associated widget to tell the scrollbar about the current view in the widget. The command takes two arguments, each of which is a real fraction @@ -196,9 +202,11 @@ 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 +\fB\-command\fR option, which usually has a form like +.QW \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. @@ -208,6 +216,7 @@ 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. @@ -216,6 +225,7 @@ 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 @@ -232,7 +242,7 @@ is deprecated. In the old command syntax, the \fBset\fR widget command has the following form: .TP -\fIpathName \fBset\fR \fItotalUnits windowUnits firstUnit lastUnit\fR +\fIpathName \fBset \fItotalUnits windowUnits firstUnit lastUnit\fR In this form the arguments are all integers. \fITotalUnits\fR gives the total size of the object being displayed in the associated widget. The meaning of one unit depends on the associated diff --git a/doc/selection.n b/doc/selection.n index 20a41ef..69f6245 100644 --- a/doc/selection.n +++ b/doc/selection.n @@ -5,8 +5,6 @@ '\" 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.16 2010/01/13 16:16:30 dkf Exp $ -'\" .so man.macros .TH selection n 8.1 Tk "Tk Built-In Commands" .BS @@ -5,8 +5,6 @@ '\" 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.11 2008/09/23 13:36:55 dkf Exp $ -'\" .so man.macros .TH send n 4.0 Tk "Tk Built-In Commands" .BS @@ -60,7 +58,7 @@ You can query and change the name of an application with the .SH "DISABLING SENDS" .PP If the \fBsend\fR command is removed from an application (e.g. -with the command \fBrename send {}\fR) then the application +with the command \fBrename\fR \fBsend {}\fR) then the application will not respond to incoming send requests anymore, nor will it be able to issue outgoing requests. Communication can be reenabled by invoking the \fBtk appname\fR diff --git a/doc/spinbox.n b/doc/spinbox.n index 82b2fc8..e88aea6 100644 --- a/doc/spinbox.n +++ b/doc/spinbox.n @@ -5,8 +5,6 @@ '\" 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.11 2008/09/23 13:36:55 dkf Exp $ -'\" .so man.macros .TH spinbox n 8.4 Tk "Tk Built-In Commands" .BS @@ -59,9 +57,9 @@ are specified correctly, the spinbox will use these values to control its contents. This value must be less than the \fB\-to\fR option. If \fB\-values\fR is specified, it supercedes this option. .OP "\-invalidcommand or \-invcmd" invalidCommand InvalidCommand -Specifies a script to eval when \fBvalidateCommand\fR returns 0. Setting +Specifies a script to eval when \fB\-validatecommand\fR returns 0. Setting it to an empty string disables this feature (the default). The best use of -this option is to set it to \fIbell\fR. See \fBValidation\fR below for +this option is to set it to \fIbell\fR. See \fBVALIDATION\fR below for more information. .OP \-increment increment Increment A floating-point value specifying the increment. When used with @@ -91,16 +89,16 @@ If \fB\-values\fR is specified, it supercedes this option. Specifies the mode in which validation should operate: \fBnone\fR, \fBfocus\fR, \fBfocusin\fR, \fBfocusout\fR, \fBkey\fR, or \fBall\fR. It defaults to \fBnone\fR. When you want validation, you must explicitly -state which mode you wish to use. See \fBValidation\fR below for more. +state which mode you wish to use. See \fBVALIDATION\fR below for more. .OP "\-validatecommand or \-vcmd" validateCommand ValidateCommand Specifies a script to evaluate when you want to validate the input in the widget. Setting it to an empty string disables this feature (the default). Validation occurs according to the value of \fB\-validate\fR. This command must return a valid Tcl boolean value. If it returns 0 (or the valid Tcl boolean equivalent) then the value of the widget will not -change and the \fBinvalidCommand\fR will be evaluated if it is set. If it +change and the \fB\-invalidcommand\fR will be evaluated if it is set. If it returns 1, then value will be changed. -See \fBValidation\fR below for more information. +See \fBVALIDATION\fR below for more information. .OP \-values values Values Must be a proper list value. If specified, the spinbox will use these values as to control its contents, starting with the first value. This @@ -131,7 +129,7 @@ to move, or spin, through a fixed set of ascending or descending values such as times or dates in addition to editing the value as in an \fBentry\fR. When first created, a spinbox's string is empty. A portion of the spinbox may be selected as described below. -If a spinbox is exporting its selection (see the \fBexportSelection\fR +If a spinbox is exporting its selection (see the \fB\-exportselection\fR option), then it will observe the standard protocols for handling the selection; spinbox selections are available as type \fBSTRING\fR. Spinboxes also observe the standard Tk rules for dealing with the @@ -143,31 +141,31 @@ Spinboxes are capable of displaying strings that are too long to fit entirely within the widget's window. In this case, only a portion of the string will be displayed; commands described below may be used to change the view in the window. Spinboxes use -the standard \fBxScrollCommand\fR mechanism for interacting with -scrollbars (see the description of the \fBxScrollCommand\fR option +the standard \fB\-xscrollcommand\fR mechanism for interacting with +scrollbars (see the description of the \fB\-xscrollcommand\fR option for details). They also support scanning, as described below. .SH VALIDATION .PP -Validation works by setting the \fBvalidateCommand\fR -option to a script which will be evaluated according to the \fBvalidate\fR +Validation works by setting the \fB\-validatecommand\fR +option to a script which will be evaluated according to the \fB\-validate\fR option as follows: .PP .IP \fBnone\fR 10 Default. This means no validation will occur. .IP \fBfocus\fR 10 -\fBvalidateCommand\fR will be called when the spinbox receives or +The \fB\-validatecommand\fR will be called when the spinbox receives or loses focus. .IP \fBfocusin\fR 10 -\fBvalidateCommand\fR will be called when the spinbox receives focus. +The \fB\-validatecommand\fR will be called when the spinbox receives focus. .IP \fBfocusout\fR 10 -\fBvalidateCommand\fR will be called when the spinbox loses focus. +The \fB\-validatecommand\fR will be called when the spinbox loses focus. .IP \fBkey\fR 10 -\fBvalidateCommand\fR will be called when the spinbox is edited. +The \fB\-validatecommand\fR will be called when the spinbox is edited. .IP \fBall\fR 10 -\fBvalidateCommand\fR will be called for all above conditions. +The \fB\-validatecommand\fR will be called for all above conditions. .PP -It is possible to perform percent substitutions on the \fBvalidateCommand\fR -and \fBinvalidCommand\fR, just as you would in a \fBbind\fR script. The +It is possible to perform percent substitutions on the \fB\-validatecommand\fR +and \fB\-invalidcommand\fR scripts, just as you would in a \fBbind\fR script. The following substitutions are recognized: .PP .IP \fB%d\fR 5 @@ -192,32 +190,32 @@ The type of validation that triggered the callback .IP \fB%W\fR 5 The name of the spinbox widget. .PP -In general, the \fBtextVariable\fR and \fBvalidateCommand\fR can be +In general, the \fB\-textvariable\fR and \fB\-validatecommand\fR can be dangerous to mix. Any problems have been overcome so that using the -\fBvalidateCommand\fR will not interfere with the traditional behavior of -the spinbox widget. Using the \fBtextVariable\fR for read-only purposes will +\fB\-validatecommand\fR will not interfere with the traditional behavior of +the spinbox widget. Using the \fB\-textvariable\fR for read-only purposes will never cause problems. The danger comes when you try set the -\fBtextVariable\fR to something that the \fBvalidateCommand\fR would not -accept, which causes \fBvalidate\fR to become \fInone\fR (the -\fBinvalidCommand\fR will not be triggered). The same happens -when an error occurs evaluating the \fBvalidateCommand\fR. +\fB\-textvariable\fR to something that the \fB\-validatecommand\fR would not +accept, which causes \fB\-validate\fR to become \fInone\fR (the +\fB\-invalidcommand\fR will not be triggered). The same happens +when an error occurs evaluating the \fB\-validatecommand\fR. .PP -Primarily, an error will occur when the \fBvalidateCommand\fR or -\fBinvalidCommand\fR encounters an error in its script while evaluating or -\fBvalidateCommand\fR does not return a valid Tcl boolean value. The -\fBvalidate\fR option will also set itself to \fBnone\fR when you edit the -spinbox widget from within either the \fBvalidateCommand\fR or the -\fBinvalidCommand\fR. Such editions will override the one that was being +Primarily, an error will occur when the \fB\-validatecommand\fR or +\fB\-invalidcommand\fR encounters an error in its script while evaluating or +\fB\-validatecommand\fR does not return a valid Tcl boolean value. The +\fB\-validate\fR option will also set itself to \fBnone\fR when you edit the +spinbox widget from within either the \fB\-validatecommand\fR or the +\fB\-invalidcommand\fR. Such editions will override the one that was being validated. If you wish to edit the value of the widget -during validation and still have the \fBvalidate\fR option set, you should +during validation and still have the \fB\-validate\fR option set, you should include the command .CS \fI%W config \-validate %v\fR .CE -in the \fBvalidateCommand\fR or \fBinvalidCommand\fR (whichever one you +in the \fB\-validatecommand\fR or \fB\-invalidcommand\fR (whichever one you were editing the spinbox widget from). It is also recommended to not set an -associated \fBtextVariable\fR during validation, as that can cause the -spinbox widget to become out of sync with the \fBtextVariable\fR. +associated \fB\-textvariable\fR during validation, as that can cause the +spinbox widget to become out of sync with the \fB\-textvariable\fR. .SH "WIDGET COMMAND" .PP The \fBspinbox\fR command creates a new Tcl command whose @@ -394,7 +392,7 @@ Returns an empty string. Returns 1 if there is are characters selected in the spinbox, 0 if nothing is selected. .TP -\fIpathName \fBselection range \fIstart\fR \fIend\fR +\fIpathName \fBselection range \fIstart end\fR Sets the selection to include the characters starting with the one indexed by \fIstart\fR and ending with the one just before \fIend\fR. @@ -422,9 +420,9 @@ value, otherwise it just returns the spinbox's string. If validation is on, it will occur when setting the string. .TP \fIpathName \fBvalidate\fR -This command is used to force an evaluation of the \fBvalidateCommand\fR -independent of the conditions specified by the \fBvalidate\fR option. -This is done by temporarily setting the \fBvalidate\fR option to \fBall\fR. +This command is used to force an evaluation of the \fB\-validatecommand\fR +independent of the conditions specified by the \fB\-validate\fR option. +This is done by temporarily setting the \fB\-validate\fR option to \fBall\fR. It returns 0 or 1. .TP \fIpathName \fBxview \fIargs\fR @@ -443,7 +441,7 @@ in the window, and 40% of the text is off-screen to the right. These are the same values passed to scrollbars via the \fB\-xscrollcommand\fR option. .TP -\fIpathName \fBxview\fR \fIindex\fR +\fIpathName \fBxview \fIindex\fR Adjusts the view in the window so that the character given by \fIindex\fR is displayed at the left edge of the window. .TP @@ -581,6 +579,8 @@ take place. .PP The behavior of spinboxes can be changed by defining new bindings for individual widgets or by redefining the class bindings. +.SH "SEE ALSO" +ttk::spinbox(n) .SH KEYWORDS spinbox, entry, widget '\" Local Variables: @@ -5,8 +5,6 @@ '\" 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.60 2010/07/06 17:15:04 andreas_kupries Exp $ -'\" .so man.macros .TH text n 8.5 Tk "Tk Built-In Commands" .BS @@ -38,12 +36,12 @@ Specifies a boolean that says whether the blinking insertion cursor should be drawn as a character-sized rectangular block. If false (the default) a thin vertical line is used for the insertion cursor. .OP \-endline endLine EndLine -Specifies an integer line index representing the last line of the underlying -textual data store that should be contained in the widget. This allows a text -widget to reflect only a portion of a larger piece of text. Instead of an -integer, the empty string can be provided to this configuration option, which -will configure the widget to end at the very last line in the textual data -store. +Specifies an integer line index representing the line of the underlying +textual data store that should be just after the last line contained in +the widget. This allows a text widget to reflect only a portion of a +larger piece of text. Instead of an integer, the empty string can be +provided to this configuration option, which will configure the widget +to end at the very last line in the textual data store. .OP \-height height Height Specifies the desired height for the window, in units of characters in the font given by the \fB\-font\fR option. Must be at least one. @@ -114,7 +112,7 @@ If the list of tab stops does not have enough elements to cover all of the tabs in a text line, then Tk extrapolates new tab stops using the spacing and alignment from the last tab stop in the list. Tab distances must be strictly positive, and must always increase from one tab stop to the next (if not, an -error is thrown). The value of the \fBtabs\fR option may be overridden by +error is thrown). The value of the \fB\-tabs\fR option may be overridden by \fB\-tabs\fR options in tags. .PP If no \fB\-tabs\fR option is specified, or if it is specified as an empty @@ -134,7 +132,7 @@ of the \fIn\fR'th tab stop, then a gap of a single space will be inserted as a fallback. If the tab style is \fBwordprocessor\fR then any tab character being laid out will use (and be defined by) the first tab stop to the right of the preceding characters already laid out on that line. The value of the -\fBtabstyle\fR option may be overridden by \fB\-tabstyle\fR options in tags. +\fB\-tabstyle\fR option may be overridden by \fB\-tabstyle\fR options in tags. .OP \-undo undo Undo Specifies a boolean that says whether the undo mechanism is active or not. .OP \-width width Width @@ -271,7 +269,7 @@ text. Spaces on either side of \fIcount\fR are optional. If the \fBdisplay\fR submodifier is given, elided characters are skipped over without being counted. If \fBany\fR is given, then all characters are counted. For historical reasons, if neither modifier is given then the count actually takes -place in units of index positions (see \fBindices\fR for details). This +place in units of index positions (see \fBINDICES\fR for details). This behaviour may be changed in a future major release, so if you need an index count, you are encouraged to use \fBindices\fR instead wherever possible. .TP @@ -284,7 +282,7 @@ the text (1.0). Spaces on either side of \fIcount\fR are optional. If the \fBdisplay\fR submodifier is given, elided characters are skipped over without being counted. If \fBany\fR is given, then all characters are counted. For historical reasons, if neither modifier is given then the count actually takes -place in units of index positions (see \fBindices\fR for details). This +place in units of index positions (see \fBINDICES\fR for details). This behavior may be changed in a future major release, so if you need an index count, you are encouraged to use \fBindices\fR instead wherever possible. .TP @@ -434,7 +432,7 @@ then a solid fill will be used for the background. . \fIPixels\fR specifies the width of a border to draw around the tag using any of the forms accepted by \fBTk_GetPixels\fR. This option should be used in -conjuction with the \fB\-relief\fR option to provide the desired border. +conjunction with the \fB\-relief\fR option to provide the desired border. .TP \fB\-elide \fIboolean\fR . @@ -767,7 +765,7 @@ the bottom of the embedded image. It may have any of the usual forms defined for a screen distance. .SH "THE SELECTION" .PP -Selection support is implemented via tags. If the \fBexportSelection\fR option +Selection support is implemented via tags. If the \fB\-exportselection\fR option for the text widget is true then the \fBsel\fR tag will be associated with the selection: .IP [1] @@ -787,8 +785,8 @@ is generated. 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" -widget command. Furthermore, the \fBselectBackground\fR, -\fBselectBorderWidth\fR, and \fBselectForeground\fR options for the text +widget command. Furthermore, the \fB\-selectbackground\fR, +\fB\-selectborderwidth\fR, and \fB\-selectforeground\fR options for the text widget are tied to the \fB\-background\fR, \fB\-borderwidth\fR, and \fB\-foreground\fR options for the \fBsel\fR tag: changes in either will automatically be reflected in the other. Also the @@ -868,8 +866,8 @@ arbitrary other widgets, cannot be shared between peers. This means the (it is advisable to use the \fB\-create\fR script capabilities to allow each peer to create its own embedded windows as needed). Fourth, all of the configuration options of each peer (e.g. \fB\-font\fR, etc) can be set -independently, with the exception of \fB\-undo\fR, \fB\-maxUndo\fR, -\fB\-autoSeparators\fR (i.e. all undo, redo and modified state issues are +independently, with the exception of \fB\-undo\fR, \fB\-maxundo\fR, +\fB\-autoseparators\fR (i.e. all undo, redo and modified state issues are shared). .PP Finally any single peer need not contain all lines from the underlying data @@ -963,7 +961,7 @@ each counting option given. Valid counting options are \fB\-chars\fR, default value, if no option is specified, is \fB\-indices\fR. There is an additional possible option \fB\-update\fR which is a modifier. If given, then all subsequent options ensure that any possible out of date information is -recalculated. This currently only has any effect for the \fI\-ypixels\fR count +recalculated. This currently only has any effect for the \fB\-ypixels\fR count (which, if \fB\-update\fR is not given, will use the text widget's current cached value for each line). The count options are interpreted as follows: .RS @@ -1134,7 +1132,7 @@ behavior of the command depends on the \fIoption\fR argument that follows the supported: .RS .TP -\fIpathName \fBedit modified ?\fIboolean\fR? +\fIpathName \fBedit modified \fR?\fIboolean\fR? . If \fIboolean\fR is not specified, returns the modified flag of the widget. The insert, delete, edit undo and edit redo commands or the user can set or @@ -1164,7 +1162,7 @@ the undo stack in between two separators. Generates an error when the undo stack is empty. Does nothing when the \fB\-undo\fR option is false. .RE .TP -\fIpathName \fBget\fR \fI?\-displaychars?\fR \fI\-\- index1\fR ?\fIindex2 ...\fR? +\fIpathName \fBget\fR ?\fB\-displaychars\fR? ?\fB\-\-\fR? \fIindex1\fR ?\fIindex2 ...\fR? . Return a range of characters from the text. The return value will be all the characters in the text starting with the one whose index is \fIindex1\fR and @@ -1189,7 +1187,7 @@ command depends on the \fIoption\fR argument that follows the \fBtag\fR argument. The following forms of the command are currently supported: .RS .TP -\fIpathName \fBimage cget\fR \fIindex option\fR +\fIpathName \fBimage cget \fIindex option\fR . Returns the value of a configuration option for an embedded image. \fIIndex\fR identifies the embedded image, and \fIoption\fR specifies a particular @@ -1309,7 +1307,7 @@ calls to This command returns an empty string. .RE .TP -\fIpathName \fBpeer\fR \fIoption args\fR +\fIpathName \fBpeer \fIoption args\fR . This command is used to create and query widget peers. It has two forms, depending on \fIoption\fR: @@ -1328,7 +1326,7 @@ Returns a list of peers of this widget (this does not include the widget itself). The order within this list is undefined. .RE .TP -\fIpathName \fBreplace\fR \fIindex1 index2 chars\fR ?\fItagList chars tagList ...\fR? +\fIpathName \fBreplace \fIindex1 index2 chars\fR ?\fItagList chars tagList ...\fR? . Replaces the range of characters between \fIindex1\fR and \fIindex2\fR with the given characters and tags. See the section on \fIpathName \fBinsert\fR for @@ -1344,7 +1342,7 @@ stack are correctly modified, if undo operations are active in the text widget. The command returns an empty string. .RE .TP -\fIpathName \fBscan\fR \fIoption args\fR +\fIpathName \fBscan \fIoption args\fR . This command is used to implement scanning on texts. It has two forms, depending on \fIoption\fR: @@ -1399,7 +1397,8 @@ those in \fIpattern\fR. This is the default. \fB\-regexp\fR . Treat \fIpattern\fR as a regular expression and match it against the text -using the rules for regular expressions (see the \fBregexp\fR command for +using the rules for regular expressions (see the \fBregexp\fR command +and the \fBre_syntax\fR page for details). The default matching automatically passes both the \fB\-lineanchor\fR and \fB\-linestop\fR options to the regexp engine (unless \fB\-nolinestop\fR is used), so that \fI^$\fR match beginning and end of line, @@ -1573,7 +1572,7 @@ bindings will be invoked first, followed by bindings for the window as a whole. .RE .TP -\fIpathName \fBtag cget\fR \fItagName option\fR +\fIpathName \fBtag cget \fItagName option\fR . This command returns the current value of the option named \fIoption\fR associated with the tag given by \fItagName\fR. \fIOption\fR may have any of @@ -1676,11 +1675,11 @@ has no effect. This command returns an empty string. \fIpathName \fBwindow \fIoption \fR?\fIarg arg ...\fR? . This command is used to manipulate embedded windows. The behavior of the -command depends on the \fIoption\fR argument that follows the \fBtag\fR +command depends on the \fIoption\fR argument that follows the \fBwindow\fR argument. The following forms of the command are currently supported: .RS .TP -\fIpathName \fBwindow cget\fR \fIindex option\fR +\fIpathName \fBwindow cget \fIindex option\fR . Returns the value of a configuration option for an embedded window. \fIIndex\fR identifies the embedded window, and \fIoption\fR specifies a @@ -1758,7 +1757,7 @@ negative then characters farther to the left become visible; if it is positive then characters farther to the right become visible. .RE .TP -\fIpathName \fByview \fI?args\fR? +\fIpathName \fByview \fR?\fIargs\fR? . This command is used to query and change the vertical position of the text in the widget's window. It can take any of the following forms: @@ -1823,7 +1822,7 @@ If \fIindex\fR is only a few lines off-screen below the window then it will be positioned at the bottom of the window. .IP [4] Otherwise, \fIindex\fR will be centered in the window. -.LP +.PP The \fB\-pickplace\fR option has been obsoleted by the \fIpathName \fBsee\fR widget command (\fIpathName \fBsee\fR handles both x- and y-motion to make a location visible, whereas the \fB\-pickplace\fR mode only handles motion in @@ -2039,7 +2038,7 @@ tags within them. .PP The display line with the insert cursor is redrawn each time the cursor blinks, which causes a steady stream of graphics traffic. Set the -\fBinsertOffTime\fR attribute to 0 avoid this. +\fB\-insertofftime\fR attribute to 0 avoid this. .SS "KNOWN BUGS" .PP The \fIpathName \fBsearch \-regexp\fR sub-command attempts to perform @@ -2058,9 +2057,9 @@ Tcl's regexp system returns the incorrect code and adding a second extra line would actually match, the text widget will return the wrong result. In practice this is a rare problem, but it can occur, for example: .CS -pack [text .t] -\.t insert 1.0 "aaaa\enbbbb\encccc\enbbbb\enaaaa\en" -\.t search \-regexp \-\- {(a+|b+\enc+\enb+)+\ena+} 1.0 +pack [\fBtext\fR .t] +\&.t insert 1.0 "aaaa\enbbbb\encccc\enbbbb\enaaaa\en" +\&.t search \-regexp \-\- {(a+|b+\enc+\enb+)+\ena+} 1.0 .CE will not find a match when one exists of 19 characters starting from the first .QW b . @@ -2074,9 +2073,9 @@ actually encompasses all of them. The search algorithm used by the widget does not look back arbitrarily far for a possible match which might cover large portions of the widget. For example: .CS -pack [text .t] -\.t insert 1.0 "aaaa\enbbbb\enbbbb\enbbbb\enbbbb\\n" -\.t search \-regexp \-backward \-\- {b+\en|a+\en(b+\en)+} end +pack [\fBtext\fR .t] +\&.t insert 1.0 "aaaa\enbbbb\enbbbb\enbbbb\enbbbb\\n" +\&.t search \-regexp \-backward \-\- {b+\en|a+\en(b+\en)+} end .CE matches at .QW 5.0 @@ -5,8 +5,6 @@ '\" 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.23 2010/01/13 15:41:29 dkf Exp $ -'\" .so man.macros .TH tk n 8.4 Tk "Tk Built-In Commands" .BS @@ -62,8 +60,8 @@ used for indicating global focus (e.g. to comply with Microsoft Accessibility guidelines), as well as for location of the over-the-spot XIM (X Input Methods) or Windows IME windows. If no options are specified, the last values used for setting the caret are return in option-value pair -format. \fI\-x\fR and \fI\-y\fR represent window-relative coordinates, and -\fI\-height\fR is the height of the current cursor location, or the height +format. \fB\-x\fR and \fB\-y\fR represent window-relative coordinates, and +\fB\-height\fR is the height of the current cursor location, or the height of the specified \fIwindow\fR if none is given. .TP \fBtk inactive \fR?\fB\-displayof \fIwindow\fR? ?\fBreset\fR? diff --git a/doc/tk_mac.n b/doc/tk_mac.n index bf683f8..a97318a 100644 --- a/doc/tk_mac.n +++ b/doc/tk_mac.n @@ -185,7 +185,7 @@ or to using a \fBttk::frame\fR. .TP \fB::tk::mac::iconBitmap \fIname width height \-kind value\fR . -Renders native icons and bitmpas in Tk applications (including any image file +Renders native icons and bitmaps in Tk applications (including any image file readable by NSImage). A native bitmap name is interpreted as follows (in order): .RS diff --git a/doc/tkerror.n b/doc/tkerror.n index 0abc87b..8d45ad2 100644 --- a/doc/tkerror.n +++ b/doc/tkerror.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tkerror.n,v 1.5 2008/09/23 13:36:55 dkf Exp $ -'\" .so man.macros .TH tkerror n 4.1 Tk "Tk Built-In Commands" .BS diff --git a/doc/tkvars.n b/doc/tkvars.n index 1bc6217..e44cf35 100644 --- a/doc/tkvars.n +++ b/doc/tkvars.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tkvars.n,v 1.9 2010/01/14 11:50:51 dkf Exp $ -'\" .so man.macros .TH tkvars n 4.1 Tk "Tk Built-In Commands" .BS diff --git a/doc/tkwait.n b/doc/tkwait.n index b5611c7..83586f6 100644 --- a/doc/tkwait.n +++ b/doc/tkwait.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tkwait.n,v 1.5 2008/09/23 13:36:56 dkf Exp $ -'\" .so man.macros .TH tkwait n "" Tk "Tk Built-In Commands" .BS @@ -45,6 +43,8 @@ the normal fashion, so the application will continue to respond to user interactions. If an event handler invokes \fBtkwait\fR again, the nested call to \fBtkwait\fR must complete before the outer call can complete. +.SH "SEE ALSO" +bind(n), vwait(n) .SH KEYWORDS variable, visibility, wait, window '\" Local Variables: diff --git a/doc/toplevel.n b/doc/toplevel.n index f213a21..7d5b53c 100644 --- a/doc/toplevel.n +++ b/doc/toplevel.n @@ -5,8 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: toplevel.n,v 1.10 2008/06/30 22:57:03 dkf Exp $ -'\" .so man.macros .TH toplevel n 8.4 Tk "Tk Built-In Commands" .BS @@ -22,7 +20,7 @@ toplevel \- Create and manipulate toplevel widgets .SE .SH "WIDGET-SPECIFIC OPTIONS" .OP \-background background Background -This option is the same as the standard \fBbackground\fR option +This option is the same as the standard \fB\-background\fR option except that its value may also be specified as an empty string. In this case, the widget will display no background or border, and no colors will be consumed from its colormap for its background @@ -32,7 +30,7 @@ Specifies a class for the window. This class will be used when querying the option database for the window's other options, and it will also be used later for other purposes such as bindings. -The \fBclass\fR option may not be changed with the \fBconfigure\fR +The \fB\-class\fR option may not be changed with the \fBconfigure\fR widget command. .OP \-colormap colormap Colormap Specifies a colormap to use for the window. @@ -41,7 +39,7 @@ created for the window and its children, or the name of another window (which must be on the same screen and have the same visual as \fIpathName\fR), in which case the new window will use the colormap from the specified window. -If the \fBcolormap\fR option is not specified, the new window +If the \fB\-colormap\fR option is not specified, the new window uses the default colormap of its screen. This option may not be changed with the \fBconfigure\fR widget command. @@ -88,7 +86,7 @@ Specifies visual information for the new window in any of the forms accepted by \fBTk_GetVisual\fR. If this option is not specified, the new window will use the default visual for its screen. -The \fBvisual\fR option may not be modified with the \fBconfigure\fR +The \fB\-visual\fR option may not be modified with the \fBconfigure\fR widget command. .OP \-width width Width Specifies the desired width for the window in any of the forms @@ -127,7 +125,7 @@ the toplevel widget's path name. \fIOption\fR and the \fIarg\fRs determine the exact behavior of the command. The following commands are possible for toplevel widgets: .TP -\fIpathName \fBcget\fR \fIoption\fR +\fIpathName \fBcget \fIoption\fR Returns the current value of the configuration option given by \fIoption\fR. \fIOption\fR may have any of the values accepted by the \fBtoplevel\fR diff --git a/doc/ttk_Geometry.3 b/doc/ttk_Geometry.3 index 0923d02..95be72f 100644 --- a/doc/ttk_Geometry.3 +++ b/doc/ttk_Geometry.3 @@ -1,8 +1,6 @@ '\" '\" Copyright (c) 2004 Joe English '\" -'\" RCS: @(#) $Id: ttk_Geometry.3,v 1.5 2008/06/30 22:57:03 dkf Exp $ -'\" .so man.macros .TH Geometry 3 8.5 Tk "Tk Themed Widget" .BS @@ -90,7 +88,7 @@ One of the standard Tk relief options (TK_RELIEF_RAISED, TK_RELIEF_SUNKEN, etc.). See \fBTk_GetReliefFromObj\fR. .AP short right in -Extra padding (in pixles) to add to the right side of a region. +Extra padding (in pixels) to add to the right side of a region. .AP Ttk_Side side in One of \fBTTK_SIDE_LEFT\fR, \fBTTK_SIDE_TOP\fR, \fBTTK_SIDE_RIGHT\fR, or \fBTTK_SIDE_BOTTOM\fR. @@ -130,7 +128,7 @@ typedef struct { .CE All coordinates are relative to the window. .PP -\fBTtk_MakeBox\fR is a convenience routine that contsructs +\fBTtk_MakeBox\fR is a convenience routine that constructs a \fBTtk_Box\fR structure representing a region \fIwidth\fR pixels wide, \fIheight\fR pixels tall, at the specified \fIx, y\fR coordinates. .PP @@ -175,7 +173,7 @@ typedef struct { } \fBTtk_Padding\fR; .CE .PP -\fBTtk_MakePadding\fR is a convenience routine that contsructs +\fBTtk_MakePadding\fR is a convenience routine that constructs a \fBTtk_Padding\fR structure with the specified left, top, right, and bottom components. .PP diff --git a/doc/ttk_Theme.3 b/doc/ttk_Theme.3 index 9340d0f..acd0e98 100644 --- a/doc/ttk_Theme.3 +++ b/doc/ttk_Theme.3 @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_Theme.3,v 1.2 2008/06/30 22:57:03 dkf Exp $ -'\" .so man.macros .TH Ttk_CreateTheme 3 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_button.n b/doc/ttk_button.n index 1232c94..c6f2308 100644 --- a/doc/ttk_button.n +++ b/doc/ttk_button.n @@ -4,8 +4,6 @@ '\" 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.16 2009/04/30 13:54:04 dkf Exp $ -'\" .so man.macros .TH ttk::button n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_checkbutton.n b/doc/ttk_checkbutton.n index afdce51..07b3205 100644 --- a/doc/ttk_checkbutton.n +++ b/doc/ttk_checkbutton.n @@ -4,8 +4,6 @@ '\" 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.16 2008/12/04 15:47:22 dkf Exp $ -'\" .so man.macros .TH ttk::checkbutton n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_combobox.n b/doc/ttk_combobox.n index 37a5d64..e01c6f6 100644 --- a/doc/ttk_combobox.n +++ b/doc/ttk_combobox.n @@ -4,8 +4,6 @@ '\" 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.19 2008/10/27 13:38:51 dkf Exp $ -'\" .so man.macros .TH ttk::combobox n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_entry.n b/doc/ttk_entry.n index f8cdf2b..42335d8 100644 --- a/doc/ttk_entry.n +++ b/doc/ttk_entry.n @@ -6,9 +6,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" SOURCE: entry.n, r1.12 -'\" RCS: @(#) $Id: ttk_entry.n,v 1.15 2008/11/24 09:56:44 dkf Exp $ -'\" .so man.macros .TH ttk::entry n 8.5 Tk "Tk Themed Widget" .BS @@ -42,7 +39,7 @@ requests when it has a selection. .\" MAYBE: .OP \-insertbackground insertBackground Foreground .\" MAYBE: .OP \-insertwidth insertWidth InsertWidth .OP \-invalidcommand invalidCommand InvalidCommand -A script template to evaluate whenever the \fBvalidateCommand\fR returns 0. +A script template to evaluate whenever the \fB\-validatecommand\fR returns 0. See \fBVALIDATION\fR below for more information. .OP \-justify justify Justify Specifies how the text is aligned within the entry widget. @@ -90,7 +87,7 @@ in average-size characters of the widget's font. .SH NOTES .PP A portion of the entry may be selected as described below. -If an entry is exporting its selection (see the \fBexportSelection\fR +If an entry is exporting its selection (see the \fB\-exportselection\fR option), then it will observe the standard X11 protocols for handling the selection; entry selections are available as type \fBSTRING\fR. Entries also observe the standard Tk rules for dealing with the @@ -102,8 +99,8 @@ Entries are capable of displaying strings that are too long to fit entirely within the widget's window. In this case, only a portion of the string will be displayed; commands described below 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 +the standard \fB\-xscrollcommand\fR mechanism for interacting with +scrollbars (see the description of the \fB\-xscrollcommand\fR option for details). .SH "INDICES" .PP diff --git a/doc/ttk_frame.n b/doc/ttk_frame.n index 19a5a2c..9dcf2dc 100644 --- a/doc/ttk_frame.n +++ b/doc/ttk_frame.n @@ -4,8 +4,6 @@ '\" 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.12 2008/09/23 13:36:56 dkf Exp $ -'\" .so man.macros .TH ttk::frame n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_image.n b/doc/ttk_image.n index 0c05ce2..3d8b13c 100644 --- a/doc/ttk_image.n +++ b/doc/ttk_image.n @@ -4,8 +4,6 @@ '\" 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.15 2008/09/23 13:36:56 dkf Exp $ -'\" .so man.macros .TH ttk_image n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_intro.n b/doc/ttk_intro.n index 9572a2e..cb0c440 100644 --- a/doc/ttk_intro.n +++ b/doc/ttk_intro.n @@ -4,8 +4,6 @@ '\" 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.13 2009/02/16 09:30:26 dkf Exp $ -'\" .so man.macros .TH ttk::intro n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_label.n b/doc/ttk_label.n index 2e4ffb5..66dafeb 100644 --- a/doc/ttk_label.n +++ b/doc/ttk_label.n @@ -4,8 +4,6 @@ '\" 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.12 2008/09/23 13:36:56 dkf Exp $ -'\" .so man.macros .TH ttk::label n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_labelframe.n b/doc/ttk_labelframe.n index f295e4d..e782f87 100644 --- a/doc/ttk_labelframe.n +++ b/doc/ttk_labelframe.n @@ -4,8 +4,6 @@ '\" 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.12 2008/09/23 13:36:56 dkf Exp $ -'\" .so man.macros .TH ttk::labelframe n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_menubutton.n b/doc/ttk_menubutton.n index 8e71bd9..99b7c4d 100644 --- a/doc/ttk_menubutton.n +++ b/doc/ttk_menubutton.n @@ -4,8 +4,6 @@ '\" 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.13 2008/12/04 15:47:22 dkf Exp $ -'\" .so man.macros .TH ttk::menubutton n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_notebook.n b/doc/ttk_notebook.n index b3eda25..fe89994 100644 --- a/doc/ttk_notebook.n +++ b/doc/ttk_notebook.n @@ -4,8 +4,6 @@ '\" 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.16 2009/11/01 18:12:44 jenglish Exp $ -'\" .so man.macros .TH ttk::notebook n 8.5 Tk "Tk Themed Widget" .BS @@ -102,7 +100,7 @@ which returns the number of tabs .QW "\fIpathname \fBindex\fR" ). .SH "WIDGET COMMAND" .TP -\fIpathname \fBadd\fR \fIwindow\fR ?\fIoptions...\fR? +\fIpathname \fBadd \fIwindow\fR ?\fIoptions...\fR? Adds a new tab to the notebook. See \fBTAB OPTIONS\fR for the list of available \fIoptions\fR. If \fIwindow\fR is currently managed by the notebook but hidden, @@ -111,38 +109,38 @@ it is restored to its previous position. \fIpathname \fBconfigure\fR ?\fIoptions\fR? See \fIttk::widget(n)\fR. .TP -\fIpathname \fBcget\fR \fIoption\fR +\fIpathname \fBcget \fIoption\fR See \fIttk::widget(n)\fR. .TP -\fIpathname \fBforget\fR \fItabid\fR +\fIpathname \fBforget \fItabid\fR Removes the tab specified by \fItabid\fR, unmaps and unmanages the associated window. .TP -\fIpathname \fBhide\fR \fItabid\fR +\fIpathname \fBhide \fItabid\fR Hides the tab specified by \fItabid\fR. The tab will not be displayed, but the associated window remains managed by the notebook and its configuration remembered. Hidden tabs may be restored with the \fBadd\fR command. .TP -\fIpathname \fBidentify\fR \fIcomponent\fR \fIx\fR \fIy\fR +\fIpathname \fBidentify\fI component x y\fR Returns the name of the element under the point given by \fIx\fR and \fIy\fR, or the empty string if no component is present at that location. The following subcommands are supported: .RS .TP -\fIpathname \fBidentify\fR \fBelement\fR \fIx\fR \fIy\fR +\fIpathname \fBidentify element\fR \fIx y\fR Returns the name of the element at the specified location. .TP -\fIpathname \fBidentify\fR \fBtab\fR \fIx\fR \fIy\fR +\fIpathname \fBidentify tab\fR \fIx y\fR Returns the index of the tab at the specified location. .RE .TP -\fIpathname \fBindex\fR \fItabid\fR +\fIpathname \fBindex \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 .QW \fBend\fR . .TP -\fIpathname \fBinsert\fR \fIpos\fR \fIsubwindow\fR \fIoptions...\fR +\fIpathname \fBinsert \fIpos subwindow options...\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. @@ -150,7 +148,7 @@ 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? +\fIpathname \fBinstate \fIstatespec \fR?\fIscript...\fR? See \fIttk::widget(n)\fR. .TP \fIpathname \fBselect\fR ?\fItabid\fR? @@ -163,7 +161,7 @@ currently selected pane. \fIpathname \fBstate\fR ?\fIstatespec\fR? See \fIttk::widget(n)\fR. .TP -\fIpathname \fBtab\fR \fItabid\fR ?\fI\-option \fR?\fIvalue ...\fR +\fIpathname \fBtab \fItabid\fR ?\fI\-option \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. @@ -186,9 +184,9 @@ 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. +\fBControl-Shift-Tab\fR selects the tab preceding the currently selected one. .IP \(bu -\fBAlt-K\fR, where \fBK\fR is the mnemonic (underlined) character +\fBAlt-\fIK\fR, where \fIK\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, @@ -201,9 +199,9 @@ virtual event after a new tab is selected. .SH "EXAMPLE" .CS pack [\fBttk::notebook\fR .nb] -\.nb add [frame .nb.f1] \-text "First tab" -\.nb add [frame .nb.f2] \-text "Second tab" -\.nb select .nb.f2 +\&.nb add [frame .nb.f1] \-text "First tab" +\&.nb add [frame .nb.f2] \-text "Second tab" +\&.nb select .nb.f2 ttk::notebook::enableTraversal .nb .CE .SH "SEE ALSO" diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n index 472761e..3b80ac8 100644 --- a/doc/ttk_panedwindow.n +++ b/doc/ttk_panedwindow.n @@ -4,8 +4,6 @@ '\" 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.20 2009/11/01 18:12:44 jenglish Exp $ -'\" .so man.macros .TH ttk::panedwindow n 8.5 Tk "Tk Themed Widget" .BS @@ -54,29 +52,29 @@ Supports the standard \fBconfigure\fR, \fBcget\fR, \fBstate\fR, and \fBinstate\fR commands; see \fIttk::widget(n)\fR for details. Additional commands: .TP -\fIpathname\fR \fBadd\fR \fIsubwindow\fR \fIoptions...\fR +\fIpathname \fBadd \fIsubwindow options...\fR Adds a new pane to the window. See \fBPANE OPTIONS\fR for the list of available options. .TP -\fIpathname\fR \fBforget\fR \fIpane\fR +\fIpathname \fBforget \fIpane\fR Removes the specified subpane from the widget. \fIpane\fR is either an integer index or the name of a managed subwindow. .TP -\fIpathname\fR \fBidentify\fR \fIcomponent\fR \fIx\fR \fIy\fR +\fIpathname \fBidentify \fIcomponent x y\fR Returns the name of the element under the point given by \fIx\fR and \fIy\fR, or the empty string if no component is present at that location. If \fIcomponent\fR is omitted, it defaults to \fBsash\fR. The following subcommands are supported: .RS .TP -\fIpathname\fR \fBidentify\fR \fBelement\fR \fIx\fR \fIy\fR +\fIpathname \fBidentify element \fIx y\fR Returns the name of the element at the specified location. .TP -\fIpathname\fR \fBidentify\fR \fBsash\fR \fIx\fR \fIy\fR +\fIpathname \fBidentify sash \fIx y\fR Returns the index of the sash at the specified location. .RE .TP -\fIpathname\fR \fBinsert\fR \fIpos\fR \fIsubwindow\fR \fIoptions...\fR +\fIpathname \fBinsert \fIpos subwindow options...\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. @@ -84,7 +82,7 @@ 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\fR \fBpane\fR \fIpane \-option \fR?\fIvalue \fR?\fI\-option value...\fR +\fIpathname \fBpane \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 @@ -92,10 +90,10 @@ 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 \fBpanes\fR +\fIpathname \fBpanes\fR Returns the list of all windows managed by the widget. .TP -\fIpathname\fR \fBsashpos\fR \fIindex\fR ?\fInewpos\fR? +\fIpathname \fBsashpos \fIindex\fR ?\fInewpos\fR? If \fInewpos\fR is specified, sets the position of sash number \fIindex\fR. May adjust the positions of adjacent sashes diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n index bd3208b..b29f88d 100644 --- a/doc/ttk_progressbar.n +++ b/doc/ttk_progressbar.n @@ -4,8 +4,6 @@ '\" 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.13 2008/09/23 13:36:57 dkf Exp $ -'\" .so man.macros .TH ttk::progressbar n 8.5 Tk "Tk Themed Widget" .BS @@ -59,13 +57,13 @@ to provide additional animation effects. .SH "WIDGET COMMAND" .PP .TP -\fIpathName \fBcget\fR \fIoption\fR +\fIpathName \fBcget \fIoption\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 \fBidentify\fR \fIx y\fR +\fIpathName \fBidentify \fIx y\fR Returns the name of the element at position \fIx\fR, \fIy\fR. See \fIttk::widget(n)\fR. .TP diff --git a/doc/ttk_radiobutton.n b/doc/ttk_radiobutton.n index d757d8e..afbd8c2 100644 --- a/doc/ttk_radiobutton.n +++ b/doc/ttk_radiobutton.n @@ -4,8 +4,6 @@ '\" 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.15 2008/12/04 15:47:22 dkf Exp $ -'\" .so man.macros .TH ttk::radiobutton n 8.5 Tk "Tk Themed Widget" .BS @@ -31,7 +29,7 @@ it sets the variable to its associated value. .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 \fI\-variable\fR +The value to store in the associated \fB\-variable\fR when the widget is selected. .OP \-variable variable Variable The name of a global variable whose value is linked to the widget. diff --git a/doc/ttk_scale.n b/doc/ttk_scale.n index 549e6de..c84461e 100644 --- a/doc/ttk_scale.n +++ b/doc/ttk_scale.n @@ -4,8 +4,6 @@ .\" See the file "license.terms" for information on usage and redistribution .\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. .\" -.\" CVS: @(#) $Id: ttk_scale.n,v 1.3 2008/06/30 22:57:03 dkf Exp $ -.\" .so man.macros .TH ttk::scale n 8.5 Tk "Tk Themed Widget" .BS @@ -41,7 +39,7 @@ or vertically. Must be either \fBhorizontal\fR or \fBvertical\fR or an abbreviation of one of these. .OP \-to to To Specifies a real value corresponding to the right or bottom end of the scale. -This value may be either less than or greater than the \fBfrom\fR option. +This value may be either less than or greater than the \fB\-from\fR option. .OP \-value value Value Specifies the current floating-point value of the variable. .OP \-variable variable Variable @@ -67,7 +65,7 @@ Get the current value of the \fB\-value\fR option, or the value corresponding to the coordinates \fIx,y\fR if they are specified. \fIX\fR and \fIy\fR are pixel coordinates relative to the scale widget origin. .TP -\fIpathName \fBidentify\fR \fIx y\fR +\fIpathName \fBidentify \fIx y\fR Returns the name of the element at position \fIx\fR, \fIy\fR. See \fIttk::widget(n)\fR. .TP diff --git a/doc/ttk_scrollbar.n b/doc/ttk_scrollbar.n index ee603d8..b406339 100644 --- a/doc/ttk_scrollbar.n +++ b/doc/ttk_scrollbar.n @@ -5,9 +5,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" SOURCE: tk/doc/scrollbar.n, r1.4 -'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.15 2008/09/23 13:36:57 dkf Exp $ -'\" .so man.macros .TH ttk::scrollbar n 8.5 Tk "Tk Themed Widget" .BS @@ -51,7 +48,7 @@ Specifies the orientation of the scrollbar. .SH "WIDGET COMMAND" .PP .TP -\fIpathName \fBcget\fR \fIoption\fR +\fIpathName \fBcget \fIoption\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? @@ -61,14 +58,14 @@ Modify or query widget options; see \fIttk::widget(n)\fR. 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 \fBidentify\fR \fIx y\fR +\fIpathName \fBidentify \fIx y\fR Returns the name of the element at position \fIx\fR, \fIy\fR. See \fIttk::widget(n)\fR. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? Test the widget state; see \fIttk::widget(n)\fR. .TP -\fIpathName \fBset\fR \fIfirst last\fR +\fIpathName \fBset \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. diff --git a/doc/ttk_separator.n b/doc/ttk_separator.n index cd8710b..78114bd 100644 --- a/doc/ttk_separator.n +++ b/doc/ttk_separator.n @@ -4,8 +4,6 @@ '\" 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.11 2008/09/23 13:36:57 dkf Exp $ -'\" .so man.macros .TH ttk::separator n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_sizegrip.n b/doc/ttk_sizegrip.n index 5131d7f..38de1ed 100644 --- a/doc/ttk_sizegrip.n +++ b/doc/ttk_sizegrip.n @@ -4,8 +4,6 @@ '\" 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.18 2008/09/23 13:36:57 dkf Exp $ -'\" .so man.macros .TH ttk::sizegrip n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_spinbox.n b/doc/ttk_spinbox.n index d8a9cfc..2933ae7 100644 --- a/doc/ttk_spinbox.n +++ b/doc/ttk_spinbox.n @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_spinbox.n,v 1.2 2008/11/24 09:56:44 dkf Exp $ -'\" .so man.macros .TH ttk::spinbox n 8.5 Tk "Tk Themed Widget" .BS @@ -32,11 +30,11 @@ to a Tcl variable. .SH "WIDGET-SPECIFIC OPTIONS" .OP \-from from From A floating\-point value specifying the lowest value for the spinbox. This is -used in conjunction with \fI\-to\fR and \fI\-increment\fR to set a numerical +used in conjunction with \fB\-to\fR and \fB\-increment\fR to set a numerical range. .OP \-to to To A floating\-point value specifying the highest permissible value for the -widget. See also \fI\-from\fR and \fI\-increment\fR. +widget. See also \fB\-from\fR and \fB\-increment\fR. range. .OP \-increment increment Increment A floating\-point value specifying the change in value to be applied each @@ -44,8 +42,8 @@ time one of the widget spin buttons is pressed. The up button applies a positive increment, the down button applies a negative increment. .OP \-values values Values This must be a Tcl list of values. If this option is set then this will -override any range set using the \fI\-from\fR, \fI\-to\fR and -\fI\-increment\fR options. The widget will instead use the values +override any range set using the \fB\-from\fR, \fB\-to\fR and +\fB\-increment\fR options. The widget will instead use the values specified beginning with the first value. .OP \-wrap wrap Wrap Must be a proper boolean value. If on, the spinbox will wrap around the @@ -63,7 +61,7 @@ See the \fBttk::entry\fR manual for information about indexing characters. .SH "VALIDATION" .PP See the \fBttk::entry\fR manual for information about using the -\fI\-validate\fR and \fI\-validatecommand\fR options. +\fB\-validate\fR and \fB\-validatecommand\fR options. .SH "WIDGET COMMAND" .PP The following subcommands are possible for spinbox widgets in addition to @@ -75,9 +73,9 @@ the commands described for the \fBttk::entry\fR widget: Returns the spinbox's current value. .TP \fIpathName \fBset \fIvalue\fR -Set the spinbox string to \fIvalue\fR. If a \fI\-format\fR option has +Set the spinbox string to \fIvalue\fR. If a \fB\-format\fR option has been configured then this format will be applied. If formatting fails -or is not set or the \fI\-values\fR option has been used then the value +or is not set or the \fB\-values\fR option has been used then the value is set directly. .SH "SEE ALSO" ttk::widget(n), ttk::entry(n), spinbox(n) diff --git a/doc/ttk_style.n b/doc/ttk_style.n index 80b7d16..c32b028 100644 --- a/doc/ttk_style.n +++ b/doc/ttk_style.n @@ -4,8 +4,6 @@ '\" 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.17 2008/09/23 13:36:57 dkf Exp $ -'\" .so man.macros .TH ttk::style n 8.5 Tk "Tk Themed Widget" .BS diff --git a/doc/ttk_treeview.n b/doc/ttk_treeview.n index f1a491e..d414f5a 100644 --- a/doc/ttk_treeview.n +++ b/doc/ttk_treeview.n @@ -4,8 +4,6 @@ '\" 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.22 2010/03/28 21:43:25 jenglish Exp $ -'\" .so man.macros .TH ttk::treeview n 8.5 Tk "Tk Themed Widget" .BS @@ -382,16 +380,16 @@ the specified tag. \fIpathName \fBtag names\fR Returns a list of all tags used by the widget. .TP -\fIpathName \fBtag add\fR \fItag\fR \fIitems\fR +\fIpathName \fBtag add \fItag items\fR Adds the specified \fItag\fR to each of the listed \fIitems\fR. If \fItag\fR is already present for a particular item, -then the \fB-tags\fR for that item are unchanged. +then the \fB\-tags\fR for that item are unchanged. .TP -\fIpathName \fBtag remove\fR \fItag\fR ?\fIitems\fR? +\fIpathName \fBtag remove \fItag\fR ?\fIitems\fR? Removes the specified \fItag\fR from each of the listed \fIitems\fR. If \fIitems\fR is omitted, removes \fItag\fR from each item in the tree. If \fItag\fR is not present for a particular item, -then the \fB-tags\fR for that item are unchanged. +then the \fB\-tags\fR for that item are unchanged. .RE .TP \fIpathName \fBxview \fIargs\fR diff --git a/doc/ttk_vsapi.n b/doc/ttk_vsapi.n index 21edbd7..313b298 100644 --- a/doc/ttk_vsapi.n +++ b/doc/ttk_vsapi.n @@ -4,8 +4,6 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_vsapi.n,v 1.4 2008/09/23 13:36:58 dkf Exp $ -'\" .so man.macros .TH ttk_vsapi n 8.5 Tk "Tk Themed Widget" .BS @@ -16,54 +14,58 @@ ttk_vsapi \- Define a Microsoft Visual Styles element .BE .SH DESCRIPTION .PP -The \fIvsapi\fR element factory creates a new element +The \fBvsapi\fR element factory creates a new element in the current theme whose visual appearance is drawn using the -Microsoft Visual Styles API which is reponsible for the themed styles +Microsoft Visual Styles API which is responsible for the themed styles on Windows XP and Vista. This factory permits any of the Visual -Styles parts to be declared as ttk elements that can then be -included in a style layout to modify the appearance of ttk widgets. +Styles parts to be declared as Ttk elements that can then be +included in a style layout to modify the appearance of Ttk widgets. .PP \fIclassName\fR and \fIpartId\fR are required parameters and specify the Visual Styles class and part as given in the Microsoft -documentation. The \fIstateMap\fR may be provided to map ttk states to +documentation. The \fIstateMap\fR may be provided to map Ttk states to Visual Styles API states (see \fBSTATE MAP\fR). .SH "OPTIONS" .PP Valid \fIoptions\fR are: .TP -\fB\-padding\fR \fIpadding\fR +\fB\-padding \fIpadding\fR +. Specify the element's interior padding. \fIpadding\fR is a list of up to four integers specifying the left, top, right and bottom padding quantities respectively. This option may not be mixed with any other options. .TP -\fB\-margins\fR \fIpadding\fR +\fB\-margins \fIpadding\fR +. Specifies the elements exterior padding. \fIpadding\fR is a list of up to four integers specifying the left, top, right and bottom padding quantities respectively. This option may not be mixed with any other options. .TP -\fB\-width\fR \fIwidth\fR +\fB\-width \fIwidth\fR +. Specifies the height for the element. If this option is set then the Visual Styles API will not be queried for the recommended -size or the part. If this option is set then \fI-height\fR should -also be set. The \fI-width\fR and \fI-height\fR options cannot -be mixed with the \fI-padding\fR or \fI-margins\fR options. +size or the part. If this option is set then \fB\-height\fR should +also be set. The \fB\-width\fR and \fB\-height\fR options cannot +be mixed with the \fB\-padding\fR or \fB\-margins\fR options. .TP -\fB\-height\fR \fIheight\fR -Specifies the height of the element. See the comments for \fI-width\fR. +\fB\-height \fIheight\fR +. +Specifies the height of the element. See the comments for \fB\-width\fR. .SH "STATE MAP" .PP The \fIstateMap\fR parameter is a list of ttk states and the corresponding Visual Styles API state value. -This permits the element appearence to respond to changes in the +This permits the element appearance to respond to changes in the widget state such as becoming active or being pressed. The list should be as described for the \fBttk::style map\fR command but note that the last pair in the list should be the default state and is typically and empty list and 1. Unfortunately all the Visual Styles parts have different state values and these must be looked up either in the Microsoft documentation or more likely in the header files. The -original header to use was \fItmschema.h\fR but in more recent +original header to use was \fItmschema.h\fR, but in more recent versions of the Windows Development Kit this is \fIvssym32.h\fR. .PP If no \fIstateMap\fR parameter is given there is an implicit default @@ -75,16 +77,16 @@ a \fBttk::button\fR(n). This uses the WINDOW part WP_SMALLCLOSEBUTTON and as documented the states CBS_DISABLED, CBS_HOT, CBS_NORMAL and CBS_PUSHED are mapped from ttk states. .CS -ttk::style element create smallclose vsapi WINDOW 19 \\ +ttk::style element create smallclose \fBvsapi\fR WINDOW 19 \\ {disabled 4 pressed 3 active 2 {} 1} ttk::style layout CloseButton {CloseButton.smallclose -sticky news} pack [ttk::button .close -style CloseButton] .CE .PP -Change the appearence of a \fBttk::checkbutton\fR(n) to use the +Change the appearance of a \fBttk::checkbutton\fR(n) to use the Explorer pin part EBP_HEADERPIN. .CS -ttk::style element create pin vsapi EXPLORERBAR 3 { +ttk::style element create pin \fBvsapi\fR EXPLORERBAR 3 { {pressed !selected} 3 {active !selected} 2 {pressed selected} 6 diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n index 0bdf2bf..e7f7154 100644 --- a/doc/ttk_widget.n +++ b/doc/ttk_widget.n @@ -4,8 +4,6 @@ '\" 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.19 2010/07/03 17:25:51 jenglish Exp $ -'\" .so man.macros .TH ttk::widget n 8.5 Tk "Tk Themed Widget" .BS @@ -56,7 +54,7 @@ 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 +Typically the \fB\-xscrollcommand\fR option consists of the path name of a \fBscrollbar\fR widget followed by .QW set , e.g. @@ -125,11 +123,13 @@ but the \fBstate\fR widget command does not affect the \fB\-state\fR option. .SH COMMANDS .TP -\fIpathName \fBcget\fR \fIoption\fR +\fIpathName \fBcget \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) @@ -144,14 +144,16 @@ and current value. If no \fIoption\fR is specified, returns a list describing all of the available options for \fIpathName\fR. .TP -\fIpathName \fBidentify\fR \fBelement\fR \fIx y\fR +\fIpathName \fBidentify element \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 within any element. \fIx\fR and \fIy\fR are pixel coordinates relative to the widget. Some widgets accept other \fBidentify\fR subcommands. .TP -\fIpathName \fBinstate\fR \fIstatespec\fR ?\fIscript\fR? +\fIpathName \fBinstate \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. @@ -161,6 +163,7 @@ if {[\fIpathName\fR instate \fIstateSpec\fR]} \fIscript\fR .CE .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 @@ -180,6 +183,7 @@ 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 @@ -189,19 +193,23 @@ and pressing a mouse button will cause some action to occur. (aka .QW hover ). .TP \fBdisabled\fR +. Widget is disabled under program control (aka .QW unavailable , -.QW inactive ) +.QW inactive ). .TP \fBfocus\fR -Widget has keyboard focus +. +Widget has keyboard focus. .TP \fBpressed\fR +. Widget is being pressed (aka .QW armed in Motif). .TP \fBselected\fR +. .QW On , .QW true , or @@ -209,6 +217,7 @@ or for things like checkbuttons and radiobuttons. .TP \fBbackground\fR +. Windows and the Mac have a notion of an .QW active or foreground window. @@ -216,9 +225,11 @@ 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 @@ -227,11 +238,13 @@ or 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.) .TP \fBhover\fR +. The mouse cursor is within the widget. This is similar to the \fBactive\fP state; it is used in some themes for widgets that @@ -247,13 +260,13 @@ indicating that the bit is off. set b [ttk::button .b] # Disable the widget: -$b state disabled +$b \fBstate\fR disabled # Invoke the widget only if it is currently pressed and enabled: -$b instate {pressed !disabled} { .b invoke } +$b \fBinstate\fR {pressed !disabled} { .b invoke } # Reenable widget: -$b state !disabled +$b \fBstate\fR !disabled .CE .SH "SEE ALSO" ttk::intro(n), ttk::style(n) diff --git a/doc/winfo.n b/doc/winfo.n index ebf6faa..61f5480 100644 --- a/doc/winfo.n +++ b/doc/winfo.n @@ -5,8 +5,6 @@ '\" 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.14 2008/09/23 13:36:58 dkf Exp $ -'\" .so man.macros .TH winfo n 4.3 Tk "Tk Built-In Commands" .BS @@ -106,7 +104,7 @@ in pixels. \fBwinfo height \fIwindow\fR Returns a decimal string giving \fIwindow\fR's height in pixels. When a window is first created its height will be 1 pixel; the -height will eventually be changed by a geometry manager to fulfill +height will eventually be changed by a geometry manager to fulfil the window's needs. If you need the true height immediately after creating a widget, invoke \fBupdate\fR to force the geometry manager to arrange it, @@ -317,7 +315,7 @@ Returns 0 if there is no virtual root window for \fIwindow\fR. \fBwinfo width \fIwindow\fR Returns a decimal string giving \fIwindow\fR's width in pixels. When a window is first created its width will be 1 pixel; the -width will eventually be changed by a geometry manager to fulfill +width will eventually be changed by a geometry manager to fulfil the window's needs. If you need the true width immediately after creating a widget, invoke \fBupdate\fR to force the geometry manager to arrange it, @@ -5,8 +5,6 @@ '\" 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.14 2010/01/13 15:17:12 dkf Exp $ -'\" .so man.macros .TH wish 1 8.0 Tk "Tk Applications" .BS @@ -5,8 +5,6 @@ '\" 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.42 2008/11/16 17:07:51 dkf Exp $ -'\" .so man.macros .TH wm n 8.5 Tk "Tk Built-In Commands" .BS @@ -61,6 +59,13 @@ values are as follows: All platforms support the following attributes (though X11 users should see the notes below): .TP +\fB\-alpha\fR +. +Specifies the alpha transparency level of the toplevel. It accepts a value +from \fB0.0\fR (fully transparent) to \fB1.0\fR (opaque). Values outside that +range will be constrained. Where not supported, the \fB\-alpha\fR value +remains at \fB1.0\fR. +.TP \fB\-fullscreen\fR . Places the window in a mode that takes up the entire screen, has no @@ -73,14 +78,6 @@ Specifies whether this is a topmost window (displays above all other windows). .PP On Windows, the following attributes may be set. .TP -\fB\-alpha\fR -. -Specifies the alpha transparency level of the toplevel. -It accepts a value from \fB0.0\fR (fully transparent) to \fB1.0\fR -(opaque). Values outside that range will be constrained. This is -supported on Windows 2000/XP+. Where not supported, the \fB\-alpha\fR -value remains at \fB1.0\fR. -.TP \fB\-disabled\fR . Specifies whether the window is in a disabled state. @@ -99,12 +96,6 @@ at \fB{}\fR. .PP On Mac OS X, the following attributes may be set. .TP -\fB\-alpha\fR -. -Specifies the alpha transparency level of the window. -It accepts a value from \fB0.0\fR (fully transparent) to \fB1.0\fR (opaque), -values outside that range will be constrained. -.TP \fB\-modified\fR . Specifies the modification state of the window (determines whether the @@ -123,7 +114,7 @@ can be dragged and dropped in lieu of the file's finder icon). \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 +the transparency to be effective, the toplevel background needs to be set to a color with some alpha, e.g. .QW systemTransparent . .PP @@ -131,6 +122,86 @@ On X11, the following attributes may be set. These are not supported by all window managers, and will have no effect under older WMs. .\" See http://www.freedesktop.org/Standards/wm-spec .TP +\fB\-type\fR +.VS 8.6 +Requests that the window should be interpreted by the window manager as being +of the specified type(s). This may cause the window to be decorated in a +different way or otherwise managed differently, though exactly what happens is +entirely up to the window manager. A list of types may be used, in order of +preference. The following values are mapped to constants defined in the EWMH +specification (using others is possible, but not advised): +.RS +.TP +\fBdesktop\fR +. +indicates a desktop feature, +.TP +\fBdock\fR +. +indicates a dock/panel feature, +.TP +\fBtoolbar\fR +. +indicates a toolbar window that should be acting on behalf of another window, +as indicated with \fBwm transient\fR, +.TP +\fBmenu\fR +. +indicates a torn-off menu that should be acting on behalf of another window, +as indicated with \fBwm transient\fR, +.TP +\fButility\fR +. +indicates a utility window (e.g., palette or toolbox) that should be acting on +behalf of another window, as indicated with \fBwm transient\fR, +.TP +\fBsplash\fR +. +indicates a splash screen, displayed during application start up, +.TP +\fBdialog\fR +. +indicates a general dialog window, that should be acting on behalf of another +window, as indicated with \fBwm transient\fR, +.TP +\fBdropdown_menu\fR +. +indicates a menu summoned from a menu bar, which should usually also be set to +be override-redirected (with \fBwm overrideredirect\fR), +.TP +\fBpopup_menu\fR +. +indicates a popup menu, which should usually also be set to be +override-redirected (with \fBwm overrideredirect\fR), +.TP +\fBtooltip\fR +. +indicates a tooltip window, which should usually also be set to be +override-redirected (with \fBwm overrideredirect\fR), +.TP +\fBnotification\fR +. +indicates a window that provides a background notification of some event, +which should usually also be set to be override-redirected (with \fBwm +overrideredirect\fR), +.TP +\fBcombo\fR +. +indicates the drop-down list of a combobox widget, which should usually also +be set to be override-redirected (with \fBwm overrideredirect\fR), +.TP +\fBdnd\fR +. +indicates a window that represents something being dragged, which should +usually also be set to be override-redirected (with +\fBwm overrideredirect\fR), +.TP +\fBnormal\fR +. +indicates a window that has no special interpretation. +.RE +.VE 8.6 +.TP \fB\-zoomed\fR . Requests that the window should be maximized. This is the same as \fBwm state @@ -278,6 +349,15 @@ If \fInewGeometry\fR is specified as an empty string then any existing user-specified geometry for \fIwindow\fR is cancelled, and the window will revert to the size requested internally by its widgets. +.PP +Note that this is related to \fBwinfo geometry\fR, but not the same. That can +only query the geometry, and always reflects Tk's current understanding of the +actual size and location of \fIwindow\fR, whereas \fBwm geometry\fR allows +both setting and querying of the \fIwindow manager\fR's understanding of the +size and location of the window. This can vary significantly, for example to +reflect the addition of decorative elements to \fIwindow\fR such as title +bars, and window managers are not required to precisely follow the requests +made through this command. .RE .TP \fBwm grid \fIwindow\fR ?\fIbaseWidth baseHeight widthInc heightInc\fR? @@ -635,6 +715,9 @@ empty string if \fIwindow\fR is not currently a transient window. A transient window will mirror state changes in the master and inherit the state of the master when initially mapped. It is an error to attempt to make a window a transient of itself. +The window manager may also decorate a transient window differently, removing +some features normally present (e.g., minimize and maximize buttons) though +this is entirely at the discretion of the window manager. .TP \fBwm withdraw \fIwindow\fR . |