HyperlinkProtocol

public protocol HyperlinkProtocol : ActionProtocol, ObjectProtocol

An ATK object which encapsulates a link or set of links (for instance in the case of client-side image maps) in a hypertext document. It may implement the AtkAction interface. AtkHyperlink may also be used to refer to inline embedded content, since it allows specification of a start and end offset within the host AtkHypertext object.

The HyperlinkProtocol protocol exposes the methods and properties of an underlying AtkHyperlink 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 Hyperlink. Alternatively, use HyperlinkRef 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 AtkHyperlink instance.

    Declaration

    Swift

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

    Typed pointer to the underlying AtkHyperlink instance.

    Default Implementation

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

    Declaration

    Swift

    var hyperlink_ptr: UnsafeMutablePointer<AtkHyperlink>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to HyperlinkProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Hyperlink Class

  • Bind a HyperlinkPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: HyperlinkPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a Hyperlink property

    Declaration

    Swift

    @inlinable
func get(property: HyperlinkPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a Hyperlink property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: HyperlinkPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Hyperlink signals

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

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: HyperlinkSignalName, 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 HyperlinkSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: HyperlinkSignalName, 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 signal link-activated is emitted when a link is activated.

    Note

    This represents the underlying link-activated signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

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

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

    Declaration

    Swift

    static var linkActivatedSignal: HyperlinkSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::end-index signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyEndIndex(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: HyperlinkRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

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

    Typed notify::end-index signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyEndIndexSignal: HyperlinkSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::number-of-anchors signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyNumberOfAnchors(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: HyperlinkRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

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

    Typed notify::number-of-anchors signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyNumberOfAnchorsSignal: HyperlinkSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::selected-link signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifySelectedLink(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: HyperlinkRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

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

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

    Declaration

    Swift

    static var notifySelectedLinkSignal: HyperlinkSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::start-index signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyStartIndex(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: HyperlinkRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

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

    Typed notify::start-index signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyStartIndexSignal: HyperlinkSignalName { get }
    Show on GitHub

Hyperlink Class: HyperlinkProtocol extension (methods and fields)

  • getEndIndex() Extension method

    Gets the index with the hypertext document at which this link ends.

    Declaration

    Swift

    @inlinable
func getEndIndex() -> Int
    Show on GitHub
  • getNAnchors() Extension method

    Gets the number of anchors associated with this hyperlink.

    Declaration

    Swift

    @inlinable
func getNAnchors() -> Int
    Show on GitHub
  • getObject(i:) Extension method

    Returns the item associated with this hyperlinks nth anchor. For instance, the returned AtkObject will implement AtkText if link_ is a text hyperlink, AtkImage if link_ is an image hyperlink etc.

    Multiple anchors are primarily used by client-side image maps.

    Declaration

    Swift

    @inlinable
func getObject(i: Int) -> Atk.ObjectRef!
    Show on GitHub
  • getStartIndex() Extension method

    Gets the index with the hypertext document at which this link begins.

    Declaration

    Swift

    @inlinable
func getStartIndex() -> Int
    Show on GitHub
  • getUri(i:) Extension method

    Get a the URI associated with the anchor specified by i of link_.

    Multiple anchors are primarily used by client-side image maps.

    Declaration

    Swift

    @inlinable
func getUri(i: Int) -> String!
    Show on GitHub
  • endIndex Extension method

    Gets the index with the hypertext document at which this link ends.

    Declaration

    Swift

    @inlinable
var endIndex: Int { get }
    Show on GitHub
  • isInline Extension method

    Indicates whether the link currently displays some or all of its content inline. Ordinary HTML links will usually return false, but an inline <src> HTML element will return true.

    Declaration

    Swift

    @inlinable
var isInline: Bool { get }
    Show on GitHub
  • isSelectedLink Extension method

    Determines whether this AtkHyperlink is selected

    is_selected_link is deprecated: Please use ATK_STATE_FOCUSABLE for all links, and ATK_STATE_FOCUSED for focused links.

    Declaration

    Swift

    @inlinable
var isSelectedLink: Bool { get }
    Show on GitHub
  • isValid Extension method

    Since the document that a link is associated with may have changed this method returns true if the link is still valid (with respect to the document it references) and false otherwise.

    Declaration

    Swift

    @inlinable
var isValid: Bool { get }
    Show on GitHub
  • nAnchors Extension method

    Gets the number of anchors associated with this hyperlink.

    Declaration

    Swift

    @inlinable
var nAnchors: Int { get }
    Show on GitHub
  • startIndex Extension method

    Gets the index with the hypertext document at which this link begins.

    Declaration

    Swift

    @inlinable
var startIndex: Int { get }
    Show on GitHub
  • parent Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parent: GObject { get }
    Show on GitHub