//
// HeaderBar.swift
// Adwaita
//
// Created by auto-generation on 30.12.25.
//
import CAdw
import LevenshteinTransformations
/// A title bar widget.
///
///
///
/// `AdwHeaderBar` is similar to `Gtk.HeaderBar`, but provides additional
/// features compared to it. Refer to `GtkHeaderBar` for details. It is typically
/// used as a top bar within `ToolbarView`.
///
///
public struct HeaderBar: 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 decoration layout for buttons.
///
/// If this property is not set, the
/// ``gtkDecorationLayout(_:)`` setting is used.
///
/// The format of the string is button names, separated by commas. A colon
/// separates the buttons that should appear at the start from those at the
/// end. Recognized button names are minimize, maximize, close and icon (the
/// window icon).
///
/// For example, “icon:minimize,maximize,close” specifies an icon at the start,
/// and minimize, maximize and close buttons at the end.
var decorationLayout: String?
/// Whether the header bar can show the back button.
///
/// The back button will never be shown unless the header bar is placed inside an
/// `NavigationView`. Usually, there is no reason to set this to `false`.
var showBackButton: Bool?
/// Whether to show title buttons at the end of the header bar.
///
/// See ``showStartTitleButtons(_:)`` for the other side.
///
/// Which buttons are actually shown and where is determined by the
/// ``decorationLayout(_:)`` property, and by the state of the
/// window (e.g. a close button will not be shown if the window can't be
/// closed).
var showEndTitleButtons: Bool?
/// Whether to show title buttons at the start of the header bar.
///
/// See ``showEndTitleButtons(_:)`` for the other side.
///
/// Which buttons are actually shown and where is determined by the
/// ``decorationLayout(_:)`` property, and by the state of the
/// window (e.g. a close button will not be shown if the window can't be
/// closed).
var showStartTitleButtons: Bool?
/// Whether the title widget should be shown.
var showTitle: Bool?
/// The title widget to display.
///
/// When set to `NULL`, the header bar will display the title of the window it
/// is contained in.
///
/// To use a different title, use `WindowTitle`:
///
/// ```xml
///
/// ```
var titleWidget: Body?
/// The body for the widget "start".
var start: () -> Body = { [] }
/// The body for the widget "end".
var end: () -> Body = { [] }
/// Initialize `HeaderBar`.
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: WidgetData, type: Data.Type) -> ViewStorage where Data: ViewRenderData {
let storage = ViewStorage(adw_header_bar_new()?.opaque())
for function in appearFunctions {
function(storage, data)
}
update(storage, data: data, updateProperties: true, type: type)
if let titleWidgetStorage = titleWidget?.storage(data: data, type: type) {
storage.content["titleWidget"] = [titleWidgetStorage]
adw_header_bar_set_title_widget(storage.opaquePointer, titleWidgetStorage.opaquePointer?.cast())
}
var startStorage: [ViewStorage] = []
for view in start() {
startStorage.append(view.storage(data: data, type: type))
adw_header_bar_pack_start(storage.opaquePointer, startStorage.last?.opaquePointer?.cast())
}
storage.content["start"] = startStorage
var endStorage: [ViewStorage] = []
for view in end() {
endStorage.append(view.storage(data: data, type: type))
adw_header_bar_pack_end(storage.opaquePointer, endStorage.last?.opaquePointer?.cast())
}
storage.content["end"] = endStorage
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
if let decorationLayout, updateProperties, (storage.previousState as? Self)?.decorationLayout != decorationLayout {
adw_header_bar_set_decoration_layout(widget, decorationLayout)
}
if let showBackButton, updateProperties, (storage.previousState as? Self)?.showBackButton != showBackButton {
adw_header_bar_set_show_back_button(widget, showBackButton.cBool)
}
if let showEndTitleButtons, updateProperties, (storage.previousState as? Self)?.showEndTitleButtons != showEndTitleButtons {
adw_header_bar_set_show_end_title_buttons(widget, showEndTitleButtons.cBool)
}
if let showStartTitleButtons, updateProperties, (storage.previousState as? Self)?.showStartTitleButtons != showStartTitleButtons {
adw_header_bar_set_show_start_title_buttons(widget, showStartTitleButtons.cBool)
}
if let showTitle, updateProperties, (storage.previousState as? Self)?.showTitle != showTitle {
adw_header_bar_set_show_title(widget, showTitle.cBool)
}
if let widget = storage.content["titleWidget"]?.first {
titleWidget?.updateStorage(widget, data: data, updateProperties: updateProperties, type: type)
}
if let startStorage = storage.content["start"] {
for (index, view) in start().enumerated() {
if let storage = startStorage[safe: index] {
view.updateStorage(
storage,
data: data,
updateProperties: updateProperties,
type: type
)
}
}
}
if let endStorage = storage.content["end"] {
for (index, view) in end().enumerated() {
if let storage = endStorage[safe: index] {
view.updateStorage(
storage,
data: data,
updateProperties: updateProperties,
type: type
)
}
}
}
}
for function in updateFunctions {
function(storage, data, updateProperties)
}
if updateProperties {
storage.previousState = self
}
}
/// The decoration layout for buttons.
///
/// If this property is not set, the
/// ``gtkDecorationLayout(_:)`` setting is used.
///
/// The format of the string is button names, separated by commas. A colon
/// separates the buttons that should appear at the start from those at the
/// end. Recognized button names are minimize, maximize, close and icon (the
/// window icon).
///
/// For example, “icon:minimize,maximize,close” specifies an icon at the start,
/// and minimize, maximize and close buttons at the end.
public func decorationLayout(_ decorationLayout: String?) -> Self {
modify { $0.decorationLayout = decorationLayout }
}
/// Whether the header bar can show the back button.
///
/// The back button will never be shown unless the header bar is placed inside an
/// `NavigationView`. Usually, there is no reason to set this to `false`.
public func showBackButton(_ showBackButton: Bool? = true) -> Self {
modify { $0.showBackButton = showBackButton }
}
/// Whether to show title buttons at the end of the header bar.
///
/// See ``showStartTitleButtons(_:)`` for the other side.
///
/// Which buttons are actually shown and where is determined by the
/// ``decorationLayout(_:)`` property, and by the state of the
/// window (e.g. a close button will not be shown if the window can't be
/// closed).
public func showEndTitleButtons(_ showEndTitleButtons: Bool? = true) -> Self {
modify { $0.showEndTitleButtons = showEndTitleButtons }
}
/// Whether to show title buttons at the start of the header bar.
///
/// See ``showEndTitleButtons(_:)`` for the other side.
///
/// Which buttons are actually shown and where is determined by the
/// ``decorationLayout(_:)`` property, and by the state of the
/// window (e.g. a close button will not be shown if the window can't be
/// closed).
public func showStartTitleButtons(_ showStartTitleButtons: Bool? = true) -> Self {
modify { $0.showStartTitleButtons = showStartTitleButtons }
}
/// Whether the title widget should be shown.
public func showTitle(_ showTitle: Bool? = true) -> Self {
modify { $0.showTitle = showTitle }
}
/// The title widget to display.
///
/// When set to `NULL`, the header bar will display the title of the window it
/// is contained in.
///
/// To use a different title, use `WindowTitle`:
///
/// ```xml
///
/// ```
public func titleWidget(@ViewBuilder _ titleWidget: () -> Body) -> Self {
modify { $0.titleWidget = titleWidget() }
}
/// Set the body for "start".
/// - Parameter body: The body.
/// - Returns: The widget.
public func start(@ViewBuilder _ body: @escaping () -> Body) -> Self {
var newSelf = self
newSelf.start = body
return newSelf
}
/// Set the body for "end".
/// - Parameter body: The body.
/// - Returns: The widget.
public func end(@ViewBuilder _ body: @escaping () -> Body) -> Self {
var newSelf = self
newSelf.end = body
return newSelf
}
}