head	1.11;
access;
symbols
	core-8-5-9:1.10
	core-8-5-8:1.10
	macosx-cocoa-merge:1.10
	macosx-cocoa-premerge:1.10
	macosx-carbon-freeze:1.10
	core-8-5-7:1.10
	core-8-5-6:1.10
	core-8-6-b1:1.10
	core-8-6-a3:1.10
	core-8-5-5:1.10
	core-8-6-a2:1.10
	core-8-5-4:1.10
	core-8-5-3:1.10
	core-8-6-a1:1.10
	core-8-4-19:1.4
	core-8-5-branch:1.10.0.2
	core-8-5-2:1.10
	core-8-4-18:1.4
	core-8-5-1:1.10
	core-8-4-17:1.4
	core-8-5-0:1.10
	core-8-5-b3:1.9
	core-8-5-b2:1.8
	core-8-4-16:1.4
	core-8-5-b1:1.6
	core-stablilizer-merge:1.6
	core-stabilizer-branch:1.6.0.2
	core-stabilizer-merge:1.10
	core-8-4-15:1.4
	core-8-5-a6:1.6
	core-8-5-a5:1.5
	core-8-4-14:1.4
	core-8-5-a4:1.5
	core-8-4-13:1.4
	core-8-4-12:1.4
	core-8-4-11:1.4
	core-8-5-a3:1.5
	core-8-4-10:1.4
	core-8-4-9-branch:1.4.0.6
	core-8-5-a2:1.4
	core-8-4-9:1.4
	core-8-4-8:1.4
	core-8-4-7:1.4
	core-8-5-a1:1.4
	core-8-4-6:1.4
	core-8-4-5:1.4
	mistachkin-dev-branch:1.4.0.4
	core-8-4-4:1.4
	core-8-4-3:1.4
	core-8-4-branch:1.4.0.2
	core-8-4-2:1.4
	core-8-4-1:1.4
	core-8-3-5:1.3
	core-8-4-0:1.4
	macosx-8-4-merge-2002-08-31-trunk:1.4
	macosx-8-4-premerge-2002-08-31-branch:1.3.18.1
	macosx-8-4-premerge-2002-08-31-trunk:1.4
	macosx-8-4-merge-2002-08-30-branch:1.3.18.1
	macosx-8-4-merge-2002-08-30-trunk:1.4
	macosx-8-4-merge-2002-08-20-branch:1.3.18.1
	macosx-8-4-merge-2002-08-20-trunk:1.4
	core-8-4-b2:1.4
	core-8-4-b1:1.3
	macosx-premerge-6-9-02:1.3
	core-8-4-a4:1.3
	core-8-3-4:1.3
	macosx-8-4-branch:1.3.0.18
	macosx-8-4-branchpoint:1.3
	core-8-4-a3:1.3
	core-8-3-3:1.3
	dgp-privates-into-namespace:1.3.0.16
	tclpro-1-5-0:1.3
	core-8-4-win-speedup:1.3.0.14
	core-8-4-a2:1.3
	tclpro-1-4-1:1.3
	tclpro-1-4-0:1.3
	core-8-3-2:1.3
	ajuba-ajuba2-2-1-base:1.3
	ajuba-ajuba2-2-0:1.3
	core-8-4-a1:1.3
	core-8-3-1-branch:1.3.0.12
	core-8-3-1:1.3
	scriptics-sc-2-0-b5:1.3
	scriptics-sc-2-0-fixed:1.3
	scriptics-sc-2-0-b2:1.3
	scriptics-sc-2-0-b1:1.3
	core-8-3-0:1.3
	core-8-3-b2:1.3
	core-8-3-b1:1.3
	scriptics-sc-1-1:1.3
	scriptics-sc-1-1-b1:1.3
	core-8-2-3:1.3
	scriptics-sc-1-1-branch:1.3.0.10
	scriptics-sc-1-1-base:1.3
	scriptics-sc-1-0:1.3
	scriptics-sc-1-0-branch:1.3.0.8
	scriptics-sc-1-0-base:1.3
	core-8-2-2:1.3
	core-8-2-1:1.3
	scriptics-bc-1-0-b1:1.3
	core-8-2-1-branch:1.3.0.6
	scriptics-tclpro-1-3-0:1.3
	core-8-2-0:1.3
	core-8-2-b3-branch:1.3.0.4
	core-8-2-b3-base:1.3
	scriptics-tclpro-1-3-b4:1.3
	core-8-2-b2:1.3
	scriptics-tclpro-1-3-b3:1.3
	core-8-2-b1:1.3
	scriptics-tclpro-1-3-b2:1.3
	merge-to-mainline-5/21/99:1.3
	scriptics-tclpro-1-3-b2-branch:1.3.0.2
	core-8-1-1:1.3
	scriptics-tclpro-1-3-b1:1.3
	core-8-1-1-base:1.3
	core-8-1-0:1.3
	merge-to-mainline-4-29-99:1.3
	merge-to-mainline-4-23-99:1.3
	core-8-1-branch-old:1.1.0.4
	core-8-0-6-branch:1.2.0.6
	core-8-0-6-base:1.2
	core-8-0-5:1.2
	core-8-1-b3:1.1.4.2
	core-8-1-b2:1.1.4.2
	dev-8-1-stubs-branch:1.1.4.2.0.2
	dev-stubs-branch:1.2.0.4
	scriptics-tclpro-1-2:1.2
	scriptics-tclpro-1-2-b2:1.2
	core-8-1-merge-2/10/99:1.2
	core-8-0-5-branch:1.2.0.2
	core-8-0-5-base:1.2
	scriptics-tclpro-1-2-b1:1.2
	scriptics-tclpro-1-2-a1:1.2
	core-8-1-b1:1.1.4.2
	core-8-0-4:1.2
	core-8-1-a2:1.1.4.1
	core-8-0-2:1.1
	core-8-0-3:1.2;
