3 '\" Copyright (c) 1990-1994 The Regents of the University of California.
4 '\" Copyright (c
) 1994-1996 Sun Microsystems
, Inc
.
6 '\" See the file
"license.terms" for information on usage
and redistribution
7 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
9 '\" RCS: @(#) $Id: template.n,v 1.1 2003/04/22 11:10:05 root Exp $
11 '\" The definitions below are for supplemental macros used in Tcl/Tk
14 '\" .AP
type name
in/out ?indent?
15 '\" Start paragraph describing an argument to a library procedure.
16 '\" type is
type of
argument (int, etc
.), in/out is either
"in", "out",
17 '\" or "in/out" to describe whether procedure reads or modifies arg,
18 '\" and indent is equivalent to second arg of
.IP (shouldn
't ever be
19 '\" needed
; use
.AS below instead
)
22 '\" Give maximum sizes of arguments for setting tab stops. Type and
23 '\" name are examples of largest possible arguments that will be passed
24 '\" to .AP later. If args are omitted, default tab stops are used.
27 '\" Start box enclosure
. From here until next
.BE
, everything will be
28 '\" enclosed in one large box.
31 '\" End of box enclosure
.
34 '\" Begin code excerpt.
39 '\" .VS ?version? ?br?
40 '\" Begin vertical sidebar, for use in marking newly-changed parts
41 '\" of man pages
. The first argument is ignored
and used
for recording
42 '\" the version when the .VS was added, so that the sidebars can be
43 '\" found
and removed
when they reach a certain age
. If another argument
44 '\" is present, then a line break is forced before starting the sidebar.
47 '\" End of vertical sidebar
.
50 '\" Begin an indented unfilled display.
53 '\" End of indented unfilled display
.
56 '\" Start of list of standard options for a Tk widget. The
57 '\" options follow on successive lines
, in four columns separated
61 '\" End of
list of standard options
for a Tk widget
.
63 '\" .OP cmdName dbName dbClass
64 '\" Start of description of a specific option. cmdName gives the
65 '\" option
's name as specified in the class command, dbName gives
66 '\" the option
's name in the option database, and dbClass gives
67 '\" the option
's class in the option database.
70 '\" Print arg1 underlined
, then print arg2 normally
.
72 '\" RCS
: @
(#) $Id: template.n,v 1.1 2003/04/22 11:10:05 root Exp $
74 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
78 '\" # Start an argument description
82 . ie !"\\$2"" .TP \\n()Cu
87 \&\\$1 \\fI\\$2\\fP (\\$3)
100 '\" # define tabbing values for .AP
103 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
106 .if !"\\$2
"" .nr
)B
\\w
'\\$2'u
+\\n()Au
+3n
107 .nr
)C
\\n()Bu
+\\w
'(in/out)'u
+2n
109 .AS Tcl_Interp Tcl_CreateInterp
in/out
110 '\" # BS - start boxed text
111 '\" # ^y = starting y location
119 .if n \l'\\n(.lu\
(ul
'
122 '\" # BE - end boxed text (draw box now)
127 .ie n \l
'\\n(^lu\(ul'
129 .\" Draw four
-sided box normally
, but don
't draw top of
130 .\" box if the box started on an earlier page.
132 \h'-1.5n
'\L'|\\n(^yu
-1v
'\l'\\n(^lu
+3n\
(ul
'\L'\\n(^tu
+1v
-\\n(^yu
'\l'|0u-1.5n\
(ul
'
135 \h'-1.5n
'\L'|\\n(^yu
-1v
'\h'\\n(^lu
+3n
'\L'\\n(^tu
+1v
-\\n(^yu
'\l'|0u-1.5n\
(ul
'
142 '\" # VS - start vertical sidebar
143 '\" # ^Y = starting y location
144 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
148 .ie n 'mc \s12\(br\s0
151 '\" # VE - end of vertical sidebar
159 \h
'|\\n(^lu+3n'\L
'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h
'-|\\n(^lu+3n'
166 '\" # Special macro to handle page bottom: finish off current
167 '\" # box/sidebar if in box/sidebar mode, then invoked standard
168 '\" # page bottom macro.
175 .\" Draw three-sided box if this is the box's first page
,
176 .\" draw two sides but no top otherwise
.
177 .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
178 .el \h
'-1.5n'\L
'|\\n(^yu-1v'\h
'\\n(^lu+3n'\L
'\\n(^tu+1v-\\n(^yu'\h
'|0u'\c
181 .nr ^x
\\n(^tu
+1v
-\\n(^Yu
182 \kx\h
'-\\nxu'\h
'|\\n(^lu+3n'\ky\L
'-\\n(^xu'\v'\\n(^xu'\h
'|0u'\c
195 '\" # DS - begin display
201 '\" # DE - end display
207 '\" # SO - start of list of standard options
215 '\" # SE - end of list of standard options
220 See the \\fBoptions\\fR manual entry for details on the standard options.
222 '\" # OP - start of full description for a single option
227 Command
-Line Name
: \\fB
\\$1
\\fR
228 Database Name
: \\fB
\\$2
\\fR
229 Database Class
: \\fB
\\$3
\\fR
233 '\" # CS - begin code excerpt
239 '\" # CE - end code excerpt
246 .ta
0m 2m 4m 6m 8m 10m 12m 14m 16m 18m 20m 22m 24m 26m 28m 30m 32m 34m 36m 38m
247 '\".ta 0m 4m 8m 12m 16m 20m 24m 28m 32m 36m 40m 44m 48m 52m 56m 60m 64m 68m 72m
248 '\".ta
.0i
.25i
.5i
.75i
1i
1.25i
1.5i
1.75i
2i
2.25i
2.5i
2.75i
3i
256 .TH %NAME
% n
0.9 TLC
"TLC Widgets"
258 '\" Note: do not modify the .SH NAME line immediately below!
260 %NAME% \- %SHORTDESC%
262 \fB%NAME%\fR \fIpathName \fR?\fIoptions\fR?
273 The \fB%NAME%\fR command creates a new window (given by the
274 \fIpathName\fR argument) and makes it into a %NAME% widget.
276 options, described above, may be specified on the command line
277 or in the option database
278 to configure aspects of the %NAME% such as its colors, font,
279 text, and initial relief. The \fB%NAME%\fR command returns its
280 \fIpathName\fR argument. At the time this command is invoked,
281 there must not exist a window named \fIpathName\fR, but
282 \fIpathName\fR's parent must exist
.
287 The
\fB%NAME
%\fR command creates a
new Tcl command whose
288 name is
\fIpathName
\fR
. This
289 command may be used to invoke various
290 operations on the widget
. It has the following general form
:
292 \fIpathName option
\fR?
\fIarg arg
...\fR?
294 \fIOption
\fR
and the
\fIarg
\fRs
295 determine the exact behavior of the command
. The following
296 commands are possible
for %NAME
% widgets
:
299 \fIpathName
\fBcget
\fR
\fIoption
\fR
300 Returns the current value of the configuration option given
302 \fIOption
\fR may have any of the values accepted by the
\fB%NAME
%\fR
305 \fIpathName
\fBconfigure
\fR ?
\fIoption
\fR? ?
\fIvalue option value
...\fR?
306 Query or modify the configuration options of the widget
.
307 If no
\fIoption
\fR is specified
, returns a
list describing all of
308 the available options
for \fIpathName
\fR
(see
\fBTk_ConfigureInfo
\fR
for
309 information on the format of
this list). If
\fIoption
\fR is specified
310 with no
\fIvalue
\fR
, then the command returns a
list describing the
311 one named
option (this list will be identical to the corresponding
312 sublist of the value returned
if no
\fIoption
\fR is specified
). If
313 one or more
\fIoption\
-value
\fR pairs are specified
, then the command
314 modifies the given widget
option(s
) to have the given
value(s
); in
315 this case the command returns an empty
string.
316 \fIOption
\fR may have any of the values accepted by the
\fB%NAME
%\fR