101 lines
3.1 KiB
Swift
101 lines
3.1 KiB
Swift
//
|
|
// Spinner.swift
|
|
// Adwaita
|
|
//
|
|
// Created by auto-generation on 15.08.24.
|
|
//
|
|
|
|
import CAdw
|
|
import LevenshteinTransformations
|
|
|
|
/// A `GtkSpinner` widget displays an icon-size spinning animation.
|
|
///
|
|
/// It is often used as an alternative to a [class@Gtk.ProgressBar]
|
|
/// for displaying indefinite activity, instead of actual progress.
|
|
///
|
|
/// 
|
|
///
|
|
/// To start the animation, use [method@Gtk.Spinner.start], to stop it
|
|
/// use [method@Gtk.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.
|
|
public struct Spinner: AdwaitaWidget {
|
|
|
|
/// Additional update functions for type extensions.
|
|
var updateFunctions: [(ViewStorage, WidgetData, Bool) -> Void] = []
|
|
/// Additional appear functions for type extensions.
|
|
var appearFunctions: [(ViewStorage, WidgetData) -> Void] = []
|
|
|
|
/// The accessible role of the given `GtkAccessible` implementation.
|
|
///
|
|
/// The accessible role cannot be changed once set.
|
|
var accessibleRole: String?
|
|
/// Whether the spinner is spinning
|
|
var spinning: Bool?
|
|
|
|
/// Initialize `Spinner`.
|
|
public init() {
|
|
}
|
|
|
|
/// The view storage.
|
|
/// - Parameters:
|
|
/// - modifiers: Modify views before being updated.
|
|
/// - type: The view render data type.
|
|
/// - Returns: The view storage.
|
|
public func container<Data>(data: WidgetData, type: Data.Type) -> ViewStorage where Data: ViewRenderData {
|
|
let storage = ViewStorage(gtk_spinner_new()?.opaque())
|
|
for function in appearFunctions {
|
|
function(storage, data)
|
|
}
|
|
update(storage, data: data, updateProperties: true, type: type)
|
|
|
|
return storage
|
|
}
|
|
|
|
/// Update the stored content.
|
|
/// - Parameters:
|
|
/// - storage: The storage to update.
|
|
/// - modifiers: Modify views before being updated
|
|
/// - updateProperties: Whether to update the view's properties.
|
|
/// - type: The view render data type.
|
|
public func update<Data>(_ storage: ViewStorage, data: WidgetData, updateProperties: Bool, type: Data.Type) where Data: ViewRenderData {
|
|
storage.modify { widget in
|
|
|
|
if let spinning, updateProperties, (storage.previousState as? Self)?.spinning != spinning {
|
|
gtk_spinner_set_spinning(widget, spinning.cBool)
|
|
}
|
|
|
|
|
|
}
|
|
for function in updateFunctions {
|
|
function(storage, data, updateProperties)
|
|
}
|
|
if updateProperties {
|
|
storage.previousState = self
|
|
}
|
|
}
|
|
|
|
/// The accessible role of the given `GtkAccessible` implementation.
|
|
///
|
|
/// The accessible role cannot be changed once set.
|
|
public func accessibleRole(_ accessibleRole: String?) -> Self {
|
|
var newSelf = self
|
|
newSelf.accessibleRole = accessibleRole
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// Whether the spinner is spinning
|
|
public func spinning(_ spinning: Bool? = true) -> Self {
|
|
var newSelf = self
|
|
newSelf.spinning = spinning
|
|
|
|
return newSelf
|
|
}
|
|
|
|
}
|