// // PreferencesRow.swift // Adwaita // // Created by auto-generation on 15.08.24. // import CAdw import LevenshteinTransformations /// A [class@Gtk.ListBoxRow] used to present preferences. /// /// The `AdwPreferencesRow` widget has a title that [class@PreferencesDialog] /// will use to let the user look for a preference. It doesn't present the title /// in any way and lets you present the preference as you please. /// /// [class@ActionRow] and its derivatives are convenient to use as preference /// rows as they take care of presenting the preference's title while letting you /// compose the inputs of the preference around it. public struct PreferencesRow: 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 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? /// 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? /// Initialize `PreferencesRow`. 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_preferences_row_new()?.opaque()) for function in appearFunctions { function(storage, data) } update(storage, data: data, updateProperties: true, type: type) 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 title, updateProperties, (storage.previousState as? Self)?.title != title { adw_preferences_row_set_title(widget?.cast(), title) } 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) } } for function in updateFunctions { function(storage, data, updateProperties) } if updateProperties { storage.previousState = self } } /// 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 } /// 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 } }