2 '\" Copyright (c) 1990 The Regents of the University of California.
3 '\" Copyright (c) 1994-1998 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.4 2002/08/05 04:30:38 dgp Exp $
10 '\" The definitions below are for supplemental macros used in Tcl/Tk
13 '\" .AP type name in/out ?indent?
14 '\" Start paragraph describing an argument to a library procedure.
15 '\" type is type of argument (int, etc.), in/out is either "in", "out",
16 '\" or "in/out" to describe whether procedure reads or modifies arg,
17 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
18 '\" needed; use .AS below instead)
21 '\" Give maximum sizes of arguments for setting tab stops. Type and
22 '\" name are examples of largest possible arguments that will be passed
23 '\" to .AP later. If args are omitted, default tab stops are used.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed in one large box.
30 '\" End of box enclosure.
33 '\" Begin code excerpt.
38 '\" .VS ?version? ?br?
39 '\" Begin vertical sidebar, for use in marking newly-changed parts
40 '\" of man pages. The first argument is ignored and used for recording
41 '\" the version when the .VS was added, so that the sidebars can be
42 '\" found and removed when they reach a certain age. If another argument
43 '\" is present, then a line break is forced before starting the sidebar.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display.
52 '\" End of indented unfilled display.
55 '\" Start of list of standard options for a Tk widget. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
62 '\" .OP cmdName dbName dbClass
63 '\" Start of description of a specific option. cmdName gives the
64 '\" option's name as specified in the class command, dbName gives
65 '\" the option's name in the option database, and dbClass gives
66 '\" the option's class in the option database.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2"" .TP \\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\(ul'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box if the box started on an earlier page.
131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
165 '\" # Special macro to handle page bottom: finish off current
166 '\" # box/sidebar if in box/sidebar mode, then invoked standard
167 '\" # page bottom macro.
174 .\" Draw three-sided box if this is the box's first page,
175 .\" draw two sides but no top otherwise.
176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
180 .nr ^x \\n(^tu+1v-\\n(^Yu
181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH Tk_GetAnchorFromObj 3 8.1 Tk "Tk Library Procedures"
249 Tk_GetAnchorFromObj, Tk_GetAnchor, Tk_NameOfAnchor \- translate between strings and anchor positions
252 \fB#include <tk.h>\fR
256 \fBTk_GetAnchorFromObj(\fIinterp, objPtr, anchorPtr\fB)\fR
260 \fBTk_GetAnchor(\fIinterp, string, anchorPtr\fB)\fR
263 \fBTk_NameOfAnchor(\fIanchor\fB)\fR
265 .AS "Tk_Anchor" *anchorPtr
266 .AP Tcl_Interp *interp in
267 Interpreter to use for error reporting, or NULL.
269 .AP Tcl_Obj *objPtr in/out
270 String value contains name of anchor point: \fBn\fR, \fBne\fR,
271 \fBe\fR, \fBse\fR, \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR;
272 internal rep will be modified to cache corresponding Tk_Anchor.
273 .AP "CONST char" *string in
274 Same as \fIobjPtr\fR except description of anchor point is passed as
277 .AP int *anchorPtr out
278 Pointer to location in which to store anchor position corresponding to
279 \fIobjPtr\fR or \fIstring\fR.
280 .AP Tk_Anchor anchor in
281 Anchor position, e.g. \fBTCL_ANCHOR_CENTER\fR.
287 \fBTk_GetAnchorFromObj\fR places in \fI*anchorPtr\fR an anchor position
288 (enumerated type \fBTk_Anchor\fR)
289 corresponding to \fIobjPtr\fR's value. The result will be one of
290 \fBTK_ANCHOR_N\fR, \fBTK_ANCHOR_NE\fR, \fBTK_ANCHOR_E\fR, \fBTK_ANCHOR_SE\fR,
291 \fBTK_ANCHOR_S\fR, \fBTK_ANCHOR_SW\fR, \fBTK_ANCHOR_W\fR, \fBTK_ANCHOR_NW\fR,
292 or \fBTK_ANCHOR_CENTER\fR.
293 Anchor positions are typically used for indicating a point on an object
294 that will be used to position the object, e.g. \fBTK_ANCHOR_N\fR means
295 position the top center point of the object at a particular place.
297 Under normal circumstances the return value is \fBTCL_OK\fR and
298 \fIinterp\fR is unused.
299 If \fIstring\fR doesn't contain a valid anchor position
300 or an abbreviation of one of these names, \fBTCL_ERROR\fR is returned,
301 \fI*anchorPtr\fR is unmodified, and an error message is
302 stored in \fIinterp\fR's result if \fIinterp\fR isn't NULL.
303 \fBTk_GetAnchorFromObj\fR caches information about the return
304 value in \fIobjPtr\fR, which speeds up future calls to
305 \fBTk_GetAnchorFromObj\fR with the same \fIobjPtr\fR.
307 \fBTk_GetAnchor\fR is identical to \fBTk_GetAnchorFromObj\fR except
308 that the description of the anchor is specified with a string instead
309 of an object. This prevents \fBTk_GetAnchor\fR from caching the
310 return value, so \fBTk_GetAnchor\fR is less efficient than
311 \fBTk_GetAnchorFromObj\fR.
314 \fBTk_NameOfAnchor\fR is the logical inverse of \fBTk_GetAnchor\fR.
315 Given an anchor position such as \fBTK_ANCHOR_N\fR it returns a
316 statically-allocated string corresponding to \fIanchor\fR.
317 If \fIanchor\fR isn't a legal anchor value, then
318 ``unknown anchor position'' is returned.