180 lines
8.1 KiB
Swift
180 lines
8.1 KiB
Swift
// Generated by PorticoGen. DO NOT EDIT. See Sources/PorticoGen to make changes.
|
|
|
|
import Adw
|
|
import Gtk
|
|
import Gio
|
|
import Gdk
|
|
|
|
// PorticoGen: generateStruct | source: Adw.ToastOverlay
|
|
/// A widget showing toasts above its content.
|
|
///
|
|
/// <picture>
|
|
/// <source srcset="toast-overlay-dark.png" media="(prefers-color-scheme: dark)">
|
|
/// <img src="toast-overlay.png" alt="toast-overlay">
|
|
/// </picture>
|
|
///
|
|
/// Much like [class`Gtk`.Overlay], `AdwToastOverlay` is a container with a single
|
|
/// main child, on top of which it can display a [class`Toast`], overlaid.
|
|
/// Toasts can be shown with [method`ToastOverlay`.add_toast].
|
|
///
|
|
/// Use [method`ToastOverlay`.dismiss_all] to dismiss all toasts at once, or
|
|
/// [method`Toast`.dismiss] to dismiss a single toast.
|
|
///
|
|
/// See [class`Toast`] for details.
|
|
///
|
|
/// ## CSS nodes
|
|
///
|
|
/// ```
|
|
/// toastoverlay
|
|
/// ├── [child]
|
|
/// ├── toast
|
|
/// ┊ ├── widget
|
|
/// ┊ │ ├── [label.heading]
|
|
/// │ ╰── [custom title]
|
|
/// ├── [button]
|
|
/// ╰── button.circular.flat
|
|
/// ```
|
|
///
|
|
/// `AdwToastOverlay`'s CSS node is called `toastoverlay`. It contains the child,
|
|
/// as well as zero or more `toast` subnodes.
|
|
///
|
|
/// Each of the `toast` nodes contains a `widget` subnode, optionally a `button`
|
|
/// subnode, and another `button` subnode with `.circular` and `.flat` style
|
|
/// classes.
|
|
///
|
|
/// The `widget` subnode contains a `label` subnode with the `.heading` style
|
|
/// class, or a custom widget provided by the application.
|
|
///
|
|
/// ## Accessibility
|
|
///
|
|
/// `AdwToastOverlay` uses the [enum`Gtk`.AccessibleRole.group] role.
|
|
///
|
|
/// A Portico view that mounts a `Adw.ToastOverlay`.
|
|
@MainActor public struct ToastOverlay: View {
|
|
private let make: (MountContext) -> Adw.ToastOverlay
|
|
private var configure: [(Adw.ToastOverlay, MountContext) -> Void] = []
|
|
|
|
public var body: Never { fatalError() }
|
|
|
|
// PorticoGen: generateInits(static) | source: Adw.ToastOverlay.init()
|
|
/// Creates a new `AdwToastOverlay`.
|
|
///
|
|
/// Applied once at mount; use the `Binding` or closure overload for values that change.
|
|
/// Each closure is evaluated once; children are added in order and slot closures mount their first view.
|
|
/// An empty closure adds no children and leaves slots unset.
|
|
/// Optional value parameters are applied only when non-`nil`; a `nil` argument leaves the widget's own default in place and cannot clear a nullable property - use the matching modifier for that.
|
|
///
|
|
/// - Parameter child: A `ViewBuilder` closure whose first view is mounted into the `child` slot.
|
|
public init(@ViewBuilder child: @escaping () -> [AnyView] = { [] }) {
|
|
make = { _ in Adw.ToastOverlay() }
|
|
configure.append { w, ctx in
|
|
if let v = Portico.mountSlotChild(child, ctx, onUpdate: { v in w.setChild(child: v) }) { w.setChild(child: v) }
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
extension ToastOverlay: WidgetView {
|
|
public typealias Target = Adw.ToastOverlay
|
|
|
|
@_spi(Portico) public func appending(
|
|
_ step: @escaping (Adw.ToastOverlay, MountContext) -> Void
|
|
) -> Self {
|
|
var c = self
|
|
c.configure.append(step)
|
|
return c
|
|
}
|
|
}
|
|
|
|
@_spi(Portico) extension ToastOverlay: Mountable {
|
|
@_spi(Portico) public func mount(_ ctx: MountContext) -> Gtk.Widget {
|
|
let w = make(ctx)
|
|
for step in configure { step(w, ctx) }
|
|
return w
|
|
}
|
|
}
|
|
|
|
// PorticoGen: generateModifierExtension | source: Adw.ToastOverlay
|
|
/// Modifiers for `Adw.ToastOverlay`, available on every Portico view whose
|
|
/// backing widget is `Adw.ToastOverlay` or one of its subclasses.
|
|
extension WidgetView where Target: Adw.ToastOverlay {
|
|
// PorticoGen: generateModifierExtension -> generatePropertyModifiers(static) | source: Adw.ToastOverlay.setChild(child:)
|
|
/// Sets the child widget of `self`.
|
|
///
|
|
/// Applied once at mount; use the `Binding` or closure overload for a value that changes.
|
|
///
|
|
/// - Parameter child: The child widget.
|
|
/// - Returns: A copy of this view with the modifier applied.
|
|
public func child(_ child: Adw.Widget?) -> Self {
|
|
appending { w, _ in
|
|
w.setChild(child: child)
|
|
}
|
|
}
|
|
|
|
// PorticoGen: generateModifierExtension -> generatePropertyModifiers(viewBuilder) | source: Adw.ToastOverlay.setChild(child:)
|
|
/// Sets the child widget of `self`.
|
|
///
|
|
/// The closure is evaluated once when the modifier is applied. Its first view is mounted into the slot.
|
|
/// Additional views are ignored; an empty closure leaves the slot unset.
|
|
///
|
|
/// - Parameter child: The child widget.
|
|
/// - Returns: A copy of this view with the modifier applied.
|
|
public func child(@ViewBuilder _ child: () -> [AnyView]) -> Self {
|
|
let childViews = child()
|
|
return appending { w, ctx in
|
|
guard let v = childViews.first else { return }
|
|
w.setChild(child: v.makeWidget(ctx))
|
|
}
|
|
}
|
|
// PorticoGen: generateModifierExtension -> generatePropertyModifiers -> bindingModifier(twoWay) | source: Adw.ToastOverlay.setChild(child:), GObject.Object.connectNotify(detail:_:), Adw.ToastOverlay.getChild()
|
|
/// Sets the child widget of `self`.
|
|
///
|
|
/// Applied at mount and re-applied on every change the binding publishes.
|
|
/// When `Adw.Widget?` conforms to `Equatable` this binds in both directions: the widget's `notify` signal writes its current value back into the binding, so changes made in the UI propagate to the bound state. Each direction compares before writing, which terminates the echo after one hop. A value type that is not `Equatable` binds one way only, because the echo cannot be broken.
|
|
///
|
|
/// - Returns: A copy of this view with the modifier applied.
|
|
public func child<W: Gtk.Widget>(_ child: Portico.Binding<W?>) -> Self {
|
|
appending { w, ctx in
|
|
Portico.bindProperty(
|
|
w, child, registry: ctx.registry, notifyDetail: "child",
|
|
read: { [w] in w.getChild() as? W },
|
|
write: { [w] v in w.setChild(child: v) }
|
|
)
|
|
}
|
|
}
|
|
|
|
// PorticoGen: generateModifierExtension -> generatePropertyModifiers -> bindingModifier(lifted,twoWay) | source: Adw.ToastOverlay.setChild(child:), GObject.Object.connectNotify(detail:_:), Adw.ToastOverlay.getChild()
|
|
/// Sets the child widget of `self`.
|
|
///
|
|
/// Applied at mount and re-applied on every change the binding publishes.
|
|
/// `Binding` is invariant, so a `Binding<Adw.Widget>` is not accepted by the nullable overload; this one takes it and promotes each value. Pass a `Binding<Adw.Widget?>` to be able to clear the property.
|
|
/// When `Adw.Widget` conforms to `Equatable` this binds in both directions: the widget's `notify` signal writes its current value back into the binding, so changes made in the UI propagate to the bound state. Each direction compares before writing, which terminates the echo after one hop. A value type that is not `Equatable` binds one way only, because the echo cannot be broken.
|
|
/// A `nil` widget value is never written back into the binding.
|
|
///
|
|
/// - Returns: A copy of this view with the modifier applied.
|
|
public func child<W: Gtk.Widget>(_ child: Portico.Binding<W>) -> Self {
|
|
appending { w, ctx in
|
|
Portico.bindProperty(
|
|
w, child, registry: ctx.registry, notifyDetail: "child",
|
|
read: { [w] in w.getChild() as? W },
|
|
write: { [w] v in w.setChild(child: v) }
|
|
)
|
|
}
|
|
}
|
|
|
|
// PorticoGen: generateModifierExtension -> generatePropertyModifiers(closure) | source: Adw.ToastOverlay.setChild(child:)
|
|
/// Sets the child widget of `self`.
|
|
///
|
|
/// The closure runs inside a `DependencyTracker`, so any `@State` it reads re-runs it and pushes the new value through `Adw.ToastOverlay.setChild(child:)`.
|
|
///
|
|
/// - Parameter child: The child widget.
|
|
/// - Returns: A copy of this view with the modifier applied.
|
|
public func child(_ child: @escaping () -> Adw.Widget?) -> Self {
|
|
appending { w, ctx in
|
|
let tracker = DependencyTracker { [w] in w.setChild(child: child()) }
|
|
tracker.run()
|
|
ctx.registry.add(tracker)
|
|
}
|
|
}
|
|
|
|
}
|