Object Hierarchy:

Description:

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

`GtkSwitch` is a "light switch" that has two states: on or off.

![An example GtkSwitch](switch.png)

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 [signal@GtkSwitch:GtkSwitch:state-set] for details.

CSS nodes

``` switch ├── label ├── label ╰── slider ```

`GtkSwitch` has four 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 gtk_accessible_role_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 GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref