Events Emitted by this Class¶

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

• EVT_TOGGLEBUTTON: Handles a wxEVT_TOGGLEBUTTON event.

Class Hierarchy¶

Inheritance diagram for class ToggleButton:

Control Appearance¶

Known Subclasses¶

wx.BitmapToggleButton

Methods Summary¶

Properties Summary¶

Class API¶

class wx.ToggleButton(AnyButton)¶

Possible constructors:

ToggleButton() -> None

ToggleButton(parent, id=ID_ANY, label='', pos=DefaultPosition,
             size=DefaultSize, style=0, val=DefaultValidator, name=CheckBoxNameStr)
             -> None

ToggleButton is a button that stays pressed when clicked by the user.

Methods¶

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

Overloaded Implementations:

---

__init__ (self)

Default constructor.

Return type:

None

---

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

Constructor, creating and showing a toggle button.

Parameters:

• parent (wx.Window) – Parent window. Must not be nullptr.

• id (wx.WindowID) – Toggle button identifier. The value wx.ID_ANY indicates a default value.

• label (string) – Text to be displayed next to the toggle button.

• pos (wx.Point) – Toggle button position. If wx.DefaultPosition is specified then a default position is chosen.

• size (wx.Size) – Toggle button size. If wx.DefaultSize is specified then a default size is chosen.

• style (long) – Window style. See wx.ToggleButton.

• val (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, val=DefaultValidator, name=CheckBoxNameStr)¶

Creates the toggle button for two-step construction.

See wx.ToggleButton for details.

Parameters:

• parent (wx.Window)

• id (wx.WindowID)

• label (string)

• pos (wx.Point)

• size (wx.Size)

• style (long)

• val (wx.Validator)

• name (string)

Return type:

bool

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters:

variant (WindowVariant)

Return type:

wx.VisualAttributes

---

GetValue(self)¶

Gets the state of the toggle button.

Return type:

bool

Returns:

Returns True if it is pressed, False otherwise.

---

SetValue(self, state)¶

Sets the toggle button to the given state.

This does not cause a EVT_TOGGLEBUTTON event to be emitted.

Parameters:

state (bool) – If True, the button is pressed.

Return type:

None

Properties¶

Value¶

See GetValue and SetValue