HypertextProtocol

public protocol HypertextProtocol

An interface used for objects which implement linking between multiple resource or content locations, or multiple ‘markers’ within a single document. A Hypertext instance is associated with one or more Hyperlinks, which are associated with particular offsets within the Hypertext’s included content. While this interface is derived from Text, there is no requirement that Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets.

The HypertextProtocol protocol exposes the methods and properties of an underlying AtkHypertext instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see Hypertext. Alternatively, use HypertextRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying AtkHypertext instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • hypertext_ptr Default implementation

    Typed pointer to the underlying AtkHypertext instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the AtkHypertext instance.

    Declaration

    Swift

    var hypertext_ptr: UnsafeMutablePointer<AtkHypertext>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to HypertextProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Hypertext signals

  • Connect a Swift signal handler to the given, typed HypertextSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: HypertextSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed HypertextSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: HypertextSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • The “link-selected” signal is emitted by an AtkHyperText object when one of the hyperlinks associated with the object is selected.

    Note

    This represents the underlying link-selected signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onLinkSelected(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: HypertextRef, _ arg1: Int) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    arg1

    the index of the hyperlink which is selected
    handler

    The signal handler to call Run the given callback whenever the linkSelected signal is emitted
    Show on GitHub
  • linkSelectedSignal Extension method

    Typed link-selected signal for using the connect(signal:) methods

    Declaration

    Swift

    static var linkSelectedSignal: HypertextSignalName { get }
    Show on GitHub

Hypertext Interface: HypertextProtocol extension (methods and fields)

  • getLink(linkIndex:) Extension method

    Gets the link in this hypertext document at index link_index

    Declaration

    Swift

    @inlinable
func getLink(linkIndex: Int) -> Atk.HyperlinkRef!
    Show on GitHub
  • getLinkIndex(charIndex:) Extension method

    Gets the index into the array of hyperlinks that is associated with the character specified by char_index.

    Declaration

    Swift

    @inlinable
func getLinkIndex(charIndex: Int) -> Int
    Show on GitHub
  • getNLinks() Extension method

    Gets the number of links within this hypertext document.

    Declaration

    Swift

    @inlinable
func getNLinks() -> Int
    Show on GitHub
  • nLinks Extension method

    Gets the number of links within this hypertext document.

    Declaration

    Swift

    @inlinable
var nLinks: Int { get }
    Show on GitHub