wx.RadioButton¶

A radio button item is a button which usually denotes one of several mutually exclusive options.

It has a text label next to a (usually) round button.

Radio buttons are typically used in groups of mutually-exclusive buttons, i.e. exactly one of the buttons in the group is checked, and the other ones are unchecked automatically. Such groups are created implicitly, but can also be started explicitly by using RB_GROUP style: a button with this style starts a new group and will become the initial selection in this group. Alternatively, a radio button may be excluded from the group that it would otherwise belong to by using RB_SINGLE style.

To find the other elements of the same radio button group, you can use GetFirstInGroup, GetPreviousInGroup, GetNextInGroup and GetLastInGroup functions.

Window Styles¶

This class supports the following styles:

wx.RB_GROUP: Marks the beginning of a new group of radio buttons.
wx.RB_SINGLE: Creates a radio button which is not part of any radio button group. When this style is used, no other radio buttons will be turned off automatically when this button is turned on and such behaviour will need to be implemented manually, in the event handler for this button. This style is currently only supported in wxMSW and wxGTK (since version 3.2.x). In the other ports it can be specified, but single radio buttons can’t be turned off, making them not very useful.

Events Emitted by this Class¶

Handlers bound for the following event types will receive a wx.CommandEvent parameter.

EVT_RADIOBUTTON: Process a wxEVT_RADIOBUTTON event, when the radiobutton is clicked.

Class Hierarchy¶

Inheritance diagram for class RadioButton:

Control Appearance¶

Methods Summary¶

`__init__`	Default constructor.
`Create`	Creates the choice for two-step construction.
`GetClassDefaultAttributes`
`GetFirstInGroup`	Returns the first button of the radio button group this button belongs to.
`GetLastInGroup`	Returns the last button of the radio button group this button belongs to.
`GetNextInGroup`	Returns the next radio button in the same group.
`GetPreviousInGroup`	Returns the previous radio button in the same group.
`GetValue`	Returns `True` if the radio button is checked, `False` otherwise.
`SetValue`	Sets the radio button to checked or unchecked status.

Properties Summary¶

`FirstInGroup`	See `GetFirstInGroup`
`LastInGroup`	See `GetLastInGroup`
`NextInGroup`	See `GetNextInGroup`
`PreviousInGroup`	See `GetPreviousInGroup`
`Value`	See `GetValue` and `SetValue`

Class API¶

class wx.RadioButton(Control)¶

Possible constructors:

RadioButton() -> None

RadioButton(parent, id=ID_ANY, label='', pos=DefaultPosition,
            size=DefaultSize, style=0, validator=DefaultValidator,
            name=RadioButtonNameStr) -> None

A radio button item is a button which usually denotes one of several mutually exclusive options.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor.

Return type:: None

See also

Create , wx.Validator

__init__ (self, parent, id=ID_ANY, label=’’, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=RadioButtonNameStr)

Constructor, creating and showing a radio button.

Parameters:

parent (wx.Window) – Parent window. Must not be None.
id (wx.WindowID) – Window identifier. The value ID_ANY indicates a default value.
label (string) – Label for the radio button.
pos (wx.Point) – Window position. If wx.DefaultPosition is specified then a default position is chosen.
size (wx.Size) – Window size. If wx.DefaultSize is specified then a default size is chosen.
style (long) – Window style. See wx.RadioButton.
validator (wx.Validator) – Window validator.
name (string) – Window name.

Return type:

None

See also

Create , wx.Validator

Create(self, parent, id=ID_ANY, label='', pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=RadioButtonNameStr)¶

Creates the choice for two-step construction.

See wx.RadioButton for further details.

Parameters:

parent (wx.Window)
id (wx.WindowID)
label (string)
pos (wx.Point)
size (wx.Size)
style (long)
validator (wx.Validator)
name (string)

Return type:

bool

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters:: variant (WindowVariant)
Return type:: wx.VisualAttributes

GetFirstInGroup(self)¶

Returns the first button of the radio button group this button belongs to.

For a radio button with RB_SINGLE style, this function returns this button itself, as it is the only member of its group. Otherwise, the function returns the closest previous radio button with RB_GROUP style (which could still be this button itself) or the first radio button in the same window.

The returned value is never None.

Return type:: wx.RadioButton

Added in version 4.1/wxWidgets-3.1.5.

GetLastInGroup(self)¶

Returns the last button of the radio button group this button belongs to.

Similarly to GetFirstInGroup , this function returns this button itself if it has RB_SINGLE style. Otherwise, the function returns the last button before the next button with RB_GROUP style or the last radio button in the same window.

The returned value is never None.

Return type:: wx.RadioButton

Added in version 4.1/wxWidgets-3.1.5.

See also

GetPreviousInGroup , GetNextInGroup

GetNextInGroup(self)¶

Returns the next radio button in the same group.

The return value is None if there is no successor or if this button has RB_SINGLE style.

Return type:: wx.RadioButton

Added in version 4.1/wxWidgets-3.1.5.

GetPreviousInGroup(self)¶

Returns the previous radio button in the same group.

The return value is None if there is no predecessor or if this button has RB_SINGLE style.

Return type:: wx.RadioButton

Added in version 4.1/wxWidgets-3.1.5.

GetValue(self)¶

Returns True if the radio button is checked, False otherwise.

Return type:: bool

SetValue(self, value)¶

Sets the radio button to checked or unchecked status.

This does not cause a wxEVT_RADIOBUTTON event to get emitted.

If the radio button belongs to a radio group exactly one button in the group may be checked and so this method can be only called with value set to True. To uncheck a radio button in a group you must check another button in the same group.

Parameters:: value (bool) – True to check, False to uncheck.
Return type:: None

Note

Under MSW, the focused radio button is always selected, i.e. its value is True. And, conversely, calling SetValue(true) will also set focus to the radio button if the focus had previously been on another radio button in the same group –