Gtk.CheckButton
Description: Reference for Gtk.CheckButton

### Class

# GtkCheckButton

#### Description [src]

    class Gtk.CheckButton : Gtk.Widget {
      parent_instance: GtkWidget
    }

A `GtkCheckButton` places a label next to an indicator.

A `GtkCheckButton` is created by calling either `gtk_check_button_new()` or `gtk_check_button_new_with_label()`.

The state of a `GtkCheckButton` can be set specifically using `gtk_check_button_set_active()`, and retrieved using `gtk_check_button_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 `gtk_check_button_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 `gtk_check_button_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.

# CSS nodes

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

A `GtkCheckButton` has a main node with name checkbutton. If the `GtkCheckButton:label` or `GtkCheckButton: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 `GTK_ACCESSIBLE_ROLE_CHECKBOX` role.

#### Hierarchy

#### Ancestors

- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GtkAccessible
- GtkActionable
- GtkBuildable
- GtkConstraintTarget

#### Constructors

###### gtk_check_button_new

Creates a new `GtkCheckButton`.

###### gtk_check_button_new_with_label

Creates a new `GtkCheckButton` with the given text.

###### gtk_check_button_new_with_mnemonic

Creates a new `GtkCheckButton` with the given text and a mnemonic.

#### Instance methods

###### gtk_check_button_get_active

Returns whether the check button is active.

###### gtk_check_button_get_child

Gets the child widget of `button` or `NULL` if `GtkCheckButton:label` is set.

since: 4.8

###### gtk_check_button_get_inconsistent

Returns whether the check button is in an inconsistent state.

###### gtk_check_button_get_label

Returns the label of the check button or `NULL` if `GtkCheckButton:child` is set.

###### gtk_check_button_get_use_underline

Returns whether underlines in the label indicate mnemonics.

###### gtk_check_button_set_active

Changes the check buttons active state.

###### gtk_check_button_set_child

Sets the child widget of `button`.

since: 4.8

###### gtk_check_button_set_group

Adds `self` to the group of `group`.

###### gtk_check_button_set_inconsistent

Sets the `GtkCheckButton` to inconsistent state.

###### gtk_check_button_set_label

Sets the text of `self`.

###### gtk_check_button_set_use_underline

Sets whether underlines in the label indicate mnemonics.

##### Methods inherited from GtkWidget (161)

Please see GtkWidget for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GtkAccessible (16)

###### gtk_accessible_get_accessible_parent

Retrieves the accessible accessible for an accessible object.

unstable since: 4.10

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

###### gtk_accessible_get_at_context

Retrieves the `GtkATContext` for the given `GtkAccessible`.

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

unstable since: 4.10

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

unstable since: 4.10

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

unstable since: 4.10

###### gtk_accessible_get_platform_state

Query a platform state, such as focus.

unstable since: 4.10

###### gtk_accessible_reset_property

Resets the accessible `property` to its default value.

###### gtk_accessible_reset_relation

Resets the accessible `relation` to its default value.

###### gtk_accessible_reset_state

Resets the accessible `state` to its default value.

###### gtk_accessible_update_property

Updates a list of accessible properties.

###### gtk_accessible_update_property_value

Updates an array of accessible properties.

###### gtk_accessible_update_relation

Updates a list of accessible relations.

###### gtk_accessible_update_relation_value

Updates an array of accessible relations.

###### gtk_accessible_update_state

Updates a list of accessible states. See the `GtkAccessibleState` documentation for the value types of accessible states.

###### gtk_accessible_update_state_value

Updates an array of accessible states.

##### Methods inherited from GtkActionable (6)

###### gtk_actionable_get_action_name

Gets the action name for `actionable`.

###### gtk_actionable_get_action_target_value

Gets the current target value of `actionable`.

###### gtk_actionable_set_action_name

Specifies the name of the action with which this widget should be associated.

###### gtk_actionable_set_action_target

Sets the target of an actionable widget.

###### gtk_actionable_set_action_target_value

Sets the target value of an actionable widget.

###### gtk_actionable_set_detailed_action_name

Sets the action-name and associated string target value of an actionable widget.

##### Methods inherited from GtkBuildable (1)

###### gtk_buildable_get_buildable_id

