gi-atk-2.0.12: Atk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Atk.Interfaces.Hypertext

Contents

Description

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.

Synopsis

Exported types

newtype Hypertext #

Instances

GObject Hypertext # 
IsObject Hypertext # 
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 SignalList Hypertext # 

Methods

getLink

data HypertextGetLinkMethodInfo #

Instances

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

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 () #