Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | '\" |
2 | '\" Copyright (c) 1990-1994 The Regents of the University of California. | |
3 | '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. | |
4 | '\" | |
5 | '\" See the file "license.terms" for information on usage and redistribution | |
6 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. | |
7 | '\" | |
8 | '\" | |
9 | '\" RCS: @(#) $Id: labelframe.n,v 1.1 2001/09/26 21:36:19 pspjuth Exp $ | |
10 | '\" | |
11 | '\" The definitions below are for supplemental macros used in Tcl/Tk | |
12 | '\" manual entries. | |
13 | '\" | |
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) | |
20 | '\" | |
21 | '\" .AS ?type? ?name? | |
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. | |
25 | '\" | |
26 | '\" .BS | |
27 | '\" Start box enclosure. From here until next .BE, everything will be | |
28 | '\" enclosed in one large box. | |
29 | '\" | |
30 | '\" .BE | |
31 | '\" End of box enclosure. | |
32 | '\" | |
33 | '\" .CS | |
34 | '\" Begin code excerpt. | |
35 | '\" | |
36 | '\" .CE | |
37 | '\" End code excerpt. | |
38 | '\" | |
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. | |
45 | '\" | |
46 | '\" .VE | |
47 | '\" End of vertical sidebar. | |
48 | '\" | |
49 | '\" .DS | |
50 | '\" Begin an indented unfilled display. | |
51 | '\" | |
52 | '\" .DE | |
53 | '\" End of indented unfilled display. | |
54 | '\" | |
55 | '\" .SO | |
56 | '\" Start of list of standard options for a Tk widget. The | |
57 | '\" options follow on successive lines, in four columns separated | |
58 | '\" by tabs. | |
59 | '\" | |
60 | '\" .SE | |
61 | '\" End of list of standard options for a Tk widget. | |
62 | '\" | |
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. | |
68 | '\" | |
69 | '\" .UL arg1 arg2 | |
70 | '\" Print arg1 underlined, then print arg2 normally. | |
71 | '\" | |
72 | '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ | |
73 | '\" | |
74 | '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. | |
75 | .if t .wh -1.3i ^B | |
76 | .nr ^l \n(.l | |
77 | .ad b | |
78 | '\" # Start an argument description | |
79 | .de AP | |
80 | .ie !"\\$4"" .TP \\$4 | |
81 | .el \{\ | |
82 | . ie !"\\$2"" .TP \\n()Cu | |
83 | . el .TP 15 | |
84 | .\} | |
85 | .ta \\n()Au \\n()Bu | |
86 | .ie !"\\$3"" \{\ | |
87 | \&\\$1 \\fI\\$2\\fP (\\$3) | |
88 | .\".b | |
89 | .\} | |
90 | .el \{\ | |
91 | .br | |
92 | .ie !"\\$2"" \{\ | |
93 | \&\\$1 \\fI\\$2\\fP | |
94 | .\} | |
95 | .el \{\ | |
96 | \&\\fI\\$1\\fP | |
97 | .\} | |
98 | .\} | |
99 | .. | |
100 | '\" # define tabbing values for .AP | |
101 | .de AS | |
102 | .nr )A 10n | |
103 | .if !"\\$1"" .nr )A \\w'\\$1'u+3n | |
104 | .nr )B \\n()Au+15n | |
105 | .\" | |
106 | .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n | |
107 | .nr )C \\n()Bu+\\w'(in/out)'u+2n | |
108 | .. | |
109 | .AS Tcl_Interp Tcl_CreateInterp in/out | |
110 | '\" # BS - start boxed text | |
111 | '\" # ^y = starting y location | |
112 | '\" # ^b = 1 | |
113 | .de BS | |
114 | .br | |
115 | .mk ^y | |
116 | .nr ^b 1u | |
117 | .if n .nf | |
118 | .if n .ti 0 | |
119 | .if n \l'\\n(.lu\(ul' | |
120 | .if n .fi | |
121 | .. | |
122 | '\" # BE - end boxed text (draw box now) | |
123 | .de BE | |
124 | .nf | |
125 | .ti 0 | |
126 | .mk ^t | |
127 | .ie n \l'\\n(^lu\(ul' | |
128 | .el \{\ | |
129 | .\" Draw four-sided box normally, but don't draw top of | |
130 | .\" box if the box started on an earlier page. | |
131 | .ie !\\n(^b-1 \{\ | |
132 | \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' | |
133 | .\} | |
134 | .el \}\ | |
135 | \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' | |
136 | .\} | |
137 | .\} | |
138 | .fi | |
139 | .br | |
140 | .nr ^b 0 | |
141 | .. | |
142 | '\" # VS - start vertical sidebar | |
143 | '\" # ^Y = starting y location | |
144 | '\" # ^v = 1 (for troff; for nroff this doesn't matter) | |
145 | .de VS | |
146 | .if !"\\$2"" .br | |
147 | .mk ^Y | |
148 | .ie n 'mc \s12\(br\s0 | |
149 | .el .nr ^v 1u | |
150 | .. | |
151 | '\" # VE - end of vertical sidebar | |
152 | .de VE | |
153 | .ie n 'mc | |
154 | .el \{\ | |
155 | .ev 2 | |
156 | .nf | |
157 | .ti 0 | |
158 | .mk ^t | |
159 | \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' | |
160 | .sp -1 | |
161 | .fi | |
162 | .ev | |
163 | .\} | |
164 | .nr ^v 0 | |
165 | .. | |
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. | |
169 | .de ^B | |
170 | .ev 2 | |
171 | 'ti 0 | |
172 | 'nf | |
173 | .mk ^t | |
174 | .if \\n(^b \{\ | |
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 | |
179 | .\} | |
180 | .if \\n(^v \{\ | |
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 | |
183 | .\} | |
184 | .bp | |
185 | 'fi | |
186 | .ev | |
187 | .if \\n(^b \{\ | |
188 | .mk ^y | |
189 | .nr ^b 2 | |
190 | .\} | |
191 | .if \\n(^v \{\ | |
192 | .mk ^Y | |
193 | .\} | |
194 | .. | |
195 | '\" # DS - begin display | |
196 | .de DS | |
197 | .RS | |
198 | .nf | |
199 | .sp | |
200 | .. | |
201 | '\" # DE - end display | |
202 | .de DE | |
203 | .fi | |
204 | .RE | |
205 | .sp | |
206 | .. | |
207 | '\" # SO - start of list of standard options | |
208 | .de SO | |
209 | .SH "STANDARD OPTIONS" | |
210 | .LP | |
211 | .nf | |
212 | .ta 5.5c 11c | |
213 | .ft B | |
214 | .. | |
215 | '\" # SE - end of list of standard options | |
216 | .de SE | |
217 | .fi | |
218 | .ft R | |
219 | .LP | |
220 | See the \\fBoptions\\fR manual entry for details on the standard options. | |
221 | .. | |
222 | '\" # OP - start of full description for a single option | |
223 | .de OP | |
224 | .LP | |
225 | .nf | |
226 | .ta 4c | |
227 | Command-Line Name: \\fB\\$1\\fR | |
228 | Database Name: \\fB\\$2\\fR | |
229 | Database Class: \\fB\\$3\\fR | |
230 | .fi | |
231 | .IP | |
232 | .. | |
233 | '\" # CS - begin code excerpt | |
234 | .de CS | |
235 | .RS | |
236 | .nf | |
237 | .ta .25i .5i .75i 1i | |
238 | .. | |
239 | '\" # CE - end code excerpt | |
240 | .de CE | |
241 | .fi | |
242 | .RE | |
243 | .. | |
244 | .de UL | |
245 | \\$1\l'|0\(ul'\\$2 | |
246 | .. | |
247 | .TH labelframe n 8.4 Tk "Tk Built-In Commands" | |
248 | .BS | |
249 | '\" Note: do not modify the .SH NAME line immediately below! | |
250 | .SH NAME | |
251 | labelframe \- Create and manipulate labelframe widgets | |
252 | .SH SYNOPSIS | |
253 | \fBlabelframe\fR \fIpathName\fR ?\fIoptions\fR? | |
254 | .SO | |
255 | \-borderwidth \-highlightbackground \-pady | |
256 | \-cursor \-highlightcolor \-relief | |
257 | \-font \-highlightthickness \-takefocus | |
258 | \-foreground \-padx \-text | |
259 | .SE | |
260 | .SH "WIDGET-SPECIFIC OPTIONS" | |
261 | .OP \-background background Background | |
262 | This option is the same as the standard \fBbackground\fR option | |
263 | except that its value may also be specified as an empty string. | |
264 | In this case, the widget will display no background or border, and | |
265 | no colors will be consumed from its colormap for its background | |
266 | and border. | |
267 | .OP \-class class Class | |
268 | Specifies a class for the window. | |
269 | This class will be used when querying the option database for | |
270 | the window's other options, and it will also be used later for | |
271 | other purposes such as bindings. | |
272 | The \fBclass\fR option may not be changed with the \fBconfigure\fR | |
273 | widget command. | |
274 | .OP \-colormap colormap Colormap | |
275 | Specifies a colormap to use for the window. | |
276 | The value may be either \fBnew\fR, in which case a new colormap is | |
277 | created for the window and its children, or the name of another | |
278 | window (which must be on the same screen and have the same visual | |
279 | as \fIpathName\fR), in which case the new window will use the colormap | |
280 | from the specified window. | |
281 | If the \fBcolormap\fR option is not specified, the new window | |
282 | uses the same colormap as its parent. | |
283 | This option may not be changed with the \fBconfigure\fR | |
284 | widget command. | |
285 | .OP \-container container Container | |
286 | The value must be a boolean. If true, it means that this window will | |
287 | be used as a container in which some other application will be embedded | |
288 | (for example, a Tk toplevel can be embedded using the \fB\-use\fR option). | |
289 | The window will support the appropriate window manager protocols for | |
290 | things like geometry requests. The window should not have any | |
291 | children of its own in this application. | |
292 | This option may not be changed with the \fBconfigure\fR | |
293 | widget command. | |
294 | .OP \-height height Height | |
295 | Specifies the desired height for the window in any of the forms | |
296 | acceptable to \fBTk_GetPixels\fR. | |
297 | If this option is less than or equal to zero then the window will | |
298 | not request any size at all. | |
299 | .OP \-labelanchor labelAnchor LabelAnchor | |
300 | Specifies where to place the label. A label is only displayed if the | |
301 | \fB\-text\fR option is not the empty string. | |
302 | Valid values for this option are (listing them clockwise) | |
303 | \fBnw\fR, \fBn\fR, \fBne\fR, \fBen\fR, \fBe\fR, \fBes\fR, | |
304 | \fBse\fR, \fBs\fR,\fBsw\fR, \fBws\fR, \fBw\fR and \fBwn\fR. | |
305 | The default value is \fBnw\fR. | |
306 | .OP \-labelwidget labelWidget LabelWidget | |
307 | Specifies a widget to use as label. This overrides any \fB\-text\fR | |
308 | option. The widget must exist before being used as \fB\-labelwidget\fR | |
309 | and if it is not a descendant of this window, it will be raised | |
310 | above it in the stacking order. | |
311 | .OP \-visual visual Visual | |
312 | Specifies visual information for the new window in any of the | |
313 | forms accepted by \fBTk_GetVisual\fR. | |
314 | If this option is not specified, the new window will use the same | |
315 | visual as its parent. | |
316 | The \fBvisual\fR option may not be modified with the \fBconfigure\fR | |
317 | widget command. | |
318 | .OP \-width width Width | |
319 | Specifies the desired width for the window in any of the forms | |
320 | acceptable to \fBTk_GetPixels\fR. | |
321 | If this option is less than or equal to zero then the window will | |
322 | not request any size at all. | |
323 | .BE | |
324 | ||
325 | .SH DESCRIPTION | |
326 | .PP | |
327 | The \fBlabelframe\fR command creates a new window (given by the | |
328 | \fIpathName\fR argument) and makes it into a labelframe widget. | |
329 | Additional | |
330 | options, described above, may be specified on the command line | |
331 | or in the option database | |
332 | to configure aspects of the labelframe such as its background color | |
333 | and relief. The \fBlabelframe\fR command returns the | |
334 | path name of the new window. | |
335 | .PP | |
336 | A labelframe is a simple widget. Its primary purpose is to act as a | |
337 | spacer or container for complex window layouts. It has the features | |
338 | of a \fBframe\fR plus the ability to display a label. | |
339 | .SH "WIDGET COMMAND" | |
340 | .PP | |
341 | The \fBlabelframe\fR command creates a new Tcl command whose | |
342 | name is the same as the path name of the labelframe's window. This | |
343 | command may be used to invoke various | |
344 | operations on the widget. It has the following general form: | |
345 | .CS | |
346 | \fIpathName option \fR?\fIarg arg ...\fR? | |
347 | .CE | |
348 | \fIPathName\fR is the name of the command, which is the same as | |
349 | the labelframe widget's path name. \fIOption\fR and the \fIarg\fRs | |
350 | determine the exact behavior of the command. The following | |
351 | commands are possible for frame widgets: | |
352 | .TP | |
353 | \fIpathName \fBcget\fR \fIoption\fR | |
354 | Returns the current value of the configuration option given | |
355 | by \fIoption\fR. | |
356 | \fIOption\fR may have any of the values accepted by the \fBlabelframe\fR | |
357 | command. | |
358 | .TP | |
359 | \fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR? | |
360 | Query or modify the configuration options of the widget. | |
361 | If no \fIoption\fR is specified, returns a list describing all of | |
362 | the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for | |
363 | information on the format of this list). If \fIoption\fR is specified | |
364 | with no \fIvalue\fR, then the command returns a list describing the | |
365 | one named option (this list will be identical to the corresponding | |
366 | sublist of the value returned if no \fIoption\fR is specified). If | |
367 | one or more \fIoption\-value\fR pairs are specified, then the command | |
368 | modifies the given widget option(s) to have the given value(s); in | |
369 | this case the command returns an empty string. | |
370 | \fIOption\fR may have any of the values accepted by the \fBlabelframe\fR | |
371 | command. | |
372 | ||
373 | .SH BINDINGS | |
374 | .PP | |
375 | When a new labelframe is created, it has no default event bindings: | |
376 | labelframes are not intended to be interactive. | |
377 | ||
378 | .SH "SEE ALSO" | |
379 | frame(n), label(n) | |
380 | ||
381 | .SH KEYWORDS | |
382 | labelframe, widget |