Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- newtype Hyperlink = Hyperlink (ManagedPtr Hyperlink)
- class (GObject o, IsDescendantOf Hyperlink o) => IsHyperlink o
- toHyperlink :: (MonadIO m, IsHyperlink o) => o -> m Hyperlink
- hyperlinkGetEndIndex :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Int32
- hyperlinkGetNAnchors :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Int32
- hyperlinkGetObject :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> Int32 -> m Object
- hyperlinkGetStartIndex :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Int32
- hyperlinkGetUri :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> Int32 -> m Text
- hyperlinkIsInline :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Bool
- hyperlinkIsSelectedLink :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Bool
- hyperlinkIsValid :: (HasCallStack, MonadIO m, IsHyperlink a) => a -> m Bool
- getHyperlinkEndIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32
- getHyperlinkNumberOfAnchors :: (MonadIO m, IsHyperlink o) => o -> m Int32
- getHyperlinkSelectedLink :: (MonadIO m, IsHyperlink o) => o -> m Bool
- getHyperlinkStartIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32
- type HyperlinkLinkActivatedCallback = IO ()
- afterHyperlinkLinkActivated :: (IsHyperlink a, MonadIO m) => a -> ((?self :: a) => HyperlinkLinkActivatedCallback) -> m SignalHandlerId
- onHyperlinkLinkActivated :: (IsHyperlink a, MonadIO m) => a -> ((?self :: a) => HyperlinkLinkActivatedCallback) -> m SignalHandlerId
Exported types
Memory-managed wrapper type.
Instances
Eq Hyperlink Source # | |
GObject Hyperlink Source # | |
Defined in GI.Atk.Objects.Hyperlink | |
ManagedPtrNewtype Hyperlink Source # | |
Defined in GI.Atk.Objects.Hyperlink toManagedPtr :: Hyperlink -> ManagedPtr Hyperlink | |
TypedObject Hyperlink Source # | |
Defined in GI.Atk.Objects.Hyperlink | |
HasParentTypes Hyperlink Source # | |
Defined in GI.Atk.Objects.Hyperlink | |
IsGValue (Maybe Hyperlink) Source # | Convert |
Defined in GI.Atk.Objects.Hyperlink gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Hyperlink -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Hyperlink) | |
type ParentTypes Hyperlink Source # | |
Defined in GI.Atk.Objects.Hyperlink |
class (GObject o, IsDescendantOf Hyperlink o) => IsHyperlink o Source #
Type class for types which can be safely cast to Hyperlink
, for instance with toHyperlink
.
Instances
(GObject o, IsDescendantOf Hyperlink o) => IsHyperlink o Source # | |
Defined in GI.Atk.Objects.Hyperlink |
toHyperlink :: (MonadIO m, IsHyperlink o) => o -> m Hyperlink Source #
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, doAction, forceFloating, freezeNotify, getv, isFloating, isInline, isSelectedLink, isValid, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getDescription, getEndIndex, getKeybinding, getLocalizedName, getNActions, getNAnchors, getName, getObject, getProperty, getQdata, getStartIndex, getUri.
Setters
getEndIndex
:: (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
:: (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
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> Int32 |
|
-> m Object | Returns: an |
getStartIndex
hyperlinkGetStartIndex Source #
:: (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
:: (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
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> m Bool | Returns: whether or not this link displays its content inline. |
isSelectedLink
hyperlinkIsSelectedLink Source #
:: (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
:: (HasCallStack, MonadIO m, IsHyperlink a) | |
=> a |
|
-> m Bool | Returns: whether or not this link is still valid |
Properties
endIndex
No description available in the introspection data.
getHyperlinkEndIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32 Source #
Get the value of the “end-index
” property.
When overloading is enabled, this is equivalent to
get
hyperlink #endIndex
numberOfAnchors
No description available in the introspection data.
getHyperlinkNumberOfAnchors :: (MonadIO m, IsHyperlink o) => o -> m Int32 Source #
Get the value of the “number-of-anchors
” property.
When overloading is enabled, this is equivalent to
get
hyperlink #numberOfAnchors
selectedLink
Selected link
getHyperlinkSelectedLink :: (MonadIO m, IsHyperlink o) => o -> m Bool Source #
Get the value of the “selected-link
” property.
When overloading is enabled, this is equivalent to
get
hyperlink #selectedLink
startIndex
No description available in the introspection data.
getHyperlinkStartIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32 Source #
Get the value of the “start-index
” property.
When overloading is enabled, this is equivalent to
get
hyperlink #startIndex
Signals
linkActivated
type HyperlinkLinkActivatedCallback = IO () Source #
The signal link-activated is emitted when a link is activated.
afterHyperlinkLinkActivated :: (IsHyperlink a, MonadIO m) => a -> ((?self :: a) => HyperlinkLinkActivatedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the linkActivated signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
hyperlink #linkActivated callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onHyperlinkLinkActivated :: (IsHyperlink a, MonadIO m) => a -> ((?self :: a) => HyperlinkLinkActivatedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the linkActivated signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
hyperlink #linkActivated callback