You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
225 lines
6.8 KiB
HTML
225 lines
6.8 KiB
HTML
<TITLE>labeledwidget - Create and manipulate a labeled widget</TITLE>
|
|
<H1>labeledwidget - Create and manipulate a labeled widget</H1>
|
|
|
|
</pre><H2>SYNOPSIS</H2>
|
|
<B>labeledwidget<I> <I>pathName </I>?<I>options</I>?
|
|
</pre><H2>INHERITANCE</H2>
|
|
itk::Widget <- labeledwidget
|
|
</pre><H2>STANDARD OPTIONS</H2>
|
|
<P>
|
|
<table cellpadding=5>
|
|
<td valign=top>
|
|
<B>background</B><br>
|
|
</td>
|
|
<td valign=top>
|
|
<B>cursor</B><br>
|
|
</td>
|
|
<td valign=top>
|
|
<B>foreground</B><br>
|
|
</td>
|
|
<td valign=top>
|
|
</td>
|
|
</table>
|
|
<P>
|
|
See 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.
|
|
</pre><H2>WIDGET-SPECIFIC OPTIONS</H2>
|
|
<P>
|
|
<pre>
|
|
Name: <B>disabledForeground</B>
|
|
Class: <B>DisabledForeground</B>
|
|
Command-Line Switch: <B>-disabledforeground</B>
|
|
</pre>
|
|
<UL>
|
|
Specifies the foreground to be used when the state is disabled.
|
|
</UL>
|
|
<P>
|
|
<pre>
|
|
Name: <B>labelBitmap</B>
|
|
Class: <B>Bitmap</B>
|
|
Command-Line Switch: <B>-labelbitmap</B>
|
|
</pre>
|
|
<UL>
|
|
Specifies a bitmap to display in the widget, in any of the forms
|
|
acceptable to <B>Tk_GetBitmap</B>. This option overrides the <I>labeltext</I>
|
|
option.
|
|
</UL>
|
|
<P>
|
|
<pre>
|
|
Name: <B>labelFont</B>
|
|
Class: <B>Font</B>
|
|
Command-Line Switch: <B>-labelfont</B>
|
|
</pre>
|
|
<UL>
|
|
Specifies the font to be used for the label.
|
|
</UL>
|
|
<P>
|
|
<pre>
|
|
Name: <B>labelImage</B>
|
|
Class: <B>Image</B>
|
|
Command-Line Switch: <B>-labelimage</B>
|
|
</pre>
|
|
<UL>
|
|
Specifies a image to be used as the label. The image may be any of the
|
|
values created by the <B>image create</B> command. This option overrides
|
|
both the <I>labelbitmap</I> and <I>labeletext</I> options.
|
|
</UL>
|
|
<P>
|
|
<pre>
|
|
Name: <B>labelMargin</B>
|
|
Class: <B>Margin</B>
|
|
Command-Line Switch: <B>-labelmargin</B>
|
|
</pre>
|
|
<UL>
|
|
Specifies the distance between the childsite and label in any of the forms
|
|
acceptable to <B>Tk_GetPixels</B>. The default is 2 pixel.
|
|
</UL>
|
|
<P>
|
|
<pre>
|
|
Name: <B>labelPos</B>
|
|
Class: <B>Position</B>
|
|
Command-Line Switch: <B>-labelpos</B>
|
|
</pre>
|
|
<UL>
|
|
Specifies the position of the label along the side of the childsite:
|
|
<B>nw</B>, <B>n</B>, <B>ne</B>, <B>sw</B>, <B>s</B>, <B>se</B>, <B>en</B>, <B>e</B>,
|
|
<B>es</B>, <B>wn</B>, <B>w</B>, or <B>ws</B>. The default is w.
|
|
</UL>
|
|
<P>
|
|
<pre>
|
|
Name: <B>labelText</B>
|
|
Class: <B>Text</B>
|
|
Command-Line Switch: <B>-labeltext</B>
|
|
</pre>
|
|
<UL>
|
|
Specifies the text of the label around the childsite.
|
|
</UL>
|
|
<P>
|
|
<pre>
|
|
Name: <B>labelVariable</B>
|
|
Class: <B>Variable</B>
|
|
Command-Line Switch: <B>-labelvariable</B>
|
|
</pre>
|
|
<UL>
|
|
Specifies the text variable of the label around the childsite.
|
|
</UL>
|
|
<P>
|
|
<pre>
|
|
Name: <B>state</B>
|
|
Class: <B>State</B>
|
|
Command-Line Switch: <B>-state</B>
|
|
</pre>
|
|
<UL>
|
|
Specifies one of two states for the label: <B>normal</B> or <B>disabled</B>.
|
|
If the label is disabled then it is displayed in a disabled foreground
|
|
color. The default is normal.
|
|
</UL>
|
|
<P>
|
|
</pre><HR>
|
|
|
|
</pre><H2>DESCRIPTION</H2>
|
|
<P>
|
|
The <B>labeledwidget</B> command creates a labeled widget which contains
|
|
a label and child site. The child site is a frame
|
|
which 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 label widget and a childsite. The options include the
|
|
ability to position the label around the childsite widget, modify the
|
|
font and margin, and control the display of the labels.
|
|
|
|
</pre><H2>METHODS</H2>
|
|
<P>
|
|
The <B>labeledwidget</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:
|
|
<pre>
|
|
<I>pathName option </I>?<I>arg arg ...</I>?
|
|
</pre>
|
|
<I>Option</I> and the <I>arg</I>s
|
|
determine the exact behavior of the command. The following
|
|
commands are possible for labeledwidget widgets:
|
|
</pre><H2>WIDGET-SPECIFIC METHODS</H2>
|
|
<DL>
|
|
<DT> <I>pathName <B>childsite</B>
|
|
</I></B>
|
|
<DD> Return the path name of the child site.
|
|
</DL>
|
|
<DL>
|
|
<DT> <I>pathName <B>cget</B> <I>option</I>
|
|
</I></B>
|
|
<DD> 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>labeledwidget</B>
|
|
command.
|
|
</DL>
|
|
<DL>
|
|
<DT> <I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value option value ...</I>?
|
|
</I></B>
|
|
<DD> 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-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>labeledwidget</B>
|
|
command.
|
|
|
|
</DL>
|
|
</pre><H2>STATIC METHODS</H2>
|
|
<DL>
|
|
<DT> <B>Labeledwidget::alignlabels</B> <I>widget</I> ?<I>widget ...</I>?
|
|
</I></B>
|
|
<DD> The alignlabels procedure takes a list of widgets derived from
|
|
the Labeledwidget class and uses the label margin to make each widget
|
|
have the same total space for the combination of label and margin. The
|
|
net effect is to left align the labels. Generally, this method is only
|
|
useful with a label position of w, which is the default.
|
|
|
|
</DL>
|
|
</pre><H2>COMPONENTS</H2>
|
|
<P>
|
|
<pre>
|
|
Name: <B>label</B>
|
|
Class: <B>label</B>
|
|
</pre>
|
|
<UL>
|
|
The label component provides the label for the labeled widget. See the
|
|
"label" widget manual entry for details on the label component item.
|
|
</UL>
|
|
<P>
|
|
<pre>
|
|
Name: <B>lwchildsite</B>
|
|
Class: <B>frame</B>
|
|
</pre>
|
|
<UL>
|
|
The lwchildsite component is the user child site for the labeled widget. See
|
|
the "frame" widget manual entry for details on the lwchildsite component item.
|
|
</UL>
|
|
</table>
|
|
|
|
</pre><H2>EXAMPLE</H2>
|
|
<UL>
|
|
The labeledwidget was primarily meant to be a base class. The
|
|
ScrolledListBox and EntryField are good examples of derived
|
|
classes of the labeledwidget class. In order to provide equal
|
|
support for composite classes, the 'childsite' methods also exists.
|
|
The following is an example of 'childsite' method usage.
|
|
</UL>
|
|
<P>
|
|
<pre>
|
|
labeledwidget .lw -labeltext "Canvas Widget" -labelpos s
|
|
pack .lw -fill both -expand yes -padx 10 -pady 10
|
|
|
|
set cw [canvas [.lw childsite].c -relief raised -width 200 -height 200]
|
|
pack $cw -padx 10 -pady 10
|
|
</pre>
|
|
</pre><H2>AUTHOR</H2>
|
|
Mark L. Ulferts
|
|
</pre><H2>KEYWORDS</H2>
|
|
labeledwidget, widget
|