1 |
578 |
markom |
'\"
|
2 |
|
|
'\" Copyright (c) 1997 DSC Technologies Corporation
|
3 |
|
|
'\"
|
4 |
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
5 |
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
6 |
|
|
'\"
|
7 |
|
|
'\" @(#) labeledframe.n 1.21 97/1/30 16:04:44
|
8 |
|
|
'/"
|
9 |
|
|
.so man.macros
|
10 |
|
|
.HS labeledframe iwid
|
11 |
|
|
.BS
|
12 |
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
13 |
|
|
.SH NAME
|
14 |
|
|
labeledframe \- Create and manipulate a labeled frame widget
|
15 |
|
|
.SH SYNOPSIS
|
16 |
|
|
\fBlabeledframe\fI \fIpathName \fR?\fIoptions\fR?
|
17 |
|
|
.SH "INHERITANCE"
|
18 |
|
|
itk::Archetype <- labeledframe
|
19 |
|
|
.SH "STANDARD OPTIONS"
|
20 |
|
|
.LP
|
21 |
|
|
.nf
|
22 |
|
|
.ta 4c 8c 12c
|
23 |
|
|
\fBbackground\fR \fBborderwidth\fR \fBcursor\fR
|
24 |
|
|
\fBforeground\fR \fBrelief\fR
|
25 |
|
|
.fi
|
26 |
|
|
.LP
|
27 |
|
|
See the "options" manual entry for details on the standard options.
|
28 |
|
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
29 |
|
|
.LP
|
30 |
|
|
.nf
|
31 |
|
|
Name: \fBiPadX\fR
|
32 |
|
|
Class: \fBIPad\fR
|
33 |
|
|
Command-Line Switch: \fB-ipadx\fR
|
34 |
|
|
.fi
|
35 |
|
|
.IP
|
36 |
|
|
Specifies horizontal padding space between the border and the childsite.
|
37 |
|
|
The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
|
38 |
|
|
The default is 0.
|
39 |
|
|
.LP
|
40 |
|
|
.nf
|
41 |
|
|
Name: \fBiPadY\fR
|
42 |
|
|
Class: \fBIPad\fR
|
43 |
|
|
Command-Line Switch: \fB-ipady\fR
|
44 |
|
|
.fi
|
45 |
|
|
.IP
|
46 |
|
|
Specifies vertical padding space between the border and the childsite.
|
47 |
|
|
The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
|
48 |
|
|
The default is 0.
|
49 |
|
|
.LP
|
50 |
|
|
.nf
|
51 |
|
|
Name: \fBlabelBitmap\fR
|
52 |
|
|
Class: \fBBitmap\fR
|
53 |
|
|
Command-Line Switch: \fB-labelbitmap\fR
|
54 |
|
|
.fi
|
55 |
|
|
.IP
|
56 |
|
|
Specifies a bitmap to display in the label, in any of the forms
|
57 |
|
|
acceptable to \fBTk_GetBitmap\fR. This option overrides the \fIlabeltext\fR
|
58 |
|
|
option.
|
59 |
|
|
.LP
|
60 |
|
|
.nf
|
61 |
|
|
Name: \fBlabelImage\fR
|
62 |
|
|
Class: \fBImage\fR
|
63 |
|
|
Command-Line Switch: \fB-labelimage\fR
|
64 |
|
|
.fi
|
65 |
|
|
.IP
|
66 |
|
|
Specifies a image to be used as the label. The image may be any of the
|
67 |
|
|
values created by the \fBimage create\fR command. This option overrides
|
68 |
|
|
both the \fIlabelbitmap\fR and \fIlabeletext\fR options.
|
69 |
|
|
.LP
|
70 |
|
|
.nf
|
71 |
|
|
Name: \fBlabelMargin\fR
|
72 |
|
|
Class: \fBMargin\fR
|
73 |
|
|
Command-Line Switch: \fB-labelmargin\fR
|
74 |
|
|
.fi
|
75 |
|
|
.IP
|
76 |
|
|
Specifies the distance between the inner ede of the hull frames relief,
|
77 |
|
|
and the label in any of the forms acceptable to \fBTk_GetPixels\fR.
|
78 |
|
|
The default is 10 pixels.
|
79 |
|
|
.LP
|
80 |
|
|
.nf
|
81 |
|
|
Name: \fBlabelText\fR
|
82 |
|
|
Class: \fBText\fR
|
83 |
|
|
Command-Line Switch: \fB-labeltext\fR
|
84 |
|
|
.fi
|
85 |
|
|
.IP
|
86 |
|
|
Specifies the text of the label around the childsite.
|
87 |
|
|
.LP
|
88 |
|
|
.nf
|
89 |
|
|
Name: \fBlabelVariable\fR
|
90 |
|
|
Class: \fBVariable\fR
|
91 |
|
|
Command-Line Switch: \fB-labelvariable\fR
|
92 |
|
|
.fi
|
93 |
|
|
.IP
|
94 |
|
|
Specifies the text variable of the label around the childsite.
|
95 |
|
|
.LP
|
96 |
|
|
.nf
|
97 |
|
|
Name: \fBlabelFont\fR
|
98 |
|
|
Class: \fBFont\fR
|
99 |
|
|
Command-Line Switch: \fB-labelfont\fR
|
100 |
|
|
.fi
|
101 |
|
|
.IP
|
102 |
|
|
Specifies the font of the label around the childsite.
|
103 |
|
|
.LP
|
104 |
|
|
.nf
|
105 |
|
|
Name: \fBlabelPos\fR
|
106 |
|
|
Class: \fBPosition\fR
|
107 |
|
|
Command-Line Switch: \fB-labelpos\fR
|
108 |
|
|
.fi
|
109 |
|
|
.IP
|
110 |
|
|
Specifies the position of the label within the grooved relief of the hull widget.
|
111 |
|
|
\fB ne, n, nw, se, s, sw, en, e, es, wn, w, ws\fR Default is \fBn\fR.
|
112 |
|
|
.LP
|
113 |
|
|
.BE
|
114 |
|
|
|
115 |
|
|
.SH DESCRIPTION
|
116 |
|
|
.PP
|
117 |
|
|
The \fBlabeledframe\fR command creates a hull frame with a
|
118 |
|
|
grooved relief, a label positioned within the grooved relief of
|
119 |
|
|
the hull frame, and a frame childsite. The frame childsite can filled with any
|
120 |
|
|
widget via a derived class or though the use of the childsite method.
|
121 |
|
|
This class was designed to be a general purpose base class for supporting the
|
122 |
|
|
combination of labeled frame and a childsite. The options include the
|
123 |
|
|
ability to position the label at configurable locations within the
|
124 |
|
|
grooved relief of the hull frame, and control the display of the label.
|
125 |
|
|
.SH "METHODS"
|
126 |
|
|
.PP
|
127 |
|
|
The \fBlabeledframe\fR command creates a new Tcl command whose
|
128 |
|
|
name is \fIpathName\fR. This
|
129 |
|
|
command may be used to invoke various
|
130 |
|
|
operations on the widget. It has the following general form:
|
131 |
|
|
.DS C
|
132 |
|
|
\fIpathName option \fR?\fIarg arg ...\fR?
|
133 |
|
|
.DE
|
134 |
|
|
\fIOption\fR and the \fIarg\fRs
|
135 |
|
|
determine the exact behavior of the command. The following
|
136 |
|
|
commands are possible for labeledframe widgets:
|
137 |
|
|
.SH "WIDGET-SPECIFIC METHODS"
|
138 |
|
|
.TP
|
139 |
|
|
\fIpathName \fBchildsite\fR
|
140 |
|
|
Return the path name of the child site.
|
141 |
|
|
.TP
|
142 |
|
|
\fIpathName \fBcget\fR \fIoption\fR
|
143 |
|
|
Returns the current value of the configuration option given
|
144 |
|
|
by \fIoption\fR.
|
145 |
|
|
\fIOption\fR may have any of the values accepted by the \fBlabeledframe\fR
|
146 |
|
|
command.
|
147 |
|
|
.TP
|
148 |
|
|
\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
149 |
|
|
Query or modify the configuration options of the widget.
|
150 |
|
|
If no \fIoption\fR is specified, returns a list describing all of
|
151 |
|
|
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
152 |
|
|
information on the format of this list). If \fIoption\fR is specified
|
153 |
|
|
with no \fIvalue\fR, then the command returns a list describing the
|
154 |
|
|
one named option (this list will be identical to the corresponding
|
155 |
|
|
sublist of the value returned if no \fIoption\fR is specified). If
|
156 |
|
|
one or more \fIoption\-value\fR pairs are specified, then the command
|
157 |
|
|
modifies the given widget option(s) to have the given value(s); in
|
158 |
|
|
this case the command returns an empty string.
|
159 |
|
|
\fIOption\fR may have any of the values accepted by the \fBlabeledframe\fR
|
160 |
|
|
command.
|
161 |
|
|
|
162 |
|
|
.SH "COMPONENTS"
|
163 |
|
|
.LP
|
164 |
|
|
.nf
|
165 |
|
|
Name: \fBlabel\fR
|
166 |
|
|
Class: \fBlabel\fR
|
167 |
|
|
.fi
|
168 |
|
|
.IP
|
169 |
|
|
The label component provides the label for the labeled widget. See the
|
170 |
|
|
"label" widget manual entry for details on the label component item.
|
171 |
|
|
.fi
|
172 |
|
|
.LP
|
173 |
|
|
|
174 |
|
|
.SH EXAMPLE
|
175 |
|
|
.IP
|
176 |
|
|
The labeledframe was primarily meant to be a base class. The
|
177 |
|
|
Radiobox is a good example of a derived classe of the labeledframe class.
|
178 |
|
|
In order to provide equal support for composite classes, the 'childsite' methods
|
179 |
|
|
also exists. The following is an example of 'childsite' method usage.
|
180 |
|
|
.LP
|
181 |
|
|
.DS
|
182 |
|
|
labeledframe .lw -labeltext "Entry Frame" -labelpos n
|
183 |
|
|
pack .lw -fill both -expand yes -padx 10 -pady 10
|
184 |
|
|
set cs [.lw childsite]
|
185 |
|
|
|
186 |
|
|
pack [Entryfield $cs.entry1 -labeltext "Name:"] -side top -fill x
|
187 |
|
|
pack [Spinint $cs.entry2 -labeltext "Number:"] -side top -fill x
|
188 |
|
|
pack [Pushbutton $cs.entry3 -text "Details:"] -side top -fill x
|
189 |
|
|
|
190 |
|
|
.DE
|
191 |
|
|
.SH AUTHOR
|
192 |
|
|
John A. Tucker
|
193 |
|
|
.SH KEYWORDS
|
194 |
|
|
labeledframe, widget
|