locks; strict;
comment	@# @;


1.11
date	2009.07.26.19.50.50;	author dkf;	state Exp;
branches;
next	1.10;

1.10
date	2007.12.13.15.23.43;	author dgp;	state Exp;
branches;
next	1.9;

1.9
date	2007.10.29.16.04.12;	author dkf;	state Exp;
branches;
next	1.8;

1.8
date	2007.10.26.20.13.22;	author dgp;	state Exp;
branches;
next	1.7;

1.7
date	2007.10.24.14.32.56;	author dkf;	state Exp;
branches;
next	1.6;

1.6
date	2007.01.05.00.00.49;	author nijtmans;	state Exp;
branches
	1.6.2.1;
next	1.5;

1.5
date	2005.04.06.21.11.53;	author dkf;	state Exp;
branches;
next	1.4;

1.4
date	2002.08.05.04.30.38;	author dgp;	state Exp;
branches;
next	1.3;

1.3
date	99.04.16.01.51.08;	author stanton;	state Exp;
branches
	1.3.18.1;
next	1.2;

1.2
date	98.09.14.18.22.48;	author stanton;	state Exp;
branches;
next	1.1;

1.1
date	98.04.01.09.40.03;	author rjohnson;	state Exp;
branches
	1.1.4.1;
next	;

1.1.4.1
date	98.09.29.00.25.08;	author stanton;	state Exp;
branches;
next	1.1.4.2;

1.1.4.2
date	98.09.30.02.15.52;	author stanton;	state Exp;
branches;
next	;

1.3.18.1
date	2002.08.20.20.27.00;	author das;	state Exp;
branches;
next	;

1.6.2.1
date	2007.11.01.16.37.12;	author dgp;	state Exp;
branches;
next	;


desc
@@


