ToggleButton

class ToggleButton(**properties: Any)

Superclasses: Button, Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Actionable, Buildable, ConstraintTarget

Constructors:

ToggleButton(**properties)
new() -> Gtk.Widget
new_with_label(label:str) -> Gtk.Widget
new_with_mnemonic(label:str) -> Gtk.Widget

Constructors

class ToggleButton

classmethod new() → Widget

Creates a new toggle button.

A widget should be packed into the button, as in new.

classmethod new_with_label(label: str) → Widget

Creates a new toggle button with a text label.

Parameters:

label – a string containing the message to be placed in the toggle button.

classmethod new_with_mnemonic(label: str) → Widget

Creates a new GtkToggleButton containing a label.

The label will be created using new_with_mnemonic, so underscores in label indicate the mnemonic for the button.

Parameters:

label – the text of the button, with an underscore in front of the mnemonic character

Methods

class ToggleButton

get_active() → bool

Queries a GtkToggleButton and returns its current state.

Returns True if the toggle button is pressed in and False if it is raised.

set_active(is_active: bool) → None

Sets the status of the toggle button.

Set to True if you want the GtkToggleButton to be “pressed in”, and False to raise it.

If the status of the button changes, this action causes the toggled signal to be emitted.

Parameters:

is_active – True or False.

set_group(group: ToggleButton | None = None) → None

Adds self to the group of group.

In a group of multiple toggle buttons, only one button can be active at a time.

Setting up groups in a cycle leads to undefined behavior.

Note that the same effect can be achieved via the Actionable API, by using the same action with parameter type and state type ‘s’ for all buttons in the group, and giving each button its own target value.

Parameters:

group – another GtkToggleButton to form a group with

toggled() → None

Emits the ::toggled signal on the GtkToggleButton.

Deprecated since version 4.10: There is no good reason for an application ever to call this function.

Properties

class ToggleButton

props.active: bool

If the toggle button should be pressed in.

props.group: ToggleButton

The toggle button whose group this widget belongs to.

Signals

class ToggleButton.signals

toggled() → None

Emitted whenever the GtkToggleButton’s state is changed.

Virtual Methods

class ToggleButton

do_toggled() → None

Emits the ::toggled signal on the GtkToggleButton.

Deprecated since version 4.10: There is no good reason for an application ever to call this function.

Fields

class ToggleButton

button