//
// OverlaySplitView.swift
// Adwaita
//
// Created by auto-generation on 04.11.25.
//
import CAdw
import LevenshteinTransformations
/// A widget presenting sidebar and content side by side or as an overlay.
///
///
///
/// `AdwOverlaySplitView` has two children: sidebar and content, and displays
/// them side by side.
///
/// When ``collapsed(_:)`` is set to `true`, the sidebar is
/// instead shown as an overlay above the content widget.
///
/// The sidebar can be hidden or shown using the
/// ``showSidebar(_:)`` property.
///
/// Sidebar can be displayed before or after the content, this can be controlled
/// with the ``sidebarPosition(_:)`` property.
///
/// Collapsing the split view automatically hides the sidebar widget, and
/// uncollapsing it shows the sidebar. If this behavior is not desired, the
/// ``pinSidebar(_:)`` property can be used to override it.
///
/// `AdwOverlaySplitView` supports an edge swipe gesture for showing the sidebar,
/// and a swipe from the sidebar for hiding it. Gestures are only supported on
/// touchscreen, but not touchpad. Gestures can be controlled with the
/// ``enableShowGesture(_:)`` and
/// ``enableHideGesture(_:)`` properties.
///
/// See also `NavigationSplitView`.
///
/// `AdwOverlaySplitView` is typically used together with an `Breakpoint`
/// setting the `collapsed` property to `true` on small widths, as follows:
///
/// ```xml
///
/// ```
///
/// `AdwOverlaySplitView` is often used for implementing the
/// [utility pane](https://developer.gnome.org/hig/patterns/containers/utility-panes.html)
/// pattern.
///
///
public struct OverlaySplitView: AdwaitaWidget {
/// Additional update functions for type extensions.
var updateFunctions: [(ViewStorage, WidgetData, Bool) -> Void] = []
/// Additional appear functions for type extensions.
var appearFunctions: [(ViewStorage, WidgetData) -> Void] = []
/// Whether the split view is collapsed.
///
/// When collapsed, the sidebar widget is presented as an overlay above the
/// content widget, otherwise they are displayed side by side.
var collapsed: Bool?
/// The content widget.
var content: Body?
/// Whether the sidebar can be closed with a swipe gesture.
///
/// Only touchscreen swipes are supported.
var enableHideGesture: Bool?
/// Whether the sidebar can be opened with an edge swipe gesture.
///
/// Only touchscreen swipes are supported.
var enableShowGesture: Bool?
/// The maximum sidebar width.
///
/// Maximum width is affected by
/// ``sidebarWidthUnit(_:)``.
///
/// The sidebar widget can still be allocated with larger width if its own
/// minimum width exceeds it.
var maxSidebarWidth: Double?
/// The minimum sidebar width.
///
/// Minimum width is affected by
/// ``sidebarWidthUnit(_:)``.
///
/// The sidebar widget can still be allocated with larger width if its own
/// minimum width exceeds it.
var minSidebarWidth: Double?
/// Whether the sidebar widget is pinned.
///
/// By default, collapsing @self automatically hides the sidebar widget, and
/// uncollapsing it shows the sidebar. If set to `true`, sidebar visibility
/// never changes on its own.
var pinSidebar: Bool?
/// Whether the sidebar widget is shown.
var showSidebar: Binding?
/// The sidebar widget.
var sidebar: Body?
/// The preferred sidebar width as a fraction of the total width.
///
/// The preferred width is additionally limited by
/// ``minSidebarWidth(_:)`` and
/// ``maxSidebarWidth(_:)``.
///
/// The sidebar widget can be allocated with larger width if its own minimum
/// width exceeds the preferred width.
var sidebarWidthFraction: Double?
/// Initialize `OverlaySplitView`.
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: WidgetData, type: Data.Type) -> ViewStorage where Data: ViewRenderData {
let storage = ViewStorage(adw_overlay_split_view_new()?.opaque())
for function in appearFunctions {
function(storage, data)
}
update(storage, data: data, updateProperties: true, type: type)
if let contentStorage = content?.storage(data: data, type: type) {
storage.content["content"] = [contentStorage]
adw_overlay_split_view_set_content(storage.opaquePointer, contentStorage.opaquePointer?.cast())
}
if let sidebarStorage = sidebar?.storage(data: data, type: type) {
storage.content["sidebar"] = [sidebarStorage]
adw_overlay_split_view_set_sidebar(storage.opaquePointer, sidebarStorage.opaquePointer?.cast())
}
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(_ storage: ViewStorage, data: WidgetData, updateProperties: Bool, type: Data.Type) where Data: ViewRenderData {
storage.modify { widget in
storage.notify(name: "show-sidebar") {
let newValue = adw_overlay_split_view_get_show_sidebar(storage.opaquePointer) != 0
if let showSidebar, newValue != showSidebar.wrappedValue {
showSidebar.wrappedValue = newValue
}
}
if let collapsed, updateProperties, (storage.previousState as? Self)?.collapsed != collapsed {
adw_overlay_split_view_set_collapsed(widget, collapsed.cBool)
}
if let widget = storage.content["content"]?.first {
content?.updateStorage(widget, data: data, updateProperties: updateProperties, type: type)
}
if let enableHideGesture, updateProperties, (storage.previousState as? Self)?.enableHideGesture != enableHideGesture {
adw_overlay_split_view_set_enable_hide_gesture(widget, enableHideGesture.cBool)
}
if let enableShowGesture, updateProperties, (storage.previousState as? Self)?.enableShowGesture != enableShowGesture {
adw_overlay_split_view_set_enable_show_gesture(widget, enableShowGesture.cBool)
}
if let maxSidebarWidth, updateProperties, (storage.previousState as? Self)?.maxSidebarWidth != maxSidebarWidth {
adw_overlay_split_view_set_max_sidebar_width(widget, maxSidebarWidth)
}
if let minSidebarWidth, updateProperties, (storage.previousState as? Self)?.minSidebarWidth != minSidebarWidth {
adw_overlay_split_view_set_min_sidebar_width(widget, minSidebarWidth)
}
if let pinSidebar, updateProperties, (storage.previousState as? Self)?.pinSidebar != pinSidebar {
adw_overlay_split_view_set_pin_sidebar(widget, pinSidebar.cBool)
}
if let showSidebar, updateProperties, (adw_overlay_split_view_get_show_sidebar(storage.opaquePointer) != 0) != showSidebar.wrappedValue {
adw_overlay_split_view_set_show_sidebar(storage.opaquePointer, showSidebar.wrappedValue.cBool)
}
if let widget = storage.content["sidebar"]?.first {
sidebar?.updateStorage(widget, data: data, updateProperties: updateProperties, type: type)
}
if let sidebarWidthFraction, updateProperties, (storage.previousState as? Self)?.sidebarWidthFraction != sidebarWidthFraction {
adw_overlay_split_view_set_sidebar_width_fraction(widget, sidebarWidthFraction)
}
}
for function in updateFunctions {
function(storage, data, updateProperties)
}
if updateProperties {
storage.previousState = self
}
}
/// Whether the split view is collapsed.
///
/// When collapsed, the sidebar widget is presented as an overlay above the
/// content widget, otherwise they are displayed side by side.
public func collapsed(_ collapsed: Bool? = true) -> Self {
modify { $0.collapsed = collapsed }
}
/// The content widget.
public func content(@ViewBuilder _ content: () -> Body) -> Self {
modify { $0.content = content() }
}
/// Whether the sidebar can be closed with a swipe gesture.
///
/// Only touchscreen swipes are supported.
public func enableHideGesture(_ enableHideGesture: Bool? = true) -> Self {
modify { $0.enableHideGesture = enableHideGesture }
}
/// Whether the sidebar can be opened with an edge swipe gesture.
///
/// Only touchscreen swipes are supported.
public func enableShowGesture(_ enableShowGesture: Bool? = true) -> Self {
modify { $0.enableShowGesture = enableShowGesture }
}
/// The maximum sidebar width.
///
/// Maximum width is affected by
/// ``sidebarWidthUnit(_:)``.
///
/// The sidebar widget can still be allocated with larger width if its own
/// minimum width exceeds it.
public func maxSidebarWidth(_ maxSidebarWidth: Double?) -> Self {
modify { $0.maxSidebarWidth = maxSidebarWidth }
}
/// The minimum sidebar width.
///
/// Minimum width is affected by
/// ``sidebarWidthUnit(_:)``.
///
/// The sidebar widget can still be allocated with larger width if its own
/// minimum width exceeds it.
public func minSidebarWidth(_ minSidebarWidth: Double?) -> Self {
modify { $0.minSidebarWidth = minSidebarWidth }
}
/// Whether the sidebar widget is pinned.
///
/// By default, collapsing @self automatically hides the sidebar widget, and
/// uncollapsing it shows the sidebar. If set to `true`, sidebar visibility
/// never changes on its own.
public func pinSidebar(_ pinSidebar: Bool? = true) -> Self {
modify { $0.pinSidebar = pinSidebar }
}
/// Whether the sidebar widget is shown.
public func showSidebar(_ showSidebar: Binding?) -> Self {
modify { $0.showSidebar = showSidebar }
}
/// The sidebar widget.
public func sidebar(@ViewBuilder _ sidebar: () -> Body) -> Self {
modify { $0.sidebar = sidebar() }
}
/// The preferred sidebar width as a fraction of the total width.
///
/// The preferred width is additionally limited by
/// ``minSidebarWidth(_:)`` and
/// ``maxSidebarWidth(_:)``.
///
/// The sidebar widget can be allocated with larger width if its own minimum
/// width exceeds the preferred width.
public func sidebarWidthFraction(_ sidebarWidthFraction: Double?) -> Self {
modify { $0.sidebarWidthFraction = sidebarWidthFraction }
}
}