Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
GI.Atk.Interfaces.Hypertext
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.
- newtype Hypertext = Hypertext (ManagedPtr Hypertext)
- noHypertext :: Maybe Hypertext
- class GObject o => IsHypertext o
- toHypertext :: (MonadIO m, IsHypertext o) => o -> m Hypertext
- data HypertextGetLinkMethodInfo
- hypertextGetLink :: (HasCallStack, MonadIO m, IsHypertext a) => a -> Int32 -> m Hyperlink
- data HypertextGetLinkIndexMethodInfo
- hypertextGetLinkIndex :: (HasCallStack, MonadIO m, IsHypertext a) => a -> Int32 -> m Int32
- data HypertextGetNLinksMethodInfo
- hypertextGetNLinks :: (HasCallStack, MonadIO m, IsHypertext a) => a -> m Int32
- type C_HypertextLinkSelectedCallback = Ptr () -> Int32 -> Ptr () -> IO ()
- type HypertextLinkSelectedCallback = Int32 -> IO ()
- data HypertextLinkSelectedSignalInfo
- afterHypertextLinkSelected :: (IsHypertext a, MonadIO m) => a -> HypertextLinkSelectedCallback -> m SignalHandlerId
- genClosure_HypertextLinkSelected :: HypertextLinkSelectedCallback -> IO Closure
- mk_HypertextLinkSelectedCallback :: C_HypertextLinkSelectedCallback -> IO (FunPtr C_HypertextLinkSelectedCallback)
- noHypertextLinkSelectedCallback :: Maybe HypertextLinkSelectedCallback
- onHypertextLinkSelected :: (IsHypertext a, MonadIO m) => a -> HypertextLinkSelectedCallback -> m SignalHandlerId
- wrap_HypertextLinkSelectedCallback :: HypertextLinkSelectedCallback -> Ptr () -> Int32 -> Ptr () -> IO ()
Exported types
Constructors
Hypertext (ManagedPtr Hypertext) |
Instances
GObject Hypertext # | |
IsObject Hypertext # | |
IsHypertext Hypertext # | |
((~) * info (ResolveHypertextMethod t Hypertext), MethodInfo * info Hypertext p) => IsLabel t (Hypertext -> p) # | |
((~) * info (ResolveHypertextMethod t Hypertext), MethodInfo * info Hypertext p) => IsLabelProxy t (Hypertext -> p) # | |
HasAttributeList * Hypertext # | |
type AttributeList Hypertext # | |
type SignalList Hypertext # | |
class GObject o => IsHypertext o #
Instances
toHypertext :: (MonadIO m, IsHypertext o) => o -> m Hypertext #
Methods
getLink
data HypertextGetLinkMethodInfo #
Instances
((~) * signature (Int32 -> m Hyperlink), MonadIO m, IsHypertext a) => MethodInfo * HypertextGetLinkMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsHypertext a) | |
=> a |
|
-> Int32 |
|
-> m Hyperlink | Returns: the link in this hypertext document at
index |
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 # | |
Arguments
:: (HasCallStack, MonadIO m, IsHypertext a) | |
=> a |
|
-> Int32 |
|
-> m Int32 | Returns: an index into the array of hyperlinks in |
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 # | |
Arguments
:: (HasCallStack, MonadIO m, IsHypertext a) | |
=> a |
|
-> m Int32 | Returns: the number of links within this hypertext document |
Gets the number of links within this hypertext document.
Signals
linkSelected
type HypertextLinkSelectedCallback = Int32 -> IO () #
afterHypertextLinkSelected :: (IsHypertext a, MonadIO m) => a -> HypertextLinkSelectedCallback -> m SignalHandlerId #
mk_HypertextLinkSelectedCallback :: C_HypertextLinkSelectedCallback -> IO (FunPtr C_HypertextLinkSelectedCallback) #
onHypertextLinkSelected :: (IsHypertext a, MonadIO m) => a -> HypertextLinkSelectedCallback -> m SignalHandlerId #
wrap_HypertextLinkSelectedCallback :: HypertextLinkSelectedCallback -> Ptr () -> Int32 -> Ptr () -> IO () #