| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Atk.Objects.Hyperlink
Description
An ATK object which encapsulates a link or set of links in a hypertext document.
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
- type family ResolveHyperlinkMethod (t :: Symbol) o where ...
- 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 HyperlinkLinkActivatedCallback = IO ()
- data HyperlinkLinkActivatedSignalInfo
- 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.
Constructors
| Hyperlink (ManagedPtr Hyperlink) |
Instances
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
type family ResolveHyperlinkMethod (t :: Symbol) o where ... Source #
Equations
getEndIndex
data HyperlinkGetEndIndexMethodInfo Source #
Instances
| (signature ~ m Int32, MonadIO m, IsHyperlink a) => OverloadedMethod HyperlinkGetEndIndexMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo HyperlinkGetEndIndexMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods | |
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 Source #
Instances
| (signature ~ m Int32, MonadIO m, IsHyperlink a) => OverloadedMethod HyperlinkGetNAnchorsMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo HyperlinkGetNAnchorsMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods | |
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 Source #
Instances
| (signature ~ (Int32 -> m Object), MonadIO m, IsHyperlink a) => OverloadedMethod HyperlinkGetObjectMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo HyperlinkGetObjectMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsHyperlink a) | |
| => a |
|
| -> Int32 |
|
| -> m Object | Returns: an |
getStartIndex
data HyperlinkGetStartIndexMethodInfo Source #
Instances
| (signature ~ m Int32, MonadIO m, IsHyperlink a) => OverloadedMethod HyperlinkGetStartIndexMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo HyperlinkGetStartIndexMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods | |
hyperlinkGetStartIndex Source #
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 Source #
Instances
| (signature ~ (Int32 -> m Text), MonadIO m, IsHyperlink a) => OverloadedMethod HyperlinkGetUriMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo HyperlinkGetUriMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods | |
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 Source #
Instances
| (signature ~ m Bool, MonadIO m, IsHyperlink a) => OverloadedMethod HyperlinkIsInlineMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo HyperlinkIsInlineMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods | |
Arguments
| :: (HasCallStack, MonadIO m, IsHyperlink a) | |
| => a |
|
| -> m Bool | Returns: whether or not this link displays its content inline. |
isSelectedLink
data HyperlinkIsSelectedLinkMethodInfo Source #
Instances
| (signature ~ m Bool, MonadIO m, IsHyperlink a) => OverloadedMethod HyperlinkIsSelectedLinkMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo HyperlinkIsSelectedLinkMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods | |
hyperlinkIsSelectedLink Source #
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 Source #
Instances
| (signature ~ m Bool, MonadIO m, IsHyperlink a) => OverloadedMethod HyperlinkIsValidMethodInfo a signature Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods overloadedMethod :: a -> signature # | |
| OverloadedMethodInfo HyperlinkIsValidMethodInfo (a :: Type) Source # | |
Defined in GI.Atk.Objects.Hyperlink Methods | |
Arguments
| :: (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.
data HyperlinkEndIndexPropertyInfo Source #
Instances
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
hyperlinkEndIndex :: AttrLabelProxy "endIndex" Source #
numberOfAnchors
No description available in the introspection data.
data HyperlinkNumberOfAnchorsPropertyInfo Source #
Instances
| AttrInfo HyperlinkNumberOfAnchorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink Associated Types
Methods attrGet :: AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo o => o -> IO (AttrGetType HyperlinkNumberOfAnchorsPropertyInfo) # attrSet :: (AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo o, AttrSetTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo o, AttrSetTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo o, AttrTransferTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType HyperlinkNumberOfAnchorsPropertyInfo) # attrPut :: AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo o => o -> AttrGetType HyperlinkNumberOfAnchorsPropertyInfo -> IO () # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps HyperlinkNumberOfAnchorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType HyperlinkNumberOfAnchorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrLabel HyperlinkNumberOfAnchorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrOrigin HyperlinkNumberOfAnchorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrTransferType HyperlinkNumberOfAnchorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
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
hyperlinkNumberOfAnchors :: AttrLabelProxy "numberOfAnchors" Source #
selectedLink
Selected link
data HyperlinkSelectedLinkPropertyInfo Source #
Instances
| AttrInfo HyperlinkSelectedLinkPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink Associated Types
Methods attrGet :: AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo o => o -> IO (AttrGetType HyperlinkSelectedLinkPropertyInfo) # attrSet :: (AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo o, AttrSetTypeConstraint HyperlinkSelectedLinkPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo o, AttrSetTypeConstraint HyperlinkSelectedLinkPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo o, AttrTransferTypeConstraint HyperlinkSelectedLinkPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType HyperlinkSelectedLinkPropertyInfo) # attrPut :: AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo o => o -> AttrGetType HyperlinkSelectedLinkPropertyInfo -> IO () # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps HyperlinkSelectedLinkPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType HyperlinkSelectedLinkPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrLabel HyperlinkSelectedLinkPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrOrigin HyperlinkSelectedLinkPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint HyperlinkSelectedLinkPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrTransferType HyperlinkSelectedLinkPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint HyperlinkSelectedLinkPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
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
hyperlinkSelectedLink :: AttrLabelProxy "selectedLink" Source #
startIndex
No description available in the introspection data.
data HyperlinkStartIndexPropertyInfo Source #
Instances
| AttrInfo HyperlinkStartIndexPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink Associated Types
Methods attrGet :: AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo o => o -> IO (AttrGetType HyperlinkStartIndexPropertyInfo) # attrSet :: (AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo o, AttrSetTypeConstraint HyperlinkStartIndexPropertyInfo b) => o -> b -> IO () # attrClear :: AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo o => o -> IO () # attrConstruct :: (AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo o, AttrSetTypeConstraint HyperlinkStartIndexPropertyInfo b) => b -> IO (GValueConstruct o) # attrTransfer :: (AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo o, AttrTransferTypeConstraint HyperlinkStartIndexPropertyInfo b) => Proxy o -> b -> IO (AttrTransferType HyperlinkStartIndexPropertyInfo) # attrPut :: AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo o => o -> AttrGetType HyperlinkStartIndexPropertyInfo -> IO () # | |||||||||||||||||||||||||||||||||
| type AttrAllowedOps HyperlinkStartIndexPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo Source # | |||||||||||||||||||||||||||||||||
| type AttrGetType HyperlinkStartIndexPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrLabel HyperlinkStartIndexPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrOrigin HyperlinkStartIndexPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrSetTypeConstraint HyperlinkStartIndexPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrTransferType HyperlinkStartIndexPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
| type AttrTransferTypeConstraint HyperlinkStartIndexPropertyInfo Source # | |||||||||||||||||||||||||||||||||
Defined in GI.Atk.Objects.Hyperlink | |||||||||||||||||||||||||||||||||
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
hyperlinkStartIndex :: AttrLabelProxy "startIndex" Source #
Signals
linkActivated
type HyperlinkLinkActivatedCallback = IO () Source #
The signal link-activated is emitted when a link is activated.
data HyperlinkLinkActivatedSignalInfo Source #
Instances
| SignalInfo HyperlinkLinkActivatedSignalInfo Source # | |||||
Defined in GI.Atk.Objects.Hyperlink Associated Types
Methods connectSignal :: GObject o => o -> (o -> HaskellCallbackType HyperlinkLinkActivatedSignalInfo) -> SignalConnectMode -> Maybe Text -> IO SignalHandlerId # | |||||
| type HaskellCallbackType HyperlinkLinkActivatedSignalInfo Source # | |||||
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