Updated 2017-12-04 17:39:24 by dbohdan

SYNOPSIS edit

instance = tkinter.Radiobutton(parent [,**options])

STANDARD OPTIONS edit

activebackground
activeforeground
anchor
background or bg
bitmap
borderwidth or bd
compound
cursor
disabledforeground
font
foreground or fg
highlightbackground
highlightcolor
highlightthickness
image
justify
padx
pady
relief
takefocus
text
textvariable
underline
wraplength

WIDGET-SPECIFIC OPTIONS edit

command
Specifies a Python callback to associate with the button. This command is typically invoked when mouse button 1 is released over the button window. The button's variable's class (variable option) will be updated before the command is invoked.

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 Screen Units); for text it is in lines of text. If this option is not specified, the button's desired height is computed from the size of the image or bitmap or text being displayed in it.

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.

selectcolor
Specifies a background color to use when the button is selected. If indicatoron is True then the color applies to the indicator. Under Windows, this color is used as the background for the indicator regardless of the select state. 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 then no special color is used for displaying when the widget is selected.

offrelief
Specifies the relief for the checkbutton when the indicator is not drawn and the checkbutton is off. The default value is "raised". By setting this option to "flat" and setting indicatoron to False and overrelief to "raised", the effect is achieved of having a flat button that raises on mouse-over and which is depressed when activated. This is the behavior typically exhibited by the Align-Left, Align-Right, and Center radiobuttons on the toolbar of a word-processor, for example.

overrelief
Specifies an alternative relief for the radiobutton, to be used when the mouse cursor is over the widget. This option can be used to make toolbar buttons, by configuring relief="flat" overrelief="raised". If the value of this option is the empty string, then no alternative relief is used when the mouse cursor is over the radiobutton. The empty string is the default value.

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.

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.

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

variable
Specifies the instance's name of a variable class 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.

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 Screen Units); for text it is in characters. If this option is not specified, the button's desired width is computed from the size of the image or bitmap or text being displayed in it.

DESCRIPTION edit

A radiobutton is a widget that displays a textual string, bitmap or image and a diamond or circle 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 Python callback whenever mouse button 1 is clicked over the check button.

WIDGET COMMAND edit

instance.cget("option")
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the Radiobutton class.

instance.configure()
instance.configure("option")
instance.configure(**options)
Query or modify the configuration options of the widget.
If no option is specified, returns a list describing all of the available options for instance: the elements of the list are the option name, database name, database class, default value, and current value.
If "option" is specified, then the method 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 **options are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the method returns an empty string. Option may have any of the values accepted by the Radiobutton class.

instance.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.

instance.invoke()
Does just what would have happened if the user invoked the radiobutton with the mouse: selects the button and invokes its associated Python callback, if there is one. The return value is the return value from the Python callback, or an empty string if there is no callback associated with the radiobutton. This command is ignored if the radiobutton's state is disabled.

instance.select()
Selects the radiobutton and sets the associated variable to the value corresponding to this widget.

BINDINGS edit

Tkinter automatically creates class bindings for radiobuttons that give them the following default behavior:
1. On Unix systems, a radiobutton activates whenever the mouse passes over it and deactivates whenever the mouse leaves the radiobutton. On Mac and Windows systems, when mouse button 1 is pressed over a radiobutton, the button activates whenever the mouse pointer is inside the button, and deactivates whenever the mouse pointer leaves the button.
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.