summaryrefslogtreecommitdiffstats
path: root/doc/TextLayout.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/TextLayout.3')
-rw-r--r--doc/TextLayout.39
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/TextLayout.3 b/doc/TextLayout.3
index 5729a44..ab73d12 100644
--- a/doc/TextLayout.3
+++ b/doc/TextLayout.3
@@ -51,7 +51,7 @@ stored in the text layout. The \fIstring\fR must remain valid for the
lifetime of the text layout.
.AP int numChars in
The number of characters to consider from \fIstring\fR. If
-\fInumChars\fR is less than 0, then assumes \fIstring\fR is null
+\fInumChars\fR is negative, then assumes \fIstring\fR is null
terminated and uses \fBTcl_NumUtfChars\fR to determine the length of
\fIstring\fR.
.AP int wrapLength in
@@ -108,8 +108,9 @@ The index of the last character up to which to draw. The character
specified by \fIlastChar\fR itself will not be drawn. A number less
than 0 means to draw all characters in the text layout.
.AP int underline in
-Index of the single character to underline in the text layout, or a number
-less than 0 for no underline.
+Index of the single character to underline in the text layout, or a
+negative number counting backwards from the end of the string. Any
+out-of-range number (e.g. INT_MIN) means no underline.
.AP int index in
The index of the character whose bounding box is desired. The bounding
box is computed with respect to the upper-left hand corner of the text layout.
@@ -178,7 +179,7 @@ located at (0, 0). Any point whose \fIy\fR-value is less that 0 will be
considered closest to the first character in the text layout; any point
whose \fIy\fR-value is greater than the height of the text layout will be
considered closest to the last character in the text layout. Any point
-whose \fIx\fR-value is less than 0 will be considered closest to the first
+whose \fIx\fR-value is negative will be considered closest to the first
character on that line; any point whose \fIx\fR-value is greater than the
width of the text layout will be considered closest to the last character on
that line. The return value is the index of the character that was closest