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.Objects.Hyperlink
Contents
Description
An ATK object which encapsulates a link or set of links (for instance in the case of client-side image maps) in a hypertext document. It may implement the AtkAction interface. AtkHyperlink may also be used to refer to inline embedded content, since it allows specification of a start and end offset within the host AtkHypertext object.
- newtype Hyperlink = Hyperlink (ManagedPtr Hyperlink)
- class GObject o => IsHyperlink o
- toHyperlink :: (MonadIO m, IsHyperlink o) => o -> m Hyperlink
- noHyperlink :: Maybe Hyperlink
- data HyperlinkGetEndIndexMethodInfo
- hyperlinkGetEndIndex :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Int32
- data HyperlinkGetNAnchorsMethodInfo
- hyperlinkGetNAnchors :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Int32
- data HyperlinkGetObjectMethodInfo
- hyperlinkGetObject :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> Int32 -> m Object
- data HyperlinkGetStartIndexMethodInfo
- hyperlinkGetStartIndex :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Int32
- data HyperlinkGetUriMethodInfo
- hyperlinkGetUri :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> Int32 -> m Text
- data HyperlinkIsInlineMethodInfo
- hyperlinkIsInline :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Bool
- data HyperlinkIsSelectedLinkMethodInfo
- hyperlinkIsSelectedLink :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Bool
- data HyperlinkIsValidMethodInfo
- hyperlinkIsValid :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Bool
- data HyperlinkEndIndexPropertyInfo
- getHyperlinkEndIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32
- hyperlinkEndIndex :: AttrLabelProxy "endIndex"
- data HyperlinkNumberOfAnchorsPropertyInfo
- getHyperlinkNumberOfAnchors :: (MonadIO m, IsHyperlink o) => o -> m Int32
- hyperlinkNumberOfAnchors :: AttrLabelProxy "numberOfAnchors"
- data HyperlinkSelectedLinkPropertyInfo
- getHyperlinkSelectedLink :: (MonadIO m, IsHyperlink o) => o -> m Bool
- hyperlinkSelectedLink :: AttrLabelProxy "selectedLink"
- data HyperlinkStartIndexPropertyInfo
- getHyperlinkStartIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32
- hyperlinkStartIndex :: AttrLabelProxy "startIndex"
- type C_HyperlinkLinkActivatedCallback = Ptr () -> Ptr () -> IO ()
- type HyperlinkLinkActivatedCallback = IO ()
- data HyperlinkLinkActivatedSignalInfo
- afterHyperlinkLinkActivated :: (IsHyperlink a, MonadIO m) => a -> HyperlinkLinkActivatedCallback -> m SignalHandlerId
- genClosure_HyperlinkLinkActivated :: HyperlinkLinkActivatedCallback -> IO Closure
- mk_HyperlinkLinkActivatedCallback :: C_HyperlinkLinkActivatedCallback -> IO (FunPtr C_HyperlinkLinkActivatedCallback)
- noHyperlinkLinkActivatedCallback :: Maybe HyperlinkLinkActivatedCallback
- onHyperlinkLinkActivated :: (IsHyperlink a, MonadIO m) => a -> HyperlinkLinkActivatedCallback -> m SignalHandlerId
- wrap_HyperlinkLinkActivatedCallback :: HyperlinkLinkActivatedCallback -> Ptr () -> Ptr () -> IO ()
Exported types
Constructors
Hyperlink (ManagedPtr Hyperlink) |
Instances
GObject Hyperlink # | |
IsObject Hyperlink # | |
IsHyperlink Hyperlink # | |
IsAction Hyperlink # | |
((~) * info (ResolveHyperlinkMethod t Hyperlink), MethodInfo * info Hyperlink p) => IsLabel t (Hyperlink -> p) # | |
((~) * info (ResolveHyperlinkMethod t Hyperlink), MethodInfo * info Hyperlink p) => IsLabelProxy t (Hyperlink -> p) # | |
HasAttributeList * Hyperlink # | |
type AttributeList Hyperlink # | |
type SignalList Hyperlink # | |
class GObject o => IsHyperlink o #
Instances
(GObject a, UnknownAncestorError Constraint Hyperlink a) => IsHyperlink a # | |
IsHyperlink Hyperlink # | |
toHyperlink :: (MonadIO m, IsHyperlink o) => o -> m Hyperlink #
Methods
getEndIndex
data HyperlinkGetEndIndexMethodInfo #
Instances
((~) * signature (m Int32), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkGetEndIndexMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> m Int32 | Returns: the index with the hypertext document at which this link ends |
Gets the index with the hypertext document at which this link ends.
getNAnchors
data HyperlinkGetNAnchorsMethodInfo #
Instances
((~) * signature (m Int32), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkGetNAnchorsMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> m Int32 | Returns: the number of anchors associated with this hyperlink |
Gets the number of anchors associated with this hyperlink.
getObject
data HyperlinkGetObjectMethodInfo #
Instances
((~) * signature (Int32 -> m Object), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkGetObjectMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> Int32 |
|
-> m Object | Returns: an |
getStartIndex
data HyperlinkGetStartIndexMethodInfo #
Instances
((~) * signature (m Int32), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkGetStartIndexMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> m Int32 | Returns: the index with the hypertext document at which this link begins |
Gets the index with the hypertext document at which this link begins.
getUri
data HyperlinkGetUriMethodInfo #
Instances
((~) * signature (Int32 -> m Text), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkGetUriMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> Int32 |
|
-> m Text | Returns: a string specifying the URI |
Get a the URI associated with the anchor specified
by i
of link_
.
Multiple anchors are primarily used by client-side image maps.
isInline
data HyperlinkIsInlineMethodInfo #
Instances
((~) * signature (m Bool), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkIsInlineMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> m Bool | Returns: whether or not this link displays its content inline. |
isSelectedLink
data HyperlinkIsSelectedLinkMethodInfo #
Instances
((~) * signature (m Bool), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkIsSelectedLinkMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> m Bool | Returns: True if the AtkHyperlink is selected, False otherwise |
Deprecated: (Since version 1.8)Please use ATK_STATE_FOCUSABLE for all links,and ATK_STATE_FOCUSED for focused links.
Determines whether this AtkHyperlink is selected
Since: 1.4
isValid
data HyperlinkIsValidMethodInfo #
Instances
((~) * signature (m Bool), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkIsValidMethodInfo a signature # | |
Arguments
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> m Bool | Returns: whether or not this link is still valid |
Properties
endIndex
data HyperlinkEndIndexPropertyInfo #
Instances
getHyperlinkEndIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32 #
hyperlinkEndIndex :: AttrLabelProxy "endIndex" #
numberOfAnchors
data HyperlinkNumberOfAnchorsPropertyInfo #
Instances
getHyperlinkNumberOfAnchors :: (MonadIO m, IsHyperlink o) => o -> m Int32 #
hyperlinkNumberOfAnchors :: AttrLabelProxy "numberOfAnchors" #
selectedLink
data HyperlinkSelectedLinkPropertyInfo #
Instances
getHyperlinkSelectedLink :: (MonadIO m, IsHyperlink o) => o -> m Bool #
hyperlinkSelectedLink :: AttrLabelProxy "selectedLink" #
startIndex
data HyperlinkStartIndexPropertyInfo #
Instances
getHyperlinkStartIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32 #
hyperlinkStartIndex :: AttrLabelProxy "startIndex" #
Signals
linkActivated
type C_HyperlinkLinkActivatedCallback = Ptr () -> Ptr () -> IO () #
type HyperlinkLinkActivatedCallback = IO () #
afterHyperlinkLinkActivated :: (IsHyperlink a, MonadIO m) => a -> HyperlinkLinkActivatedCallback -> m SignalHandlerId #
mk_HyperlinkLinkActivatedCallback :: C_HyperlinkLinkActivatedCallback -> IO (FunPtr C_HyperlinkLinkActivatedCallback) #
onHyperlinkLinkActivated :: (IsHyperlink a, MonadIO m) => a -> HyperlinkLinkActivatedCallback -> m SignalHandlerId #
wrap_HyperlinkLinkActivatedCallback :: HyperlinkLinkActivatedCallback -> Ptr () -> Ptr () -> IO () #