SwitchProtocol

public protocol SwitchProtocol : ActionableProtocol

GtkSwitch is a “light switch” that has two states: on or off.

An example GtkSwitch

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 [signalGtkSwitch::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.

The SwitchProtocol protocol exposes the methods and properties of an underlying GtkSwitch instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see Switch. Alternatively, use SwitchRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkSwitch instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • switch_ptr Default implementation

    Typed pointer to the underlying GtkSwitch instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkSwitch instance.

    Declaration

    Swift

    var switch_ptr: UnsafeMutablePointer<GtkSwitch>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to SwitchProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Switch Class

  • Bind a SwitchPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: SwitchPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a Switch property

    Declaration

    Swift

    @inlinable
func get(property: SwitchPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a Switch property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: SwitchPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Switch signals

  • Connect a Swift signal handler to the given, typed SwitchSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: SwitchSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed SwitchSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: SwitchSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub
  • onActivate(flags:handler:) Extension method

    Emitted to animate the switch.

    Applications should never connect to this signal, but use the [propertyGtk.Switch:active] property.

    Note

    This represents the underlying activate signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onActivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: SwitchRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the activate signal is emitted
    Show on GitHub
  • activateSignal Extension method

    Typed activate signal for using the connect(signal:) methods

    Declaration

    Swift

    static var activateSignal: SwitchSignalName { get }
    Show on GitHub
  • onStateSet(flags:handler:) Extension method

    Emitted to change the underlying state.

    The state-set signal is emitted when the user changes the switch position. The default handler keeps the state in sync with the [propertyGtk.Switch:active] property.

    To implement delayed state change, applications can connect to this signal, initiate the change of the underlying state, and call [methodGtk.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 [propertyGtk.Switch`:active] property is represented by the position of the switch.

    Note

    This represents the underlying state-set signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onStateSet(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: SwitchRef, _ state: Bool) -> Bool) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    state

    the new state of the switch
    handler

    true to stop the signal emission Run the given callback whenever the stateSet signal is emitted
    Show on GitHub
  • stateSetSignal Extension method

    Typed state-set signal for using the connect(signal:) methods

    Declaration

    Swift

    static var stateSetSignal: SwitchSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::active signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyActive(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: SwitchRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyActive signal is emitted
    Show on GitHub
  • notifyActiveSignal Extension method

    Typed notify::active signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyActiveSignal: SwitchSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::state signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyState(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: SwitchRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyState signal is emitted
    Show on GitHub
  • notifyStateSignal Extension method

    Typed notify::state signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyStateSignal: SwitchSignalName { get }
    Show on GitHub

Switch Class: SwitchProtocol extension (methods and fields)

  • getActive() Extension method

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

    Declaration

    Swift

    @inlinable
func getActive() -> Bool
    Show on GitHub
  • getState() Extension method

    Gets the underlying state of the GtkSwitch.

    Declaration

    Swift

    @inlinable
func getState() -> Bool
    Show on GitHub
  • setActive(isActive:) Extension method

    Changes the state of self to the desired one.

    Declaration

    Swift

    @inlinable
func setActive(isActive: Bool)
    Show on GitHub
  • set(state:) Extension method

    Sets the underlying state of the GtkSwitch.

    Normally, this is the same as [propertyGtk.Switch:active], unless the switch is set up for delayed state changes. This function is typically called from a [signalGtk.Switch::state-set] signal handler.

    See [signalGtk.Switch::state-set] for details.

    Declaration

    Swift

    @inlinable
func set(state: Bool)
    Show on GitHub
  • active Extension method

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

    Declaration

    Swift

    @inlinable
var active: Bool { get nonmutating set }
    Show on GitHub
  • state Extension method

    The backend state that is controlled by the switch.

    See [signalGtkSwitch::state-set] for details.

    Declaration

    Swift

    @inlinable
var state: Bool { get nonmutating set }
    Show on GitHub