2 '\" Copyright (c) 1990-1994 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: GetJustify.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_GetJustifyFromObj 3 8.1 Tk "Tk Library Procedures"
249 Tk_GetJustifyFromObj, Tk_GetJustify, Tk_NameOfJustify \- translate between strings and justification styles
252 \fB#include <tk.h>\fR
256 \fBTk_GetJustifyFromObj(\fIinterp, objPtr, justifyPtr\fB)\fR
259 \fBTk_GetJustify(\fIinterp, string, justifyPtr\fB)\fR
262 \fBTk_NameOfJustify(\fIjustify\fB)\fR
264 .AS "Tk_Justify" *justifyPtr
265 .AP Tcl_Interp *interp in
266 Interpreter to use for error reporting, or NULL.
268 .AP Tcl_Obj *objPtr in/out
269 String value contains name of justification style (\fBleft\fR, \fBright\fR, or
271 internal rep will be modified to cache corresponding justify value.
272 .AP "CONST char" *string in
273 Same as \fIobjPtr\fR except description of justification style is passed as
276 .AP int *justifyPtr out
277 Pointer to location in which to store justify value corresponding to
278 \fIobjPtr\fR or \fIstring\fR.
279 .AP Tk_Justify justify in
280 Justification style (one of the values listed below).
286 \fBTk_GetJustifyFromObj\fR places in \fI*justifyPtr\fR the justify value
287 corresponding to \fIobjPtr\fR's value.
289 This value will be one of the following:
291 \fBTK_JUSTIFY_LEFT\fR
292 Means that the text on each line should start at the left edge of
293 the line; as a result, the right edges of lines may be ragged.
295 \fBTK_JUSTIFY_RIGHT\fR
296 Means that the text on each line should end at the right edge of
297 the line; as a result, the left edges of lines may be ragged.
299 \fBTK_JUSTIFY_CENTER\fR
300 Means that the text on each line should be centered; as a result,
301 both the left and right edges of lines may be ragged.
304 Under normal circumstances the return value is \fBTCL_OK\fR and
305 \fIinterp\fR is unused.
306 If \fIobjPtr\fR doesn't contain a valid justification style
307 or an abbreviation of one of these names, \fBTCL_ERROR\fR is returned,
308 \fI*justifyPtr\fR is unmodified, and an error message is
309 stored in \fIinterp\fR's result if \fIinterp\fR isn't NULL.
310 \fBTk_GetJustifyFromObj\fR caches information about the return
311 value in \fIobjPtr\fR, which speeds up future calls to
312 \fBTk_GetJustifyFromObj\fR with the same \fIobjPtr\fR.
314 \fBTk_GetJustify\fR is identical to \fBTk_GetJustifyFromObj\fR except
315 that the description of the justification is specified with a string instead
316 of an object. This prevents \fBTk_GetJustify\fR from caching the
317 return value, so \fBTk_GetJustify\fR is less efficient than
318 \fBTk_GetJustifyFromObj\fR.
321 \fBTk_NameOfJustify\fR is the logical inverse of \fBTk_GetJustify\fR.
322 Given a justify value it returns a statically-allocated string
323 corresponding to \fIjustify\fR.
324 If \fIjustify\fR isn't a legal justify value, then
325 ``unknown justification style'' is returned.
328 center, fill, justification, string