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



______________________________________________________________________________

NAME
       radiobutton - Create and manipulate radiobutton widgets

SYNOPSIS
       radiobutton 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 in  the
	      button  window.  The button's global variable (-variable option)
	      will be updated before the command is invoked.

       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:	       selectColor
       Class:	       Background
       Command-Line Switch:-selectcolor

	      Specifies a background color to use when the button is selected.
	      If indicatorOn is true, the color applicies to the indicator.

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

	      Specifies	 one of three states for the radiobutton:  normal, ac-
	      tive, or disabled.  In normal state the radiobutton is displayed
	      using  the  attributes, foreground, and background options.  The
	      active state is used when the input focus is in the radiobutton.
	      In active state the radiobutton is displayed using the activeAt-
	      tributes, activeForeground, and activeBackground options.	  Dis-
	      abled  state  means  that the radiobutton should be insensitive:
	      the default bindings will refuse to activate the widget and will
	      ignore  mouse  button  presses.	In  this state the disabledAt-
	      tributes, disabledForeground and disabledBackground options  de-
	      termine how the radiobutton is displayed.

       Name:	       value
       Class:	       Value
       Command-Line Switch:-value

	      Specifies	 value	to  store  in the button's associated variable
	      whenever this button is selected.

       Name:	       variable
       Class:	       Variable
       Command-Line Switch:-variable

	      Specifies name of global variable to set whenever this button is
	      selected.	 Changes in this variable also cause the button to se-
	      lect or deselect itself. Defaults to the value selectedButton.

       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 radiobutton command creates a new window (given by the pathName ar-
       gument)	and  makes  it into a radiobutton widget.  Additional options,
       described above, may be specified on the command line or in the	option
       database	 to  configure	aspects of the radiobutton such as its colors,
       attributes, and text. The radiobutton command returns its pathName  ar-
       gument.	 At  the  time this command is invoked, there must not exist a
       window named pathName, but pathName's parent must exist.

       A radiobutton is a widget that displays a textual string and  a	circle
       called  an  indicator.  One of the characters of the string may option-
       ally be underlined using the underline, underlineAttributes, and under-
       lineForeground  options.	  A  radiobutton  has all of the behavior of a
       simple button: it can display itself in either of three different ways,
       according  to  the  state option, and it invokes a Tcl command whenever
       mouse button 1 is clicked over the check button.

       In addition, radiobuttons can be selected.  If  a  radiobutton  is  se-
       lected, the indicator is normally drawn with a special color, and a Tcl
       variable associated with the radiobutton is set to a particular	value.
       If the radiobutton is not selected, the indicator is drawn with no spe-
       cial color. Typically, several radiobuttons share a single variable and
       the  value  of  the  variable  indicates which radiobutton is to be se-
       lected.	When a radiobutton is selected it sets the value of the	 vari-
       able  to	 indicate that fact;  each radiobutton also monitors the value
       of the variable and automatically selects and deselects itself when the
       variable's  value  changes.   By default the variable selectedButton is
       used;  its contents give the name of the button that  is	 selected,  or
       the  empty  string  if  no  button associated with that variable is se-
       lected.	The name of the variable for a radiobutton, plus the  variable
       to  be stored into it, may be modified with options on the command line
       or in the option database.  Configuration options may also be  used  to
       modify  the  way the indicator is displayed.  By default a radio button
       is configured to select itself on button clicks.


WIDGET COMMAND
       The radiobutton command creates a new Tcl command whose name  is	 path-
       Name.   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 following commands are possible for radiobutton 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 ra-
	      diobutton 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,
	      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, 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 radiobutton command.

       pathName deselect
	      Deselects the radiobutton and sets the associated variable to an
	      empty string.  If this radiobutton was not  currently  selected,
	      the command has no effect.

       pathName invoke
	      Does  just  what would have happened if the user invoked the ra-
	      diobutton with the mouse: selects the button and invokes its as-
	      sociated	Tcl command, 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 radiobutton.  This command is
	      ignored if the radiobutton's state is disabled.

       pathName select
	      Selects the radiobutton and sets the associated variable to  the
	      value corresponding to this widget.


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

       [1]    The radiobutton activates whenever it gets the input  focus  and
	      deactivates whenever it loses the input focus.

       [2]    When  mouse button 1 is pressed over a radiobutton it is invoked
	      (it becomes selected and the command associated with the	button
	      is invoked, if there is one).

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

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

       The  behavior  of  radiobuttons can be changed by defining new bindings
       for individual widgets or by redefining the class bindings.


KEYWORDS
       radiobutton, widget



Ck				      8.0			radiobutton(n)
