diff options
author | hobbs <hobbs> | 2000-05-23 00:31:36 (GMT) |
---|---|---|
committer | hobbs <hobbs> | 2000-05-23 00:31:36 (GMT) |
commit | d83a7e0f396a0fb80db31573f08d03e7428d2d8e (patch) | |
tree | f445c87ce68b30ce105d0990947887c96cbb59ff /doc | |
parent | 7fdf0cb12c45945c34c3432ea01feeb23a9d7037 (diff) | |
download | tk-d83a7e0f396a0fb80db31573f08d03e7428d2d8e.zip tk-d83a7e0f396a0fb80db31573f08d03e7428d2d8e.tar.gz tk-d83a7e0f396a0fb80db31573f08d03e7428d2d8e.tar.bz2 |
* doc/bind.n:
* doc/canvas.n:
* doc/entry.n:
* doc/listbox.n:
* doc/photo.n: doc fix-ups [Bug: 5396]
Diffstat (limited to 'doc')
-rw-r--r-- | doc/bind.n | 23 | ||||
-rw-r--r-- | doc/canvas.n | 26 | ||||
-rw-r--r-- | doc/entry.n | 4 | ||||
-rw-r--r-- | doc/listbox.n | 16 | ||||
-rw-r--r-- | doc/photo.n | 16 |
5 files changed, 43 insertions, 42 deletions
@@ -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.4 2000/04/27 18:28:54 ericm Exp $ +'\" RCS: @(#) $Id: bind.n,v 1.5 2000/05/23 00:31:36 hobbs Exp $ '\" .so man.macros .TH bind n 8.0 Tk "Tk Built-In Commands" @@ -119,7 +119,7 @@ Modifiers consist of any of the following values: \fBButton3, B3\fR \fBAlt\fR \fBButton4, B4\fR \fBDouble\fR \fBButton5, B5\fR \fBTriple\fR -\fBMod1, M1\fR +\fBMod1, M1\fR \fBQuadruple\fR .DE Where more than one value is listed, separated by commas, the values are equivalent. @@ -145,16 +145,15 @@ Similarly, the \fBAlt\fR modifier refers to whichever modifier is associated with the alt key(s) on the keyboard (keysyms \fBAlt_L\fR and \fBAlt_R\fR). .PP -The \fBDouble\fR and \fBTriple\fR modifiers are a convenience -for specifying double mouse clicks and other repeated -events. They cause a particular event pattern to be -repeated 2 or 3 times, and also place a time and space requirement -on the sequence: for a sequence of events to match a \fBDouble\fR -or \fBTriple\fR pattern, all of the events must occur close together -in time and without substantial mouse motion in between. -For example, \fB<Double-Button-1>\fR -is equivalent to \fB<Button-1><Button-1>\fR with the extra -time and space requirement. +The \fBDouble\fR, \fBTriple\fR and \fBQuadruple\fR modifiers are a +convenience for specifying double mouse clicks and other repeated +events. They cause a particular event pattern to be repeated 2, 3 or 4 +times, and also place a time and space requirement on the sequence: for a +sequence of events to match a \fBDouble\fR, \fBTriple\fR or \fBQuadruple\fR +pattern, all of the events must occur close together in time and without +substantial mouse motion in between. For example, \fB<Double-Button-1>\fR +is equivalent to \fB<Button-1><Button-1>\fR with the extra time and space +requirement. .SH "EVENT TYPES" .PP diff --git a/doc/canvas.n b/doc/canvas.n index 4b2d720..1bcc62e 100644 --- a/doc/canvas.n +++ b/doc/canvas.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: canvas.n,v 1.6 2000/01/21 03:54:20 hobbs Exp $ +'\" RCS: @(#) $Id: canvas.n,v 1.7 2000/05/23 00:31:36 hobbs Exp $ '\" .so man.macros .TH canvas n 8.3 Tk "Tk Built-In Commands" @@ -283,7 +283,7 @@ are drawn transparant. The second possible syntax is a character list containing only 5 possible characters \fB[.,-_ ]\fR. The space can be used to enlarge the space between other line elements, and can not -occur as the first posibion in the string. Some examples: +occur as the first position in the string. Some examples: -dash . = -dash {2 4} -dash - = -dash {6 4} -dash -. = -dash {6 4 2 4} @@ -297,11 +297,11 @@ list will be multiplied by the line width before display. This assures that "." will always be displayed as a dot and "-" always as a dash regardless of the line width. .PP -On systems where only a limited set of dash patterns, the dash -pattern will be displayed as the most close dash pattern that -is available. For example, on Windows only the first 4 of the -above examples are available. The last 2 examples will be -displayed identically as the first one. +On systems which support only a limited set of dash patterns, the dash +pattern will be displayed as the closest dash pattern that is available. +For example, on Windows only the first 4 of the above examples are +available. The last 2 examples will be displayed identically to the first +one. .SH "WIDGET COMMAND" .PP @@ -1023,15 +1023,17 @@ explained here, and then referred to be each widget type for brevity. \fB\-activedash \fIpattern\fR .TP \fB\-disableddash \fIpattern\fR -This option specifies dash patterns for the normal state, the active -state, and the disabled state of an arc item. +This option specifies dash patterns for the normal, active +state, and disabled state of an item. \fIpattern\fR may have any of the forms accepted by \fBTk_GetDash\fR. If the dash options are omitted then the default is a solid outline. See "DASH PATTERNS" for more information. .TP \fB\-dashoffset \fIoffset\fR -The starting \fIoffset\fR into the pattern provided by the \fB\-dash\fR option. -\fB\-dashoffset\fR is ignored if there is no \fB-dash\fR pattern. +The starting \fIoffset\fR in pixels into the pattern provided by the +\fB\-dash\fR option. \fB\-dashoffset\fR is ignored if there is no +\fB-dash\fR pattern. The \fIoffset\fR may have any of the forms described +in the COORDINATES section above. .TP \fB\-fill \fIcolor\fR .TP @@ -1064,7 +1066,7 @@ Specifies the offset of stipples. The offset value can be of the form first case the origin is the origin of the toplevel of the current window. For the canvas itself and canvas objects the origin is the canvas origin, but putting \fB#\fR in front of the coordinate pair indicates using the -toplevel origin in stead. For canvas objects, the \fB-offset\fR option is +toplevel origin instead. For canvas objects, the \fB-offset\fR option is used for stippling as well. For the line and polygon canvas items you can also specify an index as argument, which connects the stipple origin to one of the coordinate points of the line/polygon. diff --git a/doc/entry.n b/doc/entry.n index 12dade2..af070cc 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.6 2000/05/17 22:23:25 ericm Exp $ +'\" RCS: @(#) $Id: entry.n,v 1.7 2000/05/23 00:31:36 hobbs Exp $ '\" .so man.macros .TH entry n 8.3 Tk "Tk Built-In Commands" @@ -146,7 +146,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: diff --git a/doc/listbox.n b/doc/listbox.n index 3973fe8..22f4c09 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.5 1999/12/21 23:54:17 hobbs Exp $ +'\" RCS: @(#) $Id: listbox.n,v 1.6 2000/05/23 00:31:36 hobbs Exp $ '\" .so man.macros .TH listbox n 8.0 Tk "Tk Built-In Commands" @@ -27,13 +27,13 @@ listbox \- Create and manipulate listbox widgets Specifies the desired height for the window, in lines. If zero or less, then the desired height for the window is made just large enough to hold all the elements in the listbox. -.OP \-listvar listVariable Variable -Specifies the name of a variable. The value of the variable is a list -to be displayed inside the widget; if the variable value changes -then the widget will automatically update itself to reflect the new value. -Attempts to assign a bad list value to a variable in use as a listvar -will cause an error. Attempts to unset a variable in use as a listvar -will fail but will not generate an error. +.OP \-listvariable listVariable Variable +Specifies the name of a variable. The value of the variable is a list to +be displayed inside the widget; if the variable value changes then the +widget will automatically update itself to reflect the new value. Attempts +to assign a variable with an invalid list value to \fB\-listvariable\fR +will cause an error. Attempts to unset a variable in use as a +\fB\-listvariable\fR will fail but will not generate an error. .OP \-selectmode selectMode SelectMode Specifies one of several styles for manipulating the selection. The value of the option may be arbitrary, but the default bindings diff --git a/doc/photo.n b/doc/photo.n index c49d2a1..00c2133 100644 --- a/doc/photo.n +++ b/doc/photo.n @@ -9,7 +9,7 @@ '\" Department of Computer Science, '\" Australian National University. '\" -'\" RCS: @(#) $Id: photo.n,v 1.4 2000/01/26 21:11:00 ericm Exp $ +'\" RCS: @(#) $Id: photo.n,v 1.5 2000/05/23 00:31:36 hobbs Exp $ '\" .so man.macros .TH photo n 4.0 Tk "Tk Built-In Commands" @@ -198,16 +198,16 @@ information. In all transparent pixels the color will be replaced by the specified color. .TP \fB\-format\fI format-name\fR -Specifies the name of the image file format handler to be used to -write the data to the file. Specifically, this subcommand searches +Specifies the name of the image file format handler to be used. +Specifically, this subcommand searches for the first handler whose name matches a initial substring of -\fIformat-name\fR and which has the capability to write an image -file. If this option is not given, this subcommand uses the first -handler that has the capability to write an image file. +\fIformat-name\fR and which has the capability to read this image data. +If this option is not given, this subcommand uses the first +handler that has the capability to read the image data. .TP \fB\-from \fIx1 y1 x2 y2\fR -Specifies a rectangular region of \fIimageName\fR to be written to the -image file. If only \fIx1\fR and \fIy1\fR are specified, the region +Specifies a rectangular region of \fIimageName\fR to be returned. +If only \fIx1\fR and \fIy1\fR are specified, the region extends from \fI(x1,y1)\fR to the bottom-right corner of \fIimageName\fR. If all four coordinates are given, they specify diagonally opposite corners of the rectangular region. The default, |