gtk.switch_

Module for Switch class

class Switch SwitchGidBuilder SwitchGidBuilderImpl

Types 3

classSwitch : gtk.widget.Widget, gtk.actionable.Actionable

gtk.switch_.Switch is a "light switch" 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.

gtk.switch_.Switch can also handle situations where the underlying state changes with a delay. In this case, the slider position indicates the user's recent change (as indicated by the gtk.switch_.Switch.active property), and the color indicates whether the underlying state (represented by the gtk.switch_.Switch.state property) has been updated yet.

!GtkSwitch with delayed state change

See gtk.switch_.Switch.stateSet for details.

CSS nodes

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

gtk.switch_.Switch 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

gtk.switch_.Switch uses the gtk.types.AccessibleRole.Switch role.

Methods

GType _getGType()

GType _gType() @property

Switch self()Returns `this`, for use in `with` statements.

SwitchGidBuilder builder()Get builder for [gtk.switch_.Switch] Returns: New builder object

bool active() @propertyGet `active` property. Returns: Whether the [gtk.switch_.Switch] widget is in its on or off state.

void active(bool propval) @propertySet `active` property. Params: propval = Whether the [gtk.switch_.Switch] widget is in its on or off state.

bool state() @propertyGet `state` property. Returns: The backend state that is controlled by the switch.

void state(bool propval) @propertySet `state` property. Params: propval = The backend state that is controlled by the switch.

bool getActive()Gets whether the [gtk.switch_.Switch] is in its “on” or “off” state. Returns: true if the [gtk.switch_.Switch] is active, and false otherwise

bool getState()Gets the underlying state of the [gtk.switch_.Switch]. Returns: the underlying state

void setActive(bool isActive)Changes the state of self to the desired one.

void setState(bool state)Sets the underlying state of the [gtk.switch_.Switch].

gulong connectActivate(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.switch_.Switch)))
   &&  Parameters!T.length <  2)

Connect to `Activate` signal.

gulong connectStateSet(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  bool)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  bool)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  gtk.switch_.Switch)))
   &&  Parameters!T.length <  3)

Connect to `StateSet` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new [gtk.switch_.Switch] widget. Returns: the newly created [gtk.switch_.Switch] instance

classSwitchGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T, gtk.actionable.ActionableGidBuilderImpl!T

Fluent builder implementation template for gtk.switch_.Switch

Methods

T active(bool propval)Set `active` property. Params: propval = Whether the [gtk.switch_.Switch] widget is in its on or off state. Returns: Builder instance for fluent chaining

T state(bool propval)Set `state` property. Params: propval = The backend state that is controlled by the switch.

classSwitchGidBuilder : SwitchGidBuilderImpl!SwitchGidBuilder

Fluent builder for gtk.switch_.Switch

Methods

Switch build()Create object from builder. Returns: New object