Check & Radio Buttons

A Gtk.CheckButton places a label next to an indicator. Check or Radio buttons are created through Gtk.CheckButton, you create one or another depending grouping.

Gtk.CheckButton can be grouped together, to form mutually exclusive groups so only one of the buttons can be toggled at a time, this create what we usually refer to as a radio button.

In addition to “on” and “off”, Gtk.CheckButton can be an “in between” state that is neither on nor off. This can be used e.g. when the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a check button, and the current values in that range are inconsistent. For this purpose use Gtk.CheckButton.props.inconsistent.

Example

import gi

gi.require_version('Gtk', '4.0')
from gi.repository import Gtk


class CheckButtonWindow(Gtk.ApplicationWindow):
    def __init__(self, **kargs):
        super().__init__(**kargs, title='CheckButton Demo')

        box = Gtk.Box(spacing=6)
        self.set_child(box)

        check = Gtk.CheckButton(label='Checkbox')
        check.connect('toggled', self.on_check_toggled)
        box.append(check)

        radio1 = Gtk.CheckButton(label='Radio 1')
        radio1.connect('toggled', self.on_radio_toggled, '1')
        box.append(radio1)

        radio2 = Gtk.CheckButton(label='Radio 2')
        radio2.set_group(radio1)
        radio2.connect('toggled', self.on_radio_toggled, '2')
        box.append(radio2)

        radio3 = Gtk.CheckButton.new_with_mnemonic('R_adio 3')
        radio3.set_group(radio1)
        radio3.connect('toggled', self.on_radio_toggled, '3')
        box.append(radio3)

    def on_check_toggled(self, check):
        if check.props.active:
            state = 'on'
        else:
            state = 'off'
        print('Checkbox was turned', state)

    def on_radio_toggled(self, radio, name):
        if radio.props.active:
            state = 'on'
        else:
            state = 'off'
        print('Radio', name, 'was turned', state)


def on_activate(app):
    win = CheckButtonWindow(application=app)
    win.present()


app = Gtk.Application(application_id='com.example.App')
app.connect('activate', on_activate)

app.run(None)