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

Exported types
Methods
Properties
Signals
- linkActivated

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.

Synopsis

Exported types

newtype Hyperlink Source #

Constructors

Hyperlink (ManagedPtr Hyperlink)

Instances

GObject Hyperlink Source #
Methods gobjectType :: Hyperlink -> IO GType #
IsObject Hyperlink Source #

IsHyperlink Hyperlink Source #

IsAction Hyperlink Source #

((~) * info (ResolveHyperlinkMethod t Hyperlink), MethodInfo * info Hyperlink p) => IsLabel t (Hyperlink -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> Hyperlink -> p #
((~) * info (ResolveHyperlinkMethod t Hyperlink), MethodInfo * info Hyperlink p) => IsLabelProxy t (Hyperlink -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> Hyperlink -> p #
HasAttributeList * Hyperlink Source #

type AttributeList Hyperlink Source #
type AttributeList Hyperlink
type SignalList Hyperlink Source #
type SignalList Hyperlink

class GObject o => IsHyperlink o Source #

Instances

(GObject a, UnknownAncestorError Constraint Hyperlink a) => IsHyperlink a Source #

IsHyperlink Hyperlink Source #

toHyperlink :: IsHyperlink o => o -> IO Hyperlink Source #

noHyperlink :: Maybe Hyperlink Source #

Methods

getEndIndex

data HyperlinkGetEndIndexMethodInfo Source #

Instances

((~) * signature (m Int32), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkGetEndIndexMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy HyperlinkGetEndIndexMethodInfo a -> signature -> s #

hyperlinkGetEndIndex Source #

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)
=> a	`link_`: an `Hyperlink`
-> 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) => MethodInfo * HyperlinkGetNAnchorsMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy HyperlinkGetNAnchorsMethodInfo a -> signature -> s #

hyperlinkGetNAnchors Source #

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)
=> a	`link_`: an `Hyperlink`
-> 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) => MethodInfo * HyperlinkGetObjectMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy HyperlinkGetObjectMethodInfo a -> signature -> s #

hyperlinkGetObject Source #

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)
=> a	`link_`: an `Hyperlink`
-> Int32	`i`: a (zero-index) integer specifying the desired anchor
-> m Object	Returns: an `Object` associated with this hyperlinks i-th anchor

Returns the item associated with this hyperlinks nth anchor. For instance, the returned Object will implement Text if link_ is a text hyperlink, Image if link_ is an image hyperlink etc.

Multiple anchors are primarily used by client-side image maps.

getStartIndex

data HyperlinkGetStartIndexMethodInfo Source #

Instances

((~) * signature (m Int32), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkGetStartIndexMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy HyperlinkGetStartIndexMethodInfo a -> signature -> s #

hyperlinkGetStartIndex Source #

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)
=> a	`link_`: an `Hyperlink`
-> 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) => MethodInfo * HyperlinkGetUriMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy HyperlinkGetUriMethodInfo a -> signature -> s #

hyperlinkGetUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)
=> a	`link_`: an `Hyperlink`
-> Int32	`i`: a (zero-index) integer specifying the desired anchor
-> 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) => MethodInfo * HyperlinkIsInlineMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy HyperlinkIsInlineMethodInfo a -> signature -> s #

hyperlinkIsInline Source #

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)
=> a	`link_`: an `Hyperlink`
-> m Bool	Returns: whether or not this link displays its content inline.

Indicates whether the link currently displays some or all of its content inline. Ordinary HTML links will usually return False, but an inline <src> HTML element will return True.

isSelectedLink

data HyperlinkIsSelectedLinkMethodInfo Source #

Instances

((~) * signature (m Bool), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkIsSelectedLinkMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy HyperlinkIsSelectedLinkMethodInfo a -> signature -> s #

hyperlinkIsSelectedLink Source #

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)
=> a	`link_`: an `Hyperlink`
-> 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) => MethodInfo * HyperlinkIsValidMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy HyperlinkIsValidMethodInfo a -> signature -> s #

hyperlinkIsValid Source #

Arguments

:: (HasCallStack, MonadIO m, IsHyperlink a)
=> a	`link_`: an `Hyperlink`
-> m Bool	Returns: whether or not this link is still valid

Since the document that a link is associated with may have changed this method returns True if the link is still valid (with respect to the document it references) and False otherwise.

Properties

endIndex

data HyperlinkEndIndexPropertyInfo Source #

Instances

AttrInfo HyperlinkEndIndexPropertyInfo Source #
Associated Types type AttrAllowedOps HyperlinkEndIndexPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint HyperlinkEndIndexPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint HyperlinkEndIndexPropertyInfo :: * -> Constraint # type AttrGetType HyperlinkEndIndexPropertyInfo :: * # type AttrLabel HyperlinkEndIndexPropertyInfo :: Symbol # type AttrOrigin HyperlinkEndIndexPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint HyperlinkEndIndexPropertyInfo o => Proxy * HyperlinkEndIndexPropertyInfo -> o -> IO (AttrGetType HyperlinkEndIndexPropertyInfo) # attrSet :: (AttrBaseTypeConstraint HyperlinkEndIndexPropertyInfo o, AttrSetTypeConstraint HyperlinkEndIndexPropertyInfo b) => Proxy * HyperlinkEndIndexPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint HyperlinkEndIndexPropertyInfo o => Proxy * HyperlinkEndIndexPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint HyperlinkEndIndexPropertyInfo o, AttrSetTypeConstraint HyperlinkEndIndexPropertyInfo b) => Proxy * HyperlinkEndIndexPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin HyperlinkEndIndexPropertyInfo Source #
type AttrOrigin HyperlinkEndIndexPropertyInfo = Hyperlink
type AttrLabel HyperlinkEndIndexPropertyInfo Source #
type AttrLabel HyperlinkEndIndexPropertyInfo = "end-index"
type AttrGetType HyperlinkEndIndexPropertyInfo Source #
type AttrGetType HyperlinkEndIndexPropertyInfo = Int32
type AttrBaseTypeConstraint HyperlinkEndIndexPropertyInfo Source #
type AttrBaseTypeConstraint HyperlinkEndIndexPropertyInfo = IsHyperlink
type AttrSetTypeConstraint HyperlinkEndIndexPropertyInfo Source #
type AttrSetTypeConstraint HyperlinkEndIndexPropertyInfo = * ~ ()
type AttrAllowedOps HyperlinkEndIndexPropertyInfo Source #
type AttrAllowedOps HyperlinkEndIndexPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getHyperlinkEndIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32 Source #

hyperlinkEndIndex :: AttrLabelProxy "endIndex" Source #

numberOfAnchors

data HyperlinkNumberOfAnchorsPropertyInfo Source #

Instances

AttrInfo HyperlinkNumberOfAnchorsPropertyInfo Source #
Associated Types type AttrAllowedOps HyperlinkNumberOfAnchorsPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo :: * -> Constraint # type AttrGetType HyperlinkNumberOfAnchorsPropertyInfo :: * # type AttrLabel HyperlinkNumberOfAnchorsPropertyInfo :: Symbol # type AttrOrigin HyperlinkNumberOfAnchorsPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo o => Proxy * HyperlinkNumberOfAnchorsPropertyInfo -> o -> IO (AttrGetType HyperlinkNumberOfAnchorsPropertyInfo) # attrSet :: (AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo o, AttrSetTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo b) => Proxy * HyperlinkNumberOfAnchorsPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo o => Proxy * HyperlinkNumberOfAnchorsPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo o, AttrSetTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo b) => Proxy * HyperlinkNumberOfAnchorsPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin HyperlinkNumberOfAnchorsPropertyInfo Source #
type AttrOrigin HyperlinkNumberOfAnchorsPropertyInfo = Hyperlink
type AttrLabel HyperlinkNumberOfAnchorsPropertyInfo Source #
type AttrLabel HyperlinkNumberOfAnchorsPropertyInfo = "number-of-anchors"
type AttrGetType HyperlinkNumberOfAnchorsPropertyInfo Source #
type AttrGetType HyperlinkNumberOfAnchorsPropertyInfo = Int32
type AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo Source #
type AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo = IsHyperlink
type AttrSetTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo Source #
type AttrSetTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo = * ~ ()
type AttrAllowedOps HyperlinkNumberOfAnchorsPropertyInfo Source #
type AttrAllowedOps HyperlinkNumberOfAnchorsPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getHyperlinkNumberOfAnchors :: (MonadIO m, IsHyperlink o) => o -> m Int32 Source #

hyperlinkNumberOfAnchors :: AttrLabelProxy "numberOfAnchors" Source #

selectedLink

data HyperlinkSelectedLinkPropertyInfo Source #

Instances

AttrInfo HyperlinkSelectedLinkPropertyInfo Source #
Associated Types type AttrAllowedOps HyperlinkSelectedLinkPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint HyperlinkSelectedLinkPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo :: * -> Constraint # type AttrGetType HyperlinkSelectedLinkPropertyInfo :: * # type AttrLabel HyperlinkSelectedLinkPropertyInfo :: Symbol # type AttrOrigin HyperlinkSelectedLinkPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo o => Proxy * HyperlinkSelectedLinkPropertyInfo -> o -> IO (AttrGetType HyperlinkSelectedLinkPropertyInfo) # attrSet :: (AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo o, AttrSetTypeConstraint HyperlinkSelectedLinkPropertyInfo b) => Proxy * HyperlinkSelectedLinkPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo o => Proxy * HyperlinkSelectedLinkPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo o, AttrSetTypeConstraint HyperlinkSelectedLinkPropertyInfo b) => Proxy * HyperlinkSelectedLinkPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin HyperlinkSelectedLinkPropertyInfo Source #
type AttrOrigin HyperlinkSelectedLinkPropertyInfo = Hyperlink
type AttrLabel HyperlinkSelectedLinkPropertyInfo Source #
type AttrLabel HyperlinkSelectedLinkPropertyInfo = "selected-link"
type AttrGetType HyperlinkSelectedLinkPropertyInfo Source #
type AttrGetType HyperlinkSelectedLinkPropertyInfo = Bool
type AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo Source #
type AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo = IsHyperlink
type AttrSetTypeConstraint HyperlinkSelectedLinkPropertyInfo Source #
type AttrSetTypeConstraint HyperlinkSelectedLinkPropertyInfo = * ~ ()
type AttrAllowedOps HyperlinkSelectedLinkPropertyInfo Source #
type AttrAllowedOps HyperlinkSelectedLinkPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getHyperlinkSelectedLink :: (MonadIO m, IsHyperlink o) => o -> m Bool Source #

