1iwidgets::labeledframe − Create and manipulate a labeled frame
2widget iwidgets::labeledframe pathName ?options? itk::Archetype
3<‐ iwidgets::Labeledframe
6See the "options" manual entry for details on the standard op‐
7tions.
8Name: iPadX
9Class: IPad
10Command‐Line Switch: ‐ipadx
11Specifies horizontal padding space between the border and the
12childsite. The value may have any of the forms acceptable to
14Name: iPadY
15Class: IPad
16Command‐Line Switch: ‐ipady
17Specifies vertical padding space between the border and the
18childsite. The value may have any of the forms acceptable to
20Name: labelBitmap
21Class: Bitmap
22Command‐Line Switch: ‐labelbitmap
23Specifies a bitmap to display in the label, in any of the forms
24acceptable to Tk_GetBitmap. This option overrides the labeltext
25option.
26Name: labelImage
27Class: Image
28Command‐Line Switch: ‐labelimage
29Specifies a image to be used as the label. The image may be any
30of the values created by the image create command. This option
31overrides both the labelbitmap and labeletext options.
32Name: labelMargin
33Class: Margin
34Command‐Line Switch: ‐labelmargin
35Specifies the distance between the inner ede of the hull frames
36relief, and the label in any of the forms acceptable to Tk_Get‐
38Name: labelText
39Class: Text
40Command‐Line Switch: ‐labeltext
41Specifies the text of the label around the childsite.
42Name: labelVariable
43Class: Variable
44Command‐Line Switch: ‐labelvariable
45Specifies the text variable of the label around the childsite.
46Name: labelFont
47Class: Font
48Command‐Line Switch: ‐labelfont
49Specifies the font of the label around the childsite.
50Name: labelPos
51Class: Position
52Command‐Line Switch: ‐labelpos
53Specifies the position of the label within the grooved relief of
54the hull widget.
55 ne, n, nw, se, s, sw, en, e, es, wn, w, ws Default is n.
56The iwidgets::labeledframe command creates a hull frame with a
58grooved relief, a label positioned within the grooved relief of
59the hull frame, and a frame childsite. The frame childsite can
60filled with any widget via a derived class or though the use of
61the childsite method. This class was designed to be a general
62purpose base class for supporting the combination of labeled
63frame and a childsite. The options include the ability to posi‐
64tion the label at configurable locations within the grooved re‐
65lief of the hull frame, and control the display of the label.
66The iwidgets::labeledframe command creates a new Tcl command
67whose name is pathName. This command may be used to invoke vari‐
68ous operations on the widget. It has the following general form:
70exact behavior of the command. The following commands are possi‐
71ble for labeledframe widgets: pathName childsite Return the path
72name of the child site. pathName cget option Returns the current
73value of the configuration option given by option. Option may
74have any of the values accepted by the iwidgets::labeledframe
75command. pathName configure ?option? ?value option value ...?
76Query or modify the configuration options of the widget. If no
78able options for pathName (see Tk_ConfigureInfo for information
79on the format of this list). If option is specified with no val‐
81tion (this list will be identical to the corresponding sublist of
82the value returned if no option is specified). If one or more
84given widget option(s) to have the given value(s); in this case
85the command returns an empty string. Option may have any of the
86values accepted by the iwidgets::labeledframe command.
87Name: label
89Class: label
90The label component provides the label for the labeled widget.
91See the "label" widget manual entry for details on the label com‐
92ponent item.
93The labeledframe was primarily meant to be a base class. The Ra‐
95diobox is a good example of a derived classe of the labeledframe
96class. In order to provide equal support for composite classes,
97the ’childsite’ methods also exists. The following is an example
98of ’childsite’ method usage.
99 package require Iwidgets 4.0
100 iwidgets::labeledframe .lw ‐labeltext "Entry Frame" ‐labelpos n
101 pack .lw ‐fill both ‐expand yes ‐padx 10 ‐pady 10
102 set cs [.lw childsite]
103 pack [iwidgets::entryfield $cs.entry1 ‐labeltext "Name:"] ‐side
105top ‐fill x
106 pack [iwidgets::spinint $cs.entry2 ‐labeltext "Number:"] ‐side
107top ‐fill x
108 pack [iwidgets::pushbutton $cs.entry3 ‐text "Details:"] ‐side
109top ‐fill x
110John A. Tucker labeledframe, widget
112