diff options
| -rw-r--r-- | ChangeLog | 126 | ||||
| -rw-r--r-- | doc/ConfigWidg.3 | 6 | ||||
| -rw-r--r-- | doc/bind.n | 146 | ||||
| -rw-r--r-- | doc/grid.n | 178 | ||||
| -rw-r--r-- | doc/panedwindow.n | 6 | ||||
| -rw-r--r-- | doc/text.n | 56 | ||||
| -rw-r--r-- | doc/ttk_Geometry.3 | 16 | ||||
| -rw-r--r-- | doc/ttk_button.n | 24 | ||||
| -rw-r--r-- | doc/ttk_checkbutton.n | 12 | ||||
| -rw-r--r-- | doc/ttk_combobox.n | 36 | ||||
| -rw-r--r-- | doc/ttk_dialog.n | 28 | ||||
| -rw-r--r-- | doc/ttk_entry.n | 84 | ||||
| -rw-r--r-- | doc/ttk_frame.n | 18 | ||||
| -rw-r--r-- | doc/ttk_image.n | 50 | ||||
| -rw-r--r-- | doc/ttk_intro.n | 2 | ||||
| -rw-r--r-- | doc/ttk_label.n | 10 | ||||
| -rw-r--r-- | doc/ttk_labelframe.n | 22 | ||||
| -rw-r--r-- | doc/ttk_menubutton.n | 2 | ||||
| -rw-r--r-- | doc/ttk_notebook.n | 14 | ||||
| -rw-r--r-- | doc/ttk_panedwindow.n | 12 | ||||
| -rw-r--r-- | doc/ttk_progressbar.n | 30 | ||||
| -rw-r--r-- | doc/ttk_radiobutton.n | 14 | ||||
| -rw-r--r-- | doc/ttk_scrollbar.n | 24 | ||||
| -rw-r--r-- | doc/ttk_separator.n | 6 | ||||
| -rw-r--r-- | doc/ttk_sizegrip.n | 6 | ||||
| -rw-r--r-- | doc/ttk_style.n | 28 | ||||
| -rw-r--r-- | doc/ttk_widget.n | 24 | ||||
| -rw-r--r-- | doc/wm.n | 12 |
28 files changed, 502 insertions, 490 deletions
@@ -1,23 +1,34 @@ +2006-11-15 Donal K. Fellows <dkf@users.sf.net> + + * doc/ConfigWidg.3, doc/bind.n, doc/grid.n, doc/panedwindow.n: + * doc/text.n, doc/ttk_Geometry.3, doc/ttk_button.n: + * doc/ttk_checkbutton.n, doc/ttk_combobox.n, doc/ttk_dialog.n: + * doc/ttk_entry.n, doc/ttk_frame.n, doc/ttk_image.n, doc/ttk_intro.n: + * doc/ttk_label.n, doc/ttk_labelframe.n, doc/ttk_menubutton.n: + * doc/ttk_notebook.n, doc/ttk_panedwindow.n, doc/ttk_progressbar.n: + * doc/ttk_radiobutton.n, doc/ttk_scrollbar.n, doc/ttk_separator.n: + * doc/ttk_sizegrip.n, doc/ttk_style.n, doc/ttk_widget.n, doc/wm.n: + Convert \fP to \fR so that man-page scrapers have an easier time. + 2006-11-14 Joe English <jenglish@users.sourceforge.net> - * generic/ttk/ttkDefaultTheme.c: Fix off-by-one bug in - tree indicator size computation [#1596021, patch from Tim Baker]. - Increased default size from 7 to 9 pixels. + * generic/ttk/ttkDefaultTheme.c: Fix off-by-one bug in tree indicator + size computation [Bug 1596021, patch from Tim Baker]. Increased + default size from 7 to 9 pixels. 2006-11-12 Joe English <jenglish@users.sourceforge.net> - * generic/ttkScroll.c: *correct* fix for #1588251. + * generic/ttkScroll.c: *correct* fix for [Bug 1588251]. 2006-11-12 Joe English <jenglish@users.sourceforge.net> - * tests/ttk/ttk.test(ttk-6.9): Workaround for #1583038 + * tests/ttk/ttk.test(ttk-6.9): Workaround for [Bug 1583038] 2006-11-12 Joe English <jenglish@users.sourceforge.net> - * generic/ttkScroll.c: Reworked cleanup procedure -- - "self-cancelling" idle call is not robust, call - Tcl_CancelIdleCall() in TtkFreeScrollHandle instead. - [fixes #1588251] + * generic/ttkScroll.c: Reworked cleanup procedure; "self-cancelling" + idle call is not robust, call Tcl_CancelIdleCall() in + TtkFreeScrollHandle instead. Fixes [Bug 1588251] 2006-11-10 Daniel Steffen <das@users.sourceforge.net> @@ -32,10 +43,10 @@ 2006-11-08 Kevin Kenny <kennykb@acm.org> - * unix/configure.in: Silenced warnings about missing Xft - configuration unless --enable-xft is requested explicitly. - Also added a few basic checks that we can actually compile - and link against Xft headers and libraries. [Bug 1592667] + * unix/configure.in: Silenced warnings about missing Xft configuration + unless --enable-xft is requested explicitly. Also added a few basic + checks that we can actually compile and link against Xft headers and + libraries. [Bug 1592667] * unix/configure: Regen. 2006-11-07 Kevin Kenny <kennykb@acm.org> @@ -46,27 +57,27 @@ 2006-11-06 Joe English <jenglish@users.sourceforge.net> * generic/ttk/ttkClassicTheme.c, generic/ttk/ttkPanedwindow.c, - generic/ttk/ttkTheme.c, generic/ttk/ttkTreeview.c, - win/ttkWinXPTheme.c, library/ttk/entry.tcl, - library/ttk/notebook.tcl, library/ttk/panedwindow.tcl, - library/ttk/utils.tcl, tests/ttk/entry.test, tests/ttk/bwidget.test: - Miscellaneous minor changes to re-sync Ttk codebase with Tile CVS: - fix comments damaged by overzealous search-and-destroy; - removed obsolete [style default] synonym for [ttk::style configure]; - removed other dead code. + * generic/ttk/ttkTheme.c, generic/ttk/ttkTreeview.c, + * win/ttkWinXPTheme.c, library/ttk/entry.tcl, + * library/ttk/notebook.tcl, library/ttk/panedwindow.tcl, + * library/ttk/utils.tcl, tests/ttk/entry.test, tests/ttk/bwidget.test: + Miscellaneous minor changes to re-sync Ttk codebase with Tile CVS: fix + comments damaged by overzealous search-and-destroy; removed obsolete + [style default] synonym for [ttk::style configure]; removed other dead + code. 2006-11-03 Pat Thoyts <patthoyts@users.sourceforge.net> * library/safetk.tcl (::safe::tkTopLevel): Theme it. - * generic/ttk/ttkLayout.c: We do not want to require tkInt in - * generic/ttk/ttkMananager.h: all the ttk files so added the - * generic/ttk/ttkTheme.h: definition of MODULE_SCOPE to - * generic/ttk/ttkWinMonitor.c: ttkTheme.h Ensure everyone - gets to see the definition from someplace. + * generic/ttk/ttkLayout.c: We do not want to require tkInt in all + * generic/ttk/ttkMananager.h: the ttk files so added the definition + * generic/ttk/ttkTheme.h: of MODULE_SCOPE to ttkTheme.h. Ensures + * generic/ttk/ttkWinMonitor.c: everyone gets to see the definition + from someplace. - * library/ttk/fonts.tcl: In a safe interp there is no osVersion - field in tcl_platform so work around it. + * library/ttk/fonts.tcl: In a safe interp there is no osVersion field + in tcl_platform so work around it. 2006-11-02 Daniel Steffen <das@users.sourceforge.net> @@ -92,7 +103,7 @@ static when possible); so that 'make check{exports,stubs}' once again complete without errors. - * macosx/tkMacOSXColor.c (TkMacOSXCompareColors): ifdef out when unused. + * macosx/tkMacOSXColor.c (TkMacOSXCompareColors): ifdef out when unused * macosx/Wish.xcodeproj/project.pbxproj: check autoconf/autoheader exit status and stop build if they fail. @@ -104,10 +115,10 @@ 2006-11-01 Daniel Steffen <das@users.sourceforge.net> - * macosx/tkMacOSXDebug.c: add TkMacOSX prefix to leftover macosx-private - * macosx/tkMacOSXDebug.h: global symbols without Tk prefix; ifdef out - * macosx/tkMacOSXEmbed.c: currently unused debug procs. - * macosx/tkMacOSXEvent.c: + * macosx/tkMacOSXDebug.c: add TkMacOSX prefix to leftover + * macosx/tkMacOSXDebug.h: macosx-private global symbols without Tk + * macosx/tkMacOSXEmbed.c: prefix; ifdef out currently unused debug + * macosx/tkMacOSXEvent.c: procs. * macosx/tkMacOSXInt.h: * macosx/tkMacOSXCarbonEvents.c: * macosx/tkMacOSXSubwindows.c: @@ -184,8 +195,8 @@ * win/ttkWinMonitor.c, win/ttkWinTheme.c, win/ttkWinXPTheme.c: First import of Ttk themed Tk widgets as branched from tile 0.7.8 - * generic/tkInt.h, generic/tkWindow.c: add Ttk_Init call, copy - tk classic widgets to ::tk namespace. + * generic/tkInt.h, generic/tkWindow.c: add Ttk_Init call, copy tk + classic widgets to ::tk namespace. * library/tk.tcl: add source of ttk/ttk.tcl, define $::ttk::library. * unix/Makefile.in, win/Makefile.in: add Ttk build bits * win/configure, win/configure.in: check for uxtheme.h (XP theme). @@ -219,12 +230,12 @@ * doc/text.n: fix docs to not correct -tabs usage case. - * generic/tkTextDisp.c (SizeOfTab): fix -tabstyle wordprocessor - tab alignment to correct tab edge case. [Bug 1578858] + * generic/tkTextDisp.c (SizeOfTab): fix -tabstyle wordprocessor tab + alignment to correct tab edge case. [Bug 1578858] 2006-10-17 Pat Thoyts <patthoyts@users.sourceforge.net> - * generic/tkText.c: Applied suggested patch from #1536735 + * generic/tkText.c: Applied suggested patch from [Bug 1536735] * tests/text.test: Update test for above patch. * tests/textWind.test: Corrected test to catch all messages * tests/safe.test: Silence spurious win32 failure awaiting TIP150 @@ -234,17 +245,18 @@ 2006-10-16 Andreas Kupries <andreask@activestate.com> * doc/WindowId.3: Pat's commit on 2006-10-08 broke the .SH NAME - information across several lines, breaking the cross-linking of - manpages during installation for this one. Put everything back - on a single line, unbreaking it. + information across several lines, breaking the cross-linking of + manpages during installation for this one. Put everything back on a + single line, unbreaking it. 2006-10-16 Daniel Steffen <das@users.sourceforge.net> * changes: updates for 8.5a5 release. - * macosx/tkMacOSXDraw.c: fix numerous issues in CG and QD drawing procs - so that they now match X11 drawing much more closely [Bug 1558051]; - use Tiger ellipse drawing API when available; fix comments & whitespace. + * macosx/tkMacOSXDraw.c: fix numerous issues in CG and QD drawing + procs so that they now match X11 drawing much more closely [Bug + 1558051]; use Tiger ellipse drawing API when available; fix comments & + whitespace. * macosx/tkMacOSXInit.c: set default linewidth limit for CG antialiasing to 0 as thin horizontal/vertical lines look good now. @@ -274,17 +286,17 @@ * unix/tkUnixFont.c (Ucs2beToUtfProc, UtfToUcs2beProc): (TkpFontPkgInit, encodingAliases): Correct alignment issues in - encoding conversion. Call ucs-2be "unicode" on big-endian - systems. [Bug 1122671] + encoding conversion. Call ucs-2be "unicode" on big-endian systems. + [Bug 1122671] 2006-09-27 Andreas Kupries <andreask@activestate.com> * unix/Makefile.in (install-binaries): Added a second guard to the - * win/Makefile.in: package index file to prevent older versions of - * win/makefile.vc: Tcl from seeing version numbers which may - contain a/b information, and then balking on them. This could - otherwise happen when Tcl/Tk 8.4 and 8.5 are installed in the - same directory, seeing each other. [SF Tk Bug 1566418]. + * win/Makefile.in: package index file to prevent older versions of Tcl + * win/makefile.vc: from seeing version numbers which may contain a/b + information, and then balking on them. This could otherwise happen + when Tcl/Tk 8.4 and 8.5 are installed in the same directory, seeing + each other. [Bug 1566418]. 2006-09-22 Andreas Kupries <andreask@activestate.com> @@ -331,7 +343,7 @@ 2006-09-10 Daniel Steffen <das@users.sourceforge.net> - * macosx/tkMacOSXColor.c (TkSetMacColor, TkpGetColor): use AppearanceMgr + * macosx/tkMacOSXColor.c (TkSetMacColor,TkpGetColor): use AppearanceMgr * macosx/tkMacOSXDefault.h: to retrieve platform std colors for text * macosx/tkMacOSXPort.h: selections, add "systemHighlightSecondary" color name for standard color of inactive selections, use this color as @@ -377,11 +389,11 @@ 2006-09-06 Jeff Hobbs <jeffh@ActiveState.com> - * generic/tkEntry.c: move hard-coded ALWAYS_SHOW_SELECTION - * generic/tkInt.h: control of entry/text selection display - * generic/tkText.c: based on focus to the Tcl level, - * generic/tkWindow.c: controlled by ::tk::AlwaysShowSelection - * library/tk.tcl: (boolean, private). [Bug 1553691] + * generic/tkEntry.c: move hard-coded ALWAYS_SHOW_SELECTION control + * generic/tkInt.h: of entry/text selection display based on focus + * generic/tkText.c: to the Tcl level, controlled by + * generic/tkWindow.c: ::tk::AlwaysShowSelection (boolean, private). + * library/tk.tcl: [Bug 1553691] * macosx/tkMacOSXDefault.h: * unix/tkUnixDefault.h: * unix/tkUnixPort.h: diff --git a/doc/ConfigWidg.3 b/doc/ConfigWidg.3 index 6a6df97..e0b6425 100644 --- a/doc/ConfigWidg.3 +++ b/doc/ConfigWidg.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ConfigWidg.3,v 1.14 2005/12/06 09:16:10 dkf Exp $ +'\" RCS: @(#) $Id: ConfigWidg.3,v 1.15 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH Tk_ConfigureWidget 3 4.1 Tk "Tk Library Procedures" @@ -64,8 +64,8 @@ order to free up resources. .BE .SH DESCRIPTION .PP -Note: \fBTk_ConfigureWidget\fP should be replaced with the new -\fBTcl_Obj\fP based API \fBTk_SetOptions\fP. The old interface is +Note: \fBTk_ConfigureWidget\fR should be replaced with the new +\fBTcl_Obj\fR based API \fBTk_SetOptions\fR. The old interface is retained for backward compatibility. .PP \fBTk_ConfigureWidget\fR is called to configure various aspects of a @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: bind.n,v 1.19 2005/04/06 21:11:54 dkf Exp $ +'\" RCS: @(#) $Id: bind.n,v 1.20 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH bind n 8.0 Tk "Tk Built-In Commands" @@ -209,139 +209,139 @@ this value is at least 120 before it is reported. However, higher resolution devices may be available in the future. The sign of the value determines which direction your widget should scroll. Positive values should scroll up and negative values should scroll down. -.IP "\fBKeyPress\fP, \fBKeyRelease\fP" 5 -The \fBKeyPress\fP and \fBKeyRelease\fP events are generated -whenever a key is pressed or released. \fBKeyPress\fP and \fBKeyRelease\fP +.IP "\fBKeyPress\fR, \fBKeyRelease\fR" 5 +The \fBKeyPress\fR and \fBKeyRelease\fR events are generated +whenever a key is pressed or released. \fBKeyPress\fR and \fBKeyRelease\fR events are sent to the window which currently has the keyboard focus. -.IP "\fBButtonPress\fP, \fBButtonRelease\fP, \fBMotion\fP" 5 -The \fBButtonPress\fP and \fBButtonRelease\fP events +.IP "\fBButtonPress\fR, \fBButtonRelease\fR, \fBMotion\fR" 5 +The \fBButtonPress\fR and \fBButtonRelease\fR events are generated when the user presses or releases a mouse button. -\fBMotion\fP events are generated whenever the pointer is moved. -\fBButtonPress\fP, \fBButtonRelease\fP, and \fBMotion\fP events are +\fBMotion\fR events are generated whenever the pointer is moved. +\fBButtonPress\fR, \fBButtonRelease\fR, and \fBMotion\fR events are normally sent to the window containing the pointer. .RS .PP When a mouse button is pressed, the window containing the pointer automatically obtains a temporary pointer grab. -Subsequent \fBButtonPress\fP, \fBButtonRelease\fP, and \fBMotion\fP +Subsequent \fBButtonPress\fR, \fBButtonRelease\fR, and \fBMotion\fR events will be sent to that window, regardless of which window contains the pointer, until all buttons have been released. .RE -.IP \fBConfigure\fP 5 -A \fBConfigure\fP event is sent to a window whenever its +.IP \fBConfigure\fR 5 +A \fBConfigure\fR event is sent to a window whenever its size, position, or border width changes, and sometimes when it has changed position in the stacking order. -.IP "\fBMap\fP, \fBUnmap\fP" 5 -The \fBMap\fP and \fBUnmap\fP events are generated whenever the mapping +.IP "\fBMap\fR, \fBUnmap\fR" 5 +The \fBMap\fR and \fBUnmap\fR events are generated whenever the mapping state of a window changes. .RS .PP Windows are created in the unmapped state. Top-level windows become mapped when they transition to the -\fBnormal\fP state, and are unmapped in the \fBwithdrawn\fP -and \fBiconic\fP states. +\fBnormal\fR state, and are unmapped in the \fBwithdrawn\fR +and \fBiconic\fR states. Other windows become mapped when they are placed under control -of a geometry manager (for example \fBpack\fP or \fBgrid\fP). +of a geometry manager (for example \fBpack\fR or \fBgrid\fR). .PP -A window is \fIviewable\fP only if it and all of its ancestors are mapped. +A window is \fIviewable\fR only if it and all of its ancestors are mapped. Note that geometry managers typically do not map their children until they have been mapped themselves, and unmap all children -when they become unmapped; hence in Tk \fBMap\fP and \fBUnmap\fP +when they become unmapped; hence in Tk \fBMap\fR and \fBUnmap\fR events indicate whether or not a window is viewable. .RE -.IP \fBVisibility\fP 5 -A window is said to be \fIobscured\fP when another window +.IP \fBVisibility\fR 5 +A window is said to be \fIobscured\fR when another window above it in the stacking order fully or partially overlaps it. -\fBVisibility\fP events are generated whenever a window's -obscurity state changes; the \fIstate\fP field (\fB%s\fP) +\fBVisibility\fR events are generated whenever a window's +obscurity state changes; the \fIstate\fR field (\fB%s\fR) specifies the new state. -.IP \fBExpose\fP 5 -An \fBExpose\fP event is generated whenever all or part of a +.IP \fBExpose\fR 5 +An \fBExpose\fR event is generated whenever all or part of a window should be redrawn (for example, when a window is first mapped or if it becomes unobscured). It is normally not necessary for client applications to -handle \fBExpose\fP events, since Tk handles them internally. -.IP \fBDestroy\fP 5 -A \fBDestroy\fP event is delivered to a window when +handle \fBExpose\fR events, since Tk handles them internally. +.IP \fBDestroy\fR 5 +A \fBDestroy\fR event is delivered to a window when it is destroyed. .RS .PP -When the \fBDestroy\fP event is delivered +When the \fBDestroy\fR event is delivered to a widget, it is in a ``half-dead'' state: the widget still exists, but most operations on it will fail. .RE -.IP "\fBFocusIn\fP, \fBFocusOut\fP" 5 -The \fBFocusIn\fP and \fBFocusOut\fP events are generated +.IP "\fBFocusIn\fR, \fBFocusOut\fR" 5 +The \fBFocusIn\fR and \fBFocusOut\fR events are generated whenever the keyboard focus changes. -A \fBFocusOut\fP event is sent to the old focus window, -and a \fBFocusIn\fP event is sent to the new one. +A \fBFocusOut\fR event is sent to the old focus window, +and a \fBFocusIn\fR event is sent to the new one. .RS .PP In addition, if the old and new focus windows do not share a common parent, ``virtual crossing'' focus events are sent to the intermediate windows in the hierarchy. -Thus a \fBFocusIn\fP event indicates +Thus a \fBFocusIn\fR event indicates that the target window or one of its descendants has acquired the focus, -and a \fBFocusOut\fP event indicates that the focus +and a \fBFocusOut\fR event indicates that the focus has been changed to a window outside the target window's hierarchy. .PP -The keyboard focus may be changed explicitly by a call to \fBfocus\fP, +The keyboard focus may be changed explicitly by a call to \fBfocus\fR, or implicitly by the window manager. .RE -.IP "\fBEnter\fP, \fBLeave\fP" 5 -An \fBEnter\fP event is sent to a window when the pointer -enters that window, and a \fBLeave\fP event is sent when +.IP "\fBEnter\fR, \fBLeave\fR" 5 +An \fBEnter\fR event is sent to a window when the pointer +enters that window, and a \fBLeave\fR event is sent when the pointer leaves it. .RS .PP -If there is a pointer grab in effect, \fBEnter\fP and \fBLeave\fP +If there is a pointer grab in effect, \fBEnter\fR and \fBLeave\fR events are only delivered to the window owning the grab. .PP In addition, when the pointer moves -between two windows, \fBEnter\fP and \fBLeave\fP +between two windows, \fBEnter\fR and \fBLeave\fR ``virtual crossing'' events are sent to intermediate windows -in the hierarchy in the same manner as for \fBFocusIn\fP and -\fBFocusOut\fP events. +in the hierarchy in the same manner as for \fBFocusIn\fR and +\fBFocusOut\fR events. .RE -.IP \fBProperty\fP -A \fBProperty\fP event is sent to a window whenever an X property +.IP \fBProperty\fR +A \fBProperty\fR event is sent to a window whenever an X property belonging to that window is changed or deleted. -\fBProperty\fP events are not normally delivered to Tk applications as +\fBProperty\fR events are not normally delivered to Tk applications as they are handled by the Tk core. -.IP \fBColormap\fP -A \fBColormap\fP event is generated whenever the colormap +.IP \fBColormap\fR +A \fBColormap\fR event is generated whenever the colormap associated with a window has been changed, installed, or uninstalled. .RS .PP Widgets may be assigned a private colormap by -specifying a \fB-colormap\fP option; the window manager +specifying a \fB-colormap\fR option; the window manager is responsible for installing and uninstalling colormaps as necessary. .PP Note that Tk provides no useful details for this event type. .RE '\" The following events were added in TIP#47 -.IP "\fBMapRequest\fP, \fBCirculateRequest\fP, \fBResizeRequest\fP, \fBConfigureRequest\fP, \fBCreate\fP" 5 +.IP "\fBMapRequest\fR, \fBCirculateRequest\fR, \fBResizeRequest\fR, \fBConfigureRequest\fR, \fBCreate\fR" 5 These events are not normally delivered to Tk applications. They are included for completeness, to make it possible to write X11 window managers in Tk. (These events are only delivered when a client has -selected \fBSubstructureRedirectMask\fP on a window; +selected \fBSubstructureRedirectMask\fR on a window; the Tk core does not use this mask.) -.IP "\fBGravity\fP, \fBReparent\fP, \fBCirculate\fP" 5 -The events \fBGravity\fP and \fBReparent\fP +.IP "\fBGravity\fR, \fBReparent\fR, \fBCirculate\fR" 5 +The events \fBGravity\fR and \fBReparent\fR are not normally delivered to Tk applications. They are included for completeness. .RS .PP -A \fBCirculate\fP event indicates that the window has moved +A \fBCirculate\fR event indicates that the window has moved to the top or to the bottom of the stacking order as -a result of an \fBXCirculateSubwindows\fP protocol request. +a result of an \fBXCirculateSubwindows\fR protocol request. Note that the stacking order may be changed for other reasons -which do not generate a \fBCirculate\fP event, and that -Tk does not use \fBXCirculateSubwindows()\fP internally. +which do not generate a \fBCirculate\fR event, and that +Tk does not use \fBXCirculateSubwindows()\fR internally. This event type is included only for completeness; there is no reliable way to track changes to a window's position in the stacking order. @@ -409,14 +409,14 @@ The \fIabove\fR field from the event, formatted as a hexadecimal number. Valid only for \fBConfigure\fR events. Indicates the sibling window immediately below the receiving window -in the stacking order, or \fB0\fP if the receiving window is at the +in the stacking order, or \fB0\fR if the receiving window is at the bottom. .IP \fB%b\fR 5 The number of the button that was pressed or released. Valid only for \fBButtonPress\fR and \fBButtonRelease\fR events. .IP \fB%c\fR 5 The \fIcount\fR field from the event. Valid only for \fBExpose\fR events. -Indicates that there are \fIcount\fP pending \fBExpose\fP events which have not +Indicates that there are \fIcount\fR pending \fBExpose\fR events which have not yet been delivered to the window. .IP \fB%d\fR 5 The \fIdetail\fR @@ -453,9 +453,9 @@ For events other than these, the substituted string is undefined. .RE .IP \fB%f\fR 5 The \fIfocus\fR field from the event (\fB0\fR or \fB1\fR). Valid only -for \fBEnter\fR and \fBLeave\fR events. \fB1\fP if the receiving +for \fBEnter\fR and \fBLeave\fR events. \fB1\fR if the receiving window is the focus window or a descendant of the focus window, -\fB0\fP otherwise. +\fB0\fR otherwise. .IP \fB%h\fR 5 The \fIheight\fR field from the event. Valid for the \fBConfigure\fR, \fBConfigureRequest\fR, \fBCreate\fR, \fBResizeRequest\fR, and @@ -486,9 +486,9 @@ The \fIstate\fR field from the event. For \fBButtonPress\fR, is substituted. For \fBVisibility\fR, one of the strings \fBVisibilityUnobscured\fR, \fBVisibilityPartiallyObscured\fR, and \fBVisibilityFullyObscured\fR is substituted. -For \fBProperty\fP events, substituted with -either the string \fBNewValue\fP (indicating that the property -has been created or modified) or \fBDelete\fP (indicating that +For \fBProperty\fR events, substituted with +either the string \fBNewValue\fR (indicating that the property +has been created or modified) or \fBDelete\fR (indicating that the property has been removed). .IP \fB%t\fR 5 The \fItime\fR field from the event. @@ -503,13 +503,13 @@ Valid only for \fBResizeRequest\fR, and \fBExpose\fR events. .IP "\fB%x\fR, \fB%y\fR" 5 The \fIx\fR and \fIy\fR fields from the event. -For \fBButtonPress\fP, \fBButtonRelease\fP, \fBMotion\fP, -\fBKeyPress\fP, \fBKeyRelease\fP, and \fBMouseWheel\fP events, -\fB%x\fP and \fB%y\fP indicate the position of the mouse pointer +For \fBButtonPress\fR, \fBButtonRelease\fR, \fBMotion\fR, +\fBKeyPress\fR, \fBKeyRelease\fR, and \fBMouseWheel\fR events, +\fB%x\fR and \fB%y\fR indicate the position of the mouse pointer relative to the receiving window. -For \fBEnter\fP and \fBLeave\fP events, the position where the +For \fBEnter\fR and \fBLeave\fR events, the position where the mouse pointer crossed the window, relative to the receiving window. -For \fBConfigure\fP and \fBCreate\fP requests, the \fIx\fP and \fIy\fP +For \fBConfigure\fR and \fBCreate\fR requests, the \fIx\fR and \fIy\fR coordinates of the window relative to its parent window. .IP \fB%A\fR 5 Substitutes the UNICODE character corresponding to the event, or @@ -530,8 +530,8 @@ the delta. The sign of the value represents the direction the mouse wheel was scrolled. .IP \fB%E\fR 5 The \fIsend_event\fR field from the event. Valid for all event types. -\fB0\fP indicates that this is a ``normal'' event, \fB1\fP indicates -that it is a ``synthetic'' event generated by \fBSendEvent\fP. +\fB0\fR indicates that this is a ``normal'' event, \fB1\fR indicates +that it is a ``synthetic'' event generated by \fBSendEvent\fR. .IP \fB%K\fR 5 The keysym corresponding to the event, substituted as a textual string. Valid only for \fBKeyPress\fR and \fBKeyRelease\fR events. @@ -541,7 +541,7 @@ number. Valid only for \fBKeyPress\fR and \fBKeyRelease\fR events. .IP \fB%P\fR 5 The name of the property being updated or deleted (which may be converted to an XAtom using \fBwinfo atom\fR.) Valid -only for \fBProperty\fP events. +only for \fBProperty\fR events. .IP \fB%R\fR 5 The \fIroot\fR window identifier from the event. Valid only for events containing a \fIroot\fR field. @@ -561,7 +561,7 @@ value is the corresponding x-coordinate in the virtual root. Valid only for \fBButtonPress\fR, \fBButtonRelease\fR, \fBKeyPress\fR, \fBKeyRelease\fR, and \fBMotion\fR events. -Same meaning as \fB%x\fP, except relative to the (virtual) root window. +Same meaning as \fB%x\fR, except relative to the (virtual) root window. .IP \fB%Y\fR 5 The \fIy_root\fR field from the event. If a virtual-root window manager is being used then the substituted @@ -569,7 +569,7 @@ value is the corresponding y-coordinate in the virtual root. Valid only for \fBButtonPress\fR, \fBButtonRelease\fR, \fBKeyPress\fR, \fBKeyRelease\fR, and \fBMotion\fR events. -Same meaning as \fB%y\fP, except relative to the (virtual) root window. +Same meaning as \fB%y\fR, except relative to the (virtual) root window. .LP The replacement string for a %-replacement is formatted as a proper Tcl list element. @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: grid.n,v 1.14 2004/10/29 07:53:15 dkf Exp $ +'\" RCS: @(#) $Id: grid.n,v 1.15 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH grid n 8.5 Tk "Tk Built-In Commands" @@ -27,7 +27,7 @@ on the \fIoption\fR argument: \fBgrid \fIslave \fR?\fIslave ...\fR? ?\fIoptions\fR? If the first argument to \fBgrid\fR is suitable as the first slave argument to \fBgrid configure\fR, either a window name (any value -starting with \fB.\fP) or one of the characters \fBx\fP or \fB^\fP +starting with \fB.\fR) or one of the characters \fBx\fR or \fB^\fR (see the \fBRELATIVE PLACEMENT\fR section below), then the command is processed in the same way as \fBgrid configure\fR. .VS 8.5 @@ -44,41 +44,41 @@ the bounding box (in pixels) of the grid is returned. The return value consists of 4 integers. The first two are the pixel offset from the master window (x then y) of the top-left corner of the grid, and the second two integers are the width and height of the grid, -also in pixels. If a single \fIcolumn\fP and \fIrow\fP is specified on +also in pixels. If a single \fIcolumn\fR and \fIrow\fR is specified on the command line, then the bounding box for that cell is returned, where the -top left cell is numbered from zero. If both \fIcolumn\fP and \fIrow\fP +top left cell is numbered from zero. If both \fIcolumn\fR and \fIrow\fR arguments are specified, then the bounding box spanning the rows and columns indicated is returned. .TP \fBgrid columnconfigure \fImaster index \fR?\fI\-option value...\fR? -Query or set the column properties of the \fIindex\fP column of the -geometry master, \fImaster\fP. -The valid options are \fB\-minsize\fP, \fB\-weight\fP, \fB\-uniform\fP -and \fB-pad\fP. -If one or more options are provided, then \fIindex\fP may be given as +Query or set the column properties of the \fIindex\fR column of the +geometry master, \fImaster\fR. +The valid options are \fB\-minsize\fR, \fB\-weight\fR, \fB\-uniform\fR +and \fB-pad\fR. +If one or more options are provided, then \fIindex\fR may be given as a list of column indices to which the configuration options will operate on. .VS 8.5 -Indices may be integers, window names or the keyword \fIall\fP. For \fIall\fP +Indices may be integers, window names or the keyword \fIall\fR. For \fIall\fR the options apply to all columns currently occupied be slave windows. For a window name, that window must be a slave of this master and the options apply to all columns currently occupied be the slave. .VE 8.5 -The \fB\-minsize\fP option sets the minimum size, in screen units, +The \fB\-minsize\fR option sets the minimum size, in screen units, that will be permitted for this column. -The \fB\-weight\fP option (an integer value) +The \fB\-weight\fR option (an integer value) sets the relative weight for apportioning any extra spaces among columns. A weight of zero (0) indicates the column will not deviate from its requested size. A column whose weight is two will grow at twice the rate as a column of weight one when extra space is allocated to the layout. -The \fB-uniform\fP option, when a non-empty value is supplied, places -the column in a \fIuniform group\fP with other columns that have the -same value for \fB-uniform\fP. The space for columns belonging to a +The \fB-uniform\fR option, when a non-empty value is supplied, places +the column in a \fIuniform group\fR with other columns that have the +same value for \fB-uniform\fR. The space for columns belonging to a uniform group is allocated so that their sizes are always in strict -proportion to their \fB-weight\fP values. See +proportion to their \fB-weight\fR values. See \fBTHE GRID ALGORITHM\fR below for further details. -The \fB-pad\fP option specifies the number of screen units that will be +The \fB-pad\fR option specifies the number of screen units that will be added to the largest window contained completely in that column when the grid geometry manager requests a size from the containing window. If only an option is specified, with no value, @@ -90,27 +90,27 @@ are returned in a list of "-option value" pairs. The arguments consist of the names of one or more slave windows followed by pairs of arguments that specify how to manage the slaves. -The characters \fB\-\fP, \fBx\fP and \fB^\fP, +The characters \fB\-\fR, \fBx\fR and \fB^\fR, can be specified instead of a window name to alter the default -location of a \fIslave\fP, as described in the \fBRELATIVE PLACEMENT\fR +location of a \fIslave\fR, as described in the \fBRELATIVE PLACEMENT\fR section, below. The following options are supported: .RS .TP \fB\-column \fIn\fR -Insert the slave so that it occupies the \fIn\fPth column in the grid. +Insert the slave so that it occupies the \fIn\fRth column in the grid. Column numbers start with 0. If this option is not supplied, then the slave is arranged just to the right of previous slave specified on this -call to \fIgrid\fP, or column "0" if it is the first slave. For each -\fBx\fP that immediately precedes the \fIslave\fP, the column position -is incremented by one. Thus the \fBx\fP represents a blank column +call to \fIgrid\fR, or column "0" if it is the first slave. For each +\fBx\fR that immediately precedes the \fIslave\fR, the column position +is incremented by one. Thus the \fBx\fR represents a blank column for this row in the grid. .TP \fB\-columnspan \fIn\fR -Insert the slave so that it occupies \fIn\fP columns in the grid. +Insert the slave so that it occupies \fIn\fR columns in the grid. The default is one column, unless the window name is followed by a -\fB\-\fP, in which case the columnspan is incremented once for each immediately -following \fB\-\fP. +\fB\-\fR, in which case the columnspan is incremented once for each immediately +following \fB\-\fR. .TP \fB\-in \fIother\fR Insert the slave(s) in the master @@ -147,30 +147,30 @@ The \fIamount\fR defaults to 0. This space is added outside the slave(s) border. .TP \fB\-row \fIn\fR -Insert the slave so that it occupies the \fIn\fPth row in the grid. +Insert the slave so that it occupies the \fIn\fRth row in the grid. Row numbers start with 0. If this option is not supplied, then the slave is arranged on the same row as the previous slave specified on this -call to \fBgrid\fP, or the first unoccupied row if this is the first slave. +call to \fBgrid\fR, or the first unoccupied row if this is the first slave. .TP \fB\-rowspan \fIn\fR -Insert the slave so that it occupies \fIn\fP rows in the grid. -The default is one row. If the next \fBgrid\fP command contains -\fB^\fP characters instead of \fIslaves\fP that line up with the columns -of this \fIslave\fP, then the \fBrowspan\fP of this \fIslave\fP is +Insert the slave so that it occupies \fIn\fR rows in the grid. +The default is one row. If the next \fBgrid\fR command contains +\fB^\fR characters instead of \fIslaves\fR that line up with the columns +of this \fIslave\fR, then the \fBrowspan\fR of this \fIslave\fR is extended by one. .TP \fB\-sticky \fIstyle\fR If a slave's cell is larger than its requested dimensions, this option may be used to position (or stretch) the slave within its cell. \fIStyle\fR is a string that contains zero or more of the characters -\fBn\fP, \fBs\fP, \fBe\fP or \fBw\fP. +\fBn\fR, \fBs\fR, \fBe\fR or \fBw\fR. The string can optionally contains spaces or commas, but they are ignored. Each letter refers to a side (north, south, -east, or west) that the slave will "stick" to. If both \fBn\fP and \fBs\fP (or -\fBe\fP and \fBw\fP) are specified, the slave will be stretched to fill the entire -height (or width) of its cavity. The \fBsticky\fP option subsumes the -combination of \fB\-anchor\fP and \fB\-fill\fP that is used by \fBpack\fP. -The default is \fB{}\fP, which causes the slave to be centered in its cavity, +east, or west) that the slave will "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 +combination of \fB\-anchor\fR and \fB\-fill\fR that is used by \fBpack\fR. +The default is \fB{}\fR, which causes the slave to be centered in its cavity, at its requested size. .LP If any of the slaves are already managed by the geometry manager @@ -194,9 +194,9 @@ The first two elements of the list are ``\fB\-in \fImaster\fR'' where \fImaster\fR is the slave's master. .TP \fBgrid location \fImaster x y\fR -Given \fIx\fP and \fIy\fP values in screen units relative to the master window, -the column and row number at that \fIx\fP and \fIy\fP location is returned. -For locations that are above or to the left of the grid, \fB-1\fP is returned. +Given \fIx\fR and \fIy\fR values in screen units relative to the master window, +the column and row number at that \fIx\fR and \fIy\fR location is returned. +For locations that are above or to the left of the grid, \fB-1\fR is returned. .TP \fBgrid propagate \fImaster\fR ?\fIboolean\fR? If \fIboolean\fR has a true boolean value such as \fB1\fR or \fBon\fR @@ -211,34 +211,34 @@ for \fImaster\fR. Propagation is enabled by default. .TP \fBgrid rowconfigure \fImaster index \fR?\fI\-option value...\fR? -Query or set the row properties of the \fIindex\fP row of the -geometry master, \fImaster\fP. -The valid options are \fB\-minsize\fP, \fB\-weight\fP, \fB\-uniform\fP -and \fB-pad\fP. -If one or more options are provided, then \fIindex\fP may be given as +Query or set the row properties of the \fIindex\fR row of the +geometry master, \fImaster\fR. +The valid options are \fB\-minsize\fR, \fB\-weight\fR, \fB\-uniform\fR +and \fB-pad\fR. +If one or more options are provided, then \fIindex\fR may be given as a list of row indices to which the configuration options will operate on. .VS 8.5 -Indices may be integers, window names or the keyword \fIall\fP. For \fIall\fP +Indices may be integers, window names or the keyword \fIall\fR. For \fIall\fR the options apply to all rows currently occupied be slave windows. For a window name, that window must be a slave of this master and the options apply to all rows currently occupied be the slave. .VE 8.5 -The \fB\-minsize\fP option sets the minimum size, in screen units, +The \fB\-minsize\fR option sets the minimum size, in screen units, that will be permitted for this row. -The \fB\-weight\fP option (an integer value) +The \fB\-weight\fR option (an integer value) sets the relative weight for apportioning any extra spaces among rows. A weight of zero (0) indicates the row will not deviate from its requested size. A row whose weight is two will grow at twice the rate as a row of weight one when extra space is allocated to the layout. -The \fB-uniform\fP option, when a non-empty value is supplied, places -the row in a \fIuniform group\fP with other rows that have the -same value for \fB-uniform\fP. The space for rows belonging to a +The \fB-uniform\fR option, when a non-empty value is supplied, places +the row in a \fIuniform group\fR with other rows that have the +same value for \fB-uniform\fR. The space for rows belonging to a uniform group is allocated so that their sizes are always in strict -proportion to their \fB-weight\fP values. See +proportion to their \fB-weight\fR values. See \fBTHE GRID ALGORITHM\fR below for further details. -The \fB-pad\fP option specifies the number of screen units that will be +The \fB-pad\fR option specifies the number of screen units that will be added to the largest window contained completely in that row when the grid geometry manager requests a size from the containing window. If only an option is specified, with no value, @@ -256,48 +256,48 @@ slave is managed once more by the grid geometry manager, the previous values are retained. .TP \fBgrid size \fImaster\fR -Returns the size of the grid (in columns then rows) for \fImaster\fP. -The size is determined either by the \fIslave\fP occupying the largest -row or column, or the largest column or row with a \fBminsize\fP, -\fBweight\fP, or \fBpad\fP that is non-zero. +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. .TP \fBgrid slaves \fImaster\fR ?\fI\-option value\fR? If no options are supplied, a list of all of the slaves in \fImaster\fR are returned, most recently manages first. -\fIOption\fP can be either \fB\-row\fP or \fB\-column\fP which -causes only the slaves in the row (or column) specified by \fIvalue\fP +\fIOption\fR can be either \fB\-row\fR or \fB\-column\fR which +causes only the slaves in the row (or column) specified by \fIvalue\fR to be returned. .SH "RELATIVE PLACEMENT" .PP -The \fBgrid\fP command contains a limited set of capabilities that +The \fBgrid\fR command contains a limited set of capabilities that permit layouts to be created without specifying the row and column information for each slave. This permits slaves to be rearranged, added, or removed without the need to explicitly specify row and column information. -When no column or row information is specified for a \fIslave\fP, +When no column or row information is specified for a \fIslave\fR, default values are chosen for -\fBcolumn\fP, \fBrow\fP, \fBcolumnspan\fP and \fBrowspan\fP -at the time the \fIslave\fP is managed. The values are chosen -based upon the current layout of the grid, the position of the \fIslave\fP -relative to other \fIslave\fPs in the same grid command, and the presence -of the characters \fB\-\fP, \fBx\fP, and \fB^\fP in \fBgrid\fP -command where \fIslave\fP names are normally expected. +\fBcolumn\fR, \fBrow\fR, \fBcolumnspan\fR and \fBrowspan\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 +of the characters \fB\-\fR, \fBx\fR, and \fB^\fR in \fBgrid\fR +command where \fIslave\fR names are normally expected. .RS .TP -\fB\-\fP -This increases the columnspan of the \fIslave\fP to the left. Several -\fB\-\fP's in a row will successively increase the columnspan. A \fB\-\fP -may not follow a \fB^\fP or a \fBx\fP, nor may it be the first \fIslave\fP +\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 +may not follow a \fB^\fR or a \fBx\fR, nor may it be the first \fIslave\fR argument to \fBgrid configure\fR. .TP -\fBx\fP -This leaves an empty column between the \fIslave\fP on the left and -the \fIslave\fP on the right. +\fBx\fR +This leaves an empty column between the \fIslave\fR on the left and +the \fIslave\fR on the right. .TP -\fB^\fP -This extends the \fBrowspan\fP of the \fIslave\fP above the \fB^\fP's -in the grid. The number of \fB^\fP's in a row must match the number of -columns spanned by the \fIslave\fP above it. +\fB^\fR +This extends the \fBrowspan\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 .SH "THE GRID ALGORITHM" .PP @@ -309,33 +309,33 @@ In the second step, the requested size is compared against the actual size of the master. If the sizes are different, then spaces is added to or taken away from the layout as needed. For the final step, each slave is positioned in its row(s) and column(s) -based on the setting of its \fIsticky\fP flag. +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, and computes the nominal size of each row or column to be either the -\fIminsize\fP for that row or column, or the sum of the \fIpad\fPding +\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 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\fP. For each +row or column in the group according to its \fIweight\fR. For each group whose weights are all zero, the additional space is apportioned equally. .PP When multiple rows or columns belong to a uniform group, the space allocated to them is always in proportion to their weights. (A weight of zero is considered to be 1.) In other words, a row or column -configured with \fB-weight 1 -uniform a\fP will have exactly the same +configured with \fB-weight 1 -uniform a\fR will have exactly the same size as any other row or column configured with \fB-weight 1 -uniform -a\fP. A row or column configured with \fB-weight 2 -uniform b\fR will +a\fR. A row or column configured with \fB-weight 2 -uniform b\fR will be exactly twice as large as one that is configured with \fB-weight 1 --uniform b\fP. +-uniform b\fR. .PP More technically, each row or column in the group will have a size -equal to \fIk*weight\fP for some constant \fIk\fP. The constant -\fIk\fP is chosen so that no row or column becomes smaller than its +equal to \fIk*weight\fR for some constant \fIk\fR. The constant +\fIk\fR is chosen so that no row or column becomes smaller than its minimum size. For example, if all rows or columns in a group have the same weight, then each row or column will have the same size as the largest row or column in the group. @@ -373,7 +373,7 @@ The master for each slave must either be the slave's parent This restriction is necessary to guarantee that the slave can be placed over any part of its master that is visible without danger of the slave being clipped by its parent. -In addition, all slaves in one call to \fBgrid\fP must have the same master. +In addition, all slaves in one call to \fBgrid\fR must have the same master. .SH "STACKING ORDER" .PP If the master for a slave is not its parent then you must make sure @@ -385,7 +385,7 @@ to create the master window first: the most recently created window will be highest in the stacking order. .SH CREDITS .PP -The \fBgrid\fP command is based on ideas taken from the \fIGridBag\fP +The \fBgrid\fR command is based on ideas taken from the \fIGridBag\fR geometry manager written by Doug. Stein, and the \fBblt_table\fR geometry manager, written by George Howlett. .SH EXAMPLES diff --git a/doc/panedwindow.n b/doc/panedwindow.n index 141c832..5f51675 100644 --- a/doc/panedwindow.n +++ b/doc/panedwindow.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: panedwindow.n,v 1.8 2004/12/20 10:04:23 dkf Exp $ +'\" RCS: @(#) $Id: panedwindow.n,v 1.9 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH panedwindow n 8.4 Tk "Tk Built-In Commands" @@ -218,10 +218,10 @@ have any of the forms accepted by \fBTk_GetPixels\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 -of the characters \fBn\fP, \fBs\fP, \fBe\fP or \fBw\fP. The string +of the characters \fBn\fR, \fBs\fR, \fBe\fR or \fBw\fR. The string can optionally contains spaces or commas, but they are ignored. Each letter refers to a side (north, south, east, or west) that the window -will "stick" to. If both \fBn\fP and \fBs\fP (or \fBe\fP and \fBw\fP) +will "stick" to. If both \fBn\fR and \fBs\fR (or \fBe\fR and \fBw\fR) are specified, the window will be stretched to fill the entire height (or width) of its cavity. .TP @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: text.n,v 1.42 2006/10/18 00:01:38 hobbs Exp $ +'\" RCS: @(#) $Id: text.n,v 1.43 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH text n 8.5 Tk "Tk Built-In Commands" @@ -283,8 +283,8 @@ Indicates the position of the embedded image whose name is This form generates an error if there is no embedded image by the given name. .PP -If the \fIbase\fP could match more than one of the above forms, such -as a \fImark\fP and \fIimageName\fP both having the same value, then +If the \fIbase\fR could match more than one of the above forms, such +as a \fImark\fR and \fIimageName\fR both having the same value, then the form earlier in the above list takes precedence. If modifiers follow the base index, each one of them must have one of the forms listed below. Keywords such as \fBchars\fR and \fBwordend\fR @@ -420,7 +420,7 @@ widget. So, for example, the index ``\fB1.0 -1c +1c\fR'' refers to the index ``\fB2.0\fR''. .PP Where modifiers result in index changes by display lines, display chars -or display indices, and the \fIbase\fP refers to an index inside an +or display indices, and the \fIbase\fR refers to an index inside an elided tag, that base index is considered to be equivalent to the first following non-elided index. @@ -812,22 +812,22 @@ unit's worth of index space in the text widget, and it may be referred to either by its position in the widget's index space, or the name it is assigned -when the image is inserted into the text widget with \fBimage create\fP. +when the image is inserted into the text widget with \fBimage create\fR. If the range of text containing the embedded image is deleted then that copy of the image is removed from the screen. .PP When an embedded image is added to a text widget with the \fBimage create\fR widget command, a name unique to this instance of the image is returned. This name may then be used to refer to this image -instance. The name is taken to be the value of the \fB\-name\fP option -(described below). If the \fB\-name\fP option is not provided, the -\fB\-image\fP name is used instead. If the \fIimageName\fP is already +instance. The name is taken to be the value of the \fB\-name\fR option +(described below). If the \fB\-name\fR option is not provided, the +\fB\-image\fR name is used instead. If the \fIimageName\fR is already in use in the text widget, then \fB#\fInn\fR is added to the end of the -\fIimageName\fP, where \fInn\fP is an arbitrary integer. This insures -the \fIimageName\fP is unique. +\fIimageName\fR, where \fInn\fR is an arbitrary integer. This insures +the \fIimageName\fR is unique. Once this name is assigned to this instance of the image, it does not -change, even though the \fB\-image\fP or \fB\-name\fP values can be changed -with \fBimage configure\fP. +change, even though the \fB\-image\fR or \fB\-name\fR values can be changed +with \fBimage configure\fR. .PP When an embedded image is added to a text widget with the \fBimage create\fR widget command, several configuration @@ -848,13 +848,13 @@ of the line). .TP \fB\-image \fIimage\fR Specifies the name of the Tk image to display in the annotation. -If \fIimage\fP is not a valid Tk image, then an error is returned. +If \fIimage\fR is not a valid Tk image, then an error is returned. .TP \fB\-name \fIImageName\fR Specifies the name by which this image instance may be referenced in -the text widget. If \fIImageName\fP is not supplied, then the +the text widget. If \fIImageName\fR is not supplied, then the name of the Tk image is used instead. -If the \fIimageName\fP is already in use, \fI#nn\fP is appended to +If the \fIimageName\fR is already in use, \fI#nn\fR is appended to the end of the name as described above. .TP \fB\-padx \fIpixels\fR @@ -1200,10 +1200,10 @@ in the following format: .RS \fIkey1 value1 index1 key2 value2 index2\fR ... .LP -The possible \fIkey\fP values are \fBtext\fP, \fBmark\fP, -\fBtagon\fP, \fBtagoff\fP, \fBimage\fP, and \fBwindow\fP. The corresponding -\fIvalue\fP is the text, mark name, tag name, image name, or window name. -The \fIindex\fP information is the index of the +The possible \fIkey\fR values are \fBtext\fR, \fBmark\fR, +\fBtagon\fR, \fBtagoff\fR, \fBimage\fR, and \fBwindow\fR. The corresponding +\fIvalue\fR is the text, mark name, tag name, image name, or window name. +The \fIindex\fR information is the index of the start of the text, mark, tag transition, image or window. One or more of the following switches (or abbreviations thereof) may be specified to control the dump: @@ -1216,7 +1216,7 @@ This is the default. Instead of returning the information as the result of the dump operation, invoke the \fIcommand\fR on each element of the text widget within the range. The command has three arguments appended to it before it is evaluated: -the \fIkey\fP, \fIvalue\fP, and \fIindex\fP. +the \fIkey\fR, \fIvalue\fR, and \fIindex\fR. .TP \fB\-image\fR Include information about images in the dump results. @@ -1226,7 +1226,7 @@ Include information about marks in the dump results. .TP \fB\-tag\fR Include information about tag transitions in the dump results. Tag -information is returned as \fBtagon\fP and \fBtagoff\fP elements that +information is returned as \fBtagon\fR and \fBtagoff\fR elements that indicate the begin and end of each range of each tag, respectively. .TP \fB\-text\fR @@ -1396,11 +1396,11 @@ If \fIindex\fR is the name of a mark, then the search for the next mark begins immediately after that mark. This can still return a mark at the same position if there are multiple marks at the same index. -These semantics mean that the \fBmark next\fP operation can be used to +These semantics mean that the \fBmark next\fR operation can be used to step through all the marks in a text widget in the same order -as the mark information returned by the \fBdump\fP operation. -If a mark has been set to the special \fBend\fP index, -then it appears to be \fIafter\fP \fBend\fP with respect to the \fBmark next\fP operation. +as the mark information returned by the \fBdump\fR operation. +If a mark has been set to the special \fBend\fR index, +then it appears to be \fIafter\fR \fBend\fR with respect to the \fBmark next\fR operation. An empty string is returned if there are no marks after \fIindex\fR. .TP \fIpathName \fBmark previous \fIindex\fR @@ -1411,9 +1411,9 @@ If \fIindex\fR is the name of a mark, then the search for the next mark begins immediately before that mark. This can still return a mark at the same position if there are multiple marks at the same index. -These semantics mean that the \fBmark previous\fP operation can be used to +These semantics mean that the \fBmark previous\fR operation can be used to step through all the marks in a text widget in the reverse order -as the mark information returned by the \fBdump\fP operation. +as the mark information returned by the \fBdump\fR operation. An empty string is returned if there are no marks before \fIindex\fR. .TP \fIpathName \fBmark set \fImarkName index\fR @@ -2193,7 +2193,7 @@ especially if they have many marks and 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\fP attribute to 0 avoid this. +Set the \fBinsertOffTime\fR attribute to 0 avoid this. .SH "KNOWN BUGS" .VS 8.5 .PP diff --git a/doc/ttk_Geometry.3 b/doc/ttk_Geometry.3 index f902122..7617d6a 100644 --- a/doc/ttk_Geometry.3 +++ b/doc/ttk_Geometry.3 @@ -1,7 +1,7 @@ '\" '\" Copyright (c) 2004 Joe English '\" -'\" RCS: @(#) $Id: ttk_Geometry.3,v 1.1 2006/10/31 01:42:25 hobbs Exp $ +'\" RCS: @(#) $Id: ttk_Geometry.3,v 1.2 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH Geometry 3 8.5 Tk "Tk Themed Widget" @@ -139,7 +139,7 @@ wide, \fIheight\fR pixels tall, at the specified \fIx, y\fR coordinates. shrunken according to the left, top, right, and bottom margins specified by \fIpadding\fR. .PP -\fBTtk_ExpandBox\fR is the inverse of \fBTtk_PadBox\fP: +\fBTtk_ExpandBox\fR is the inverse of \fBTtk_PadBox\fR: it returns a new box surrounding the specified \fIparcel\fR, expanded according to the left, top, right, and bottom margins specified by \fIpadding\fR. @@ -152,10 +152,10 @@ and shrinks the \fIcavity\fR accordingly. and \fIheight\fR inside the \fIparcel\fR according to the \fIsticky\fR bits. .PP -\fBTtk_PlaceBox\fP combines \fBTtk_PackBox\fP and \fBTtk_StickBox\fP: -it allocates a parcel on the specified \fIside\fP of the \fIcavity\fP, -places a box of the requested size inside the parcel according to \fIsticky\fP, -and shrinks the \fIcavity\fP. +\fBTtk_PlaceBox\fR combines \fBTtk_PackBox\fR and \fBTtk_StickBox\fR: +it allocates a parcel on the specified \fIside\fR of the \fIcavity\fR, +places a box of the requested size inside the parcel according to \fIsticky\fR, +and shrinks the \fIcavity\fR. .PP \fBTtk_AnchorBox\fR places a box with the requested \fIwidth\fR and \fIheight\fR inside the \fIparcel\fR according to the @@ -211,9 +211,9 @@ If fewer than four elements are specified, \fItop\fR defaults to \fIleft\fR. See \fBTk_GetPixelsFromObj(3)\fR for the syntax of length specifications. .PP -\fBTtk_GetBorderFromObj\fR is the same as \fBTtk_GetPaddingFromObj\fP +\fBTtk_GetBorderFromObj\fR is the same as \fBTtk_GetPaddingFromObj\fR except that the lengths are specified as integers -(i.e., resolution-dependant values like \fI3m\fP are not allowed). +(i.e., resolution-dependant values like \fI3m\fR are not allowed). .PP \fBTtk_GetStickyFromObj\fR converts the string in \fIobjPtr\fR to a \fIsticky\fR bitmask. The string contains zero or more diff --git a/doc/ttk_button.n b/doc/ttk_button.n index b085d8b..396360c 100644 --- a/doc/ttk_button.n +++ b/doc/ttk_button.n @@ -10,7 +10,7 @@ ttk::button \- Widget that issues a command when pressed \fBttk::button\fR \fIpathName \fR?\fIoptions\fR? .BE .SH DESCRIPTION -A \fBbutton\fP widget displays a textual label and/or image, +A \fBbutton\fR widget displays a textual label and/or image, and evaluates a command when pressed. .SO \-class \-compound \-cursor \-image @@ -21,23 +21,23 @@ and evaluates a command when pressed. .OP \-command command Command A script to evaluate when the widget is invoked. .OP \-default default Default -May be set to one of \fBnormal\fP, \fBactive\fP, or \fBdisabled\fP. +May be set to one of \fBnormal\fR, \fBactive\fR, or \fBdisabled\fR. In a dialog box, one button may be designated the "default" button (meaning, roughly, "the one that gets invoked when the user presses <Enter>"). -\fBactive\fP indicates that this is currently the default button; -\fBnormal\fP means that it may become the default button, and -\fBdisabled\fP means that it is not defaultable. -The default is \fBnormal\fP. +\fBactive\fR indicates that this is currently the default button; +\fBnormal\fR means that it may become the default button, and +\fBdisabled\fR means that it is not defaultable. +The default is \fBnormal\fR. .br Depending on the theme, the default button may be displayed with an extra highlight ring, or with a different border color. -See also: \fIkeynav(n)\fP. +See also: \fIkeynav(n)\fR. .OP \-width width Width If greater than zero, specifies how much space, in character widths, to allocate for the text label. If less than zero, specifies a minimum width. If zero or unspecified, the natural width of the text label is used. -Note that some themes may specify a non-zero \fB-width\fP +Note that some themes may specify a non-zero \fB-width\fR in the style. '\" Not documented -- may go away '\" .OP \-padding padding Padding @@ -59,14 +59,14 @@ Invokes the command associated with the button. \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -See \fIwidget(n)\fP +See \fIwidget(n)\fR .SH "COMPATIBILITY OPTIONS" .OP \-state state State -May be set to \fBnormal\fP or \fBdisabled\fP -to control the \fBdisabled\fP state bit. +May be set to \fBnormal\fR or \fBdisabled\fR +to control the \fBdisabled\fR state bit. This is a ``write-only'' option: setting it changes the -widget state, but the \fBstate\fP widget command does +widget state, but the \fBstate\fR widget command does not affect the state option. .SH "SEE ALSO" diff --git a/doc/ttk_checkbutton.n b/doc/ttk_checkbutton.n index cd5ee64..e74b7b2 100644 --- a/doc/ttk_checkbutton.n +++ b/doc/ttk_checkbutton.n @@ -47,13 +47,13 @@ Returns the result of the \fI-command\fR. .\" Are these useful? They don't invoke the -command .\" Missing: flash. This is definitely not useful. .SH "WIDGET STATES" -The widget does not respond to user input if the \fBdisabled\fP state is set. -The widget sets the \fBselected\fP state whenever -the linked \fB-variable\fP is set to the widget's \fB-onvalue\fP, +The widget does not respond to user input if the \fBdisabled\fR state is set. +The widget sets the \fBselected\fR state whenever +the linked \fB-variable\fR is set to the widget's \fB-onvalue\fR, and clears it otherwise. -The widget sets the \fBalternate\fP state whenever the -linked \fB-variable\fP is unset. -(The \fBalternate\fP state may be used to indicate a ``tri-state'' +The widget sets the \fBalternate\fR state whenever the +linked \fB-variable\fR is unset. +(The \fBalternate\fR state may be used to indicate a ``tri-state'' or ``indeterminate'' selection.) .SH "SEE ALSO" widget(n), keynav(n), radiobutton(n) diff --git a/doc/ttk_combobox.n b/doc/ttk_combobox.n index 1e0664a..3e2fe23 100644 --- a/doc/ttk_combobox.n +++ b/doc/ttk_combobox.n @@ -18,19 +18,19 @@ Boolean value. If set, the widget selection is linked to the X selection. .OP \-justify justify Justify Specifies how the text is aligned within the widget. -One of \fBleft\fP, \fBcenter\fP, or \fBright\fP. +One of \fBleft\fR, \fBcenter\fR, or \fBright\fR. .OP \-postcommand postCommand PostCommand A Tcl script to evaluate immediately before displaying the listbox. -The \fB-postcommand\fP script may specify the \fB-values\fP to display. +The \fB-postcommand\fR script may specify the \fB-values\fR to display. .OP \-state state State -One of \fBnormal\fR, \fBreadonly\fR, or \fBdisabled\fP. -In the \fBreadonly\fP state, +One of \fBnormal\fR, \fBreadonly\fR, or \fBdisabled\fR. +In the \fBreadonly\fR state, the value may not be edited directly, and -the user can only select one of the \fB-values\fP from the +the user can only select one of the \fB-values\fR from the dropdown list. -In the \fBnormal\fP state, +In the \fBnormal\fR state, the text field is directly editable. -In the \fBdisabled\fP state, no interaction is possible. +In the \fBdisabled\fR state, no interaction is possible. .OP \-textvariable textVariable TextVariable Specifies the name of a variable whose value is linked to the widget value. @@ -49,15 +49,15 @@ values in the list. .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR -Returns the current value of the specified \fIoption\fP. -See \fIwidget(n)\fP. +Returns the current value of the specified \fIoption\fR. +See \fIwidget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? Modify or query widget options. -See \fIwidget(n)\fP. +See \fIwidget(n)\fR. .TP \fIpathName \fBcurrent\fR ?\fInewIndex\fR? -If \fInewIndex\fP is supplied, sets the combobox value +If \fInewIndex\fR is supplied, sets the combobox value to the element at position \fInewIndex\fR in the list of \fB-values\fR. Otherwise, returns the index of the current value in the list of \fB-values\fR or \fB-1\fR if the current value does not appear in the list. @@ -66,22 +66,22 @@ or \fB-1\fR if the current value does not appear in the list. Returns the current value of the combobox. .TP \fIpathName \fBidentify \fIx y\fR -Returns the name of the element at position \fIx\fP, \fIy\fP, +Returns the name of the element at position \fIx\fR, \fIy\fR, or the empty string if the coordinates are outside the window. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? Test the widget state. -See \fIwidget(n)\fP. +See \fIwidget(n)\fR. .TP \fIpathName \fBset\fR \fIvalue\fR -Sets the value of the combobox to \fIvalue\fP. +Sets the value of the combobox to \fIvalue\fR. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? Modify or query the widget state. -See \fIwidget(n)\fP. +See \fIwidget(n)\fR. .PP -The combobox widget also supports the following \fIentry\fP -widget commands (see \fIentry(n)\fP for details): +The combobox widget also supports the following \fIentry\fR +widget commands (see \fIentry(n)\fR for details): .DS .ta 5.5c 11c bbox delete icursor @@ -89,7 +89,7 @@ index insert selection xview .DE .SH "VIRTUAL EVENTS" -The combobox widget generates a \fB<<ComboboxSelected>>\fP virtual event +The combobox widget generates a \fB<<ComboboxSelected>>\fR virtual event when the user selects an element from the list of values. This event is generated after the listbox is unposted. .SH "SEE ALSO" diff --git a/doc/ttk_dialog.n b/doc/ttk_dialog.n index 3fdeb24..8bcea18 100644 --- a/doc/ttk_dialog.n +++ b/doc/ttk_dialog.n @@ -36,11 +36,11 @@ If omitted, the default is the nearest ancestor toplevel. If set to the empty string, the dialog will not be a transient window. .OP \-type undefined undefined Specifies a built-in or user-defined dialog type. -See \fBPREDEFINED DIALOG TYPES\fP, below. +See \fBPREDEFINED DIALOG TYPES\fR, below. .OP \-icon undefined undefined Specifies one of the stock dialog icons, -\fBinfo\fP, \fBquestion\fP, \fBwarning\fP, \fBerror\fP, -\fBauth\fP, or \fBbusy\fP. +\fBinfo\fR, \fBquestion\fR, \fBwarning\fR, \fBerror\fR, +\fBauth\fR, or \fBbusy\fR. If set to the empty string (the defalt), no icon is displayed. .OP \-buttons undefined undefined A list of symbolic button names. @@ -53,7 +53,7 @@ The symbolic name of the default button. The symbolic name of the "cancel" button. The cancel button is invoked if the user presses the Escape key and when the dialog is closed from the window manager. -If \fB-cancel\fP is not specified, +If \fB-cancel\fR is not specified, the dialog ignores window manager close commands (WM_DELETE_WINDOW). .SH "WIDGET COMMANDS" .TP @@ -62,9 +62,9 @@ Returns the widget path of the client frame. Other widgets may be added to the client frame. The client frame appears between the detail message and the command buttons. .SH "PREDEFINED DIALOG TYPES" -The \fB-type\fP option, if present, specifies default values +The \fB-type\fR option, if present, specifies default values for other options. \fBttk::dialog::define \fItype options...\fR -specifies a new stock dialog \fItype\fP. +specifies a new stock dialog \fItype\fR. The following stock dialog types are predefined: .CS ttk::dialog::define ok \e @@ -80,22 +80,22 @@ ttk::dialog::define retrycancel \e .CE .SH "STOCK BUTTONS" The following ``stock'' symbolic button names have predefined labels: -\fByes\fP, \fBno\fP, \fBok\fP, \fBcancel\fP, and \fBretry\fP. +\fByes\fR, \fBno\fR, \fBok\fR, \fBcancel\fR, and \fBretry\fR. .PP -It is not necessary to list these in the \fB-labels\fP dictionary. +It is not necessary to list these in the \fB-labels\fR dictionary. .\" .SH "DIFFERENCES FROM MESSAGE BOXES" .\" The \fBttk::dialog\fR constructor is similar to -.\" the Tk library procedure \fBtk_messageBox\fP, +.\" the Tk library procedure \fBtk_messageBox\fR, .\" but with the following notable differences: .\" .IP \(bu -.\" The first argument to \fBttk::dialog\fP is the name of -.\" the widget to create; \fBtk_messageBox\fP has +.\" The first argument to \fBttk::dialog\fR is the name of +.\" the widget to create; \fBtk_messageBox\fR has .\" .IP \(bu .\" Ttk dialog boxes are non-modal by default. .\" .IP \(bu -.\" The \fBtk_messageBox\fP command is blocking: +.\" The \fBtk_messageBox\fR command is blocking: .\" it does not return until the user presses one of the command buttons. -.\" \fBttk::dialog\fP returns immediately after creating the dialog box. +.\" \fBttk::dialog\fR returns immediately after creating the dialog box. .SH EXAMPLE .CS proc saveFileComplete {button} { @@ -117,4 +117,4 @@ ttk::dialog .saveFileDialog \e ; .CE .SH "SEE ALSO" -\fBtk_messageBox(n)\fR, \fBwm(n)\fR, \fBtoplevel(n)\fP +\fBtk_messageBox(n)\fR, \fBwm(n)\fR, \fBtoplevel(n)\fR diff --git a/doc/ttk_entry.n b/doc/ttk_entry.n index 7b665eb..1a55452 100644 --- a/doc/ttk_entry.n +++ b/doc/ttk_entry.n @@ -18,12 +18,12 @@ ttk::entry \- Editable text field widget \fBttk::entry\fR \fIpathName \fR?\fIoptions\fR? .SH DESCRIPTION .PP -An \fBentry\fP widget displays a one-line text string and +An \fBentry\fR widget displays a one-line text string and allows that string to be edited by the user. The value of the string may be linked to a Tcl variable -with the \fB-textvariable\fP option. +with the \fB-textvariable\fR option. Entry widgets support horizontal scrolling with the -standard \fB-xscrollcommand\fP option and \fBxview\fP widget command. +standard \fB-xscrollcommand\fR option and \fBxview\fR widget command. .SO \-class \-cursor \-style \-takefocus \-xscrollcommand @@ -45,7 +45,7 @@ A script template to evaluate whenever the \fBvalidateCommand\fR returns 0. See \fBVALIDATION\fR below for more information. .OP \-justify justify Justify Specifies how the text is aligned within the entry widget. -One of \fBleft\fP, \fBcenter\fP, or \fBright\fP. +One of \fBleft\fR, \fBcenter\fR, or \fBright\fR. .\" MAYBE: .OP \-selectbackground selectBackground Foreground .\" MAYBE: .OP \-selectborderwidth selectBorderWidth BorderWidth .\" MAYBE: .OP \-selectforeground selectForeground Background @@ -60,10 +60,10 @@ If characters in the entry are selected and copied elsewhere, the information copied will be what is displayed, not the true contents of the entry. .OP \-state state State -Compatibility option; see \fBwidget(n)\fP for details. +Compatibility option; see \fBwidget(n)\fR for details. Specifies one of three states for the entry, \fBnormal\fR, \fBdisabled\fR, or \fBreadonly\fR. -See \fBWIDGET STATES\fP, below. +See \fBWIDGET STATES\fR, below. .OP \-textvariable textVariable Variable Specifies the name of a variable whose value is linked to the entry widget's contents. @@ -103,7 +103,7 @@ the standard \fBxScrollCommand\fR mechanism for interacting with scrollbars (see the description of the \fBxScrollCommand\fR option for details). .SH "INDICES" -Many of the \fBentry\fP widget commands take one or more indices as +Many of the \fBentry\fR widget commands take one or more indices as arguments. An index specifies a particular character in the entry's string, in any of the following ways: .IP \fInumber\fR @@ -147,12 +147,12 @@ The bounding box may refer to a region outside the visible area of the window. .TP \fIpathName \fBcget\fR \fIoption\fR -Returns the current value of the specified \fIoption\fP. -See \fIwidget(n)\fP. +Returns the current value of the specified \fIoption\fR. +See \fIwidget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? Modify or query widget options. -See \fIwidget(n)\fP. +See \fIwidget(n)\fR. .TP \fIpathName \fBdelete \fIfirst \fR?\fIlast\fR? Delete one or more elements of the entry. @@ -171,7 +171,7 @@ Arrange for the insert cursor to be displayed just before the character given by \fIindex\fR. Returns the empty string. .TP \fIpathName \fBidentify \fIx y\fR -Returns the name of the element at position \fIx\fP, \fIy\fP, +Returns the name of the element at position \fIx\fR, \fIy\fR, or the empty string if the coordinates are outside the window. .TP \fIpathName \fBindex\fI index\fR @@ -183,7 +183,7 @@ indicated by \fIindex\fR. Returns the empty string. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? Test the widget state. -See \fIwidget(n)\fP. +See \fIwidget(n)\fR. .TP \fIpathName \fBselection \fIoption arg\fR This command is used to adjust the selection within an entry. It @@ -209,13 +209,13 @@ earlier one, then the entry's selection is cleared. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? Modify or query the widget state. -See \fIwidget(n)\fP. +See \fIwidget(n)\fR. .TP \fIpathName \fBvalidate\fR Force revalidation, independent of the conditions specified by the \fB-validate\fR option. Returns 0 if validation fails, 1 if it succeeds. -Sets or clears the \fBinvalid\fP state accordingly. +Sets or clears the \fBinvalid\fR state accordingly. .TP \fIpathName \fBxview \fIargs\fR This command is used to query and change the horizontal position of the @@ -256,24 +256,24 @@ become visible; if it is positive then characters farther to the right become visible. .RE .SH VALIDATION -The \fB-validate\fP, \fB-validatecommand\fP, and \fB-invalidcommand\fP +The \fB-validate\fR, \fB-validatecommand\fR, and \fB-invalidcommand\fR options are used to enable entry widget validation. .SS "VALIDATION MODES" -There are two main validation modes: \fIprevalidation\fP, -in which the \fB-validatecommand\fP is evaluated prior to each edit +There are two main validation modes: \fIprevalidation\fR, +in which the \fB-validatecommand\fR is evaluated prior to each edit and the return value is used to determine whether to accept or reject the change; -and \fIrevalidation\fP, in which the \fB-validatecommand\fP is +and \fIrevalidation\fR, in which the \fB-validatecommand\fR is evaluated to determine whether the current value is valid. .PP -The \fB-validate\fP option determines when validation occurs; +The \fB-validate\fR option determines when validation occurs; it may be set to any of the following values: .IP \fBnone\fR Default. This means validation will only occur when -specifically requested by the \fBvalidate\fP widget command. +specifically requested by the \fBvalidate\fR widget command. .IP \fBkey\fR The entry will be prevalidated prior to each edit -(specifically, whenever the \fBinsert\fP or \fBdelete\fP +(specifically, whenever the \fBinsert\fR or \fBdelete\fR widget commands are called). If prevalidation fails, the edit is rejected. .IP \fBfocus\fR @@ -285,18 +285,18 @@ The entry is revalidated when the entry loses focus. .IP \fBall\fR Validation is performed for all above conditions. .PP -The \fB-invalidcommand\fP is evaluated whenever -the \fB-validatecommand\fP returns a false value. +The \fB-invalidcommand\fR is evaluated whenever +the \fB-validatecommand\fR returns a false value. .PP -The \fB-validatecommand\fP and \fB-invalidcommand\fP +The \fB-validatecommand\fR and \fB-invalidcommand\fR may modify the entry widget's value -via the widget \fBinsert\fP or \fBdelete\fP commands, -or by setting the linked \fB-textvariable\fP. +via the widget \fBinsert\fR or \fBdelete\fR commands, +or by setting the linked \fB-textvariable\fR. If either does so during prevalidation, then the edit is rejected -regardless of the value returned by the \fB-validatecommand\fP. +regardless of the value returned by the \fB-validatecommand\fR. .PP -If \fB-validatecommand\fP is empty (the default), +If \fB-validatecommand\fR is empty (the default), validation always succeeds. .SS "VALIDATION SCRIPT SUBSTITUTIONS" It is possible to perform percent substitutions on the @@ -317,26 +317,26 @@ The current value of entry prior to editing. .IP \fB%S\fR The text string being inserted/deleted, if any, {} otherwise. .IP \fB%v\fR -The current value of the \fB-validate\fP option. +The current value of the \fB-validate\fR option. .IP \fB%V\fR The validation condition that triggered the callback -(\fBkey\fP, \fBfocusin\fP, \fBfocusout\fP, or \fBforced\fP). +(\fBkey\fR, \fBfocusin\fR, \fBfocusout\fR, or \fBforced\fR). .IP \fB%W\fR The name of the entry widget. .SS "DIFFERENCES FROM TK ENTRY WIDGET VALIDATION" .IP \(bu The standard Tk entry widget automatically disables validation -(by setting \fB-validate\fP to \fBnone\fP) -if the \fB-validatecommand\fP or \fB-invalidcommand\fP modifies +(by setting \fB-validate\fR to \fBnone\fR) +if the \fB-validatecommand\fR or \fB-invalidcommand\fR modifies the entry's value. The Tk themed entry widget only disables validation if one -of the validation scripts raises an error, or if \fB-validatecommand\fP +of the validation scripts raises an error, or if \fB-validatecommand\fR does not return a valid boolean value. (Thus, it is not necessary to reenable validation after modifying the entry value in a validation script). .IP \(bu The standard entry widget invokes validation whenever the linked -\fB-textvariable\fP is modified; the Tk themed entry widget does not. +\fB-textvariable\fR is modified; the Tk themed entry widget does not. .SH "DEFAULT BINDINGS" The entry widget's default bindings enable the following behavior. In the descriptions below, ``word'' refers to a contiguous group @@ -417,22 +417,22 @@ Control-d deletes the character to the right of the insert cursor. Control-k deletes all the characters to the right of the insertion cursor. .SH "WIDGET STATES" -In the \fBdisabled\fP state, +In the \fBdisabled\fR state, the entry cannot be edited and the text cannot be selected. -In the \fBreadonly\fP state, +In the \fBreadonly\fR state, no insert cursor is displayed and the entry cannot be edited -(specifically: the \fBinsert\fP and \fBdelete\fP commands have no effect). -The \fBdisabled\fP state is the same as \fBreadonly\fP, +(specifically: the \fBinsert\fR and \fBdelete\fR commands have no effect). +The \fBdisabled\fR state is the same as \fBreadonly\fR, and in addition text cannot be selected. .PP -Note that changes to the linked \fB-textvariable\fP will +Note that changes to the linked \fB-textvariable\fR will still be reflected in the entry, even if it is disabled or readonly. .PP -Typically, the text is "grayed-out" in the \fBdisabled\fP state, -and a different background is used in the \fBreadonly\fP state. +Typically, the text is "grayed-out" in the \fBdisabled\fR state, +and a different background is used in the \fBreadonly\fR state. .PP -The entry widget sets the \fBinvalid\fP state if revalidation fails, +The entry widget sets the \fBinvalid\fR state if revalidation fails, and clears it whenever validation succeeds. .SH KEYWORDS entry, widget, text field diff --git a/doc/ttk_frame.n b/doc/ttk_frame.n index da7a00a..efb6fa6 100644 --- a/doc/ttk_frame.n +++ b/doc/ttk_frame.n @@ -8,7 +8,7 @@ ttk::frame \- Simple container widget \fBttk::frame\fR \fIpathName \fR?\fIoptions\fR? .BE .SH DESCRIPTION -A \fBframe\fP widget is a container, used to group other widgets together. +A \fBframe\fR widget is a container, used to group other widgets together. .SO \-class \-cursor \-takefocus \-style .SE @@ -18,8 +18,8 @@ The desired width of the widget border. Defaults to 0. .OP -relief relief Relief One of the standard Tk border styles: \fBflat\fR, \fBgroove\fR, \fBraised\fR, \fBridge\fR, -\fBsolid\fR, or \fBsunken\fP. -Defaults to \fBflat\fP. +\fBsolid\fR, or \fBsunken\fR. +Defaults to \fBflat\fR. .OP -padding padding Padding Additional padding to include inside the border. .OP -width width Width @@ -28,14 +28,14 @@ If specified, the widget's requested width in pixels. If specified, the widget's requested height in pixels. .SH "WIDGET COMMAND" Supports the standard widget commands -\fBconfigure\fP, \fBcget\fP, \fBinstate\fP, and \fBstate\fP; -see \fIwidget(n)\fP. +\fBconfigure\fR, \fBcget\fR, \fBinstate\fR, and \fBstate\fR; +see \fIwidget(n)\fR. .SH "NOTES" -Note that if the \fBpack\fP, \fBgrid\fP, or other geometry managers -are used to manage the children of the \fBframe\fP, +Note that if the \fBpack\fR, \fBgrid\fR, or other geometry managers +are used to manage the children of the \fBframe\fR, by the GM's requested size will normally take precedence -over the \fBframe\fP widget's \fB-width\fP and \fB-height\fP options. -[\fBpack propagate\fP] and [\fBgrid propagate\fP] can be used +over the \fBframe\fR widget's \fB-width\fR and \fB-height\fR options. +[\fBpack propagate\fR] and [\fBgrid propagate\fR] can be used to change this. .SH "SEE ALSO" widget(n), labelframe(n) diff --git a/doc/ttk_image.n b/doc/ttk_image.n index 87e2deb..962b9be 100644 --- a/doc/ttk_image.n +++ b/doc/ttk_image.n @@ -1,6 +1,6 @@ '\" '\" Copyright (c) 2004 Joe English -'\" $Id: ttk_image.n,v 1.1 2006/10/31 01:42:25 hobbs Exp $ +'\" $Id: ttk_image.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH ttk_image n 8.5 Tk "Tk Themed Widget" @@ -11,52 +11,52 @@ ttk_image \- Define an element based on an image \fBttk::style create element \fIname\fR \fBimage\fR \fIimageName\fR ?\fIoptions\fR? .BE .SH DESCRIPTION -The \fIimage\fP element factory creates a new element +The \fIimage\fR element factory creates a new element in the current theme whose visual appearance is determined by a Tk image. .SH OPTIONS Valid \fIoptions\fR are: .TP -\fB-border\fP \fIpadding\fP -\fIpadding\fP is a list of up to four integers, specifying +\fB-border\fR \fIpadding\fR +\fIpadding\fR is a list of up to four integers, specifying the left, top, right, and bottom borders, respectively. -See \fBIMAGE STRETCHING\fP, below. +See \fBIMAGE STRETCHING\fR, below. .TP -\fB-height \fIheight\fP +\fB-height \fIheight\fR Specifies a minimum height for the element. If less than zero, the base image's height is used as a default. .TP -\fB-map { \fIstatespec\fP \fIimage\fP.. } +\fB-map { \fIstatespec\fR \fIimage\fR.. } Specifies auxilliary images to use in different states. -Each \fIstatespec\fP is a list of state names optionally -prefixed by an exclamation point, as in \fBttk::style map\fP. -Each \fIimageName\fP is the name of a Tk image -defined with \fBimage create ...\fP. -When the element is displayed, each \fIstatespec\fP is -tested in order, and the \fIimage\fP corresponding to -the first matching \fIstatespec\fP is used. -If none match, the base \fIimageName\fP is used. +Each \fIstatespec\fR is a list of state names optionally +prefixed by an exclamation point, as in \fBttk::style map\fR. +Each \fIimageName\fR is the name of a Tk image +defined with \fBimage create ...\fR. +When the element is displayed, each \fIstatespec\fR is +tested in order, and the \fIimage\fR corresponding to +the first matching \fIstatespec\fR is used. +If none match, the base \fIimageName\fR is used. .TP -\fB-padding\fP \fIpadding\fP +\fB-padding\fR \fIpadding\fR Specifies the element's interior padding. Defaults to -\fI-border\fP if not specified. +\fI-border\fR if not specified. .TP -\fB-sticky\fP \fIspec\fP +\fB-sticky\fR \fIspec\fR Specifies how the image is placed within the final parcel. -\fIspec\fP contains zero or more characters "n", "s", "w", or "e". +\fIspec\fR contains zero or more characters "n", "s", "w", or "e". .TP -\fB-width \fIwidth\fP +\fB-width \fIwidth\fR Specifies a minimum width for the element. If less than zero, the base image's width is used as a default. .SH "IMAGE STRETCHING" If the element's allocated parcel is larger than the image, -the image will be placed in the parcel based on the \fB-sticky\fP option. -If the image needs to stretch horizontally (i.e., \fB-sticky ew\fP) -or vertically (\fB-sticky ns\fP), +the image will be placed in the parcel based on the \fB-sticky\fR option. +If the image needs to stretch horizontally (i.e., \fB-sticky ew\fR) +or vertically (\fB-sticky ns\fR), subregions of the image are replicated to fill the parcel -based on the \fB-border\fP option. -The \fB-border\fP divides the image into 9 regions: +based on the \fB-border\fR option. +The \fB-border\fR divides the image into 9 regions: four fixed corners, top and left edges (which may be tiled horizontally), left and right edges (which may be tiled vertically), and the central area (which may be tiled in both directions). diff --git a/doc/ttk_intro.n b/doc/ttk_intro.n index cbe49b4..1187c3f 100644 --- a/doc/ttk_intro.n +++ b/doc/ttk_intro.n @@ -147,7 +147,7 @@ style default TButton \e Many elements are displayed differently depending on the widget state. For example, buttons have a different background when they are active, a different foreground when disabled, and a different relief when pressed. -The \fBstyle map\fP command specifies dynamic resources +The \fBstyle map\fR command specifies dynamic resources for a particular style: .CS style map TButton \e diff --git a/doc/ttk_label.n b/doc/ttk_label.n index 77ac736..02f21eb 100644 --- a/doc/ttk_label.n +++ b/doc/ttk_label.n @@ -10,7 +10,7 @@ ttk::label \- Display a text string and/or image \fBttk::label\fR \fIpathName \fR?\fIoptions\fR? .BE .SH DESCRIPTION -A \fBlabel\fP widget displays a textual label and/or image. +A \fBlabel\fR widget displays a textual label and/or image. The label may be linked to a Tcl variable to automatically change the displayed text. .SO @@ -24,7 +24,7 @@ Specifies how the information in the widget is positioned relative to the inner margins. Legal values are \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR, \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, and \fBcenter\fR. -See also \fB-justify\fP. +See also \fB-justify\fR. .OP \-background frameColor FrameColor The widget's background color. If unspecified, the theme default is used. @@ -36,8 +36,8 @@ If unspecified, the theme default is used. .OP \-justify justify Justify If there are multiple lines of text, specifies how the lines are laid out relative to one another. -One of \fBleft\fP, \fBcenter\fP, or \fBright\fP. -See also \fB-anchor\fP. +One of \fBleft\fR, \fBcenter\fR, or \fBright\fR. +See also \fB-anchor\fR. .OP \-padding padding Padding Specifies the amount of extra space to allocate for the widget. The padding is a list of up to four length specifications @@ -70,6 +70,6 @@ than the specified value. \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -See \fIwidget(n)\fP +See \fIwidget(n)\fR .SH "SEE ALSO" widget(n) diff --git a/doc/ttk_labelframe.n b/doc/ttk_labelframe.n index 1eabcf2..8771f19 100644 --- a/doc/ttk_labelframe.n +++ b/doc/ttk_labelframe.n @@ -8,7 +8,7 @@ ttk::labelframe \- Container widget with optional label \fBttk::labelframe\fR \fIpathName \fR?\fIoptions\fR? .BE .SH DESCRIPTION -A \fBlabelframe\fP widget is a container used to group other widgets together. +A \fBlabelframe\fR widget is a container used to group other widgets together. It has an optional label, which may be a plain text string or another widget. .SO \-class \-cursor \-takefocus \-style @@ -20,7 +20,7 @@ It has an optional label, which may be a plain text string or another widget. '\" XXX: .OP -relief relief Relief '\" XXX: One of the standard Tk border styles: '\" XXX: \fBflat\fR, \fBgroove\fR, \fBraised\fR, \fBridge\fR, -'\" XXX: \fBsolid\fR, or \fBsunken\fP. +'\" XXX: \fBsolid\fR, or \fBsunken\fR. '\" XXX: Default is theme-dependent. .OP -labelanchor labelAnchor LabelAnchor Specifies where to place the label. @@ -39,25 +39,25 @@ If set, specifies the integer index (0-based) of a character to underline in the text string. The underlined character is used for mnemonic activation (see \fIkeynav(n)\fR). -Mnemonic activation for a \fBttk::labelframe\fP -sets the keyboard focus to the first child of the \fBttk::labelframe\fP widget. +Mnemonic activation for a \fBttk::labelframe\fR +sets the keyboard focus to the first child of the \fBttk::labelframe\fR widget. .OP -padding padding Padding Additional padding to include inside the border. .OP -labelwidget labelWidget LabelWidget The name of a widget to use for the label. -If set, overrides the \fB-text\fP option. -The \fB-labelwidget\fP must be a child of the \fBlabelframe\fP widget -or one of the \fBlabelframe\fP's ancestors, and must belong to the -same top-level widget as the \fBlabelframe\fP. +If set, overrides the \fB-text\fR option. +The \fB-labelwidget\fR must be a child of the \fBlabelframe\fR widget +or one of the \fBlabelframe\fR's ancestors, and must belong to the +same top-level widget as the \fBlabelframe\fR. .OP -width width Width If specified, the widget's requested width in pixels. .OP -height height Height If specified, the widget's requested height in pixels. -(See \fIttk::frame\fP for further notes on \fB-width\fP and \fB-height\fP). +(See \fIttk::frame\fR for further notes on \fB-width\fR and \fB-height\fR). .SH "WIDGET COMMAND" Supports the standard widget commands -\fBconfigure\fP, \fBcget\fP, \fBinstate\fP, and \fBstate\fP; -see \fIwidget(n)\fP. +\fBconfigure\fR, \fBcget\fR, \fBinstate\fR, and \fBstate\fR; +see \fIwidget(n)\fR. .SH "SEE ALSO" widget(n), frame(n) .SH "KEYWORDS" diff --git a/doc/ttk_menubutton.n b/doc/ttk_menubutton.n index cf3c576..572a2ea 100644 --- a/doc/ttk_menubutton.n +++ b/doc/ttk_menubutton.n @@ -10,7 +10,7 @@ ttk::menubutton \- Widget that pops down a menu when pressed \fBttk::menubutton\fR \fIpathName \fR?\fIoptions\fR? .BE .SH DESCRIPTION -A \fBmenubutton\fP widget displays a textual label and/or image, +A \fBmenubutton\fR widget displays a textual label and/or image, and displays a menu when pressed. .SO \-class \-compound \-cursor \-image diff --git a/doc/ttk_notebook.n b/doc/ttk_notebook.n index e123077..8912666 100644 --- a/doc/ttk_notebook.n +++ b/doc/ttk_notebook.n @@ -13,7 +13,7 @@ ttk::notebook \- Multi-paned container widget \fIpathName \fBinsert\fR \fIindex\fR \fIpathName\fR.\fIsubwindow\fR ?\fIoptions...\fR? .BE .SH DESCRIPTION -A \fBnotebook\fP widget manages a collection of subpanes +A \fBnotebook\fR widget manages a collection of subpanes and displays a single one at a time. Each pane is associated with a tab, which the user may select to change the currently-displayed pane. @@ -43,8 +43,8 @@ Otherwise, the maximum width of all panes is used. .SH "TAB OPTIONS" The following options may be specified for individual notebook panes: .OP \-state state State -Either \fBnormal\fP, \fBdisabled\fP or \fBhidden\fP. -If \fBdisabled\fP, then the tab is not selectable. If \fBhidden\fP, +Either \fBnormal\fR, \fBdisabled\fR or \fBhidden\fR. +If \fBdisabled\fR, then the tab is not selectable. If \fBhidden\fR, then the tab is not shown. .OP \-sticky sticky Sticky Specifies how the child pane is positioned within the pane area. @@ -55,7 +55,7 @@ that the child window will "stick" to, as per the \fBgrid\fR geometry manager. .OP \-padding padding Padding Specifies the amount of extra space to add between the notebook and this pane. -Syntax is the same as for the widget \fB-padding\fP option. +Syntax is the same as for the widget \fB-padding\fR option. .OP \-text text Text Specifies a string to be displayed in the tab. .OP \-image image Image @@ -116,7 +116,7 @@ See \fIwidget(n)\fR. \fIpathname \fBtab\fR \fItabid\fR ?\fI-options \fR?\fIvalue ...\fR Query or modify the options of the specific tab. If no \fI-option\fR is specified, returns a dictionary of the tab option values. -If one \fI-option\fP is specified, returns the value of that \fIoption\fR. +If one \fI-option\fR is specified, returns the value of that \fIoption\fR. Otherwise, sets the \fI-option\fRs to the corresponding \fIvalue\fRs. See \fBTAB OPTIONS\fR for the available options. .TP @@ -137,7 +137,7 @@ containing the notebook as follows: .IP \(bu \fBShift-Control-Tab\fR selects the tab preceding the currently selected one. .IP \(bu -\fBAlt-K\fP, where \fBK\fP is the mnemonic (underlined) character +\fBAlt-K\fR, where \fBK\fR is the mnemonic (underlined) character of any tab, will select that tab. .PP Multiple notebooks in a single toplevel may be enabled for traversal, @@ -163,7 +163,7 @@ which returns the number of tabs (only valid for "\fIpathname \fBindex\fR"). .SH "VIRTUAL EVENTS" -The notebook widget generates a \fB<<NotebookTabChanged>>\fP +The notebook widget generates a \fB<<NotebookTabChanged>>\fR virtual event after a new tab is selected. .SH "EXAMPLE" .CS diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n index d38a007..1c7661e 100644 --- a/doc/ttk_panedwindow.n +++ b/doc/ttk_panedwindow.n @@ -1,4 +1,4 @@ -'\" $Id: ttk_panedwindow.n,v 1.1 2006/10/31 01:42:25 hobbs Exp $ +'\" $Id: ttk_panedwindow.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ '\" Copyright (c) 2005 Joe English .so man.macros .TH ttk_panedwindow n 8.5 Tk "Tk Themed Widget" @@ -24,16 +24,16 @@ by dragging the sash between panes. .SH "WIDGET OPTIONS" .OP \-orient orient Orient Specifies the orientation of the window. -If \fBvertical\fP, subpanes are stacked top-to-bottom; -if \fBhorizontal\fP, subpanes are stacked left-to-right. +If \fBvertical\fR, subpanes are stacked top-to-bottom; +if \fBhorizontal\fR, subpanes are stacked left-to-right. .SH "PANE OPTIONS" The following options may be specified for each pane: .OP \-weight weight Weight An integer specifying the relative stretchability of the pane. When the paned window is resized, the extra space is added -or subracted to each pane proportionally to its \fB-weight\fP. +or subracted to each pane proportionally to its \fB-weight\fR. .SH "WIDGET COMMAND" -Supports the standard \fBconfigure\fR, \fBcget\fR, \fBstate\fP, +Supports the standard \fBconfigure\fR, \fBcget\fR, \fBstate\fR, and \fBinstate\fR commands; see \fIwidget(n)\fR for details. Additional commands: .TP @@ -59,7 +59,7 @@ Query or modify the options of the specified \fIpane\fR, where \fIpane\fR is either an integer index or the name of a managed subwindow. If no \fI-option\fR is specified, returns a dictionary of the pane option values. -If one \fI-option\fP is specified, returns the value of that \fIoption\fR. +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. .SH "INTERNAL ROUTINES" The following routines are used internally by the \fBpaned\fR widget diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n index 15ac048..2f5eedb 100644 --- a/doc/ttk_progressbar.n +++ b/doc/ttk_progressbar.n @@ -13,60 +13,60 @@ ttk::progressbar \- Provide progress feedback .SE .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient -One of \fBhorizontal\fP or \fBvertical\fP. +One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the progress bar. .OP \-length length Length Specifies the length of the long axis of the progress bar (width if horizontal, height if vertical). .OP \-mode mode Mode -One of \fBdeterminate\fP or \fBindeterminate\fP. +One of \fBdeterminate\fR or \fBindeterminate\fR. .OP \-maximum maximum Maximum A floating point number specifying the maximum \fB-value\fR. Defaults to 100. .OP \-value value Value The current value of the progress bar. In \fIdeterminate\fR mode, this represents the amount of work completed. -In \fIindeterminate\fR mode, it is interpreted modulo \fB-maximum\fP; +In \fIindeterminate\fR mode, it is interpreted modulo \fB-maximum\fR; that is, the progress bar completes one "cycle" when -the \fB-value\fP increases by \fB-maximum\fP. +the \fB-value\fR increases by \fB-maximum\fR. .OP \-variable variable Variable -The name of a Tcl variable which is linked to the \fB-value\fP. -If specified, the \fB-value\fP of the progress bar is +The name of a Tcl variable which is linked to the \fB-value\fR. +If specified, the \fB-value\fR of the progress bar is automatically set to the value of the variable whenever the latter is modified. .OP \-phase phase Phase Read-only option. The widget periodically increments the value of this option -whenever the \fB-value\fP is greater than 0 and, +whenever the \fB-value\fR is greater than 0 and, in \fIdeterminate\fR mode, less than \fB-maximum\fR. This option may be used by the current theme to provide additional animation effects. .BE .SH "DESCRIPTION" A progress bar widget shows the status of a long-running operation. -They can operate in two modes: \fIdeterminate\fP mode shows the +They can operate in two modes: \fIdeterminate\fR mode shows the amount completed relative to the total amount of work to be done, and \fIindeterminate\fR mode provides an animated display to let the user know that something is happening. .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR -Returns the current value of the specified \fIoption\fP; see \fIwidget(n)\fP. +Returns the current value of the specified \fIoption\fR; see \fIwidget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -Modify or query widget options; see \fIwidget(n)\fP. +Modify or query widget options; see \fIwidget(n)\fR. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? -Test the widget state; see \fIwidget(n)\fP. +Test the widget state; see \fIwidget(n)\fR. .TP \fIpathName \fBstart\fR ?\fIinterval\fR? Begin autoincrement mode: -schedules a recurring timer event that calls \fBstep\fP -every \fIinterval\fP milliseconds. -If omitted, \fIinterval\fP defaults to 50 milliseconds (20 steps/second). +schedules a recurring timer event that calls \fBstep\fR +every \fIinterval\fR milliseconds. +If omitted, \fIinterval\fR defaults to 50 milliseconds (20 steps/second). .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -Modify or query the widget state; see \fIwidget(n)\fP. +Modify or query the widget state; see \fIwidget(n)\fR. .TP \fIpathName \fBstep\fR ?\fIamount\fR? Increments the \fB-value\fR by \fIamount\fR. diff --git a/doc/ttk_radiobutton.n b/doc/ttk_radiobutton.n index 134b4c6..6d6d9db 100644 --- a/doc/ttk_radiobutton.n +++ b/doc/ttk_radiobutton.n @@ -28,7 +28,7 @@ The value to store in the associated \fI-variable\fR when the widget is selected. .OP \-variable variable Variable The name of a global variable whose value is linked to the widget. -Default value is \fB::selectedButton\fP. +Default value is \fB::selectedButton\fR. .SH "WIDGET COMMAND" In addition to the standard \fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR @@ -43,13 +43,13 @@ string if no \fI-command\fR is specified. .\" Missing: select, deselect. Useful? .\" Missing: flash. This is definitely not useful. .SH "WIDGET STATES" -The widget does not respond to user input if the \fBdisabled\fP state is set. -The widget sets the \fBselected\fP state whenever -the linked \fB-variable\fP is set to the widget's \fB-value\fP, +The widget does not respond to user input if the \fBdisabled\fR state is set. +The widget sets the \fBselected\fR state whenever +the linked \fB-variable\fR is set to the widget's \fB-value\fR, and clears it otherwise. -The widget sets the \fBalternate\fP state whenever the -linked \fB-variable\fP is unset. -(The \fBalternate\fP state may be used to indicate a ``tri-state'' +The widget sets the \fBalternate\fR state whenever the +linked \fB-variable\fR is unset. +(The \fBalternate\fR state may be used to indicate a ``tri-state'' or ``indeterminate'' selection.) .SH "SEE ALSO" widget(n), keynav(n), checkbutton(n) diff --git a/doc/ttk_scrollbar.n b/doc/ttk_scrollbar.n index 4593140..090c964 100644 --- a/doc/ttk_scrollbar.n +++ b/doc/ttk_scrollbar.n @@ -8,7 +8,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" $Id: ttk_scrollbar.n,v 1.1 2006/10/31 01:42:25 hobbs Exp $ +'\" $Id: ttk_scrollbar.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH ttk_scrollbar n 8.5 Tk "Tk Themed Widget" @@ -25,15 +25,15 @@ ttk::scrollbar \- Control the viewport of a scrollable widget A Tcl script prefix to evaluate to change the view in the widget associated with the scrollbar. Additional arguments are appended to the value of this option, -as described in \fBSCROLLING COMMANDS\fP below, +as described in \fBSCROLLING COMMANDS\fR below, whenever the user requests a view change by manipulating the scrollbar. .br This option typically consists of a two-element list, containing the name of a scrollable widget followed by -either \fBxview\fP (for horizontal scrollbars) -or \fByview\fP (for vertical scrollbars). +either \fBxview\fR (for horizontal scrollbars) +or \fByview\fR (for vertical scrollbars). .OP \-orient orient Orient -One of \fBhorizontal\fP or \fBvertical\fP. +One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the scrollbar. .BE @@ -53,26 +53,26 @@ these are used to scroll the visible region in discrete units. .SH "WIDGET COMMAND" .TP \fIpathName \fBcget\fR \fIoption\fR -Returns the current value of the specified \fIoption\fP; see \fIwidget(n)\fP. +Returns the current value of the specified \fIoption\fR; see \fIwidget(n)\fR. .TP \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -Modify or query widget options; see \fIwidget(n)\fP. +Modify or query widget options; see \fIwidget(n)\fR. .TP \fIpathName \fBget\fR Returns the scrollbar settings in the form of a list whose elements are the arguments to the most recent \fBset\fR widget command. .TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? -Test the widget state; see \fIwidget(n)\fP. +Test the widget state; see \fIwidget(n)\fR. .TP \fIpathName \fBset\fR \fIfirst last\fR This command is normally invoked by the scrollbar's associated widget -from an \fB-xscrollcommand\fP or \fB-yscrollcommand\fP callback. +from an \fB-xscrollcommand\fR or \fB-yscrollcommand\fR callback. Specifies the visible range to be displayed. \fIfirst\fR and \fIlast\fR are real fractions between 0 and 1. .TP \fIpathName \fBstate\fR ?\fIstateSpec\fR? -Modify or query the widget state; see \fIwidget(n)\fP. +Modify or query the widget state; see \fIwidget(n)\fR. .SH "INTERNAL COMMANDS" The following widget commands are used internally by the TScrollbar widget class bindings. @@ -139,10 +139,10 @@ is a slight overlap between the old and new views. become visible, or \-1, which means that the previous page should become visible. .SH "WIDGET STATES" -The scrollbar automatically sets the \fBdisabled\fP state bit. +The scrollbar automatically sets the \fBdisabled\fR state bit. when the entire range is visible (range is 0.0 to 1.0), and clears it otherwise. -It also sets the \fBactive\fP and \fBpressed\fP state flags +It also sets the \fBactive\fR and \fBpressed\fR state flags of individual elements, based on the position and state of the mouse pointer. .SH EXAMPLE .CS diff --git a/doc/ttk_separator.n b/doc/ttk_separator.n index 4a6a3b4..50892e9 100644 --- a/doc/ttk_separator.n +++ b/doc/ttk_separator.n @@ -1,4 +1,4 @@ -'\" $Id: ttk_separator.n,v 1.1 2006/10/31 01:42:25 hobbs Exp $ +'\" $Id: ttk_separator.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ '\" '\" Copyright (c) 2004 Joe English '\" @@ -11,14 +11,14 @@ ttk::separator \- Separator bar \fBttk::separator\fR \fIpathName \fR?\fIoptions\fR? .BE .SH DESCRIPTION -A \fBseparator\fP widget displays a horizontal or vertical separator bar. +A \fBseparator\fR widget displays a horizontal or vertical separator bar. .SO \-class \-cursor \-state \-style \-takefocus .SE .SH "WIDGET-SPECIFIC OPTIONS" .OP \-orient orient Orient -One of \fBhorizontal\fP or \fBvertical\fP. +One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the separator. .SH "WIDGET COMMAND" Separator widgets support the standard diff --git a/doc/ttk_sizegrip.n b/doc/ttk_sizegrip.n index 3735f11..505013c 100644 --- a/doc/ttk_sizegrip.n +++ b/doc/ttk_sizegrip.n @@ -1,4 +1,4 @@ -'\" $Id: ttk_sizegrip.n,v 1.1 2006/10/31 01:42:25 hobbs Exp $ +'\" $Id: ttk_sizegrip.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ '\" '\" Copyright (c) 2006 Joe English '\" @@ -11,7 +11,7 @@ ttk::sizegrip \- A silly widget \fBttk::sizegrip\fR \fIpathName \fR?\fIoptions\fR? .BE .SH DESCRIPTION -A \fBsizegrip\fP widget (also known as a \fIgrow box\fR) +A \fBsizegrip\fR widget (also known as a \fIgrow box\fR) allows the user to resize the containing toplevel window by pressing and dragging the grip. .SO @@ -25,7 +25,7 @@ methods. No other widget methods are used. .SH "PLATFORM-SPECIFIC NOTES" On Mac OSX, toplevel windows automatically include a built-in size grip by default. -Adding an \fBttk::sizegrip\fP there is harmless, since +Adding an \fBttk::sizegrip\fR there is harmless, since the built-in grip will just mask the widget. .SH EXAMPLES .CS diff --git a/doc/ttk_style.n b/doc/ttk_style.n index 9b57bf8..cbdb165 100644 --- a/doc/ttk_style.n +++ b/doc/ttk_style.n @@ -1,6 +1,6 @@ '\" '\" Copyright (c) 2004 Joe English -'\" $Id: ttk_style.n,v 1.1 2006/10/31 01:42:25 hobbs Exp $ +'\" $Id: ttk_style.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH ttk_style n 8.5 Tk "Tk Themed Widget" @@ -23,7 +23,7 @@ which specifies the set of elements making up the widget and how they are arranged, along with dynamic and default settings for element resources. By default, the style name is the same as the widget's class; -this may be overridden by the \fB-style\fP option. +this may be overridden by the \fB-style\fR option. .PP A \fItheme\fR is a collection of elements and styles which controls the overall look and feel of an application. @@ -36,16 +36,16 @@ Sets the default value of the specified option(s) in \fIstyle\fR. \fBttk::style map \fIstyle\fR ?\fI-option\fR { \fIstatespec value\fR } ... ? Sets dynamic values of the specified option(s) in \fIstyle\fR. Each \fIstatespec / value\fR pair is examined in order; -the value corresponding to the first matching \fIstatespec\fP +the value corresponding to the first matching \fIstatespec\fR is used. .TP \fBttk::style lookup \fIstyle\fR \fI-option \fR?\fIstate \fR?\fIdefault\fR?? -Returns the value specified for \fI-option\fP in style \fIstyle\fP -in state \fIstate\fP, using the standard lookup rules for element options. +Returns the value specified for \fI-option\fR in style \fIstyle\fR +in state \fIstate\fR, using the standard lookup rules for element options. \fIstate\fR is a list of state names; if omitted, it defaults to all bits off (the ``normal'' state). -If the \fIdefault\fP argument is present, it is used as a fallback -value in case no specification for \fI-option\fP is found. +If the \fIdefault\fR argument is present, it is used as a fallback +value in case no specification for \fI-option\fR is found. .\" Otherwise -- signal error? return empty string? Leave unspecified for now. .TP \fBttk::style layout \fIstyle\fR ?\fIlayoutSpec\fR? @@ -70,13 +70,13 @@ Returns the list of \fIelement\fR's options. Creates a new theme. It is an error if \fIthemeName\fR already exists. If \fI-parent\fR is specified, the new theme will inherit styles, elements, and layouts from the parent theme \fIbasedon\fB. -If \fI-settings\fR is present, \fIscript\fP is evaluated in the -context of the new theme as per \fBttk::style theme settings\fP. +If \fI-settings\fR is present, \fIscript\fR is evaluated in the +context of the new theme as per \fBttk::style theme settings\fR. .TP -\fBttk::style theme settings \fIthemeName\fP \fIscript\fP +\fBttk::style theme settings \fIthemeName\fR \fIscript\fR Temporarily sets the current theme to \fIthemeName\fR, evaluate \fIscript\fR, then restore the previous theme. -Typically \fIscript\fP simply defines styles and elements, +Typically \fIscript\fR simply defines styles and elements, though arbitrary Tcl code may appear. .TP \fBttk::style theme names\fR @@ -86,16 +86,16 @@ Returns a list of the available themes. Sets the current theme to \fIthemeName\fR, and refreshes all widgets. .SH LAYOUTS -A \fIlayout\fP specifies a list of elements, each followed +A \fIlayout\fR specifies a list of elements, each followed by one or more options specifying how to arrange the element. -The layout mechanism uses a simplified version of the \fBpack\fP +The layout mechanism uses a simplified version of the \fBpack\fR geometry manager: given an initial cavity, each element is allocated a parcel. Valid options are: .TP \fB-side \fIside\fR Specifies which side of the cavity to place the element; -one of \fBleft\fP, \fBright\fP, \fBtop\fP, or \fBbottom\fP. +one of \fBleft\fR, \fBright\fR, \fBtop\fR, or \fBbottom\fR. If omitted, the element occupies the entire cavity. .TP \fB-sticky \fI[nswe]\fR diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n index 1d7de13..da22343 100644 --- a/doc/ttk_widget.n +++ b/doc/ttk_widget.n @@ -1,6 +1,6 @@ '\" '\" Copyright (c) 2004 Joe English -'\" $Id: ttk_widget.n,v 1.1 2006/10/31 01:42:25 hobbs Exp $ +'\" $Id: ttk_widget.n,v 1.2 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH ttk_widget n 8.5 Tk "Tk Themed Widget" @@ -39,7 +39,7 @@ May be used to specify a custom widget style. .PP The following options are supported by widgets that are controllable by a scrollbar. -See \fIscrollbar(n)\fP for more information +See \fIscrollbar(n)\fR for more information .OP \-xscrollcommand xScrollCommand ScrollCommand A command prefix, used to communicate with horizontal scrollbars. .br @@ -54,7 +54,7 @@ that is visible in the window, and the second fraction indicates the information just after the last portion that is visible. .br Typically the \fBxScrollCommand\fR option consists of the path name -of a \fBscrollbar\fP widget followed by ``set'', e.g. ``.x.scrollbar set''. +of a \fBscrollbar\fR widget followed by ``set'', e.g. ``.x.scrollbar set''. This will cause the scrollbar to be updated whenever the view in the window changes. .br @@ -62,7 +62,7 @@ If this option is set to the empty string (the default), then no command is be executed. .OP \-yscrollcommand yScrollCommand ScrollCommand A command prefix, used to communicate with vertical scrollbars. -See the description of \fB-xscrollcommand\fP above for details. +See the description of \fB-xscrollcommand\fR above for details. .SH "LABEL OPTIONS" The following options are supported by labels, buttons, and other button-like widgets: @@ -71,7 +71,7 @@ Specifies a text string to be displayed inside the widget (unless overridden by \fB-textvariable\fR). .OP \-textvariable textVariable Variable Specifies the name of variable whose value will be used -in place of the \fB-text\fP resource. +in place of the \fB-text\fR resource. .OP \-underline underline Underline If set, specifies the integer index (0-based) of a character to underline in the text string. @@ -112,10 +112,10 @@ If zero or unspecified, the natural width of the text label is used. .SH "COMPATIBILITY OPTIONS" .OP \-state state State -May be set to \fBnormal\fP or \fBdisabled\fP -to control the \fBdisabled\fP state bit. +May be set to \fBnormal\fR or \fBdisabled\fR +to control the \fBdisabled\fR state bit. This is a ``write-only'' option: setting it changes the -widget state, but the \fBstate\fP widget command does +widget state, but the \fBstate\fR widget command does not affect the state option. .SH COMMANDS @@ -185,7 +185,7 @@ Widget is being pressed (aka "armed" in Motif). .TP \fBbackground\fR Windows and the Mac have a notion of an "active" or foreground window. -The \fBbackground\fP state is set for widgets in a background window, +The \fBbackground\fR state is set for widgets in a background window, and cleared for those in the foreground window. .TP \fBreadonly\fR @@ -195,14 +195,14 @@ Widget should not allow user modification. A widget-specific alternate display format. For example, used for checkbuttons and radiobuttons in the "tristate" or "mixed" state, -and for buttons with \fB-default active\fP. +and for buttons with \fB-default active\fR. .TP -\fBinvalid\fP +\fBinvalid\fR The widget's value is invalid. (Potential uses: scale widget value out of bounds, entry widget value failed validation.) .PP -A \fIstate specification\fP or \fIstateSpec\fP is a list +A \fIstate specification\fR or \fIstateSpec\fR is a list of state names, optionally prefixed with an exclamation point (!) indicating that the bit is off. .SH EXAMPLES @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: wm.n,v 1.25 2006/04/11 07:36:36 das Exp $ +'\" RCS: @(#) $Id: wm.n,v 1.26 2006/11/15 13:29:17 dkf Exp $ '\" .so man.macros .TH wm n 8.5 Tk "Tk Built-In Commands" @@ -89,16 +89,16 @@ and will have no effect under older WMs. .\" See http://www.freedesktop.org/Standards/wm-spec .RS .TP -\fB-topmost\fP +\fB-topmost\fR Requests that this window should be kept above -all other windows that do not also have the \fB-topmost\fP +all other windows that do not also have the \fB-topmost\fR attribute set. .TP -\fB-zoomed\fP +\fB-zoomed\fR Requests that the window should be maximized. -This is the same as \fB[wm state zoomed]\fP on Windows and Mac OS X. +This is the same as \fB[wm state zoomed]\fR on Windows and Mac OS X. .TP -\fB-fullscreen\fP +\fB-fullscreen\fR Requests that the window should fill the entire screen and have no window decorations. .RE |