URL
https://opencores.org/ocsvn/or1k_old/or1k_old/trunk
Subversion Repositories or1k_old
[/] [or1k_old/] [trunk/] [insight/] [itcl/] [iwidgets3.0.0/] [demos/] [html/] [labeledwidget.n.html] - Rev 1782
Compare with Previous | Blame | View Log
<HTML> <HEAD> <TITLE>iwidgets2.2.0 User Commands - labeledwidget</TITLE> </HEAD> <BODY BGCOLOR="#FFFFFF"> <H1>iwidgets2.2.0 User Commands - labeledwidget</H1> <HR> <PRE> </PRE> <H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE> </PRE> <H2>NAME</H2><PRE> labeledwidget - Create and manipulate a labeled widget </PRE> <H2>SYNOPSIS</H2><PRE> <STRONG>labeledwidget</STRONG> <EM>pathName</EM> ?<EM>options</EM>? </PRE> <H2>INHERITANCE</H2><PRE> itk::Widget <- labeledwidget </PRE> <H2>STANDARD OPTIONS</H2><PRE> <STRONG>background</STRONG> <STRONG>cursor</STRONG> <STRONG>foreground</STRONG> See the "options" manual entry for details on the standard options. </PRE> <H2>WIDGET-SPECIFIC OPTIONS</H2><PRE> Name: <STRONG>labelBitmap</STRONG> Class: <STRONG>Bitmap</STRONG> Command-Line Switch: <STRONG>-labelbitmap</STRONG> Specifies a bitmap to display in the widget, in any of the forms acceptable to <STRONG>Tk_GetBitmap</STRONG>. This option overrides the <EM>labeltext</EM> option. Name: <STRONG>labelFont</STRONG> Class: <STRONG>Font</STRONG> Command-Line Switch: <STRONG>-labelfont</STRONG> Specifies the font to be used for the label. Name: <STRONG>labelImage</STRONG> Class: <STRONG>Image</STRONG> Command-Line Switch: <STRONG>-labelimage</STRONG> Specifies a image to be used as the label. The image may be any of the values created by the <STRONG>image</STRONG> <STRONG>create</STRONG> command. This option overrides both the <EM>labelbitmap</EM> and <EM>labeletext</EM> options. Name: <STRONG>labelMargin</STRONG> Class: <STRONG>Margin</STRONG> Command-Line Switch: <STRONG>-labelmargin</STRONG> Specifies the distance between the childsite and label in any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>. The default is 1 pixel. Name: <STRONG>labelPos</STRONG> Class: <STRONG>Position</STRONG> Command-Line Switch: <STRONG>-labelpos</STRONG> Specifies the position of the label along the side of the childsite: <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>, <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, or <STRONG>nw</STRONG>. The default is w. Name: <STRONG>labelText</STRONG> Class: <STRONG>Text</STRONG> Command-Line Switch: <STRONG>-labeltext</STRONG> Specifies the text of the label around the childsite. Name: <STRONG>labelVariable</STRONG> Class: <STRONG>Variable</STRONG> Command-Line Switch: <STRONG>-labelvariable</STRONG> Specifies the text variable of the label around the childsite. </PRE> <H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE> </PRE> <H2>DESCRIPTION</H2><PRE> The <STRONG>labeledwidget</STRONG> 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><PRE> The <STRONG>labeledwidget</STRONG> command creates a new Tcl command whose name is <EM>pathName</EM>. This command may be used to invoke vari- ous operations on the widget. It has the following general form: <EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...? <EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com- mand. The following commands are possible for labeledwidget widgets: </PRE> <H2>WIDGET-SPECIFIC METHODS</H2><PRE> <EM>pathName</EM> <STRONG>childsite</STRONG> Return the path name of the child site. <EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM> Returns the current value of the configuration option given by <EM>option</EM>. <EM>Option</EM> may have any of the values accepted by the <STRONG>labeledwidget</STRONG> command. <EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...? Query or modify the configuration options of the widget. If no <EM>option</EM> is specified, returns a list describing all of the available options for <EM>pathName</EM> (see <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of this list). If <EM>option</EM> is specified with no <EM>value</EM>, then the command returns a list describing the one named option (this list will be identical to the correspond- ing sublist of the value returned if no <EM>option</EM> is specified). If one or more <EM>option</EM> - <EM>value</EM> 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. <EM>Option</EM> may have any of the values accepted by the <STRONG>labeledwidget</STRONG> command. </PRE> <H2>STATIC METHODS</H2><PRE> <STRONG>Labeledwidget::alignlabels</STRONG> <EM>widget</EM> ?<EM>widget</EM> ...? 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. </PRE> <H2>COMPONENTS</H2><PRE> Name: <STRONG>label</STRONG> Class: <STRONG>label</STRONG> The label component provides the label for the labeled widget. See the "label" widget manual entry for details on the label component item. Name: <STRONG>lwchildsite</STRONG> Class: <STRONG>frame</STRONG> 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. </PRE> <H2>EXAMPLE</H2><PRE> 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 fol- lowing is an example of 'childsite' method usage. 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> <H2>AUTHOR</H2><PRE> Mark L. Ulferts </PRE> <H2>KEYWORDS</H2><PRE> labeledwidget, widget </PRE> </BODY> </HTML>