1<TITLE>labeledframe - Create and manipulate a labeled frame widget</TITLE> 2<H1>labeledframe - Create and manipulate a labeled frame widget</H1> 3 4</pre><H2>SYNOPSIS</H2> 5<B>labeledframe<I> <I>pathName </I>?<I>options</I>? 6</pre><H2>INHERITANCE</H2> 7itk::Archetype <- labeledframe 8</pre><H2>STANDARD OPTIONS</H2> 9<P> 10<table cellpadding=5> 11<td valign=top> 12<B>background</B><br> 13<B>relief</B><br> 14</td> 15<td valign=top> 16<B>borderwidth</B><br> 17</td> 18<td valign=top> 19<B>cursor</B><br> 20</td> 21<td valign=top> 22<B>foreground</B><br> 23</td> 24</table> 25<P> 26See the <A HREF="http://www.sco.com/Technology/tcl/man/tk_man/options.n.html"> "options" </A> manual entry for details on the standard options. 27</pre><H2>WIDGET-SPECIFIC OPTIONS</H2> 28<P> 29<pre> 30Name: <B>iPadX</B> 31Class: <B>IPad</B> 32Command-Line Switch: <B>-ipadx</B> 33</pre> 34<UL> 35Specifies horizontal padding space between the border and the childsite. 36The value may have any of the forms acceptable to <B>Tk_GetPixels</B>. 37The default is 0. 38</UL> 39<P> 40<pre> 41Name: <B>iPadY</B> 42Class: <B>IPad</B> 43Command-Line Switch: <B>-ipady</B> 44</pre> 45<UL> 46Specifies vertical padding space between the border and the childsite. 47The value may have any of the forms acceptable to <B>Tk_GetPixels</B>. 48The default is 0. 49</UL> 50<P> 51<pre> 52Name: <B>labelBitmap</B> 53Class: <B>Bitmap</B> 54Command-Line Switch: <B>-labelbitmap</B> 55</pre> 56<UL> 57Specifies a bitmap to display in the label, in any of the forms 58acceptable to <B>Tk_GetBitmap</B>. This option overrides the <I>labeltext</I> 59option. 60</UL> 61<P> 62<pre> 63Name: <B>labelImage</B> 64Class: <B>Image</B> 65Command-Line Switch: <B>-labelimage</B> 66</pre> 67<UL> 68Specifies a image to be used as the label. The image may be any of the 69values created by the <B>image create</B> command. This option overrides 70both the <I>labelbitmap</I> and <I>labeletext</I> options. 71</UL> 72<P> 73<pre> 74Name: <B>labelMargin</B> 75Class: <B>Margin</B> 76Command-Line Switch: <B>-labelmargin</B> 77</pre> 78<UL> 79Specifies the distance between the inner ede of the hull frames relief, 80and the label in any of the forms acceptable to <B>Tk_GetPixels</B>. 81The default is 10 pixels. 82</UL> 83<P> 84<pre> 85Name: <B>labelText</B> 86Class: <B>Text</B> 87Command-Line Switch: <B>-labeltext</B> 88</pre> 89<UL> 90Specifies the text of the label around the childsite. 91</UL> 92<P> 93<pre> 94Name: <B>labelVariable</B> 95Class: <B>Variable</B> 96Command-Line Switch: <B>-labelvariable</B> 97</pre> 98<UL> 99Specifies the text variable of the label around the childsite. 100</UL> 101<P> 102<pre> 103Name: <B>labelFont</B> 104Class: <B>Font</B> 105Command-Line Switch: <B>-labelfont</B> 106</pre> 107<UL> 108Specifies the font of the label around the childsite. 109</UL> 110<P> 111<pre> 112Name: <B>labelPos</B> 113Class: <B>Position</B> 114Command-Line Switch: <B>-labelpos</B> 115</pre> 116<UL> 117Specifies the position of the label within the grooved relief of the hull widget. 118<B> ne, n, nw, se, s, sw, en, e, es, wn, w, ws</B> Default is <B>n</B>. 119</UL> 120<P> 121</pre><HR> 122 123</pre><H2>DESCRIPTION</H2> 124<P> 125The <B>labeledframe</B> command creates a hull frame with a 126grooved relief, a label positioned within the grooved relief of 127the hull frame, and a frame childsite. The frame childsite can filled with any 128widget via a derived class or though the use of the childsite method. 129This class was designed to be a general purpose base class for supporting the 130combination of labeled frame and a childsite. The options include the 131ability to position the label at configurable locations within the 132grooved relief of the hull frame, and control the display of the label. 133</pre><H2>METHODS</H2> 134<P> 135The <B>labeledframe</B> command creates a new Tcl command whose 136name is <I>pathName</I>. This 137command may be used to invoke various 138operations on the widget. It has the following general form: 139<pre> 140<I>pathName option </I>?<I>arg arg ...</I>? 141</pre> 142<I>Option</I> and the <I>arg</I>s 143determine the exact behavior of the command. The following 144commands are possible for labeledframe widgets: 145</pre><H2>WIDGET-SPECIFIC METHODS</H2> 146<DL> 147<DT> <I>pathName <B>childsite</B> 148</I></B> 149<DD> Return the path name of the child site. 150</DL> 151<DL> 152<DT> <I>pathName <B>cget</B> <I>option</I> 153</I></B> 154<DD> Returns the current value of the configuration option given 155by <I>option</I>. 156<I>Option</I> may have any of the values accepted by the <B>labeledframe</B> 157command. 158</DL> 159<DL> 160<DT> <I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value option value ...</I>? 161</I></B> 162<DD> Query or modify the configuration options of the widget. 163If no <I>option</I> is specified, returns a list describing all of 164the available options for <I>pathName</I> (see <B>Tk_ConfigureInfo</B> for 165information on the format of this list). If <I>option</I> is specified 166with no <I>value</I>, then the command returns a list describing the 167one named option (this list will be identical to the corresponding 168sublist of the value returned if no <I>option</I> is specified). If 169one or more <I>option-value</I> pairs are specified, then the command 170modifies the given widget option(s) to have the given value(s); in 171this case the command returns an empty string. 172<I>Option</I> may have any of the values accepted by the <B>labeledframe</B> 173command. 174 175</DL> 176</pre><H2>COMPONENTS</H2> 177<P> 178<pre> 179Name: <B>label</B> 180Class: <B>label</B> 181</pre> 182<UL> 183The label component provides the label for the labeled widget. See the 184"label" widget manual entry for details on the label component item. 185</UL> 186</table> 187<P> 188 189</pre><H2>EXAMPLE</H2> 190<UL> 191The labeledframe was primarily meant to be a base class. The 192Radiobox is a good example of a derived classe of the labeledframe class. 193In order to provide equal support for composite classes, the 'childsite' methods 194also exists. The following is an example of 'childsite' method usage. 195</UL> 196<P> 197<pre> 198 labeledframe .lw -labeltext "Entry Frame" -labelpos n 199 pack .lw -fill both -expand yes -padx 10 -pady 10 200 set cs [.lw childsite] 201 202 pack [Entryfield $cs.entry1 -labeltext "Name:"] -side top -fill x 203 pack [Spinint $cs.entry2 -labeltext "Number:"] -side top -fill x 204 pack [Pushbutton $cs.entry3 -text "Details:"] -side top -fill x 205 206</pre> 207</pre><H2>AUTHOR</H2> 208John A. Tucker 209</pre><H2>KEYWORDS</H2> 210labeledframe, widget 211