CSS nodes

1
2

switch
╰── slider

GtkSwitch has two css nodes, the main node with the name switch and a subnode named slider. Neither of them is using any style classes.

gtk_switch_new ()

GtkWidget *
gtk_switch_new (void);

Creates a new GtkSwitch widget.

Since: 3.0

gtk_switch_set_active ()

void
gtk_switch_set_active (GtkSwitch *sw,
                       gboolean is_active);

Changes the state of sw to the desired one.

Since: 3.0

gtk_switch_get_active ()

gboolean
gtk_switch_get_active (GtkSwitch *sw);

Gets whether the GtkSwitch is in its “on” or “off” state.

Since: 3.0

gtk_switch_set_state ()

void
gtk_switch_set_state (GtkSwitch *sw,
                      gboolean state);

Sets the underlying state of the GtkSwitch.

Normally, this is the same as “active”, unless the switch is set up for delayed state changes. This function is typically called from a “state-set” signal handler.

See “state-set” for details.

Since: 3.14

gtk_switch_get_state ()

gboolean
gtk_switch_get_state (GtkSwitch *sw);

Gets the underlying state of the GtkSwitch.

Since: 3.14

struct GtkSwitch

struct GtkSwitch;

The GtkSwitch contains private data and it should only be accessed using the provided API.

struct GtkSwitchClass

struct GtkSwitchClass {
  GtkWidgetClass parent_class;

  void (* activate) (GtkSwitch *sw);

  gboolean (* state_set) (GtkSwitch *sw, gboolean state);
};

The “active” property

  “active”                   gboolean

Whether the GtkSwitch widget is in its on or off state.

Owner: GtkSwitch

Flags: Read / Write

Default value: FALSE

The “state” property

  “state”                    gboolean

The backend state that is controlled by the switch. See “state-set” for details.

Owner: GtkSwitch

Flags: Read / Write

Default value: FALSE

Since: 3.14

The “slider-height” style property

  “slider-height”            int

The minimum height of the GtkSwitch handle, in pixels.

Owner: GtkSwitch

Flags: Read

Allowed values: >= 22

Default value: 22

Since: 3.18

The “slider-width” style property

  “slider-width”             int

The minimum width of the GtkSwitch handle, in pixels.

Owner: GtkSwitch

Flags: Read

Allowed values: >= 36

Default value: 36

The “activate” signal

void
user_function (GtkSwitch *widget,
               gpointer   user_data)

The ::activate signal on GtkSwitch is an action signal and emitting it causes the switch to animate. Applications should never connect to this signal, but use the notify::active signal.

Flags: Action

The “state-set” signal

gboolean
user_function (GtkSwitch *widget,
               gboolean   state,
               gpointer   user_data)

The ::state-set signal on GtkSwitch is emitted to change the underlying state. It is emitted when the user changes the switch position. The default handler keeps the state in sync with the “active” property.

To implement delayed state change, applications can connect to this signal, initiate the change of the underlying state, and call gtk_switch_set_state() when the underlying state change is complete. The signal handler should return TRUE to prevent the default handler from running.

Visually, the underlying state is represented by the trough color of the switch, while the “active” property is represented by the position of the switch.

Flags: Run Last

Since: 3.14