diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/selection.n | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/doc/selection.n b/doc/selection.n index f6caddd..a67678b 100644 --- a/doc/selection.n +++ b/doc/selection.n @@ -5,10 +5,10 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: selection.n,v 1.2 1998/09/14 18:22:59 stanton Exp $ +'\" RCS: @(#) $Id: selection.n,v 1.3 1999/06/03 18:50:45 stanton Exp $ '\" .so man.macros -.TH selection n 4.0 Tk "Tk Built-In Commands" +.TH selection n 8.1 Tk "Tk Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -70,19 +70,21 @@ and \fItype\fR is the requested type, \fIcommand\fR will be executed as a Tcl command with two additional numbers appended to it (with space separators). The two additional numbers -are \fIoffset\fR and \fImaxBytes\fR: \fIoffset\fR specifies a starting -character position in the selection and \fImaxBytes\fR gives the maximum -number of bytes to retrieve. The command should return a value consisting -of at most \fImaxBytes\fR of the selection, starting at position -\fIoffset\fR. For very large selections (larger than \fImaxBytes\fR) +.VS +are \fIoffset\fR and \fImaxChars\fR: \fIoffset\fR specifies a starting +character position in the selection and \fImaxChars\fR gives the maximum +number of characters to retrieve. The command should return a value consisting +of at most \fImaxChars\fR of the selection, starting at position +\fIoffset\fR. For very large selections (larger than \fImaxChars\fR) the selection will be retrieved using several invocations of \fIcommand\fR with increasing \fIoffset\fR values. If \fIcommand\fR returns a string -whose length is less than \fImaxBytes\fR, the return value is assumed to +whose length is less than \fImaxChars\fR, the return value is assumed to include all of the remainder of the selection; if the length of -\fIcommand\fR's result is equal to \fImaxBytes\fR then +\fIcommand\fR's result is equal to \fImaxChars\fR then \fIcommand\fR will be invoked again, until it eventually -returns a result shorter than \fImaxBytes\fR. The value of \fImaxBytes\fR -will always be relatively large (thousands of bytes). +returns a result shorter than \fImaxChars\fR. The value of \fImaxChars\fR +will always be relatively large (thousands of characters). +.VE .PP If \fIcommand\fR returns an error then the selection retrieval is rejected just as if the selection didn't exist at all. |