249 lines
11 KiB
Swift
249 lines
11 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.BreakpointBin
|
|
/// A widget that changes layout based on available size.
|
|
///
|
|
/// <picture>
|
|
/// <source srcset="breakpoint-bin-dark.png" media="(prefers-color-scheme: dark)">
|
|
/// <img src="breakpoint-bin.png" alt="breakpoint-bin">
|
|
/// </picture>
|
|
///
|
|
/// `AdwBreakpointBin` provides a way to use breakpoints without [class`Window`],
|
|
/// [class`ApplicationWindow`] or [class`Dialog`]. It can be useful for limiting
|
|
/// breakpoints to a single page and similar purposes. Most applications
|
|
/// shouldn't need it.
|
|
///
|
|
/// `AdwBreakpointBin` is similar to [class`Bin`]. It has one child, set via the
|
|
/// [property`BreakpointBin`:child] property.
|
|
///
|
|
/// When `AdwBreakpointBin` is resized, its child widget can rearrange its layout
|
|
/// at specific thresholds.
|
|
///
|
|
/// The thresholds and layout changes are defined via [class`Breakpoint`] objects.
|
|
/// They can be added using [method`BreakpointBin`.add_breakpoint].
|
|
///
|
|
/// Each breakpoint has a condition, specifying the bin's size and/or aspect
|
|
/// ratio, and setters that automatically set object properties when that
|
|
/// happens. The [signal`Breakpoint`::apply] and [signal`Breakpoint`::unapply] can
|
|
/// be used instead for more complex scenarios.
|
|
///
|
|
/// Breakpoints are only allowed to modify widgets inside the `AdwBreakpointBin`,
|
|
/// but not on the `AdwBreakpointBin` itself or any other widgets.
|
|
///
|
|
/// If multiple breakpoints can be used for the current size, the last one is
|
|
/// always picked. The current breakpoint can be tracked using the
|
|
/// [property`BreakpointBin`:current-breakpoint] property.
|
|
///
|
|
/// If none of the breakpoints can be used, that property will be set to `NULL`,
|
|
/// and the original property values will be used instead.
|
|
///
|
|
/// ## Minimum Size
|
|
///
|
|
/// Adding a breakpoint to `AdwBreakpointBin` will result in it having no minimum
|
|
/// size. The [property`Gtk`.Widget:width-request] and
|
|
/// [property`Gtk`.Widget:height-request] properties must always be set when using
|
|
/// breakpoints, indicating the smallest size you want to support.
|
|
///
|
|
/// The minimum size and breakpoint conditions must be carefully selected so that
|
|
/// the child widget completely fits. If it doesn't, it will overflow and a
|
|
/// warning message will be printed.
|
|
///
|
|
/// When choosing minimum size, consider translations and text scale factor
|
|
/// changes. Make sure to leave enough space for text labels, and enable
|
|
/// ellipsizing or wrapping if they might not fit.
|
|
///
|
|
/// For [class`Gtk`.Label] this can be done via [property`Gtk`.Label:ellipsize], or
|
|
/// via [property`Gtk`.Label:wrap] together with [property`Gtk`.Label:wrap-mode].
|
|
///
|
|
/// For buttons, use [property`Gtk`.Button:can-shrink],
|
|
/// [property`Gtk`.MenuButton:can-shrink], [property`Adw`.SplitButton:can-shrink],
|
|
/// or [property`Adw`.ButtonContent:can-shrink].
|
|
///
|
|
/// ## Example
|
|
///
|
|
/// ```c
|
|
/// GtkWidget *bin, *child;
|
|
/// AdwBreakpoint *breakpoint;
|
|
///
|
|
/// bin = adw_breakpoint_bin_new ();
|
|
/// gtk_widget_set_size_request (bin, 150, 150);
|
|
///
|
|
/// child = gtk_label_new ("Wide");
|
|
/// gtk_label_set_ellipsize (GTK_LABEL (label), PANGO_ELLIPSIZE_END);
|
|
/// gtk_widget_add_css_class (child, "title-1");
|
|
/// adw_breakpoint_bin_set_child (ADW_BREAKPOINT_BIN (bin), child);
|
|
///
|
|
/// breakpoint = adw_breakpoint_new (adw_breakpoint_condition_parse ("max-width: 200px"));
|
|
/// adw_breakpoint_add_setters (breakpoint,
|
|
/// G_OBJECT (child), "label", "Narrow",
|
|
/// NULL);
|
|
/// adw_breakpoint_bin_add_breakpoint (ADW_BREAKPOINT_BIN (bin), breakpoint);
|
|
/// ```
|
|
///
|
|
/// The bin has a single label inside it, displaying "Wide". When the bin's width
|
|
/// is smaller than or equal to 200px, it changes to "Narrow".
|
|
///
|
|
/// ## `AdwBreakpointBin` as `GtkBuildable`
|
|
///
|
|
/// `AdwBreakpointBin` allows adding `AdwBreakpoint` objects as children.
|
|
///
|
|
/// Example of an `AdwBreakpointBin` UI definition:
|
|
///
|
|
/// ```xml
|
|
/// <object class="AdwBreakpointBin">
|
|
/// <property name="width-request">150</property>
|
|
/// <property name="height-request">150</property>
|
|
/// <property name="child">
|
|
/// <object class="GtkLabel" id="child">
|
|
/// <property name="label">Wide</property>
|
|
/// <property name="ellipsize">end</property>
|
|
/// <style>
|
|
/// <class name="title-1"/>
|
|
/// </style>
|
|
/// </object>
|
|
/// </property>
|
|
/// <child>
|
|
/// <object class="AdwBreakpoint">
|
|
/// <condition>max-width: 200px</condition>
|
|
/// <setter object="child" property="label">Narrow</setter>
|
|
/// </object>
|
|
/// </child>
|
|
/// </object>
|
|
/// ```
|
|
///
|
|
/// See [class`Breakpoint`] documentation for details.
|
|
///
|
|
/// A Portico view that mounts a `Adw.BreakpointBin`.
|
|
@MainActor public struct BreakpointBin: View {
|
|
private let make: (MountContext) -> Adw.BreakpointBin
|
|
private var configure: [(Adw.BreakpointBin, MountContext) -> Void] = []
|
|
|
|
public var body: Never { fatalError() }
|
|
|
|
// PorticoGen: generateInits(static) | source: Adw.BreakpointBin.init()
|
|
/// Creates a new `AdwBreakpointBin`.
|
|
///
|
|
/// 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.BreakpointBin() }
|
|
configure.append { w, ctx in
|
|
if let v = Portico.mountSlotChild(child, ctx, onUpdate: { v in w.setChild(child: v) }) { w.setChild(child: v) }
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
extension BreakpointBin: WidgetView {
|
|
public typealias Target = Adw.BreakpointBin
|
|
|
|
@_spi(Portico) public func appending(
|
|
_ step: @escaping (Adw.BreakpointBin, MountContext) -> Void
|
|
) -> Self {
|
|
var c = self
|
|
c.configure.append(step)
|
|
return c
|
|
}
|
|
}
|
|
|
|
@_spi(Portico) extension BreakpointBin: 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.BreakpointBin
|
|
/// Modifiers for `Adw.BreakpointBin`, available on every Portico view whose
|
|
/// backing widget is `Adw.BreakpointBin` or one of its subclasses.
|
|
extension WidgetView where Target: Adw.BreakpointBin {
|
|
// PorticoGen: generateModifierExtension -> generatePropertyModifiers(static) | source: Adw.BreakpointBin.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.BreakpointBin.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.BreakpointBin.setChild(child:), GObject.Object.connectNotify(detail:_:), Adw.BreakpointBin.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.BreakpointBin.setChild(child:), GObject.Object.connectNotify(detail:_:), Adw.BreakpointBin.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.BreakpointBin.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.BreakpointBin.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)
|
|
}
|
|
}
|
|
|
|
}
|