hyperlinkSelectedLink :: AttrLabelProxy "selectedLink" Source #

startIndex

data HyperlinkStartIndexPropertyInfo Source #

Instances

AttrInfo HyperlinkStartIndexPropertyInfo Source #
Associated Types type AttrAllowedOps HyperlinkStartIndexPropertyInfo :: [AttrOpTag] # type AttrSetTypeConstraint HyperlinkStartIndexPropertyInfo :: * -> Constraint # type AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo :: * -> Constraint # type AttrGetType HyperlinkStartIndexPropertyInfo :: * # type AttrLabel HyperlinkStartIndexPropertyInfo :: Symbol # type AttrOrigin HyperlinkStartIndexPropertyInfo :: * # Methods attrGet :: AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo o => Proxy * HyperlinkStartIndexPropertyInfo -> o -> IO (AttrGetType HyperlinkStartIndexPropertyInfo) # attrSet :: (AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo o, AttrSetTypeConstraint HyperlinkStartIndexPropertyInfo b) => Proxy * HyperlinkStartIndexPropertyInfo -> o -> b -> IO () # attrClear :: AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo o => Proxy * HyperlinkStartIndexPropertyInfo -> o -> IO () # attrConstruct :: (AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo o, AttrSetTypeConstraint HyperlinkStartIndexPropertyInfo b) => Proxy * HyperlinkStartIndexPropertyInfo -> b -> IO (GValueConstruct o) #
type AttrOrigin HyperlinkStartIndexPropertyInfo Source #
type AttrOrigin HyperlinkStartIndexPropertyInfo = Hyperlink
type AttrLabel HyperlinkStartIndexPropertyInfo Source #
type AttrLabel HyperlinkStartIndexPropertyInfo = "start-index"
type AttrGetType HyperlinkStartIndexPropertyInfo Source #
type AttrGetType HyperlinkStartIndexPropertyInfo = Int32
type AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo Source #
type AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo = IsHyperlink
type AttrSetTypeConstraint HyperlinkStartIndexPropertyInfo Source #
type AttrSetTypeConstraint HyperlinkStartIndexPropertyInfo = * ~ ()
type AttrAllowedOps HyperlinkStartIndexPropertyInfo Source #
type AttrAllowedOps HyperlinkStartIndexPropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

getHyperlinkStartIndex :: (MonadIO m, IsHyperlink o) => o -> m Int32 Source #

hyperlinkStartIndex :: AttrLabelProxy "startIndex" Source #

Signals

linkActivated

type C_HyperlinkLinkActivatedCallback = Ptr () -> Ptr () -> IO () Source #

type HyperlinkLinkActivatedCallback = IO () Source #

data HyperlinkLinkActivatedSignalInfo Source #

Instances

afterHyperlinkLinkActivated :: (GObject a, MonadIO m) => a -> HyperlinkLinkActivatedCallback -> m SignalHandlerId Source #

genClosure_HyperlinkLinkActivated :: HyperlinkLinkActivatedCallback -> IO Closure Source #

mk_HyperlinkLinkActivatedCallback :: C_HyperlinkLinkActivatedCallback -> IO (FunPtr C_HyperlinkLinkActivatedCallback) Source #

noHyperlinkLinkActivatedCallback :: Maybe HyperlinkLinkActivatedCallback Source #

onHyperlinkLinkActivated :: (GObject a, MonadIO m) => a -> HyperlinkLinkActivatedCallback -> m SignalHandlerId Source #

wrap_HyperlinkLinkActivatedCallback :: HyperlinkLinkActivatedCallback -> Ptr () -> Ptr () -> IO () Source #

SignalInfo HyperlinkLinkActivatedSignalInfo Source #
Associated Types type HaskellCallbackType HyperlinkLinkActivatedSignalInfo :: * # Methods connectSignal :: GObject o => SignalProxy o HyperlinkLinkActivatedSignalInfo -> o -> HaskellCallbackType HyperlinkLinkActivatedSignalInfo -> SignalConnectMode -> IO SignalHandlerId #
type HaskellCallbackType HyperlinkLinkActivatedSignalInfo Source #
type HaskellCallbackType HyperlinkLinkActivatedSignalInfo = HyperlinkLinkActivatedCallback