1.11
log
@Slight clarification.
@
text
@'\"
'\" Copyright (c) 1990 The Regents of the University of California.
'\" Copyright (c) 1994-1998 Sun Microsystems, Inc.
'\"
'\" 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.10 2007/12/13 15:23:43 dgp Exp $
'\" 
.so man.macros
.TH Tk_GetAnchorFromObj 3 8.1 Tk "Tk Library Procedures"
.BS
.SH NAME
Tk_GetAnchorFromObj, Tk_GetAnchor, Tk_NameOfAnchor \- translate between strings and anchor positions
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
.sp
int
\fBTk_GetAnchorFromObj(\fIinterp, objPtr, anchorPtr\fB)\fR
.sp
int
\fBTk_GetAnchor(\fIinterp, string, anchorPtr\fB)\fR
.sp
const char *
\fBTk_NameOfAnchor(\fIanchor\fB)\fR
.SH ARGUMENTS
.AS "Tk_Anchor" *anchorPtr
.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:
.QW \fBn\fR  ,
.QW \fBne\fR ,
.QW \fBe\fR  ,
.QW \fBse\fR ,
.QW \fBs\fR  ,
.QW \fBsw\fR ,
.QW \fBw\fR  ,
.QW \fBnw\fR ,
or
.QW \fBcenter\fR ;
internal rep will be modified to cache corresponding Tk_Anchor. In the
case of
.QW \fBcenter\fR
on input, a non-empty abbreviation of it may also be used on input.
.AP "const char" *string in
Same as \fIobjPtr\fR except description of anchor point is passed as
a string.
.AP int *anchorPtr out
Pointer to location in which to store anchor position corresponding to
\fIobjPtr\fR or \fIstring\fR.
.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
(enumerated type \fBTk_Anchor\fR)
corresponding to \fIobjPtr\fR's value.  The result will be one of
\fBTK_ANCHOR_N\fR, \fBTK_ANCHOR_NE\fR, \fBTK_ANCHOR_E\fR, \fBTK_ANCHOR_SE\fR,
\fBTK_ANCHOR_S\fR, \fBTK_ANCHOR_SW\fR, \fBTK_ANCHOR_W\fR, \fBTK_ANCHOR_NW\fR,
or \fBTK_ANCHOR_CENTER\fR.
Anchor positions are typically used for indicating a point on an object
that will be used to position the object, e.g. \fBTK_ANCHOR_N\fR means
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 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 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.
.PP
\fBTk_GetAnchor\fR is identical to \fBTk_GetAnchorFromObj\fR except
that the description of the anchor is specified with a string instead
of an object.  This prevents \fBTk_GetAnchor\fR from caching the
return value, so \fBTk_GetAnchor\fR is less efficient than
\fBTk_GetAnchorFromObj\fR.
.PP
\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 is not a legal anchor value, then
.QW "unknown anchor position"
is returned.
.SH KEYWORDS
anchor position
@


1.10
log
@merge stable branch onto HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetAnchor.3,v 1.6.2.1 2007/11/01 16:37:12 dgp Exp $
d33 8
a40 8
.QW n  ,
.QW ne ,
.QW e  ,
.QW se ,
.QW s  ,
.QW sw ,
.QW w  ,
.QW nw ,
d42 5
a46 2
.QW center ;
internal rep will be modified to cache corresponding Tk_Anchor.
@


1.9
log
@Lots more GOOBE stuff. Now works with 'make html'!
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetAnchor.3,v 1.8 2007/10/26 20:13:22 dgp Exp $
@


