CSS nodes

1
2

switch
╰── slider

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

ctk_switch_new ()

CtkWidget *
ctk_switch_new (void);

Creates a new CtkSwitch widget.

Since: 3.0

ctk_switch_set_active ()

void
ctk_switch_set_active (CtkSwitch *sw,
                       gboolean is_active);

Changes the state of sw to the desired one.

Since: 3.0

ctk_switch_get_active ()

gboolean
ctk_switch_get_active (CtkSwitch *sw);

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

Since: 3.0

ctk_switch_set_state ()

void
ctk_switch_set_state (CtkSwitch *sw,
                      gboolean state);

Sets the underlying state of the CtkSwitch.

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

ctk_switch_get_state ()

gboolean
ctk_switch_get_state (CtkSwitch *sw);

Gets the underlying state of the CtkSwitch.

Since: 3.14

struct CtkSwitch

struct CtkSwitch;

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

struct CtkSwitchClass

struct CtkSwitchClass {
  CtkWidgetClass parent_class;

  void (* activate) (CtkSwitch *sw);

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

The “active” property

  “active”                   gboolean

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

Owner: CtkSwitch

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: CtkSwitch

Flags: Read / Write

Default value: FALSE

Since: 3.14

The “activate” signal

void
user_function (CtkSwitch *widget,
               gpointer   user_data)

The ::activate signal on CtkSwitch 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 (CtkSwitch *widget,
               gboolean   state,
               gpointer   user_data)

The ::state-set signal on CtkSwitch 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 ctk_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