*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->IRIX man pages -> Tk/radiobutton (3)              


radiobutton(3Tk)					      radiobutton(3Tk)

NAME    [Toc]    [Back]

     radiobutton - Create and manipulate radiobutton widgets

SYNOPSIS    [Toc]    [Back]

     radiobutton pathName ?options?

STANDARD OPTIONS    [Toc]    [Back]

     activeBackground  cursor		    highlightThickness	takeFocus     |
     activeForeground  disabledForeground   image		text	      |
     anchor	       font		    justify		textVariable  |
     background	       foreground	    padX		underline     |
     bitmap	       highlightColor	    padY		wrapLength    |
     borderWidth       highlightBackground  relief

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

     Name:	     command
     Class:	     Command
     Command-Line Switch:-command

	  Specifies a Tcl command to associate with the	button.	 This command
	  is typically invoked when mouse button 1 is released over 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.  If an image or bitmap is
	  being	displayed in the button	then the value is in screen units
	  (i.e.	any of the forms acceptable to Tk_GetPixels); for text it is
	  in lines of text.  If	this option isn't specified, the button's
	  desired height is computed from the size of the image	or bitmap or
	  text being displayed in it.

     Name:	     indicatorOn					      |
     Class:	     IndicatorOn					      |
     Command-Line Switch:-indicatoron					      |

	  Specifies whether or not the indicator should	be drawn.  Must	be a  |
	  proper boolean value.	 If false, the relief option is	ignored	and   |
	  the widget's relief is always	sunken if the widget is	selected and  |
	  raised otherwise.

     Name:	     selectColor					      |
     Class:	     Background						      |
     Command-Line Switch:-selectcolor					      |

									Page 1

radiobutton(3Tk)					      radiobutton(3Tk)

	  Specifies a background color to use when the button is selected.  If|
	  indicatorOn is true, the color applicies to the indicator.  If      |
	  indicatorOn is false,	this color is used as the background for the  |
	  entire widget, in place of background	or activeBackground, whenever |
	  the widget is	selected.  If specified	as an empty string, no special|
	  color	is used	for displaying when the	widget is selected.

     Name:	     selectImage					      |
     Class:	     SelectImage					      |
     Command-Line Switch:-selectimage					      |

	  Specifies an image to	display	(in place of the image option) when   |
	  the radiobutton is selected.	This option is ignored unless the     |
	  image	option has been	specified.

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

	  Specifies one	of three states	for the	radiobutton:  normal, active,
	  or disabled.	In normal state	the radiobutton	is displayed using the
	  foreground and background options.  The active state is typically
	  used when the	pointer	is over	the radiobutton.  In active state the
	  radiobutton is displayed using the activeForeground and
	  activeBackground options.  Disabled 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
	  disabledForeground and background options determine 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 select
	  or deselect itself.  Defaults	to the value selectedButton.

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

	  Specifies a desired width for	the button.  If	an image or bitmap is
	  being	displayed in the button, the value is in screen	units (i.e.
	  any of the forms acceptable to Tk_GetPixels);	for text it is in

									Page 2

radiobutton(3Tk)					      radiobutton(3Tk)

	  characters.  If this option isn't specified, the button's desired
	  width	is computed from the size of the image or bitmap or text being
	  displayed in it.

DESCRIPTION    [Toc]    [Back]

     The radiobutton command creates a new window (given by the	pathName
     argument) 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,
     font, text, and initial relief.  The radiobutton 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 radiobutton is a	widget that displays a textual string, bitmap or image|
     and a diamond called an indicator.	 If text is displayed, it must all be |
     in	a single font, but it can occupy multiple lines	on the screen (if it  |
     contains newlines or if wrapping occurs because of	the wrapLength option)|
     and one of	the characters may optionally be underlined using the	      |
     underline option.	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; it can be made to appear raised, sunken,
     or	flat; it can be	made to	flash; 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 selected,|
     the indicator is normally drawn with a sunken relief and 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 a|
     raised relief and no special color.  Typically, several radiobuttons     |
     share a single variable and the value of the variable indicates which    |
     radiobutton is to be selected.  When a radiobutton	is selected it sets   |
     the value of the variable 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 selected.	 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 (or whether it |
     is	displayed at all).  By default a radio button is configured to select
     itself on button clicks.

WIDGET COMMAND    [Toc]    [Back]

     The radiobutton 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 ...?

									Page 3

radiobutton(3Tk)					      radiobutton(3Tk)

     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	      |
	  radiobutton 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 available
	  options for pathName (see Tk_ConfigureInfo for information on	the
	  format of this list).	 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 option-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 flash
	  Flashes the radiobutton.  This is accomplished by redisplaying the
	  radiobutton several times, alternating between active	and normal
	  colors.  At the end of the flash the radiobutton is left in the same
	  normal/active	state as when the command was invoked.	This command
	  is ignored if	the radiobutton's state	is disabled.

     pathName invoke
	  Does just what would have happened if	the user invoked the
	  radiobutton with the mouse: selects the button and invokes its
	  associated 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    [Toc]    [Back]

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

									Page 4

radiobutton(3Tk)					      radiobutton(3Tk)

     [1]  The radiobutton activates whenever the mouse passes over it and
	  deactivates whenever the mouse leaves	the radiobutton.

     [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 key	causes 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    [Toc]    [Back]

     radiobutton, widget

									PPPPaaaaggggeeee 5555
[ Back ]
 Similar pages
Name OS Title
checkbutton IRIX Create and manipulate checkbutton widgets
canvas IRIX Create and manipulate canvas widgets
scale IRIX Create and manipulate scale widgets
label IRIX Create and manipulate label widgets
listbox IRIX Create and manipulate listbox widgets
menu IRIX Create and manipulate menu widgets
button IRIX Create and manipulate button widgets
menubutton IRIX Create and manipulate menubutton widgets
message IRIX Create and manipulate message widgets
scrollbar IRIX Create and manipulate scrollbar widgets
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service