GI.Atk.Interfaces.Hypertext

The ATK interface which provides standard mechanism for manipulating hyperlinks.

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.

Exported types

newtype Hypertext

Memory-managed wrapper type.

Constructors

Hypertext (ManagedPtr Hypertext)

Instances

Eq Hypertext

Defined in GI.Atk.Interfaces.Hypertext

Methods

(==) :: Hypertext -> Hypertext -> Bool

(/=) :: Hypertext -> Hypertext -> Bool

GObject Hypertext

Defined in GI.Atk.Interfaces.Hypertext

ManagedPtrNewtype Hypertext

Defined in GI.Atk.Interfaces.Hypertext

Methods

toManagedPtr :: Hypertext -> ManagedPtr Hypertext

TypedObject Hypertext

Defined in GI.Atk.Interfaces.Hypertext

Methods

glibType :: IO GType

HasParentTypes Hypertext

Defined in GI.Atk.Interfaces.Hypertext

IsGValue (Maybe Hypertext)

Convert Hypertext to and from GValue. See toGValue and fromGValue.

Defined in GI.Atk.Interfaces.Hypertext

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Hypertext -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Hypertext)

type ParentTypes Hypertext

Defined in GI.Atk.Interfaces.Hypertext

type ParentTypes Hypertext = '[Object]

class (GObject o, IsDescendantOf Hypertext o) => IsHypertext o

Type class for types which can be safely cast to Hypertext, for instance with toHypertext.

Instances

(GObject o, IsDescendantOf Hypertext o) => IsHypertext o

Defined in GI.Atk.Interfaces.Hypertext

toHypertext :: (MonadIO m, IsHypertext o) => o -> m Hypertext

Cast to Hypertext, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getLink, getLinkIndex, getNLinks, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

getLink

hypertextGetLink

Arguments

:: (HasCallStack, MonadIO m, IsHypertext a)

=> a

hypertext: an Hypertext

-> Int32

linkIndex: an integer specifying the desired link

-> m Hyperlink

Returns: the link in this hypertext document at index linkIndex

Gets the link in this hypertext document at index linkIndex

getLinkIndex

hypertextGetLinkIndex

Arguments

:: (HasCallStack, MonadIO m, IsHypertext a)

=> a

hypertext: an Hypertext

-> Int32

charIndex: a character index

-> m Int32

Returns: an index into the array of hyperlinks in hypertext, or -1 if there is no hyperlink associated with this character.

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

getNLinks

hypertextGetNLinks

Arguments

:: (HasCallStack, MonadIO m, IsHypertext a)

=> a

hypertext: an Hypertext

-> m Int32

Returns: the number of links within this hypertext document

Gets the number of links within this hypertext document.

Signals

linkSelected

type HypertextLinkSelectedCallback

Arguments

 = Int32

arg1: the index of the hyperlink which is selected

-> IO ()

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

afterHypertextLinkSelected :: (IsHypertext a, MonadIO m) => a -> ((?self :: a) => HypertextLinkSelectedCallback) -> m SignalHandlerId

Connect a signal handler for the linkSelected signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after hypertext #linkSelected callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onHypertextLinkSelected :: (IsHypertext a, MonadIO m) => a -> ((?self :: a) => HypertextLinkSelectedCallback) -> m SignalHandlerId

Connect a signal handler for the linkSelected signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on hypertext #linkSelected callback