diff options
Diffstat (limited to 'doc/GetAnchor.3')
| -rw-r--r-- | doc/GetAnchor.3 | 26 |
1 files changed, 17 insertions, 9 deletions
diff --git a/doc/GetAnchor.3 b/doc/GetAnchor.3 index cf22d1a..0d0f74e 100644 --- a/doc/GetAnchor.3 +++ b/doc/GetAnchor.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: GetAnchor.3,v 1.8 2007/10/26 20:13:22 dgp Exp $ +'\" RCS: @(#) $Id: GetAnchor.3,v 1.9 2007/10/29 16:04:12 dkf Exp $ '\" .so man.macros .TH Tk_GetAnchorFromObj 3 8.1 Tk "Tk Library Procedures" @@ -29,8 +29,17 @@ 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 anchor point: \fBn\fR, \fBne\fR, -\fBe\fR, \fBse\fR, \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR; +String value contains name of anchor point: +.QW n , +.QW ne , +.QW e , +.QW se , +.QW s , +.QW sw , +.QW w , +.QW nw , +or +.QW center ; internal rep will be modified to cache corresponding Tk_Anchor. .AP "const char" *string in Same as \fIobjPtr\fR except description of anchor point is passed as @@ -41,7 +50,6 @@ Pointer to location in which to store anchor position corresponding to .AP Tk_Anchor anchor in Anchor position, e.g. \fBTCL_ANCHOR_CENTER\fR. .BE - .SH DESCRIPTION .PP \fBTk_GetAnchorFromObj\fR places in \fI*anchorPtr\fR an anchor position @@ -56,10 +64,10 @@ position the top center point of the object at a particular place. .PP Under normal circumstances the return value is \fBTCL_OK\fR and \fIinterp\fR is unused. -If \fIstring\fR doesn't contain a valid anchor position +If \fIstring\fR does not contain a valid anchor position or an abbreviation of one of these names, \fBTCL_ERROR\fR is returned, \fI*anchorPtr\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_GetAnchorFromObj\fR caches information about the return value in \fIobjPtr\fR, which speeds up future calls to \fBTk_GetAnchorFromObj\fR with the same \fIobjPtr\fR. @@ -73,8 +81,8 @@ return value, so \fBTk_GetAnchor\fR is less efficient than \fBTk_NameOfAnchor\fR is the logical inverse of \fBTk_GetAnchor\fR. Given an anchor position such as \fBTK_ANCHOR_N\fR it returns a statically-allocated string corresponding to \fIanchor\fR. -If \fIanchor\fR isn't a legal anchor value, then -``unknown anchor position'' is returned. - +If \fIanchor\fR is not a legal anchor value, then +.QW "unknown anchor position" +is returned. .SH KEYWORDS anchor position |