GI.Atk.Interfaces.Hypertext

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

Methods

gobjectType :: IO GType

IsGValue Hypertext

Convert Hypertext to and from GValue with toGValue and fromGValue.

Defined in GI.Atk.Interfaces.Hypertext

Methods

toGValue :: Hypertext -> IO GValue

fromGValue :: GValue -> IO Hypertext

HasParentTypes Hypertext

Defined in GI.Atk.Interfaces.Hypertext

type ParentTypes Hypertext

Defined in GI.Atk.Interfaces.Hypertext

type ParentTypes Hypertext = '[Object]

noHypertext :: Maybe Hypertext

A convenience alias for Nothing :: Maybe Hypertext.

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

Overloaded methods

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 C_HypertextLinkSelectedCallback = Ptr () -> Int32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

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 -> 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

genClosure_HypertextLinkSelected :: MonadIO m => HypertextLinkSelectedCallback -> m (GClosure C_HypertextLinkSelectedCallback)

Wrap the callback into a GClosure.

mk_HypertextLinkSelectedCallback :: C_HypertextLinkSelectedCallback -> IO (FunPtr C_HypertextLinkSelectedCallback)

Generate a function pointer callable from C code, from a C_HypertextLinkSelectedCallback.

noHypertextLinkSelectedCallback :: Maybe HypertextLinkSelectedCallback

A convenience synonym for Nothing :: Maybe HypertextLinkSelectedCallback.

onHypertextLinkSelected :: (IsHypertext a, MonadIO m) => 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

wrap_HypertextLinkSelectedCallback :: HypertextLinkSelectedCallback -> C_HypertextLinkSelectedCallback

Wrap a HypertextLinkSelectedCallback into a C_HypertextLinkSelectedCallback.