Switch

Object Hierarchy:

Object hierarchy for Switch

Description:

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

Switch is a widget that has two states: on or off.

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

GtkSwitch can also handle situations where the underlying state changes with a delay. See state_set for details.

CSS nodes

switch
├── label
├── label
╰── slider
ur css nodes, the main node with the name switch and subnodes for the slider and the on and off labels. Neither of them is using any style classes.

Accessibility

GtkSwitch uses the SWITCH role.


Namespace: Gtk
Package: gtk4

Content:

Properties:

  • public bool active { get; set; }
    Whether the Switch 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 Switch widget.

Methods:

  • public bool get_active ()
    Gets whether the Switch is in its “on” or “off” state.
  • public bool get_state ()
    Gets the underlying state of the Switch.
  • 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 Switch.

Signals:

  • public signal void activate ()
    The activate signal on GtkSwitch is an action signal and emitting it causes the switch to animate.
  • public signal bool state_set (bool state)
    The state_set signal on GtkSwitch is 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