Gets the ID of the `buildable` object.

#### Properties

###### Gtk.CheckButton:active

If the check button is active.

###### Gtk.CheckButton:child

The child widget.

since: 4.8

###### Gtk.CheckButton:group

The check button whose group this widget belongs to.

###### Gtk.CheckButton:inconsistent

If the check button is in an “in between” state.

###### Gtk.CheckButton:label

Text of the label inside the check button, if it contains a label widget.

###### Gtk.CheckButton:use-underline

If set, an underline in the text indicates that the following character is to be used as mnemonic.

##### Properties inherited from GtkWidget (34)

###### Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

###### Gtk.Widget:can-target

Whether the widget can receive pointer events.

###### Gtk.Widget:css-classes

A list of css classes applied to this widget.

###### Gtk.Widget:css-name

The name of this widget in the CSS tree.

###### Gtk.Widget:cursor

The cursor used by `widget`.

###### Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

###### Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

###### Gtk.Widget:has-default

Whether the widget is the default widget.

###### Gtk.Widget:has-focus

Whether the widget has the input focus.

###### Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on `widget`.

###### Gtk.Widget:height-request

Override for height request of the widget.

###### Gtk.Widget:hexpand

Whether to expand horizontally.

###### Gtk.Widget:hexpand-set

Whether to use the `hexpand` property.

###### Gtk.Widget:layout-manager

The `GtkLayoutManager` instance to use to compute the preferred size of the widget, and allocate its children.

###### Gtk.Widget:margin-bottom

Margin on bottom side of widget.

###### Gtk.Widget:margin-end

Margin on end of widget, horizontally.

###### Gtk.Widget:margin-start

Margin on start of widget, horizontally.

###### Gtk.Widget:margin-top

Margin on top side of widget.

###### Gtk.Widget:name

The name of the widget.

###### Gtk.Widget:opacity

The requested opacity of the widget.

###### Gtk.Widget:overflow

How content outside the widget’s content area is treated.

###### Gtk.Widget:parent

The parent widget of this widget.

###### Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

###### Gtk.Widget:root

The `GtkRoot` widget of the widget tree containing this widget.

###### Gtk.Widget:scale-factor

The scale factor of the widget.

###### Gtk.Widget:sensitive

Whether the widget responds to input.

###### Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

###### Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

###### Gtk.Widget:vexpand

Whether to expand vertically.

###### Gtk.Widget:vexpand-set

Whether to use the `vexpand` property.

###### Gtk.Widget:visible

Whether the widget is visible.

###### Gtk.Widget:width-request

Override for width request of the widget.

##### Properties inherited from GtkAccessible (1)

###### GtkAccessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

##### Properties inherited from GtkActionable (2)

###### GtkActionable:action-name

No description available.

###### GtkActionable:action-target

No description available.

#### Signals

###### Gtk.CheckButton::activate

Emitted to when the check button is activated.

since: 4.2

###### Gtk.CheckButton::toggled

Emitted when the buttons’s `GtkCheckButton:active` property changes.

##### Signals inherited from GtkWidget (13)

###### GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

###### GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

###### GtkWidget::hide

Emitted when `widget` is hidden.

###### GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

###### GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

###### GtkWidget::move-focus

Emitted when the focus is moved.

###### GtkWidget::query-tooltip

Emitted when the widgets tooltip is about to be shown.

###### GtkWidget::realize

Emitted when `widget` is associated with a `GdkSurface`.

###### GtkWidget::show

Emitted when `widget` is shown.

###### GtkWidget::state-flags-changed

Emitted when the widget state changes.

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

###### GtkWidget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct GtkCheckButtonClass {
      GtkWidgetClass parent_class;
      void (* toggled) (
        GtkCheckButton* check_button
      );
      void (* activate) (
        GtkCheckButton* check_button
      );

    }

No description available.

###### Class members

`parent_class: GtkWidgetClass`
  No description available.
`toggled: void (* toggled) ( GtkCheckButton* check_button )`
  No description available.
`activate: void (* activate) ( GtkCheckButton* check_button )`
  No description available.

#### Virtual methods

###### Gtk.CheckButtonClass.activate

No description available.

###### Gtk.CheckButtonClass.toggled

No description available.