gtk.switch_

Module for [Switch] class

class Switch SwitchGidBuilder SwitchGidBuilderImpl

Types 3

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

#GtkSwitch 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 #GtkSwitch::state-set for details.

CSS nodes

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.

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

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

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

bool active() @property nothrowGet `active` property. Returns: Whether the #GtkSwitch widget is in its on or off state.

void active(bool propval) @property nothrowSet `active` property. Params: propval = Whether the #GtkSwitch widget is in its on or off state.

bool state() @property nothrowGet `state` property. Returns: The backend state that is controlled by the switch. See #GtkSwitch::state-set for details.

void state(bool propval) @property nothrowSet `state` property. Params: propval = The backend state that is controlled by the switch. See #GtkSwitch::state-set for details.

bool getActive() nothrowGets whether the #GtkSwitch is in its “on” or “off” state. Returns: true if the #GtkSwitch is active, and false otherwise

bool getState() nothrowGets the underlying state of the #GtkSwitch. Returns: the underlying state

void setActive(bool isActive) nothrowChanges the state of sw to the desired one.

void setState(bool state) nothrowSets the underlying state of the #GtkSwitch.

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)

nothrowConnect 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)

nothrowConnect to `StateSet` signal.

Constructors

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

this()Creates a new #GtkSwitch widget. Returns: the newly created #GtkSwitch instance

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

Fluent builder implementation template for gtk.switch_.Switch

Methods

T active(bool propval) nothrowSet `active` property. Params: propval = Whether the #GtkSwitch widget is in its on or off state. Returns: Builder instance for fluent chaining

T state(bool propval) nothrowSet `state` property. Params: propval = The backend state that is controlled by the switch. See #GtkSwitch::state-set for details. Returns: Builder instance for fluent chaining

classSwitchGidBuilder : SwitchGidBuilderImpl!SwitchGidBuilder

Fluent builder for gtk.switch_.Switch

Methods

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