GI.Atk.Objects.Hyperlink

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.

Exported types

newtype Hyperlink

Constructors

Hyperlink (ManagedPtr Hyperlink)

Instances

GObject Hyperlink

Methods

gobjectType :: Hyperlink -> IO GType

IsObject Hyperlink

IsHyperlink Hyperlink

IsAction Hyperlink

class GObject o => IsHyperlink o

Instances

(GObject a, UnknownAncestorError Constraint Hyperlink a) => IsHyperlink a

IsHyperlink Hyperlink

toHyperlink :: (MonadIO m, IsHyperlink o) => o -> m Hyperlink

noHyperlink :: Maybe Hyperlink

Methods

getEndIndex

hyperlinkGetEndIndex

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)

=> a

link_: an Hyperlink

-> m Int32

Returns: the index with the hypertext document at which this link ends

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

getNAnchors

hyperlinkGetNAnchors

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)

=> a

link_: an Hyperlink

-> m Int32

Returns: the number of anchors associated with this hyperlink

Gets the number of anchors associated with this hyperlink.

getObject

hyperlinkGetObject

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)

=> a

link_: an Hyperlink

-> Int32

i: a (zero-index) integer specifying the desired anchor

-> m Object

Returns: an Object associated with this hyperlinks i-th anchor

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

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

getStartIndex

hyperlinkGetStartIndex

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)

=> a

link_: an Hyperlink

-> m Int32

Returns: the index with the hypertext document at which this link begins

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

getUri

hyperlinkGetUri

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)

=> a

link_: an Hyperlink

-> Int32

i: a (zero-index) integer specifying the desired anchor

-> m Text

Returns: a string specifying the URI

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

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

isInline

hyperlinkIsInline

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)

=> a

link_: an Hyperlink

-> m Bool

Returns: whether or not this link displays its content inline.

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.

isSelectedLink

hyperlinkIsSelectedLink

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)

=> a

link_: an Hyperlink

-> m Bool

Returns: True if the AtkHyperlink is selected, False otherwise

Deprecated: (Since version 1.8)Please use ATK_STATE_FOCUSABLE for all links,and ATK_STATE_FOCUSED for focused links.

Determines whether this AtkHyperlink is selected

Since: 1.4

isValid

hyperlinkIsValid

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)

=> a

link_: an Hyperlink

-> m Bool

Returns: whether or not this link is still valid

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.

Properties

endIndex

getHyperlinkEndIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32

numberOfAnchors

getHyperlinkNumberOfAnchors :: (MonadIO m, IsHyperlink o) => o -> m Int32

selectedLink

getHyperlinkSelectedLink :: (MonadIO m, IsHyperlink o) => o -> m Bool

startIndex

getHyperlinkStartIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32

Signals

linkActivated

type C_HyperlinkLinkActivatedCallback = Ptr () -> Ptr () -> IO ()

type HyperlinkLinkActivatedCallback = IO ()

afterHyperlinkLinkActivated :: (IsHyperlink a, MonadIO m) => a -> HyperlinkLinkActivatedCallback -> m SignalHandlerId

genClosure_HyperlinkLinkActivated :: HyperlinkLinkActivatedCallback -> IO Closure

mk_HyperlinkLinkActivatedCallback :: C_HyperlinkLinkActivatedCallback -> IO (FunPtr C_HyperlinkLinkActivatedCallback)

noHyperlinkLinkActivatedCallback :: Maybe HyperlinkLinkActivatedCallback

onHyperlinkLinkActivated :: (IsHyperlink a, MonadIO m) => a -> HyperlinkLinkActivatedCallback -> m SignalHandlerId

wrap_HyperlinkLinkActivatedCallback :: HyperlinkLinkActivatedCallback -> Ptr () -> Ptr () -> IO ()