diff options
Diffstat (limited to 'doc/GetJustify.3')
| -rw-r--r-- | doc/GetJustify.3 | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/GetJustify.3 b/doc/GetJustify.3 index 4752405..1a99d17 100644 --- a/doc/GetJustify.3 +++ b/doc/GetJustify.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: GetJustify.3,v 1.8 2007/10/26 20:13:22 dgp Exp $ +'\" RCS: @(#) $Id: GetJustify.3,v 1.9 2007/10/29 16:04:12 dkf Exp $ '\" .so man.macros .TH Tk_GetJustifyFromObj 3 8.1 Tk "Tk Library Procedures" @@ -29,9 +29,12 @@ const char * .AP Tcl_Interp *interp in Interpreter to use for error reporting, or NULL. .AP Tcl_Obj *objPtr in/out -String value contains name of justification style (\fBleft\fR, \fBright\fR, or -\fBcenter\fR). The -internal rep will be modified to cache corresponding justify value. +String value contains name of justification style, one of +.QW left , +.QW right , +or +.QW center . +The internal rep will be modified to cache corresponding justify value. .AP "const char" *string in Same as \fIobjPtr\fR except description of justification style is passed as a string. @@ -41,7 +44,6 @@ Pointer to location in which to store justify value corresponding to .AP Tk_Justify justify in Justification style (one of the values listed below). .BE - .SH DESCRIPTION .PP \fBTk_GetJustifyFromObj\fR places in \fI*justifyPtr\fR the justify value @@ -62,10 +64,10 @@ both the left and right edges of lines may be ragged. .PP Under normal circumstances the return value is \fBTCL_OK\fR and \fIinterp\fR is unused. -If \fIobjPtr\fR doesn't contain a valid justification style +If \fIobjPtr\fR does not contain a valid justification style or an abbreviation of one of these names, \fBTCL_ERROR\fR is returned, \fI*justifyPtr\fR is unmodified, and an error message is -stored in \fIinterp\fR's result if \fIinterp\fR isn't NULL. +stored in \fIinterp\fR's result if \fIinterp\fR is not NULL. \fBTk_GetJustifyFromObj\fR caches information about the return value in \fIobjPtr\fR, which speeds up future calls to \fBTk_GetJustifyFromObj\fR with the same \fIobjPtr\fR. @@ -79,8 +81,9 @@ return value, so \fBTk_GetJustify\fR is less efficient than \fBTk_NameOfJustify\fR is the logical inverse of \fBTk_GetJustify\fR. Given a justify value it returns a statically-allocated string corresponding to \fIjustify\fR. -If \fIjustify\fR isn't a legal justify value, then -``unknown justification style'' is returned. +If \fIjustify\fR is not a legal justify value, then +.QW "unknown justification style" +is returned. .SH KEYWORDS center, fill, justification, string |