CheckButton

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_check_button_get_type ()" ) ]
public class CheckButton : Widget, Accessible, Actionable, Buildable, ConstraintTarget

Places a label next to an indicator.

A `GtkCheckButton` is created by calling either [ctor@Gtk.CheckButton.new] or [ctor@Gtk.CheckButton.new_with_label].

The state of a `GtkCheckButton` can be set specifically using [method@Gtk.CheckButton.set_active], and retrieved using [ method@Gtk.CheckButton.get_active].

Inconsistent state

In addition to "on" and "off", check buttons 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.

To set a `GtkCheckButton` to inconsistent state, use [method@Gtk.CheckButton.set_inconsistent].

Grouping

Check buttons can be grouped together, to form mutually exclusive groups - only one of the buttons can be toggled at a time, and toggling another one will switch the currently toggled one off.

Grouped check buttons use a different indicator, and are commonly referred to as *radio buttons*.

To add a `GtkCheckButton` to a group, use [method@Gtk.CheckButton.set_group].

When the code must keep track of the state of a group of radio buttons, it is recommended to keep track of such state through a stateful `GAction` with a target for each button. Using the `toggled` signals to keep track of the group changes and state is discouraged.

Shortcuts and Gestures

`GtkCheckButton` supports the following keyboard shortcuts:

<kbd>␣</kbd> or <kbd>Enter</kbd> activates the button.

CSS nodes

``` checkbutton.text-button ├── check ╰── [label] ```

A `GtkCheckButton` has a main node with name checkbutton. If the [property@Gtk.CheckButton:label] or [property@Gtk.CheckButton:child] properties are set, it contains a child widget. The indicator node is named check when no group is set, and radio if the checkbutton is grouped together with other checkbuttons.

Accessibility

`GtkCheckButton` uses the [enum@Gtk.AccessibleRole.checkbox] role.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public bool active { get; set; }
If the check button is active.
public Widget child { get; set; }
The child widget.
public CheckButton group { set; }
The check button whose group this widget belongs to.
public bool inconsistent { get; set; }
If the check button is in an “in between” state.
public string label { get; set; }
Text of the label inside the check button, if it contains a label widget.
public bool use_underline { get; set; }
If set, an underline in the text indicates that the following character is to be used as mnemonic.

Creation methods:

public CheckButton ()
Creates a new `GtkCheckButton`.
public CheckButton.with_label (string? label)
Creates a new `GtkCheckButton` with the given text.
public CheckButton.with_mnemonic (string? label)
Creates a new `GtkCheckButton` with the given text and a mnemonic.

Methods:

public bool get_active ()
Returns whether the check button is active.
public unowned Widget? get_child ()
Gets the child widget of this or `NULL` if [property@CheckButton:label] is set.
public bool get_inconsistent ()
Returns whether the check button is in an inconsistent state.
public unowned string? get_label ()
Returns the label of the check button or `NULL` if [ property@CheckButton:child] is set.
public bool get_use_underline ()
Returns whether underlines in the label indicate mnemonics.
public void set_active (bool setting)
Changes the check buttons active state.
public void set_child (Widget? child)
Sets the child widget of this.
public void set_group (CheckButton? group)
Adds this to the group of group.
public void set_inconsistent (bool inconsistent)
Sets the `GtkCheckButton` to inconsistent state.
public void set_label (string? label)
Sets the text of this.
public void set_use_underline (bool setting)
Sets whether underlines in the label indicate mnemonics.

Signals:

public virtual signal void activate ()
Emitted to when the check button is activated.
public virtual signal void toggled ()
Emitted when the buttons's [property@Gtk.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Actionable

All known members inherited from interface Gtk.Buildable