1<TITLE>extbutton - Extends the behavior of the Tk button</TITLE>
2<H1>extbutton - Extends the behavior of the Tk button</H1>
3
4</pre><H2>SYNOPSIS</H2>
5<B>extbutton <I>pathName </I>?<I>options</I>?
6</pre><H2>INHERITANCE</H2>
7<I>itk::Widget &lt;- extbutton</I>
8</pre><H2>STANDARD OPTIONS</H2>
9<P><I>
10<table cellpadding=5>
11<td valign=top>
12<B>activebackground</B><br>
13<B>bd</B><br>
14<B>foreground</B><br>
15<B>text</B><br>
16</td>
17<td valign=top>
18<B>activeforeground</B><br>
19<B>cursor</B><br>
20<B>image</B><br>
21</td>
22<td valign=top>
23<B>bitmap</B><br>
24<B>disabledforeground</B><br>
25<B>justify</B><br>
26</td>
27<td valign=top>
28<B>background</B><br>
29<B>font</B><br>
30<B>relief</B><br>
31</td>
32</table>
33</I>
34<P>
35See 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.
36</pre><H2>WIDGET-SPECIFIC OPTIONS</H2>
37<P>
38<pre>
39Name:                   <B>bitmapforeground</B>
40Class:                  <B>Foreground</B>
41Command-Line Switch:	<B>-bitmapforeground</B>
42</pre>
43<UL>
44Configures the foreground color of the bitmap.
45</UL>
46<P>
47<pre>
48Name:                   <B>command</B>
49Class:                  <B>Command</B>
50Command-Line Switch:	<B>-command</B>
51</pre>
52<UL>
53Associate a command with the extbutton. Simulates a Tk button's
54-command option. Invoked by either &lt;1&gt; events or by explicitly
55calling the public invoke() method.
56</UL>
57<P>
58<pre>
59Name:                   <B>defaultring</B>
60Class:                  <B>DefaultRing</B>
61Command-Line Switch:    <B>-defaultring</B>
62</pre>
63<UL>
64Boolean describing whether the extbutton displays its default ring given in
65any of the forms acceptable to <B>Tcl_GetBoolean</B>.  The default is false.
66</UL>
67<P>
68<pre>
69Name:                   <B>defaultringpad</B>
70Class:                  <B>Pad</B>
71Command-Line Switch:    <B>-defaultringpad</B>
72</pre>
73<UL>
74Specifies the amount of space to be allocated to the indentation of the
75default ring ring given in any of the forms acceptable to <B>Tcl_GetPixels</B>.
76The option has no effect if the defaultring option is set to false.  The
77default is 4 pixels.
78</UL>
79<P>
80<pre>
81Name:                   <B>imagePos</B>
82Class:                  <B>Position</B>
83Command-Line Switch:    <B>-imagepos</B>
84</pre>
85<UL>
86Specifies the image position relative to the message text: <B>n</B>, <B>ne</B>,
87<B>nw</B>, <B>s</B>, <B>se</B>, <B>sw</B>, <B>w</B>, <B>wn</B>, <B>ws</B>, <B>e</B>,
88<B>en</B>, or <B>es</B>. The default is w.
89</UL>
90<P>
91<pre>
92Name:                   <B>ringBackground</B>
93Class:                  <B>Background</B>
94Command-Line Switch:	<B>-ringbackground</B>
95</pre>
96<UL>
97Configures the background color of the default ring frame (if -defaultring
98is set to boolean true).
99</UL>
100<P>
101</pre><HR>
102
103</pre><H2>DESCRIPTION</H2>
104<P>
105The <B>extbutton</B> extends the behavior of the atomic Tk button by
106allowing text and an image or bitmap to coexist. The user may use
107the -image or -bitmap options to specify an image as well as the
108-imagepos option to specify image position relative to the text.
109Note that the extbutton is not intended to be used without an
110image/bitmap. There will be an emtpy space next to the text if
111no image/bitmap is specified.
112
113</pre><H2>METHODS</H2>
114<P>
115The <B>extbutton</B> command creates a new Tcl command whose
116name is <I>pathName</I>.  This command may be used to invoke various
117operations on the widget.  It has the following general form:
118<pre>
119<I>pathName option </I>?<I>arg arg ...</I>?
120</pre>
121
122</pre><H2>INHERITED METHODS</H2>
123Each of the following methods are inherited from itk::Archetype. See that
124man page for details.
125<pre>
126<I>pathName <B>cget</B>
127pathName <B>component</B>
128pathName <B>config</B>
129pathName <B>configure</B></I>
130</pre>
131
132</pre><H2>WIDGET-SPECIFIC METHODS</H2>
133<DL>
134<DT> <I><B>pathName invoke
135</I></B>
136<DD> Evaluates the command fragment associated with the -command option.
137</DL>
138<DL>
139<DT> <I><B>pathName flash
140</I></B>
141<DD> Simulates the Tk button's flash command.
142</DL>
143</pre><H2>EXAMPLES</H2>
144<pre>
145</B>
146iwidgets::extbutton .eb -text "Bitmap example" -bitmap info \
147  -background bisque -activeforeground red -bitmapforeground blue \
148  -defaultring 1 -command {puts "Bisque is beautiful"}
149pack .eb -expand 1
150
151iwidgets::extbutton .eb -text "Image example" -relief ridge -image \
152  [image create photo -file $itk::/iwidgets/demos/images/clear.gif] \
153  -font 9x15bold -background lightgreen -imagepos e \
154  -activebackground lightyellow
155pack .eb -expand 1
156
157</pre><H2>AUTHOR</H2>
158Chad Smith
159</pre><H2>KEYWORDS</H2>
160button, pushbutton
161