radiobutton

Create and manipulate radiobutton widgets


SYNOPSIS

(radiobutton widget-name . options)

Standard options


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


Widget-specific options

Name: procedure
Class: Command
Command-Line Switch: :procedure

Name: height
Class: Height
Command-Line Switch: :height Name: indicatorOn
Class: IndicatorOn
Command-Line Switch: :indicatoron

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

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

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

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

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


DESCRIPTION

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

The radiobutton procedure creates a new STk procedure whose name is widget-name. This procedure may be used to invoke various operations on the widget. It has the following general form:

widget-name option ?arg arg ...?

Option and the args determine the exact behavior of the procedure. The following procedures are possible for radiobutton widgets:

widget-name cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the radiobutton procedure.

widget-name 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 widget_name (see Tk_ConfigureInfo for information on the format of this list). If option is specified with no value, the procedure 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 procedure modifies the given widget option(s) to have the given value(s); in this case the procedure returns an empty string. Option may have any of the values accepted by the radiobutton procedure.

widget-name deselect
Deselects the radiobutton and sets the associated variable to an empty string. If this radiobutton was not currently selected, the procedure has no effect.

widget-name 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 procedure was invoked. This procedure is ignored if the radiobutton's state is disabled.

widget-name invoke
Does just what would have happened if the user invoked the radiobutton with the mouse: selects the button and invokes its associated STk procedure, if there is one. The return value is the return value from the STk procedure, or an empty string if there is no procedure associated with the radiobutton. This procedure is ignored if the radiobutton's state is disabled.

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


BINDINGS

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

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

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


Go to top