From 3fb4b62b126615f18524357090c3bccf0985fcae Mon Sep 17 00:00:00 2001 From: dkf Date: Tue, 17 Aug 2004 22:37:23 +0000 Subject: Doc patches [1010083] and [1010607] from Mikhail Kolesnitschenko. Also some general fixes to menu.n and text.n --- ChangeLog | 9 +++ doc/button.n | 3 +- doc/entry.n | 10 +-- doc/listbox.n | 4 +- doc/menu.n | 33 +++++----- doc/message.n | 4 +- doc/panedwindow.n | 7 ++- doc/scale.n | 4 +- doc/scrollbar.n | 4 +- doc/spinbox.n | 6 +- doc/text.n | 185 +++++++++++++++++++++++++++--------------------------- 11 files changed, 140 insertions(+), 129 deletions(-) diff --git a/ChangeLog b/ChangeLog index 515b62d..e4848cf 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +2004-08-17 Donal K. Fellows + + * doc/menu.n, doc/text.n: Assorted fixes, including spelling fixes + from Mikhail Kolesnitschenko. [Patch 1010083] + + * doc/spinbox.n, doc/scrollbar.n, doc/scale.n, doc/panedwindow.n: + * doc/message.n, doc/listbox.n, doc/entry.n, doc/button.n: + More spelling fixes from Mikhail Kolesnitschenko. [Patch 1010607] + 2004-08-16 Donal K. Fellows * doc/button.n, doc/checkbutton.n, doc/label.n, doc/menubutton.n: diff --git a/doc/button.n b/doc/button.n index d05e76e..16535aa 100644 --- a/doc/button.n +++ b/doc/button.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: button.n,v 1.7 2004/08/16 14:01:10 dkf Exp $ +'\" RCS: @(#) $Id: button.n,v 1.8 2004/08/17 22:37:24 dkf Exp $ '\" .so man.macros .TH button n 4.4 Tk "Tk Built-In Commands" @@ -44,7 +44,6 @@ the same size. In disabled state, the button is drawn with the non-default button appearance without leaving space for the default appearance. The disabled state may result in a smaller button than the active state. -ring. .VE .OP \-height height Height Specifies a desired height for the button. diff --git a/doc/entry.n b/doc/entry.n index 60c5660..e02f4d8 100644 --- a/doc/entry.n +++ b/doc/entry.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: entry.n,v 1.12 2003/12/08 18:47:23 hobbs Exp $ +'\" RCS: @(#) $Id: entry.n,v 1.13 2004/08/17 22:37:24 dkf Exp $ '\" .so man.macros .TH entry n 8.3 Tk "Tk Built-In Commands" @@ -78,8 +78,8 @@ state which mode you wish to use. See \fBValidation\fR below for more. .OP "\-validatecommand or \-vcmd" validateCommand ValidateCommand Specifies a script to eval when you want to validate the input into the entry widget. Setting it to {} disables this feature (the default). -This command must return a valid tcl boolean value. If it returns 0 (or -the valid tcl boolean equivalent) then it means you reject the new edition +This command must return a valid Tcl boolean value. If it returns 0 (or +the valid Tcl boolean equivalent) then it means you reject the new edition and it will not occur and the \fBinvalidCommand\fR will be evaluated if it is set. If it returns 1, then the new edition occurs. See \fBValidation\fR below for more information. @@ -183,7 +183,7 @@ when an error occurs evaluating the \fBvalidateCommand\fR. .PP Primarily, an error will occur when the \fBvalidateCommand\fR or \fBinvalidCommand\fR encounters an error in its script while evaluating or -\fBvalidateCommand\fR does not return a valid tcl boolean value. The +\fBvalidateCommand\fR does not return a valid Tcl boolean value. The \fBvalidate\fR option will also set itself to \fBnone\fR when you edit the entry widget from within either the \fBvalidateCommand\fR or the \fBinvalidCommand\fR. Such editions will override the one that was being @@ -334,7 +334,7 @@ has several forms, depending on \fIoption\fR: \fIpathName \fBselection adjust \fIindex\fR Locate the end of the selection nearest to the character given by \fIindex\fR, and adjust that end of the selection to be at \fIindex\fR -(i.e including but not going beyond \fIindex\fR). The other +(i.e. including but not going beyond \fIindex\fR). The other end of the selection is made the anchor point for future \fBselect to\fR commands. If the selection isn't currently in the entry, then a new selection is created to diff --git a/doc/listbox.n b/doc/listbox.n index c84d1d2..1a36230 100644 --- a/doc/listbox.n +++ b/doc/listbox.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: listbox.n,v 1.10 2004/03/25 12:12:36 vincentdarley Exp $ +'\" RCS: @(#) $Id: listbox.n,v 1.11 2004/08/17 22:37:24 dkf Exp $ '\" .so man.macros .TH listbox n 8.4 Tk "Tk Built-In Commands" @@ -30,7 +30,7 @@ listbox \- Create and manipulate listbox widgets .OP \-activestyle activeStyle ActiveStyle Specifies the style in which to draw the active element. This must be one of \fBdotbox\fR (show a focus ring around the active element), -\fBnone\fR (nospecial indication of active element) or +\fBnone\fR (no special indication of active element) or \fBunderline\fR (underline the active element). The default is \fBunderline\fR. .VS 8.4 diff --git a/doc/menu.n b/doc/menu.n index 2f5a6ce..dca1eb5 100644 --- a/doc/menu.n +++ b/doc/menu.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: menu.n,v 1.9 2004/03/04 00:06:06 hobbs Exp $ +'\" RCS: @(#) $Id: menu.n,v 1.10 2004/08/17 22:37:24 dkf Exp $ '\" .so man.macros .TH menu n 4.1 Tk "Tk Built-In Commands" @@ -29,10 +29,10 @@ menu, tk_menuSetFocus \- Create and manipulate menu widgets .OP \-postcommand postCommand Command If this option is specified then it provides a Tcl command to execute each time the menu is posted. The command is invoked by the \fBpost\fR -widget command before posting the menu. Note that in 8.0 on Macintosh -and Windows, all commands in a menu systems are executed before any -are posted. This is due to the limitations in the individual platforms' -menu managers. +widget command before posting the menu. Note that in Tk 8.0 on Macintosh +and Windows, all post-commands in a system of menus are executed before any +of those menus are posted. +This is due to the limitations in the individual platforms' menu managers. .VE .OP \-selectcolor selectColor Background For menu entries that are check buttons or radio buttons, this option @@ -151,7 +151,7 @@ the entry is deselected another value (determined by the \fB\-offvalue\fR option) is stored in the global variable. An indicator box is displayed to the left of the label in a checkbutton entry. If the entry is selected then the indicator's center is displayed -in the color given by the \fB-selectcolor\fR option for the entry; +in the color given by the \fB\-selectcolor\fR option for the entry; otherwise the indicator's center is displayed in the background color for the menu. If a \fB\-command\fR option is specified for a checkbutton entry, then its value is evaluated as a Tcl command each time the entry @@ -236,7 +236,7 @@ Any menu can be set as a menubar for a toplevel window (see \fBtoplevel\fR command for syntax). On the Macintosh, whenever the toplevel is in front, this menu's cascade items will appear in the menubar across the top of the main monitor. On Windows and Unix, this -menu's items will be displayed in a menubar accross the top of the +menu's items will be displayed in a menubar across the top of the window. These menus will behave according to the interface guidelines of their platforms. For every menu set as a menubar, a clone menu is made. See the \fBCLONES\fR section for more information. @@ -277,7 +277,7 @@ the tearoff item displayed as "(TearOff)". When Tk see a Help menu on the Macintosh, the menu's contents are appended to the standard help menu on the right of the user's menubar whenever the user's menubar is in front. The first items in the menu -are provided by Apple. Similar to the Apple Menu, cusomization in this +are provided by Apple. Similar to the Apple Menu, customization in this menu is limited to what the system provides. .PP When Tk sees a System menu on Windows, its items are appended to the @@ -410,18 +410,18 @@ This option is not available for separator or tear-off entries. \fB\-bitmap \fIvalue\fR Specifies a bitmap to display in the menu instead of a textual label, in any of the forms accepted by \fBTk_GetBitmap\fR. -This option overrides the \fB\-label\fR option but may be reset +This option overrides the \fB\-label\fR option +(as controlled by the \fB\-compound\fR option) +but may be reset to an empty string to enable a textual label to be displayed. If a \fB\-image\fR option has been specified, it overrides \fB\-bitmap\fR. This option is not available for separator or tear-off entries. -.VS 8.0 .TP \fB\-columnbreak \fIvalue\fR -When this option is zero, the appears below the previous entry. When -this option is one, the menu appears at the top of a new column in the +When this option is zero, the entry appears below the previous entry. When +this option is one, the entry appears at the top of a new column in the menu. -.VE .TP \fB\-command \fIvalue\fR Specifies a Tcl command to execute when the menu entry is invoked. @@ -462,10 +462,11 @@ the entry is hidden; 0 means that the margin is used. .TP \fB\-image \fIvalue\fR Specifies an image to display in the menu instead of a text string -or bitmap +or bitmap. The image must have been created by some previous invocation of \fBimage create\fR. This option overrides the \fB\-label\fR and \fB\-bitmap\fR options +(as controlled by the \fB\-compound\fR option) but may be reset to an empty string to enable a textual or bitmap label to be displayed. This option is not available for separator or tear-off entries. @@ -676,7 +677,7 @@ This is the most command case. You create a menu widget that will become the menu bar. You then add cascade entries to this menu, specifying the pull down menus you wish to use in your menu bar. You then create all of the pulldowns. Once you have done this, specify the menu using the -\fB-menu\fR option of the toplevel's widget command. See the +\fB\-menu\fR option of the toplevel's widget command. See the \fBtoplevel\fR manual entry for details. .VE .TP @@ -731,7 +732,7 @@ The Space and Return keys invoke the active entry and unpost the menu. .IP [5] If any of the entries in a menu have letters underlined with -with \fB\-underline\fR option, then pressing one of the underlined +the \fB\-underline\fR option, then pressing one of the underlined letters (or its upper-case or lower-case equivalent) invokes that entry and unposts the menu. .IP [6] diff --git a/doc/message.n b/doc/message.n index 70a412b..df0e9fc 100644 --- a/doc/message.n +++ b/doc/message.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: message.n,v 1.3 2000/08/25 06:58:32 ericm Exp $ +'\" RCS: @(#) $Id: message.n,v 1.4 2004/08/17 22:37:24 dkf Exp $ '\" .so man.macros .TH message n 4.0 Tk "Tk Built-In Commands" @@ -50,7 +50,7 @@ rectangular region. For example, suppose \fBanchor\fR is \fBe\fR and \fBjustify\fR is \fBleft\fR, and that the message window is much larger than needed for the text. -The the text will displayed so that the left edges of all the lines +The text will be displayed so that the left edges of all the lines line up and the right edge of the longest line is \fBpadX\fR from the right side of the window; the entire text block will be centered in the vertical span of the window. diff --git a/doc/panedwindow.n b/doc/panedwindow.n index e287475..891f102 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.3 2003/07/17 20:52:08 dkf Exp $ +'\" RCS: @(#) $Id: panedwindow.n,v 1.4 2004/08/17 22:37:24 dkf Exp $ '\" .so man.macros .TH panedwindow n 8.4 Tk "Tk Built-In Commands" @@ -125,7 +125,7 @@ the following forms: Return a list containing the x and y coordinates of the most recent proxy location. .TP -\fIpathname \fBproxy forget\fR +\fIpathName \fBproxy forget\fR Remove the proxy from the display. .TP \fIpathName \fBproxy place \fIx y\fR @@ -142,6 +142,7 @@ Return the current x and y coordinate pair for the sash given by \fIindex\fR. \fIIndex\fR must be an integer between 0 and 1 less than the number of panes in the panedwindow. The coordinates given are those of the top left corner of the region containing the sash. +.TP \fIpathName \fBsash dragto \fIindex x y\fR This command computes the difference between the given coordinates and the coordinates given to the last \fBsash coord\fR command for the given @@ -238,7 +239,7 @@ bindings on the widget. When a sash is moved, the sizes of the panes on each side of the sash, and thus the widgets in those panes, are adjusted. .PP -When a pane is resized from outside (eg, it is packed to expand and +When a pane is resized from outside (e.g. it is packed to expand and fill, and the containing toplevel is resized), space is added to the final (rightmost or bottommost) pane in the window. diff --git a/doc/scale.n b/doc/scale.n index ba6a124..4fd2ac3 100644 --- a/doc/scale.n +++ b/doc/scale.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: scale.n,v 1.3 2000/08/25 06:58:32 ericm Exp $ +'\" RCS: @(#) $Id: scale.n,v 1.4 2004/08/17 22:37:24 dkf Exp $ '\" .so man.macros .TH scale n 4.1 Tk "Tk Built-In Commands" @@ -63,7 +63,7 @@ rounding occurs. Defaults to 1 (i.e., the value will be integral). Specifies a boolean value indicating whether or not the current value of the scale is to be displayed. .OP \-sliderlength sliderLength SliderLength -Specfies the size of the slider, measured in screen units along the slider's +Specifies the size of the slider, measured in screen units along the slider's long dimension. The value may be specified in any of the forms acceptable to \fBTk_GetPixels\fR. .OP \-sliderrelief sliderRelief SliderRelief diff --git a/doc/scrollbar.n b/doc/scrollbar.n index 2c2d73b..f4f86b0 100644 --- a/doc/scrollbar.n +++ b/doc/scrollbar.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: scrollbar.n,v 1.3 2000/08/25 06:58:32 ericm Exp $ +'\" RCS: @(#) $Id: scrollbar.n,v 1.4 2004/08/17 22:37:24 dkf Exp $ '\" .so man.macros .TH scrollbar n 4.1 Tk "Tk Built-In Commands" @@ -69,7 +69,7 @@ A scrollbar is a widget that displays two arrows, one at each end of the scrollbar, and a \fIslider\fR in the middle portion of the scrollbar. It provides information about what is visible in an \fIassociated window\fR -that displays an document of some sort (such as a file being edited or +that displays a document of some sort (such as a file being edited or a drawing). The position and size of the slider indicate which portion of the document is visible in the associated window. For example, if the diff --git a/doc/spinbox.n b/doc/spinbox.n index 9da7b41..0aa9103 100644 --- a/doc/spinbox.n +++ b/doc/spinbox.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: spinbox.n,v 1.3 2001/12/18 23:02:35 hobbs Exp $ +'\" RCS: @(#) $Id: spinbox.n,v 1.4 2004/08/17 22:37:24 dkf Exp $ '\" .so man.macros .TH spinbox n 8.4 Tk "Tk Built-In Commands" @@ -168,7 +168,7 @@ loses focus. .IP \fBall\fR 10 \fBvalidateCommand\fR will be called for all above conditions. .PP -It is posible to perform percent substitutions on the \fBvalidateCommand\fR +It is possible to perform percent substitutions on the \fBvalidateCommand\fR and \fBinvalidCommand\fR, just as you would in a \fBbind\fR script. The following substitutions are recognized: .PP @@ -365,7 +365,7 @@ has several forms, depending on \fIoption\fR: \fIpathName \fBselection adjust \fIindex\fR Locate the end of the selection nearest to the character given by \fIindex\fR, and adjust that end of the selection to be at \fIindex\fR -(i.e including but not going beyond \fIindex\fR). The other +(i.e. including but not going beyond \fIindex\fR). The other end of the selection is made the anchor point for future \fBselect to\fR commands. If the selection isn't currently in the spinbox, then a new selection is created to diff --git a/doc/text.n b/doc/text.n index 062254d..a670c14 100644 --- a/doc/text.n +++ b/doc/text.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: text.n,v 1.26 2004/06/04 10:51:17 vincentdarley Exp $ +'\" RCS: @(#) $Id: text.n,v 1.27 2004/08/17 22:37:24 dkf Exp $ '\" .so man.macros .TH text n 8.5 Tk "Tk Built-In Commands" @@ -58,21 +58,21 @@ Requests additional space above each text line in the widget, using any of the standard forms for screen distances. If a line wraps, this option only applies to the first line on the display. -This option may be overriden with \fB\-spacing1\fR options in +This option may be overridden with \fB\-spacing1\fR options in tags. .OP \-spacing2 spacing2 Spacing2 For lines that wrap (so that they cover more than one line on the display) this option specifies additional space to provide between the display lines that represent a single line of text. The value may have any of the standard forms for screen distances. -This option may be overriden with \fB\-spacing2\fR options in +This option may be overridden with \fB\-spacing2\fR options in tags. .OP \-spacing3 spacing3 Spacing3 Requests additional space below each text line in the widget, using any of the standard forms for screen distances. If a line wraps, this option only applies to the last line on the display. -This option may be overriden with \fB\-spacing3\fR options in +This option may be overridden with \fB\-spacing3\fR options in tags. .OP \-state state State Specifies one of two states for the text: \fBnormal\fR or \fBdisabled\fR. @@ -156,8 +156,8 @@ that scripts are invoked when particular actions such as keystrokes and mouse button presses occur in particular ranges of the text. See TAGS below for more details. .PP -The second form of annotation consists of marks, which are floating -markers in the text. +The second form of annotation consists of floating markers in the text +called "marks". Marks are used to keep track of various interesting positions in the text as it is edited. See MARKS below for more details. @@ -190,15 +190,15 @@ Where \fIbase\fR gives a starting point and the \fImodifier\fRs adjust the index from the starting point (e.g. move forward or backward one character). Every index must contain a \fIbase\fR, but the \fImodifier\fRs are optional. Most modifiers (as documented below) allow -an optional submodifier. Valid \fIsubmodifier\fRs are nothing, \fIany\fB -or \fIdisplay\fR. If the submodifier is abbreviated, then it must be +an optional submodifier. Valid submodifiers are \fBany\fR +and \fBdisplay\fR. If the submodifier is abbreviated, then it must be followed by whitespace, but otherwise there need be no space between the -submodifier and the following \fImodifier\fR. Typically the \fIdisplay\fR +submodifier and the following \fImodifier\fR. Typically the \fBdisplay\fR submodifier adjusts the meaning of the following \fImodifier\fR to make it refer to visual or non-elided units rather than logical units, but this is explained for each relevant case below. Lastly, where \fIcount\fR is used as part of a modifier, it can be positive or negative, so '\fIbase\fR -- -3 lines' is perfectly valid (and equivalent to '\fIbase\fR +\- \-3 lines' is perfectly valid (and equivalent to '\fIbase\fR +3lines'). .PP The \fIbase\fR for an index must have one of the following forms: @@ -253,54 +253,54 @@ 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 may be abbreviated as long as the abbreviation is unambiguous. .TP -\fB+ \fIcount\fB \fI?submodifier?\fB chars\fR +\fB+ \fIcount\fR ?\fIsubmodifier\fR? \fBchars\fR Adjust the index forward by \fIcount\fR characters, moving to later lines in the text if necessary. If there are fewer than \fIcount\fR characters in the text after the current index, then set the index to the last index in the text. Spaces on either side of \fIcount\fR are optional. If the -\fIdisplay\fR submodifier is given, elided characters are skipped over -without being counted. If \fIany\fR is given, then all characters are +\fBdisplay\fR submodifier is given, elided characters are skipped over +without being counted. If \fBany\fR is given, then all characters are counted. For historical reasons, if neither modifier is given then the count actually takes place in units of index positions (see \fBindices\fR for details). This behaviour may be changed in a future major release, so if you need an index count, you are encouraged to use \fBindices\fR instead wherever possible. .TP -\fB\- \fIcount\fB \fI?submodifier?\fB chars\fR +\fB\- \fIcount\fR ?\fIsubmodifier\fR? \fBchars\fR Adjust the index backward by \fIcount\fR characters, moving to earlier lines in the text if necessary. If there are fewer than \fIcount\fR characters in the text before the current index, then set the index to the first index in the text (1.0). Spaces on either side of \fIcount\fR -are optional. If the \fIdisplay\fR submodifier is given, elided -characters are skipped over without being counted. If \fIany\fR is +are optional. If the \fBdisplay\fR submodifier is given, elided +characters are skipped over without being counted. If \fBany\fR is given, then all characters are counted. For historical reasons, if neither modifier is given then the count actually takes place in units of index positions (see \fBindices\fR for details). This behaviour may be changed in a future major release, so if you need an index count, you are encouraged to use \fBindices\fR instead wherever possible. .TP -\fB+ \fIcount\fB \fI?submodifier?\fB indices\fR +\fB+ \fIcount\fR ?\fIsubmodifier\fR? \fBindices\fR Adjust the index forward by \fIcount\fR index positions, moving to later lines in the text if necessary. If there are fewer than \fIcount\fR index positions in the text after the current index, then set the index to the last index position in the text. Spaces on either side of \fIcount\fR are optional. Note that an index position is either a single character or a single embedded image or embedded window. If the -\fIdisplay\fR submodifier is given, elided indices are skipped over -without being counted. If \fIany\fR is given, then all indices are -counted, which is also the default behaviour if no modifier is given. +\fBdisplay\fR submodifier is given, elided indices are skipped over +without being counted. If \fBany\fR is given, then all indices are +counted; this is also the default behaviour if no modifier is given. .TP -\fB\- \fIcount\fB \fI?submodifier?\fB indices\fR +\fB\- \fIcount\fR ?\fIsubmodifier\fR? \fBindices\fR Adjust the index backward by \fIcount\fR index positions, moving to earlier lines in the text if necessary. If there are fewer than \fIcount\fR index positions in the text before the current index, then set the index to the first index position (1.0) in the text. Spaces on -either side of \fIcount\fR are optional. If the \fIdisplay\fR +either side of \fIcount\fR are optional. If the \fBdisplay\fR submodifier is given, elided indices are skipped over without being -counted. If \fIany\fR is given, then all indices are counted, which is +counted. If \fBany\fR is given, then all indices are counted; this is also the default behaviour if no modifier is given. .TP -\fB+ \fIcount\fB \fI?submodifier?\fB lines\fR +\fB+ \fIcount\fR ?\fIsubmodifier\fR? \fBlines\fR Adjust the index forward by \fIcount\fR lines, retaining the same character position within the line. If there are fewer than \fIcount\fR lines after the line containing the current index, then set the index to @@ -308,13 +308,13 @@ refer to the same character position on the last line of the text. Then, if the line is not long enough to contain a character at the indicated character position, adjust the character position to refer to the last character of the line (the newline). Spaces on either side of -\fIcount\fR are optional. If the \fIdisplay\fR submodifier is given, +\fIcount\fR are optional. If the \fBdisplay\fR submodifier is given, then each visual display line is counted separately. Otherwise, if -\fIany\fR (or no modifier) is given, then each logical line (no matter +\fBany\fR (or no modifier) is given, then each logical line (no matter how many times it is visually wrapped) counts just once. If the relevant lines are not wrapped, then these two methods of counting are equivalent. .TP -\fB\- \fIcount\fB \fI?submodifier?\fB lines\fR +\fB\- \fIcount\fR ?\fIsubmodifier\fR? \fBlines\fR Adjust the index backward by \fIcount\fR logical lines, retaining the same character position within the line. If there are fewer than \fIcount\fR lines before the line containing the current index, then set @@ -322,34 +322,34 @@ the index to refer to the same character position on the first line of the text. Then, if the line is not long enough to contain a character at the indicated character position, adjust the character position to refer to the last character of the line (the newline). Spaces on either side -of \fIcount\fR are optional. If the \fIdisplay\fR submodifier is given, +of \fIcount\fR are optional. If the \fBdisplay\fR submodifier is given, then each visual display line is counted separately. Otherwise, if -\fIany\fR (or no modifier) is given, then each logical line (no matter +\fBany\fR (or no modifier) is given, then each logical line (no matter how many times it is visually wrapped) counts just once. If the relevant lines are not wrapped, then these two methods of counting are equivalent. .TP -\fB\fI?submodifier?\fB linestart\fR +?\fIsubmodifier\fR? \fBlinestart\fR Adjust the index to refer to the first character on the line. If the -\fIdisplay\fR submodifier is given, this is the first character on the +\fBdisplay\fR submodifier is given, this is the first character on the display line, otherwise on the logical line. .TP -\fB\fI?submodifier?\fB lineend\fR +?\fIsubmodifier\fR? \fBlineend\fR Adjust the index to refer to the last character on the line (the -newline). If the \fIdisplay\fR submodifier is given, this is the last +newline). If the \fBdisplay\fR submodifier is given, this is the last character on the display line, otherwise on the logical line. .TP -\fB\fI?submodifier?\fB wordstart\fR +?\fIsubmodifier\fR? \fBwordstart\fR Adjust the index to refer to the first character of the word containing the current index. A word consists of any number of adjacent characters that are letters, digits, or underscores, or a single character that is -not one of these. If the \fIdisplay\fR submodifier is given, this only +not one of these. If the \fBdisplay\fR submodifier is given, this only examines non-elided characters, otherwise all characters (elided or not) are examined. .TP -\fB\fI?submodifier?\fB wordend\fR +?\fIsubmodifier\fR? \fBwordend\fR Adjust the index to refer to the character just after the last one of the word containing the current index. If the current index refers to the -last character of the text then it is not modified. If the \fIdisplay\fR +last character of the text then it is not modified. If the \fBdisplay\fR submodifier is given, this only examines non-elided characters, otherwise all characters (elided or not) are examined. .PP @@ -360,7 +360,8 @@ refers to the next-to-last character in the text and the first one in the word containing the insertion cursor. .PP Where modifiers result in index changes by display lines, display chars -or display indices and the \fIbase\fP refers to an index which is elided, +or display indices, and the \fIbase\fP refers to an index inside an +elided tag, that base index is considered to be equivalent to the first following non-elided index. .SH TAGS @@ -369,7 +370,7 @@ The first form of annotation in text widgets is a tag. A tag is a textual string that is associated with some of the characters in a text. Tags may contain arbitrary characters, but it is probably best to -avoid using the the characters `` '' (space), \fB+\fR, or \fB\-\fR: +avoid using the characters `` '' (space), \fB+\fR, or \fB\-\fR: these characters have special meaning in indices, so tags containing them can't be used as indices. There may be any number of tags associated with characters in a @@ -594,7 +595,7 @@ Marks may be manipulated with the ``\fIpathName \fBmark\fR'' widget command, and their current locations may be determined by using the mark name as an index in widget commands. .PP -Each mark also has a \fIgravity\fR, which is either \fBleft\fR or +Each mark also has a "gravity", which is either \fBleft\fR or \fBright\fR. The gravity for a mark specifies what happens to the mark when text is inserted at the point of the mark. @@ -703,21 +704,21 @@ text is modified or scrolled. Each embedded image occupies one 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 widh \fBimage create\fP. +when the image is inserted into the text widget with \fBimage create\fP. 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\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 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. 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 +change, even though the \fB\-image\fP or \fB\-name\fP values can be changed with \fBimage configure\fP. .PP When an embedded image is added to a text widget with the @@ -800,7 +801,7 @@ this point whenever the text widget has the input focus. .SH "THE MODIFIED FLAG" The text widget can keep track of changes to the content of the widget by means of the modified flag. Inserting or deleting text will set -this flag. The flag can be queried, set and cleared programatically +this flag. The flag can be queried, set and cleared programmatically as well. Whenever the flag changes state a \fB<>\fR virtual event is generated. See the \fBedit modified\fR widget command for more details. @@ -809,7 +810,7 @@ more details. .PP .VS 8.4 The text widget has an unlimited undo and redo mechanism (when the -\fB-undo\fR widget option is true) which records every insert and +\fB\-undo\fR widget option is true) which records every insert and delete action on a stack. .PP Boundaries (called "separators") are inserted between edit actions. The @@ -820,8 +821,8 @@ redo stack, so that an undone edit can be redone again. The redo stack is cleared whenever new edit actions are recorded on the undo stack. The undo and redo stacks can be cleared to keep their depth under control. .PP -Separators are inserted automatically when the \fB-autoseparators\fR -widget option is true. You can insert separators programatically as +Separators are inserted automatically when the \fB\-autoseparators\fR +widget option is true. You can insert separators programmatically as well. If a separator is already present at the top of the undo stack no other will be inserted. That means that two separators on the undo stack are always separated by at least one insert or delete action. @@ -900,60 +901,60 @@ If \fIindex1\fR is after \fIindex2\fR, the result will be a negative number (and this holds for each of the possible options). The actual items which are counted depend on the options given. The result is a list of integers, one for the result of -each counting option given. Valid counting options are \fI-chars\fR, -\fI-displaychars\fR, \fI-displayindices\fR, \fI-displaylines\fR, -\fI-indices\fR, \fI-lines\fR, \fI-xpixels\fR and \fI-ypixels\fR. The -default value, if no option is specified, is \fI-indices\fR. There is an -additional possible option \fI-update\fR which is a modifier. If given, +each counting option given. Valid counting options are \fB\-chars\fR, +\fB\-displaychars\fR, \fB\-displayindices\fR, \fB\-displaylines\fR, +\fB\-indices\fR, \fB\-lines\fR, \fB\-xpixels\fR and \fB\-ypixels\fR. The +default value, if no option is specified, is \fB\-indices\fR. There is an +additional possible option \fB\-update\fR which is a modifier. If given, then all subsequent options ensure that any possible out of date information is recalculated. This currently only has any effect for the -\fI-ypixels\fR count (which, if 'update' is not given, will use the text +\fI\-ypixels\fR count (which, if \fB\-update\fR is not given, will use the text widget's current cached value for each line). The count options are interpreted as follows: .RS -.IP \fI-chars\fR +.IP \fB\-chars\fR count all characters, whether elided or not. Do not count embedded windows or images. -.IP \fI-displaychars\fR +.IP \fB\-displaychars\fR count all non-elided characters. -.IP \fI-displayindices\fR +.IP \fB\-displayindices\fR count all non-elided characters, windows and images. -.IP \fI-displaylines\fR +.IP \fB\-displaylines\fR count all display lines (i.e. counting one for each time a line wraps) from the line of the first index up to, but not including the display line of the second index. Therefore if they are both on the same display line, zero will be returned. By definition displaylines are visible and therefore this only counts portions of actual visible lines. -.IP \fI-indices\fR +.IP \fB\-indices\fR count all characters and embedded windows or images (i.e. everything which counts in text-widget index space), whether they are elided or not. -.IP \fI-lines\fR +.IP \fB\-lines\fR count all logical lines (irrespective of wrapping) from the line of the first index up to, but not including the line of the second index. Therefore if they are both on the same line, zero will be returned. Logical lines are counted whether they are currently visible (non-elided) or not. -.IP \fI-xpixels\fR +.IP \fB\-xpixels\fR count the number of horizontal pixels from the first pixel of the first index to (but not including) the first pixel of the second index. To count the total desired width of the text widget (assuming wrapping is not enabled), first find the longest line and then -use '.text count -xpixels "${line}.0" "${line}.0 lineend"'. -.IP \fI-ypixels\fR +use '.text count \-xpixels "${line}.0" "${line}.0 lineend"'. +.IP \fB\-ypixels\fR count the number of vertical pixels from the first pixel of the first index to (but not including) the first pixel of the second index. If both indices are on the same display line, zero will be returned. To count the total number of vertical pixels in the text -widget, use '.text count -ypixels 1.0 end', and to ensure this is up to -date, use '.text count -update -ypixels 1.0 end'. +widget, use '.text count \-ypixels 1.0 end', and to ensure this is up to +date, use '.text count \-update \-ypixels 1.0 end'. .PP The command returns a positive or negative integer corresponding to the number of items counted between the two indices. One such integer is returned for each counting option given, so a list is returned if more -than one option was supplied. For example '.text count -xpixels --ypixels 1.3 4.5' is perfectly valid and will return a list of two +than one option was supplied. For example '.text count \-xpixels +\-ypixels 1.3 4.5' is perfectly valid and will return a list of two elements. .RE .VE 8.5 @@ -997,7 +998,7 @@ The command returns an empty string. If more indices are given, multiple ranges of text will be deleted. All indices are first checked for validity before any deletions are made. They are sorted and the text is removed from the last range to the -first range to deleted text does not cause a undesired index shifting +first range to deleted text does not cause an undesired index shifting side-effects. If multiple ranges with the same start index are given, then the longest range is used. If overlapping ranges are given, then they will be merged into spans that do not cause deletion of text @@ -1069,7 +1070,7 @@ Include information about text in the dump results. The value is the text up to the next element or the end of range indicated by \fIindex2\fR. A text element does not span newlines. A multi-line block of text that contains no marks or tag transitions will still be dumped as a set -of text seqments that each end with a newline. The newline is part +of text segments that each end with a newline. The newline is part of the value. .TP \fB\-window\fR @@ -1095,9 +1096,9 @@ user can set or clear the modified flag. If \fIboolean\fR is specified, sets the modified flag of the widget to \fIboolean\fR. .TP \fIpathName \fBedit redo\fR -When the \fB-undo\fR option is true, reapplies the last undone edits +When the \fB\-undo\fR option is true, reapplies the last undone edits provided no other edits were done since then. Generates an error when -the redo stack is empty. Does nothing when the \fB-undo\fR option is +the redo stack is empty. Does nothing when the \fB\-undo\fR option is false. .TP \fIpathName \fBedit reset\fR @@ -1105,18 +1106,18 @@ Clears the undo and redo stacks. .TP \fIpathName \fBedit separator\fR Inserts a separator (boundary) on the undo stack. Does nothing when -the \fB-undo\fR option is false. +the \fB\-undo\fR option is false. .TP \fIpathName \fBedit undo\fR -Undoes the last edit action when the \fB-undo\fR option is true. An +Undoes the last edit action when the \fB\-undo\fR option is true. An edit action is defined as all the insert and delete commands that are recorded on the undo stack in between two separators. Generates an -error when the undo stack is empty. Does nothing when the \fB-undo\fR +error when the undo stack is empty. Does nothing when the \fB\-undo\fR option is false. .RE .VE 8.4 .TP -\fIpathName \fBget\fR \fI?-displaychars?\fR \fI-- index1\fR ?\fIindex2 ...\fR? +\fIpathName \fBget\fR \fI?\-displaychars?\fR \fI\-\- index1\fR ?\fIindex2 ...\fR? Return a range of characters from the text. The return value will be all the characters in the text starting with the one whose index is \fIindex1\fR and ending just before @@ -1135,7 +1136,7 @@ in a list. Invalid ranges will not be represented with empty strings in the list. The ranges are returned in the order passed to \fBget\fR. .VE 8.4 .VS 8.5 -If the \fI-displaychars\fR option is given, then, within each range, +If the \fB\-displaychars\fR option is given, then, within each range, only those characters which are not elided will be returned. This may have the effect that some of the returned ranges are empty strings. .VE 8.5 @@ -1346,7 +1347,7 @@ This allows \fI.\fR and \fI[^\fR sequences to match the newline character \fI\en\fR, which they will otherwise not do (see the \fBregexp\fR command for details). This option is only meaningful if \fB\-regexp\fR is also given, and an error will be thrown otherwise. For example, -to match the entire text, use 'search -nolinestop -regexp ".*" 1.0'. +to match the entire text, use 'search \-nolinestop \-regexp ".*" 1.0'. .TP \fB\-nocase\fR Ignore case differences between the pattern and the text. @@ -1367,10 +1368,10 @@ given, then \fBvarName\fR is also set to a list containing one element for each successful match. Note that, even for exact searches, the elements of this list may be different, if there are embedded images, windows or hidden text. Searches with \fB\-all\fR behave very -similarly to the Tcl command \fBregexp -all\fR, in that overlapping +similarly to the Tcl command \fBregexp \-all\fR, in that overlapping matches are not normally returned. For example, applying an \fB\-all\fR search of the pattern '\\w+' against 'hello there' will just match twice, once -for each word, and matching 'Z[a-z]+Z' against 'ZooZooZoo' will just +for each word, and matching 'Z[a\-z]+Z' against 'ZooZooZoo' will just match once. .TP \fB\-overlap\fR @@ -1380,11 +1381,11 @@ switch changes that behaviour so that all matches which are not totally enclosed within another match are returned. For example, applying an \fB\-overlap\fR search of the pattern '\\w+' against 'hello there' will just match twice (i.e. no different to just \fB\-all\fR), -but matching 'Z[a-z]+Z' against 'ZooZooZoo' will now match twice. +but matching 'Z[a\-z]+Z' against 'ZooZooZoo' will now match twice. An error will be thrown if this switch is used without \fB\-all\fR. .TP \fB\-elide\fR -Find elidden (hidden) text as well. By default only displayed text is +Find elided (hidden) text as well. By default only displayed text is searched. .TP \fB\-\|\-\fR @@ -1933,11 +1934,11 @@ the insertion cursor. .IP [32] .VS 8.4 Control-z (and Control-underscore on UNIX when \fBtk_strictMotif\fR is -true) undoes the last edit action if the \fB-undo\fR option is true. +true) undoes the last edit action if the \fB\-undo\fR option is true. Does nothing otherwise. .IP [33] Control-Z (or Control-y on Windows) reapplies the last undone edit -action if the \fB-undo\fR option is true. Does nothing otherwise. +action if the \fB\-undo\fR option is true. Does nothing otherwise. .VE 8.4 .PP If the widget is disabled using the \fB\-state\fR option, then its @@ -1954,8 +1955,8 @@ Before Tk 8.5, the widget used the string "chars" to refer to index positions (which included characters, embedded windows and embedded images). As of Tk 8.5 the text widget deals separately and correctly with "chars" and "indices". For backwards compatibility, however, the -index modifiers "+N chars" and "-N chars" continue to refer to indices. -One must use any of the full forms "+N any chars" or "-N any chars" etc +index modifiers "+N chars" and "\-N chars" continue to refer to indices. +One must use any of the full forms "+N any chars" or "\-N any chars" etc to refer to actual character indices. This confusion may be fixed in a future release by making the widget correctly interpret "+N chars" as a synonym for "+N any chars". @@ -1996,7 +1997,7 @@ Set the \fBinsertOffTime\fP attribute to 0 avoid this. .SH "KNOWN BUGS" .PP -The \fB-elide\fP tag attribute, introduced in Tk 8.3, has one known +The \fB\-elide\fP tag attribute, introduced in Tk 8.3, has one known limitation. Newlines which have this attribute are only actually elided if their entire logical line is also elided. Where there is a logical line which begins un-elided but terminates with an elided newline, that @@ -2007,9 +2008,9 @@ logical lines. This does mean, however, that logical lines which are completely elided have no problems. .VS 8.5 .PP -The \fBsearch -regexp\fR sub-command attempts to perform sophisticated +The \fBsearch \-regexp\fR sub-command attempts to perform sophisticated regexp matching across multiple lines in an efficient fashion (since Tk -8.5), examing each line individually, and then in small groups of lines, +8.5), examining each line individually, and then in small groups of lines, whether searching forwards or backwards. Under certain conditions the search result might differ from that obtained by applying the same regexp to the entire text from the widget in one go. For example, when @@ -2026,7 +2027,7 @@ a rare problem, but it can occur, for example: .CS pack [text .t] .t insert 1.0 "aaaa\\nbbbb\\ncccc\\nbbbb\\naaaa\\n" - .t search -regexp -- {(a+|b+\\nc+\\nb+)+\\na+} 1.0 + .t search \-regexp \-\- {(a+|b+\\nc+\\nb+)+\\na+} 1.0 .CE will not find a match when one exists of 19 characters starting from the first 'b'. @@ -2043,10 +2044,10 @@ For example: .CS pack [text .t] .t insert 1.0 "aaaa\\nbbbb\\nbbbb\\nbbbb\\nbbbb\\n" - .t search -regexp -backward -- {b+\\n|a+\\n(b+\\n)+} end + .t search \-regexp \-backward \-\- {b+\\n|a+\\n(b+\\n)+} end .CE matches at '5.0' when a true greedy match would match at '1.0'. -Similarly if we add \fB-all\fR to this case, it matches at +Similarly if we add \fB\-all\fR to this case, it matches at all of '5.0', '4.0', '3.0' and '1.0', when really it should only match at '1.0' since that match encloses all the others. -- cgit v0.12