button(n)		     Ck Built-In Commands		     button(n)



______________________________________________________________________________

NAME
       button - Create and manipulate button widgets

SYNOPSIS
       button pathName ?options?

STANDARD OPTIONS
       activeAttributes		     attributes	    disabledForegroundtextVariable
       activeBackground		     background	    foregroundunderline
       activeForeground		     disabledAttributestakeFocusunderlineAttributes
       anchor	      disabledBackground	    textunderlineForeground

       See the ``options'' manual entry for details on the standard options.

WIDGET-SPECIFIC OPTIONS
       Name:	       command
       Class:	       Command
       Command-Line Switch:-command

	      Specifies a Tcl command to associate with the button.  This com-
	      mand is typically invoked when mouse button 1  is	 pressed  over
	      the button window.

       Name:	       height
       Class:	       Height
       Command-Line Switch:-height

	      Specifies	 a  desired height for the button in screen lines.  If
	      this option isn't specified, the button's desired	 height	 is  1
	      line.

       Name:	       state
       Class:	       State
       Command-Line Switch:-state

	      Specifies	 one  of three states for the button:  normal, active,
	      or disabled.  In normal state the button is displayed using  the
	      foreground  and  background  options.  The active state is typi-
	      cally used when the input focus is in  the  button.   In	active
	      state  the  button  is displayed using the activeAttributes, ac-
	      tiveForeground and  activeBackground  options.   Disabled	 state
	      means  that  the button should be insensitive: the default bind-
	      ings will refuse to activate the widget and  will	 ignore	 mouse
	      button  presses. In this state the disabledAttributes, disabled-
	      Foreground and disabledBackground options determine how the but-
	      ton is displayed.

       Name:	       width
       Class:	       Width
       Command-Line Switch:-width

	      Specifies	 a desired width for the button in screen columns.  If
	      this option isn't specified, the button's desired width is  com-
	      puted from the size of the text being displayed in it.
_________________________________________________________________


DESCRIPTION
       The  button  command  creates a new window (given by the pathName argu-
       ment) and makes it into a button widget.	 Additional options, described
       above,  may  be specified on the command line or in the option database
       to configure aspects of the button such as its colors, attributes,  and
       text.  The  button  command returns its pathName argument.  At the time
       this command is invoked, there must not exist a window named  pathName,
       but pathName's parent must exist.

       A  button  is a widget that displays a textual string, bitmap or image.
       One of the characters may optionally be underlined using the underline,
       underlineAttributes,  and  underlineForeground  options. It can display
       itself in either of three different ways, according to  the  state  op-
       tion.   When a user invokes the button (e.g. by pressing mouse button 1
       with the cursor over the button), then the Tcl command specified in the
       -command option is invoked.


WIDGET COMMAND
       The  button  command  creates a new Tcl command whose name is pathName.
       This command may be used to invoke various operations on the widget. It
       has  the	 following general form: pathName option ?arg arg ...?	Option
       and the args determine the exact behavior of the command.  The  follow-
       ing commands are possible for button widgets:

       pathName cget option
	      Returns  the  current value of the configuration option given by
	      option.  Option may have any of the values accepted by the  but-
	      ton command.

       pathName configure ?option? ?value option value ...?
	      Query  or modify the configuration options of the widget.	 If no
	      option is specified, returns a list describing all of the avail-
	      able options for pathName. If option is specified with no value,
	      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 option is specified).  If one or  more  op-
	      tion-value  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.  Option may have any of the
	      values accepted by the button command.

       pathName invoke
	      Invoke the Tcl command associated with the button, if  there  is
	      one.  The return value is the return value from the Tcl command,
	      or an empty string if there is no command	 associated  with  the
	      button.	This  command is ignored if the button's state is dis-
	      abled.


DEFAULT BINDINGS
       Ck automatically creates class bindings for buttons that give them  the
       following default behavior:

       [1]    A	 button activates whenever it gets the input focus and deacti-
	      vates whenever it loses the input focus.

       [2]    If mouse button 1 is pressed over a button, the  button  is  in-
	      voked.

       [3]    When a button has the input focus, the space or return key cause
	      the button to be invoked.

       If the button's state is disabled then none of the above actions occur:
       the button is completely non-responsive.

       The behavior of buttons can be changed by defining new bindings for in-
       dividual widgets or by redefining the class bindings.


KEYWORDS
       button, widget



Ck				      8.0			     button(n)