1.8
log
@        * doc/*.1:              Revert doc changes that broke
        * doc/*.3:              `make html` so we can get the release
        * doc/*.n:              out the door.
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetAnchor.3,v 1.6 2007/01/05 00:00:49 nijtmans Exp $
d32 11
a42 2
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;
a52 1

d67 1
a67 1
If \fIstring\fR doesn't contain a valid anchor position
d70 1
a70 1
stored in \fIinterp\fR's result if \fIinterp\fR isn't NULL.
d84 3
a86 3
If \fIanchor\fR isn't a legal anchor value, then
``unknown anchor position'' is returned.

@


1.7
log
@Lots of improvements to look and feel of manual pages
@
text
@d77 1
a77 2
.QW "unknown anchor position"
is returned.
@


1.6
log
@various "const" additions, in line with TIP #27
fix bug #1627732
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetAnchor.3,v 1.5 2005/04/06 21:11:53 dkf Exp $
d77 2
a78 1
``unknown anchor position'' is returned.
@


1.6.2.1
log
@merge updates from HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetAnchor.3,v 1.6 2007/01/05 00:00:49 nijtmans Exp $
d32 2
a33 11
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 ;
d44 1
d59 1
a59 1
If \fIstring\fR does not contain a valid anchor position
d62 1
a62 1
stored in \fIinterp\fR's result if \fIinterp\fR is not NULL.
d76 3
a78 3
If \fIanchor\fR is not a legal anchor value, then
.QW "unknown anchor position"
is returned.
@


1.5
log
@Purge old and inaccurate .VS/.VE macros.
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetAnchor.3,v 1.4 2002/08/05 04:30:38 dgp Exp $
d25 1
a25 1
CONST char *
d35 1
a35 1
.AP "CONST char" *string in
@


1.4
log
@Applied companion patch for Tcl Patch 585105,
updating Tk to use Tcl 8.4's fully CONST-ified
interface, and fully CONSTifying Tk at the
same time.

This patch includes purging Tk of its last
direct access to interp->result.  [Bug 589853]

The substantial changes include copying
event sequence strings into Tcl_DStrings
in tkBind.c, and copying [text] indices into
Tcl_DStrings because parsing them involved
overwriting them.  If this causes performance
trouble, that can be resolved by further
converting them to Tcl_Obj's.

The #defines USE_NON_CONST and USE_COMPAT_CONST
have the same effect for Tk as they do for Tcl.
(They actually change tcl.h)
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetAnchor.3,v 1.3 1999/04/16 01:51:08 stanton Exp $
a18 1
.VS 8.1
a20 1
.VE
a30 1
.VS 8.1 br
a37 1
.VE
a46 1
.VS 8.1
a71 1
.VE
@


1.3
log
@* Merged 8.1 branch into the main trunk
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id$
d27 1
a27 1
char *
d38 1
a38 1
.AP char *string in
@


1.3.18.1
log
@merged with trunk at tag macosx-8-4-merge-2002-08-20-trunk
@
text
@d27 1
a27 1
CONST char *
d38 1
a38 1
.AP "CONST char" *string in
@


1.2
log
@Replaced SCCS strings, fixed binary files
@
text
@d3 1
a3 1
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
d11 1
a11 1
.TH Tk_GetAnchor 3 "" Tk "Tk Library Procedures"
d14 1
a14 1
Tk_GetAnchor, Tk_NameOfAnchor \- translate between strings and anchor positions
d19 5
d32 6
a37 1
Interpreter to use for error reporting.
d39 3
a41 2
String containing name of anchor point: one of ``n'', ``ne'', ``e'', ``se'',
``s'', ``sw'', ``w'', ``nw'', or ``center''.
d44 1
a44 1
\fIstring\fR.
d51 2
a52 1
\fBTk_GetAnchor\fR places in \fI*anchorPtr\fR an anchor position
d54 1
a54 1
corresponding to \fIstring\fR,  which will be one of
d59 1
a59 1
that will be used to position that object, e.g. \fBTK_ANCHOR_N\fR means
d65 13
a77 3
or an abbreviation of one of these names, then an error message is
stored in \fIinterp->result\fR, \fBTCL_ERROR\fR is returned, and
\fI*anchorPtr\fR is unmodified.
@


1.1
log
@Initial revision
@
text
@d8 1
a8 1
'\" SCCS: @@(#) GetAnchor.3 1.9 96/03/26 18:08:45
@


1.1.4.1
log
@initial tk8.1a2 version
@
text
@d3 1
a3 1
'\" Copyright (c) 1994-1998 Sun Microsystems, Inc.
d8 1
a8 1
'\" SCCS: @@(#) GetAnchor.3 1.11 98/01/28 13:00:43
d11 1
a11 1
.TH Tk_GetAnchorFromObj 3 8.1 Tk "Tk Library Procedures"
d14 1
a14 1
Tk_GetAnchorFromObj, Tk_GetAnchor, Tk_NameOfAnchor \- translate between strings and anchor positions
a18 5
.VS 8.1
int
\fBTk_GetAnchorFromObj(\fIinterp, objPtr, anchorPtr\fB)\fR
.VE
.sp
d27 1
a27 6
Interpreter to use for error reporting, or NULL.
.VS 8.1 br
.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;
internal rep will be modified to cache corresponding Tk_Anchor.
d29 2
a30 3
Same as \fIobjPtr\fR except description of anchor point is passed as
a string.
.VE
d33 1
a33 1
\fIobjPtr\fR or \fIstring\fR.
d40 1
a40 2
.VS 8.1
\fBTk_GetAnchorFromObj\fR places in \fI*anchorPtr\fR an anchor position
d42 1
a42 1
corresponding to \fIobjPtr\fR's value.  The result will be one of
d47 1
a47 1
that will be used to position the object, e.g. \fBTK_ANCHOR_N\fR means
d53 3
a55 13
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.
\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.
.PP
\fBTk_GetAnchor\fR is identical to \fBTk_GetAnchorFromObj\fR except
that the description of the anchor is specified with a string instead
of an object.  This prevents \fBTk_GetAnchor\fR from caching the
return value, so \fBTk_GetAnchor\fR is less efficient than
\fBTk_GetAnchorFromObj\fR.
.VE
@


1.1.4.2
log
@Merged 8.0.3 changes into 8.1
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: GetAnchor.3,v 1.2 1998/09/14 18:22:48 stanton Exp $
@


