// // ActionRow.swift // Adwaita // // Created by auto-generation on 15.08.24. // import CAdw import LevenshteinTransformations /// A [class@Gtk.ListBoxRow] used to present actions. /// /// action-row /// /// The `AdwActionRow` widget can have a title, a subtitle and an icon. The row /// can receive additional widgets at its end, or prefix widgets at its start. /// /// It is convenient to present a preference and its related actions. /// /// `AdwActionRow` is unactivatable by default, giving it an activatable widget /// will automatically make it activatable, but unsetting it won't change the /// row's activatability. /// /// ## AdwActionRow as GtkBuildable /// /// The `AdwActionRow` implementation of the [iface@Gtk.Buildable] interface /// supports adding a child at its end by specifying “suffix” or omitting the /// “type” attribute of a element. /// /// It also supports adding a child as a prefix widget by specifying “prefix” as /// the “type” attribute of a element. /// /// ## CSS nodes /// /// `AdwActionRow` has a main CSS node with name `row`. /// /// It contains the subnode `box.header` for its main horizontal box, and /// `box.title` for the vertical box containing the title and subtitle labels. /// /// It contains subnodes `label.title` and `label.subtitle` representing /// respectively the title label and subtitle label. /// /// `AdwActionRow` can use the /// [`.property`](style-classes.html#property-rows) style class to emphasize /// the row subtitle instead of the row title, which is useful for /// displaying read-only properties. public struct ActionRow: 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 widget to activate when the row is activated. /// /// The row can be activated either by clicking on it, calling /// [method@ActionRow.activate], or via mnemonics in the title. /// See the [property@PreferencesRow:use-underline] property to enable /// mnemonics. /// /// The target widget will be activated by emitting the /// [signal@Gtk.Widget::mnemonic-activate] signal on it. var activatableWidget: (() -> Body)? /// The subtitle for this row. /// /// The subtitle is interpreted as Pango markup unless /// [property@PreferencesRow:use-markup] is set to `FALSE`. var subtitle: String? /// The number of lines at the end of which the subtitle label will be /// ellipsized. /// /// If the value is 0, the number of lines won't be limited. var subtitleLines: Int? /// Whether the user can copy the subtitle from the label. /// /// See also [property@Gtk.Label:selectable]. var subtitleSelectable: Bool? /// The title of the preference represented by this row. /// /// The title is interpreted as Pango markup unless /// [property@PreferencesRow:use-markup] is set to `FALSE`. var title: String? /// The number of lines at the end of which the title label will be ellipsized. /// /// If the value is 0, the number of lines won't be limited. var titleLines: Int? /// Whether the user can copy the title from the label. /// /// See also [property@Gtk.Label:selectable]. var titleSelectable: Bool? /// Whether to use Pango markup for the title label. /// /// Subclasses may also use it for other labels, such as subtitle. /// /// See also [func@Pango.parse_markup]. var useMarkup: Bool? /// Whether an embedded underline in the title indicates a mnemonic. var useUnderline: Bool? /// This signal is emitted after the row has been activated. var activated: (() -> Void)? /// The body for the widget "suffix". var suffix: () -> Body = { [] } /// The body for the widget "prefix". var prefix: () -> Body = { [] } /// Initialize `ActionRow`. public init() { } /// The view storage. /// - Parameters: /// - modifiers: Modify views before being updated. /// - type: The type of the app storage. /// - Returns: The view storage. public func container(data: WidgetData, type: Data.Type) -> ViewStorage where Data: ViewRenderData { let storage = ViewStorage(adw_action_row_new()?.opaque()) for function in appearFunctions { function(storage, data) } update(storage, data: data, updateProperties: true, type: type) if let activatableWidgetStorage = activatableWidget?().storage(data: data, type: type) { storage.content["activatableWidget"] = [activatableWidgetStorage] adw_action_row_set_activatable_widget(storage.opaquePointer?.cast(), activatableWidgetStorage.opaquePointer?.cast()) } var suffixStorage: [ViewStorage] = [] for view in suffix() { suffixStorage.append(view.storage(data: data, type: type)) adw_action_row_add_suffix(storage.opaquePointer?.cast(), suffixStorage.last?.opaquePointer?.cast()) } storage.content["suffix"] = suffixStorage var prefixStorage: [ViewStorage] = [] for view in prefix() { prefixStorage.append(view.storage(data: data, type: type)) adw_action_row_add_prefix(storage.opaquePointer?.cast(), prefixStorage.last?.opaquePointer?.cast()) } storage.content["prefix"] = prefixStorage 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 type of the app storage. public func update(_ storage: ViewStorage, data: WidgetData, updateProperties: Bool, type: Data.Type) where Data: ViewRenderData { if let activated { storage.connectSignal(name: "activated", argCount: 0) { activated() } } storage.modify { widget in if let widget = storage.content["activatableWidget"]?.first { activatableWidget?().updateStorage(widget, data: data, updateProperties: updateProperties, type: type) } if let subtitleLines, updateProperties, (storage.previousState as? Self)?.subtitleLines != subtitleLines { adw_action_row_set_subtitle_lines(widget?.cast(), subtitleLines.cInt) } if let subtitleSelectable, updateProperties, (storage.previousState as? Self)?.subtitleSelectable != subtitleSelectable { adw_action_row_set_subtitle_selectable(widget?.cast(), subtitleSelectable.cBool) } if let titleLines, updateProperties, (storage.previousState as? Self)?.titleLines != titleLines { adw_action_row_set_title_lines(widget?.cast(), titleLines.cInt) } if let titleSelectable, updateProperties, (storage.previousState as? Self)?.titleSelectable != titleSelectable { adw_preferences_row_set_title_selectable(widget?.cast(), titleSelectable.cBool) } if let useMarkup, updateProperties, (storage.previousState as? Self)?.useMarkup != useMarkup { adw_preferences_row_set_use_markup(widget?.cast(), useMarkup.cBool) } if let useUnderline, updateProperties, (storage.previousState as? Self)?.useUnderline != useUnderline { adw_preferences_row_set_use_underline(widget?.cast(), useUnderline.cBool) } if let title, updateProperties, (storage.previousState as? Self)?.title != title { adw_preferences_row_set_title(widget?.cast(), title) } if let subtitle, updateProperties, (storage.previousState as? Self)?.subtitle != subtitle { adw_action_row_set_subtitle(widget?.cast(), subtitle) } if let suffixStorage = storage.content["suffix"] { for (index, view) in suffix().enumerated() { if let storage = suffixStorage[safe: index] { view.updateStorage( storage, data: data, updateProperties: updateProperties, type: type ) } } } if let prefixStorage = storage.content["prefix"] { for (index, view) in prefix().enumerated() { if let storage = prefixStorage[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 widget to activate when the row is activated. /// /// The row can be activated either by clicking on it, calling /// [method@ActionRow.activate], or via mnemonics in the title. /// See the [property@PreferencesRow:use-underline] property to enable /// mnemonics. /// /// The target widget will be activated by emitting the /// [signal@Gtk.Widget::mnemonic-activate] signal on it. public func activatableWidget(@ViewBuilder _ activatableWidget: @escaping (() -> Body)) -> Self { var newSelf = self newSelf.activatableWidget = activatableWidget return newSelf } /// The subtitle for this row. /// /// The subtitle is interpreted as Pango markup unless /// [property@PreferencesRow:use-markup] is set to `FALSE`. public func subtitle(_ subtitle: String?) -> Self { var newSelf = self newSelf.subtitle = subtitle return newSelf } /// The number of lines at the end of which the subtitle label will be /// ellipsized. /// /// If the value is 0, the number of lines won't be limited. public func subtitleLines(_ subtitleLines: Int?) -> Self { var newSelf = self newSelf.subtitleLines = subtitleLines return newSelf } /// Whether the user can copy the subtitle from the label. /// /// See also [property@Gtk.Label:selectable]. public func subtitleSelectable(_ subtitleSelectable: Bool? = true) -> Self { var newSelf = self newSelf.subtitleSelectable = subtitleSelectable return newSelf } /// The title of the preference represented by this row. /// /// The title is interpreted as Pango markup unless /// [property@PreferencesRow:use-markup] is set to `FALSE`. public func title(_ title: String?) -> Self { var newSelf = self newSelf.title = title return newSelf } /// The number of lines at the end of which the title label will be ellipsized. /// /// If the value is 0, the number of lines won't be limited. public func titleLines(_ titleLines: Int?) -> Self { var newSelf = self newSelf.titleLines = titleLines return newSelf } /// Whether the user can copy the title from the label. /// /// See also [property@Gtk.Label:selectable]. public func titleSelectable(_ titleSelectable: Bool? = true) -> Self { var newSelf = self newSelf.titleSelectable = titleSelectable return newSelf } /// Whether to use Pango markup for the title label. /// /// Subclasses may also use it for other labels, such as subtitle. /// /// See also [func@Pango.parse_markup]. public func useMarkup(_ useMarkup: Bool? = true) -> Self { var newSelf = self newSelf.useMarkup = useMarkup return newSelf } /// Whether an embedded underline in the title indicates a mnemonic. public func useUnderline(_ useUnderline: Bool? = true) -> Self { var newSelf = self newSelf.useUnderline = useUnderline return newSelf } /// This signal is emitted after the row has been activated. public func activated(_ activated: @escaping () -> Void) -> Self { var newSelf = self newSelf.activated = activated return newSelf } /// Set the body for "suffix". /// - Parameter body: The body. /// - Returns: The widget. public func suffix(@ViewBuilder _ body: @escaping () -> Body) -> Self { var newSelf = self newSelf.suffix = body return newSelf } /// Set the body for "prefix". /// - Parameter body: The body. /// - Returns: The widget. public func prefix(@ViewBuilder _ body: @escaping () -> Body) -> Self { var newSelf = self newSelf.prefix = body return newSelf } }