1<TITLE>pushbutton - Create and manipulate a push button widget</TITLE>
2<H1>pushbutton - Create and manipulate a push button widget</H1>
3
4</pre><H2>SYNOPSIS</H2>
5<B>pushbutton<I> <I>pathName </I>?<I>options</I>?
6</pre><H2>INHERITANCE</H2>
7itk::Widget &lt;- pushbutton
8</pre><H2>STANDARD OPTIONS</H2>
9<P>
10<table cellpadding=5>
11<td valign=top>
12<B>activeBackground</B><br>
13<B>borderWidth</B><br>
14<B>font</B><br>
15<B>highlightThickness</B><br>
16<B>state</B><br>
17</td>
18<td valign=top>
19<B>activeForeground</B><br>
20<B>command</B><br>
21<B>foreground</B><br>
22<B>image</B><br>
23<B>text</B><br>
24</td>
25<td valign=top>
26<B>background</B><br>
27<B>cursor</B><br>
28<B>highlightBackground</B><br>
29<B>padX</B><br>
30<B>underline</B><br>
31</td>
32<td valign=top>
33<B>bitmap</B><br>
34<B>disabledForeground</B><br>
35<B>highlightColor</B><br>
36<B>padY</B><br>
37<B>wrapLength</B><br>
38</td>
39</table>
40<P>
41See 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.
42</pre><H2>WIDGET-SPECIFIC OPTIONS</H2>
43<P>
44<pre>
45Name:                   <B>defaultRing</B>
46Class:                  <B>DefaultRing</B>
47Command-Line Switch:	<B>-defaultring</B>
48</pre>
49<UL>
50Boolean describing whether the button displays its default ring given in 
51any of the forms acceptable to <B>Tcl_GetBoolean</B>.  The default is false.
52</UL>
53<P>
54<pre>
55Name:                   <B>defaultRingPad</B>
56Class:                  <B>Pad</B>
57Command-Line Switch:	<B>-defaultringpad</B>
58</pre>
59<UL>
60Specifies the amount of space to be allocated to the indentation of the
61default ring ring given in any of the forms acceptable to <B>Tcl_GetPixels</B>.
62The option has no effect if the defaultring option is set to false.  The 
63default is 2 pixels.
64</UL>
65<P>
66<pre>
67Name:                   <B>height</B>
68Class:                  <B>Height</B>
69Command-Line Switch:	<B>-height</B>
70</pre>
71<UL>
72Specifies the height of the button inclusive of any default ring given in
73any of the forms acceptable to <B>Tk_GetPixels</B>.  A value of zero lets 
74the push button determine the height based on the requested height plus 
75highlightring and defaultringpad.
76</UL>
77<P>
78<pre>
79Name:                   <B>width</B>
80Class:                  <B>Width</B>
81Command-Line Switch:	<B>-width</B>
82</pre>
83<UL>
84Specifies the width of the button inclusive of any default ring given in
85any of the forms acceptable to <B>Tk_GetPixels</B>.  A value of zero lets 
86the push button determine the width based on the requested width plus 
87highlightring and defaultringpad.
88</UL>
89<P>
90</pre><HR>
91
92</pre><H2>DESCRIPTION</H2>
93<P>
94The <B>pushbutton</B> command creates a push button with an 
95optional default ring used for default designation and traversal.
96
97</pre><H2>METHODS</H2>
98<P>
99The <B>pushbutton</B> command creates a new Tcl command whose
100name is <I>pathName</I>.  This
101command may be used to invoke various
102operations on the widget.  It has the following general form:
103<pre>
104<I>pathName option </I>?<I>arg arg ...</I>?
105</pre>
106<I>Option</I> and the <I>arg</I>s
107determine the exact behavior of the command.  The following
108commands are possible for pushbutton widgets:
109</pre><H2>ASSOCIATED METHODS</H2>
110<P>
111<table cellpadding=5>
112<td valign=top>
113<B>flash</B><br>
114</td>
115<td valign=top>
116<B>invoke</B><br>
117</td>
118<td valign=top>
119</td>
120<td valign=top>
121</td>
122</table>
123<P>
124See the <A HREF="http://www.sco.com/Technology/tcl/man/tk_man/button.n.html"> "button" </A> manual entry for details on the associated methods.
125
126</pre><H2>WIDGET-SPECIFIC METHODS</H2>
127<DL>
128<DT> <I>pathName <B>cget</B> <I>option</I>
129</I></B>
130<DD> Returns the current value of the configuration option given
131by <I>option</I>.
132<I>Option</I> may have any of the values accepted by the <B>pushbutton</B>
133command.
134</DL>
135<DL>
136<DT> <I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value option value ...</I>?
137</I></B>
138<DD> Query or modify the configuration options of the widget.
139If no <I>option</I> is specified, returns a list describing all of
140the available options for <I>pathName</I> (see <B>Tk_ConfigureInfo</B> for
141information on the format of this list).  If <I>option</I> is specified
142with no <I>value</I>, then the command returns a list describing the
143one named option (this list will be identical to the corresponding
144sublist of the value returned if no <I>option</I> is specified).  If
145one or more <I>option-value</I> pairs are specified, then the command
146modifies the given widget option(s) to have the given value(s);  in
147this case the command returns an empty string.
148<I>Option</I> may have any of the values accepted by the <B>pushbutton</B>
149command.
150
151</DL>
152</pre><H2>COMPONENTS</H2>
153<P>
154<pre>
155Name:                   <B>pushbutton</B>
156Class:                  <B>Button</B>
157</pre>
158<UL>
159The pushbutton component is the button surrounded by the optional default ring.
160See the <A HREF="http://www.sco.com/Technology/tcl/man/tk_man/button.n.html"> "button" </A> widget manual entry for details on the pushbutton
161component item.
162</UL>
163</table>
164
165</pre><H2>EXAMPLE</H2>
166<pre>
167pushbutton .pb -text "Hello" -command {puts "Hello World"} -defaultring 1
168pack .pb -padx 10 -pady 10
169</pre>
170</pre><H2>AUTHOR</H2>
171Bret A. Schuhmacher
172<P>
173Mark L. Ulferts
174</pre><H2>KEYWORDS</H2>
175pushbutton, widget
176