Tk_GetAnchor (3)
translate between strings and anchor positions
SYNOPSIS
#include <tk.h>
int
Tk_GetAnchor(interp, string, anchorPtr)
char *
Tk_NameOfAnchor(anchor)
ARGUMENTS
"Tk_Anchor" *anchorPtr
Tcl_Interp *interp in
Interpreter to use for error reporting.
char *string in
String containing name of anchor point: one of ``n'', ``ne'', ``e'', ``se'',
``s'', ``sw'', ``w'', ``nw'', or ``center''.
int *anchorPtr out
Pointer to location in which to store anchor position corresponding to
string.
Tk_Anchor anchor in
Anchor position, e.g. TCL_ANCHOR_CENTER.
DESCRIPTION
Tk_GetAnchor places in *anchorPtr an anchor position
(enumerated type Tk_Anchor)
corresponding to string, which will be one of
TK_ANCHOR_N, TK_ANCHOR_NE, TK_ANCHOR_E, TK_ANCHOR_SE,
TK_ANCHOR_S, TK_ANCHOR_SW, TK_ANCHOR_W, TK_ANCHOR_NW,
or TK_ANCHOR_CENTER.
Anchor positions are typically used for indicating a point on an object
that will be used to position that object, e.g. TK_ANCHOR_N means
position the top center point of the object at a particular place.
Under normal circumstances the return value is TCL_OK and
interp is unused.
If string doesn't contain a valid anchor position
or an abbreviation of one of these names, then an error message is
stored in interp->result, TCL_ERROR is returned, and
*anchorPtr is unmodified.
Tk_NameOfAnchor is the logical inverse of Tk_GetAnchor.
Given an anchor position such as TK_ANCHOR_N it returns a
statically-allocated string corresponding to anchor.
If anchor isn't a legal anchor value, then
``unknown anchor position'' is returned.
KEYWORDS
anchor position
'\"
'\" Copyright (c) 1990 The Regents of the University of California.
'\" Copyright (c) 1994-1996 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: GetBitmap.3,v 1.2 1998/09/14 18:22:48 stanton Exp $
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.2 1998/09/14 18:39:54 stanton Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|