File: pushbutton.n.html

package info (click to toggle)
itcl3.0 3.0.1-6
links: PTS
area: main
in suites: sarge
size: 10,128 kB
ctags: 3,519
sloc: tcl: 32,416; ansic: 12,683; sh: 3,917; makefile: 692; awk: 273; perl: 265
file content (239 lines) | stat: -rw-r--r-- 6,738 bytes
parent folder | download | duplicates (8)
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>

<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>

pushbutton - Create and manipulate a push button widget
<P>

<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>

<B>pushbutton</B> <I>pathName</I> ?<I>options</I>?
<P>

<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>

itk::Widget &lt;- pushbutton
<P>

<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>

<DL>
<DT><B>activeBackground</B> <DD>              <B>activeForegroundbackgroundbitmap</B>
<B>borderWidth</B>     <B>command</B>        <B>cursor</B>          <B>disabledForeground</B>
</DD>
</DL>
<DL>
<DT><B>font</B> <DD>           <B>foreground</B>     <B>highlightBackgroundhighlightColor</B>
</DD>
</DL>
<DL>
<DT><B>highlightThickness</B> <DD>            <B>image</B>           <B>padXpadY</B>
</DD>
</DL>
<DL>
<DT><B>state</B> <DD>          <B>text</B>           <B>underline</B>       <B>wrapLength</B>
<P>
</DD>
</DL>
See the &quot;options&quot; manual entry for details on the standard
options.
<P>

<H2><A NAME="sect5" HREF="#toc5"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>

<DL>
<DT>Name: <DD>          <B>defaultRing</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>DefaultRing</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-defaultring</B>
<P>
</DD>
</DL>
Boolean describing whether the button displays its
default ring given in any of the forms acceptable to
<B>Tcl_GetBoolean</B>. The default is false.
<P>
<DL>
<DT>Name: <DD>          <B>defaultRingPad</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Pad</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-defaultringpad</B>
<P>
</DD>
</DL>
Specifies the amount of space to be allocated to the
indentation of the default ring ring given in any of
the forms acceptable to <B>Tcl_GetPixels</B>. The option has
no effect if the defaultring option is set to false.
The default is 2 pixels.
<P>
<DL>
<DT>Name: <DD>          <B>height</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Height</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-height</B>
<P>
</DD>
</DL>
Specifies the height of the button inclusive of any
default ring given in any of the forms acceptable to
<B>Tk_GetPixels</B>. A value of zero lets the push button
determine the height based on the requested height plus
highlightring and defaultringpad.
<P>
<DL>
<DT>Name: <DD>          <B>width</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Width</B>
<P>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-width</B>
<P>
</DD>
</DL>
Specifies the width of the button inclusive of any
default ring given in any of the forms acceptable to
<B>Tk_GetPixels</B>. A value of zero lets the push button
determine the width based on the requested width plus
highlightring and defaultringpad.
<P>
_________________________________________________________________
<P>

<H2><A NAME="sect6" HREF="#toc6"><B>DESCRIPTION</B></A></H2>

The <B>pushbutton</B> command creates a push button with an
optional default ring used for default designation and
traversal.
<P>

<H2><A NAME="sect7" HREF="#toc7"><B>METHODS</B></A></H2>

The <B>pushbutton</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:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
The following commands are possible for pushbutton
widgets:
<P>

<H2><A NAME="sect8" HREF="#toc8"><B>ASSOCIATED</B> <B>METHODS</B></A></H2>

<DL>
<DT><B>flash</B> <DD>          <B>invoke</B>
<P>
</DD>
</DL>
See the &quot;button&quot; manual entry for details on the associated
methods.
<P>

<H2><A NAME="sect9" HREF="#toc9"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>

<I>pathName</I> <B>cget</B> <I>option</I><BR>

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>pushbutton</B> command.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
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</I> - <I>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>pushbutton</B> command.
<P>

<H2><A NAME="sect10" HREF="#toc10"><B>COMPONENTS</B></A></H2>

<DL>
<DT>Name: <DD>          <B>pushbutton</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Button</B>
<P>
</DD>
</DL>
The pushbutton component is the button surrounded by
the optional default ring. See the &quot;button&quot; widget
manual entry for details on the pushbutton component
item.
<P>

<H2><A NAME="sect11" HREF="#toc11"><B>EXAMPLE</B></A></H2>

pushbutton .pb -text &quot;Hello&quot; -command {puts &quot;Hello World"} -defaultring 1
pack .pb -padx 10 -pady 10
<P>

<H2><A NAME="sect12" HREF="#toc12"><B>AUTHOR</B></A></H2>

Bret A. Schuhmacher
<P>
Mark L. Ulferts
<P>

<H2><A NAME="sect13" HREF="#toc13"><B>KEYWORDS</B></A></H2>

pushbutton, widget
<P>

<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">DESCRIPTION</A></LI>
<LI><A NAME="toc7" HREF="#sect7">METHODS</A></LI>
<LI><A NAME="toc8" HREF="#sect8">ASSOCIATED METHODS</A></LI>
<LI><A NAME="toc9" HREF="#sect9">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">COMPONENTS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">EXAMPLE</A></LI>
<LI><A NAME="toc12" HREF="#sect12">AUTHOR</A></LI>
<LI><A NAME="toc13" HREF="#sect13">KEYWORDS</A></LI>
</UL>
</BODY></HTML>