1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>
<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>
labeledframe - Create and manipulate a labeled frame widget
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>labeledframe</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Archetype <- labeledframe
<P>
<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>background</B> <DD> <B>borderwidth</B> <B>cursor</B>
</DD>
</DL>
<DL>
<DT><B>foreground</B> <DD> <B>relief</B>
<P>
</DD>
</DL>
See the "options" manual entry for details on the standard
options.
<P>
<H2><A NAME="sect5" HREF="#toc5"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
<DL>
<DT>Name: <DD> <B>iPadX</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>IPad</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-ipadx</B>
<P>
</DD>
</DL>
Specifies horizontal padding space between the border
and the childsite. The value may have any of the forms
acceptable to <B>Tk_GetPixels</B>. The default is 0.
<P>
<DL>
<DT>Name: <DD> <B>iPadY</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>IPad</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-ipady</B>
<P>
</DD>
</DL>
Specifies vertical padding space between the border and
the childsite. The value may have any of the forms
acceptable to <B>Tk_GetPixels</B>. The default is 0.
<P>
<DL>
<DT>Name: <DD> <B>labelBitmap</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Bitmap</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-labelbitmap</B>
<P>
</DD>
</DL>
Specifies a bitmap to display in the label, in any of
the forms acceptable to <B>Tk_GetBitmap</B>. This option
overrides the <I>labeltext</I> option.
<P>
<DL>
<DT>Name: <DD> <B>labelImage</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Image</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-labelimage</B>
<P>
</DD>
</DL>
Specifies a image to be used as the label. The image
may be any of the values created by the <B>image</B> <B>create</B>
command. This option overrides both the <I>labelbitmap</I>
and <I>labeletext</I> options.
<P>
<DL>
<DT>Name: <DD> <B>labelMargin</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Margin</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-labelmargin</B>
<P>
</DD>
</DL>
Specifies the distance between the inner ede of the
hull frames relief, and the label in any of the forms
acceptable to <B>Tk_GetPixels</B>. The default is 10 pixels.
<P>
<DL>
<DT>Name: <DD> <B>labelText</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Text</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-labeltext</B>
<P>
</DD>
</DL>
Specifies the text of the label around the childsite.
<P>
<DL>
<DT>Name: <DD> <B>labelVariable</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Variable</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-labelvariable</B>
<P>
</DD>
</DL>
Specifies the text variable of the label around the
childsite.
<P>
<DL>
<DT>Name: <DD> <B>labelFont</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Font</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-labelfont</B>
<P>
</DD>
</DL>
Specifies the font of the label around the childsite.
<P>
<DL>
<DT>Name: <DD> <B>labelPos</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Position</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-labelpos</B>
<P>
</DD>
</DL>
Specifies the position of the label within the grooved
relief of the hull widget.<BR>
<B>ne,</B> <B>n,</B> <B>nw,</B> <B>se,</B> <B>s,</B> <B>sw,</B> <B>en,</B> <B>e,</B> <B>es,</B> <B>wn,</B> <B>w,</B> <B>ws</B> Default is
<B>n</B>.
<P>
_________________________________________________________________
<P>
<H2><A NAME="sect6" HREF="#toc6"><B>DESCRIPTION</B></A></H2>
The <B>labeledframe</B> command creates a hull frame with a grooved
relief, a label positioned within the grooved relief of the
hull frame, and a frame childsite. The frame childsite can
filled with any widget via a derived class or though the use
of the childsite method. This class was designed to be a
general purpose base class for supporting the combination of
labeled frame and a childsite. The options include the
ability to position the label at configurable locations
within the grooved relief of the hull frame, and control the
display of the label.
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>METHODS</B></A></H2>
The <B>labeledframe</B> command creates a new Tcl command whose
name is <I>pathName</I>. This command may be used to invoke various
operations on the widget. It has the following general
form:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
The following commands are possible for labeledframe
widgets:
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>
<I>pathName</I> <B>childsite</B><BR>
Return the path name of the child site.
<P>
<I>pathName</I> <B>cget</B> <I>option</I><BR>
Returns the current value of the configuration option
given by <I>option</I>. <I>Option</I> may have any of the values
accepted by the <B>labeledframe</B> command.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
Query or modify the configuration options of the
widget. If no <I>option</I> is specified, returns a list
describing all of the available options for <I>pathName</I>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, then
the command returns a list describing the one named
option (this list will be identical to the corresponding
sublist of the value returned if no <I>option</I> is
specified). If one or more <I>option</I> - <I>value</I> pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. <I>Option</I> may have any
of the values accepted by the <B>labeledframe</B> command.
<P>
<H2><A NAME="sect9" HREF="#toc9"><B>COMPONENTS</B></A></H2>
<DL>
<DT>Name: <DD> <B>label</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>label</B>
<P>
</DD>
</DL>
The label component provides the label for the labeled
widget. See the "label" widget manual entry for
details on the label component item.
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>EXAMPLE</B></A></H2>
The labeledframe was primarily meant to be a base
class. The Radiobox is a good example of a derived
classe of the labeledframe class. In order to provide
equal support for composite classes, the `childsite'
methods also exists. The following is an example of
`childsite' method usage.
<P>
labeledframe .lw -labeltext "Entry Frame" -labelpos n
pack .lw -fill both -expand yes -padx 10 -pady 10
set cs [.lw childsite]
<P>
pack [Entryfield $cs.entry1 -labeltext "Name:"] -side top -fill x
pack [Spinint $cs.entry2 -labeltext "Number:"] -side top -fill x
pack [Pushbutton $cs.entry3 -text "Details:"] -side top -fill x
<P>
<H2><A NAME="sect11" HREF="#toc11"><B>AUTHOR</B></A></H2>
John A. Tucker
<P>
<H2><A NAME="sect12" HREF="#toc12"><B>KEYWORDS</B></A></H2>
labeledframe, widget
<P>
<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">DESCRIPTION</A></LI>
<LI><A NAME="toc7" HREF="#sect7">METHODS</A></LI>
<LI><A NAME="toc8" HREF="#sect8">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc9" HREF="#sect9">COMPONENTS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">EXAMPLE</A></LI>
<LI><A NAME="toc11" HREF="#sect11">AUTHOR</A></LI>
<LI><A NAME="toc12" HREF="#sect12">KEYWORDS</A></LI>
</UL>
</BODY></HTML>
|
