Switch

Object Hierarchy:

Gtk.Switch Gtk.Switch Gtk.Switch Gtk.Widget Gtk.Widget Gtk.Widget->Gtk.Switch GLib.InitiallyUnowned GLib.InitiallyUnowned GLib.InitiallyUnowned->Gtk.Widget GLib.Object GLib.Object GLib.Object->GLib.InitiallyUnowned Gtk.Accessible Gtk.Accessible Gtk.Accessible->Gtk.Switch Gtk.Accessible->Gtk.Widget Gtk.Buildable Gtk.Buildable Gtk.Buildable->Gtk.Switch Gtk.Buildable->Gtk.Widget Gtk.ConstraintTarget Gtk.ConstraintTarget Gtk.ConstraintTarget->Gtk.Switch Gtk.ConstraintTarget->Gtk.Widget Gtk.Actionable Gtk.Actionable Gtk.Actionable->Gtk.Switch

Description:

[ CCode ( type_id = "gtk_switch_get_type ()" ) ]
public sealed class Switch : Widget, Accessible, Actionable, Buildable, ConstraintTarget

Shows a "light switch" that has two states: on or off.

<picture> <source srcset="switch-dark.png" media="(prefers-color-scheme: dark)"> <img alt="An example GtkSwitch" src="switch.png"> </picture>

The user can control which state should be active by clicking the empty area, or by dragging the slider.

`GtkSwitch` can also express situations where the underlying state changes with a delay. In this case, the slider position indicates the user's recent change (represented by the [property@Gtk.Switch:active] property), while the trough color indicates the present underlying state ( represented by the [property@Gtk.Switch:state] property).

<picture> <source srcset="switch-state-dark.png" media="(prefers-color-scheme: dark)"> <img alt="GtkSwitch with delayed state change" src="switch-state.png"> </picture>

See [signal@Gtk.Switch:GtkSwitch:state-set] for details.

Shortcuts and Gestures

`GtkSwitch` supports pan and drag gestures to move the slider.

CSS nodes

``` switch ├── image ├── image ╰── slider ```

`GtkSwitch` has four css nodes, the main node with the name switch and subnodes for the slider and the on and off images. Neither of them is using any style classes.

Accessibility

`GtkSwitch` uses the [enum@Gtk.AccessibleRole.switch] role.


Namespace: Gtk
Package: gtk4

Content:

Properties:

  • public bool active { get; set; }
    Whether the `GtkSwitch` widget is in its on or off state.
  • public bool state { get; set; }
    The backend state that is controlled by the switch.

Creation methods:

  • public Switch ()
    Creates a new `GtkSwitch` widget.

Methods:

  • public bool get_active ()
    Gets whether the `GtkSwitch` is in its “on” or “off” state.
  • public bool get_state ()
    Gets the underlying state of the `GtkSwitch`.
  • public void set_active (bool is_active)
    Changes the state of this to the desired one.
  • public void set_state (bool state)
    Sets the underlying state of the `GtkSwitch`.

Signals:

  • public signal void activate ()
    Emitted to animate the switch.
  • public signal bool state_set (bool state)
    Emitted to change the underlying state.

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