SpinnerProtocol

public protocol SpinnerProtocol : WidgetProtocol

A GtkSpinner widget displays an icon-size spinning animation.

It is often used as an alternative to a [classGtk.ProgressBar] for displaying indefinite activity, instead of actual progress.

An example GtkSpinner

To start the animation, use [methodGtk.Spinner.start], to stop it use [methodGtk.Spinner.stop].

CSS nodes

GtkSpinner has a single CSS node with the name spinner. When the animation is active, the :checked pseudoclass is added to this node.

The SpinnerProtocol protocol exposes the methods and properties of an underlying GtkSpinner 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 Spinner. Alternatively, use SpinnerRef 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 GtkSpinner instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkSpinner instance.

    Default Implementation

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

    Declaration

    Swift

    var spinner_ptr: UnsafeMutablePointer<GtkSpinner>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to SpinnerProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Spinner Class

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

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: SpinnerPropertyName, 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 Spinner property

    Declaration

    Swift

    @inlinable
func get(property: SpinnerPropertyName) -> 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 Spinner property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Spinner Class: SpinnerProtocol extension (methods and fields)

  • getSpinning() Extension method

    Returns whether the spinner is spinning.

    Declaration

    Swift

    @inlinable
func getSpinning() -> Bool
    Show on GitHub
  • set(spinning:) Extension method

    Sets the activity of the spinner.

    Declaration

    Swift

    @inlinable
func set(spinning: Bool)
    Show on GitHub
  • start() Extension method

    Starts the animation of the spinner.

    Declaration

    Swift

    @inlinable
func start()
    Show on GitHub
  • stop() Extension method

    Stops the animation of the spinner.

    Declaration

    Swift

    @inlinable
func stop()
    Show on GitHub
  • spinning Extension method

    Whether the spinner is spinning

    Declaration

    Swift

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