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

Constructors

Hypertext (ManagedPtr Hypertext)

Instances

WrappedPtr Hypertext

Methods

wrappedPtrCalloc :: IO (Ptr Hypertext)

wrappedPtrCopy :: Hypertext -> IO Hypertext

wrappedPtrFree :: Maybe (FunPtr (Ptr Hypertext -> IO ()))

IsHypertext Hypertext

((~) * info (ResolveHypertextMethod t Hypertext), MethodInfo * info Hypertext p) => IsLabel t (Hypertext -> p)

Methods

fromLabel :: Proxy# Symbol t -> Hypertext -> p

((~) * info (ResolveHypertextMethod t Hypertext), MethodInfo * info Hypertext p) => IsLabelProxy t (Hypertext -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Hypertext -> p

HasAttributeList * Hypertext

type AttributeList Hypertext

type AttributeList Hypertext

type SignalList Hypertext

type SignalList Hypertext

noHypertext :: Maybe Hypertext

class ManagedPtrNewtype a => IsHypertext a

Instances

IsHypertext Hypertext

IsHypertext NoOpObject

Methods

getLink

data HypertextGetLinkMethodInfo

Instances

((~) * signature (Int32 -> m Hyperlink), MonadIO m, IsHypertext a) => MethodInfo * HypertextGetLinkMethodInfo a signature

Methods

overloadedMethod :: MethodProxy HypertextGetLinkMethodInfo a -> signature -> s

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

data HypertextGetLinkIndexMethodInfo

Instances

((~) * signature (Int32 -> m Int32), MonadIO m, IsHypertext a) => MethodInfo * HypertextGetLinkIndexMethodInfo a signature

Methods

overloadedMethod :: MethodProxy HypertextGetLinkIndexMethodInfo a -> signature -> s

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

data HypertextGetNLinksMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsHypertext a) => MethodInfo * HypertextGetNLinksMethodInfo a signature

Methods

overloadedMethod :: MethodProxy HypertextGetNLinksMethodInfo a -> signature -> s

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

data HypertextLinkSelectedSignalInfo

Instances

SignalInfo HypertextLinkSelectedSignalInfo

Associated Types

type HaskellCallbackType HypertextLinkSelectedSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o HypertextLinkSelectedSignalInfo -> o -> HaskellCallbackType HypertextLinkSelectedSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType HypertextLinkSelectedSignalInfo

type HaskellCallbackType HypertextLinkSelectedSignalInfo = HypertextLinkSelectedCallback

afterHypertextLinkSelected :: (GObject a, MonadIO m) => a -> HypertextLinkSelectedCallback -> m SignalHandlerId

genClosure_HypertextLinkSelected :: HypertextLinkSelectedCallback -> IO Closure

mk_HypertextLinkSelectedCallback :: C_HypertextLinkSelectedCallback -> IO (FunPtr C_HypertextLinkSelectedCallback)

noHypertextLinkSelectedCallback :: Maybe HypertextLinkSelectedCallback

onHypertextLinkSelected :: (GObject a, MonadIO m) => a -> HypertextLinkSelectedCallback -> m SignalHandlerId

wrap_HypertextLinkSelectedCallback :: HypertextLinkSelectedCallback -> Ptr () -> Int32 -> Ptr () -> IO ()