279 lines
9.7 KiB
Swift
279 lines
9.7 KiB
Swift
//
|
|
// LinkButton.swift
|
|
// Adwaita
|
|
//
|
|
// Created by auto-generation on 15.08.24.
|
|
//
|
|
|
|
import CAdw
|
|
import LevenshteinTransformations
|
|
|
|
/// A `GtkLinkButton` is a button with a hyperlink.
|
|
///
|
|
/// 
|
|
///
|
|
/// It is useful to show quick links to resources.
|
|
///
|
|
/// A link button is created by calling either [ctor@Gtk.LinkButton.new] or
|
|
/// [ctor@Gtk.LinkButton.new_with_label]. If using the former, the URI you
|
|
/// pass to the constructor is used as a label for the widget.
|
|
///
|
|
/// The URI bound to a `GtkLinkButton` can be set specifically using
|
|
/// [method@Gtk.LinkButton.set_uri].
|
|
///
|
|
/// By default, `GtkLinkButton` calls [method@Gtk.FileLauncher.launch] when the button
|
|
/// is clicked. This behaviour can be overridden by connecting to the
|
|
/// [signal@Gtk.LinkButton::activate-link] signal and returning %TRUE from
|
|
/// the signal handler.
|
|
///
|
|
/// # CSS nodes
|
|
///
|
|
/// `GtkLinkButton` has a single CSS node with name button. To differentiate
|
|
/// it from a plain `GtkButton`, it gets the .link style class.
|
|
///
|
|
/// # Accessibility
|
|
///
|
|
/// `GtkLinkButton` uses the %GTK_ACCESSIBLE_ROLE_LINK role.
|
|
public struct LinkButton: 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 accessible role of the given `GtkAccessible` implementation.
|
|
///
|
|
/// The accessible role cannot be changed once set.
|
|
var accessibleRole: String?
|
|
/// action-name
|
|
var actionName: String?
|
|
/// Whether the size of the button can be made smaller than the natural
|
|
/// size of its contents.
|
|
///
|
|
/// For text buttons, setting this property will allow ellipsizing the label.
|
|
///
|
|
/// If the contents of a button are an icon or a custom widget, setting this
|
|
/// property has no effect.
|
|
var canShrink: Bool?
|
|
/// The child widget.
|
|
var child: (() -> Body)?
|
|
/// Whether the button has a frame.
|
|
var hasFrame: Bool?
|
|
/// The name of the icon used to automatically populate the button.
|
|
var iconName: String?
|
|
/// Text of the label inside the button, if the button contains a label widget.
|
|
var label: String?
|
|
/// The URI bound to this button.
|
|
var uri: String
|
|
/// If set, an underline in the text indicates that the following character is
|
|
/// to be used as mnemonic.
|
|
var useUnderline: Bool?
|
|
/// The 'visited' state of this button.
|
|
///
|
|
/// A visited link is drawn in a different color.
|
|
var visited: Bool?
|
|
/// Emitted to animate press then release.
|
|
///
|
|
/// This is an action signal. Applications should never connect
|
|
/// to this signal, but use the [signal@Gtk.Button::clicked] signal.
|
|
///
|
|
/// The default bindings for this signal are all forms of the
|
|
/// <kbd>␣</kbd> and <kbd>Enter</kbd> keys.
|
|
var activate: (() -> Void)?
|
|
/// Emitted when the button has been activated (pressed and released).
|
|
var clicked: (() -> Void)?
|
|
|
|
/// Initialize `LinkButton`.
|
|
public init(uri: String) {
|
|
self.uri = uri
|
|
}
|
|
|
|
/// The view storage.
|
|
/// - Parameters:
|
|
/// - modifiers: Modify views before being updated.
|
|
/// - type: The view render data type.
|
|
/// - Returns: The view storage.
|
|
public func container<Data>(data: WidgetData, type: Data.Type) -> ViewStorage where Data: ViewRenderData {
|
|
let storage = ViewStorage(gtk_link_button_new(uri)?.opaque())
|
|
for function in appearFunctions {
|
|
function(storage, data)
|
|
}
|
|
update(storage, data: data, updateProperties: true, type: type)
|
|
if let childStorage = child?().storage(data: data, type: type) {
|
|
storage.content["child"] = [childStorage]
|
|
gtk_button_set_child(storage.opaquePointer?.cast(), childStorage.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<Data>(_ storage: ViewStorage, data: WidgetData, updateProperties: Bool, type: Data.Type) where Data: ViewRenderData {
|
|
if let activate {
|
|
storage.connectSignal(name: "activate", argCount: 0) {
|
|
activate()
|
|
}
|
|
}
|
|
if let clicked {
|
|
storage.connectSignal(name: "clicked", argCount: 0) {
|
|
clicked()
|
|
}
|
|
}
|
|
storage.modify { widget in
|
|
|
|
if let actionName, updateProperties, (storage.previousState as? Self)?.actionName != actionName {
|
|
gtk_actionable_set_action_name(widget, actionName)
|
|
}
|
|
if let canShrink, updateProperties, (storage.previousState as? Self)?.canShrink != canShrink {
|
|
gtk_button_set_can_shrink(widget?.cast(), canShrink.cBool)
|
|
}
|
|
if let widget = storage.content["child"]?.first {
|
|
child?().updateStorage(widget, data: data, updateProperties: updateProperties, type: type)
|
|
}
|
|
if let hasFrame, updateProperties, (storage.previousState as? Self)?.hasFrame != hasFrame {
|
|
gtk_button_set_has_frame(widget?.cast(), hasFrame.cBool)
|
|
}
|
|
if let iconName, updateProperties, (storage.previousState as? Self)?.iconName != iconName {
|
|
gtk_button_set_icon_name(widget?.cast(), iconName)
|
|
}
|
|
if let label, storage.content["child"] == nil, updateProperties, (storage.previousState as? Self)?.label != label {
|
|
gtk_button_set_label(widget?.cast(), label)
|
|
}
|
|
if updateProperties, (storage.previousState as? Self)?.uri != uri {
|
|
gtk_link_button_set_uri(widget, uri)
|
|
}
|
|
if let useUnderline, updateProperties, (storage.previousState as? Self)?.useUnderline != useUnderline {
|
|
gtk_button_set_use_underline(widget?.cast(), useUnderline.cBool)
|
|
}
|
|
if let visited, updateProperties, (storage.previousState as? Self)?.visited != visited {
|
|
gtk_link_button_set_visited(widget, visited.cBool)
|
|
}
|
|
|
|
|
|
}
|
|
for function in updateFunctions {
|
|
function(storage, data, updateProperties)
|
|
}
|
|
if updateProperties {
|
|
storage.previousState = self
|
|
}
|
|
}
|
|
|
|
/// The accessible role of the given `GtkAccessible` implementation.
|
|
///
|
|
/// The accessible role cannot be changed once set.
|
|
public func accessibleRole(_ accessibleRole: String?) -> Self {
|
|
var newSelf = self
|
|
newSelf.accessibleRole = accessibleRole
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// action-name
|
|
public func actionName(_ actionName: String?) -> Self {
|
|
var newSelf = self
|
|
newSelf.actionName = actionName
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// Whether the size of the button can be made smaller than the natural
|
|
/// size of its contents.
|
|
///
|
|
/// For text buttons, setting this property will allow ellipsizing the label.
|
|
///
|
|
/// If the contents of a button are an icon or a custom widget, setting this
|
|
/// property has no effect.
|
|
public func canShrink(_ canShrink: Bool? = true) -> Self {
|
|
var newSelf = self
|
|
newSelf.canShrink = canShrink
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// The child widget.
|
|
public func child(@ViewBuilder _ child: @escaping (() -> Body)) -> Self {
|
|
var newSelf = self
|
|
newSelf.child = child
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// Whether the button has a frame.
|
|
public func hasFrame(_ hasFrame: Bool? = true) -> Self {
|
|
var newSelf = self
|
|
newSelf.hasFrame = hasFrame
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// The name of the icon used to automatically populate the button.
|
|
public func iconName(_ iconName: String?) -> Self {
|
|
var newSelf = self
|
|
newSelf.iconName = iconName
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// Text of the label inside the button, if the button contains a label widget.
|
|
public func label(_ label: String?) -> Self {
|
|
var newSelf = self
|
|
newSelf.label = label
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// The URI bound to this button.
|
|
public func uri(_ uri: String) -> Self {
|
|
var newSelf = self
|
|
newSelf.uri = uri
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// If set, an underline in the text indicates that the following character is
|
|
/// to be used as mnemonic.
|
|
public func useUnderline(_ useUnderline: Bool? = true) -> Self {
|
|
var newSelf = self
|
|
newSelf.useUnderline = useUnderline
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// The 'visited' state of this button.
|
|
///
|
|
/// A visited link is drawn in a different color.
|
|
public func visited(_ visited: Bool? = true) -> Self {
|
|
var newSelf = self
|
|
newSelf.visited = visited
|
|
|
|
return newSelf
|
|
}
|
|
|
|
/// Emitted to animate press then release.
|
|
///
|
|
/// This is an action signal. Applications should never connect
|
|
/// to this signal, but use the [signal@Gtk.Button::clicked] signal.
|
|
///
|
|
/// The default bindings for this signal are all forms of the
|
|
/// <kbd>␣</kbd> and <kbd>Enter</kbd> keys.
|
|
public func activate(_ activate: @escaping () -> Void) -> Self {
|
|
var newSelf = self
|
|
newSelf.activate = activate
|
|
return newSelf
|
|
}
|
|
|
|
/// Emitted when the button has been activated (pressed and released).
|
|
public func clicked(_ clicked: @escaping () -> Void) -> Self {
|
|
var newSelf = self
|
|
newSelf.clicked = clicked
|
|
return newSelf
|
|
}
|
|
|
|
}
|