2
'\" Copyright (c) 1990 The Regents of the University of California.
3
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5
'\" See the file "license.terms" for information on usage and redistribution
6
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8
'\" RCS: @(#) $Id: GetAnchor.3,v 1.2 1998/09/14 18:22:48 stanton Exp $
11
.TH Tk_GetAnchor 3 "" Tk "Tk Library Procedures"
14
Tk_GetAnchor, Tk_NameOfAnchor \- translate between strings and anchor positions
20
\fBTk_GetAnchor(\fIinterp, string, anchorPtr\fB)\fR
23
\fBTk_NameOfAnchor(\fIanchor\fB)\fR
25
.AS "Tk_Anchor" *anchorPtr
26
.AP Tcl_Interp *interp in
27
Interpreter to use for error reporting.
29
String containing name of anchor point: one of ``n'', ``ne'', ``e'', ``se'',
30
``s'', ``sw'', ``w'', ``nw'', or ``center''.
31
.AP int *anchorPtr out
32
Pointer to location in which to store anchor position corresponding to
34
.AP Tk_Anchor anchor in
35
Anchor position, e.g. \fBTCL_ANCHOR_CENTER\fR.
40
\fBTk_GetAnchor\fR places in \fI*anchorPtr\fR an anchor position
41
(enumerated type \fBTk_Anchor\fR)
42
corresponding to \fIstring\fR, which will be one of
43
\fBTK_ANCHOR_N\fR, \fBTK_ANCHOR_NE\fR, \fBTK_ANCHOR_E\fR, \fBTK_ANCHOR_SE\fR,
44
\fBTK_ANCHOR_S\fR, \fBTK_ANCHOR_SW\fR, \fBTK_ANCHOR_W\fR, \fBTK_ANCHOR_NW\fR,
45
or \fBTK_ANCHOR_CENTER\fR.
46
Anchor positions are typically used for indicating a point on an object
47
that will be used to position that object, e.g. \fBTK_ANCHOR_N\fR means
48
position the top center point of the object at a particular place.
50
Under normal circumstances the return value is \fBTCL_OK\fR and
51
\fIinterp\fR is unused.
52
If \fIstring\fR doesn't contain a valid anchor position
53
or an abbreviation of one of these names, then an error message is
54
stored in \fIinterp->result\fR, \fBTCL_ERROR\fR is returned, and
55
\fI*anchorPtr\fR is unmodified.
57
\fBTk_NameOfAnchor\fR is the logical inverse of \fBTk_GetAnchor\fR.
58
Given an anchor position such as \fBTK_ANCHOR_N\fR it returns a
59
statically-allocated string corresponding to \fIanchor\fR.
60
If \fIanchor\fR isn't a legal anchor value, then
61
``unknown anchor position'' is returned.
added
removed
doc/GetAnchor.3
