gi-atk-2.0.12: Atk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

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.

Synopsis

Exported types

newtype Hyperlink #

Methods

getEndIndex

hyperlinkGetEndIndex #

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

hyperlinkGetNAnchors #

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

hyperlinkGetObject #

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

hyperlinkGetStartIndex #

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 #

Instances

((~) * signature (Int32 -> m Text), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkGetUriMethodInfo a signature # 

hyperlinkGetUri #

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 #

Instances

((~) * signature (m Bool), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkIsInlineMethodInfo a signature # 

hyperlinkIsInline #

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

hyperlinkIsSelectedLink #

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 #

Instances

((~) * signature (m Bool), MonadIO m, IsHyperlink a) => MethodInfo * HyperlinkIsValidMethodInfo a signature # 

hyperlinkIsValid #

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 #

Instances

AttrInfo HyperlinkEndIndexPropertyInfo # 
type AttrOrigin HyperlinkEndIndexPropertyInfo # 
type AttrLabel HyperlinkEndIndexPropertyInfo # 
type AttrGetType HyperlinkEndIndexPropertyInfo # 
type AttrBaseTypeConstraint HyperlinkEndIndexPropertyInfo # 
type AttrSetTypeConstraint HyperlinkEndIndexPropertyInfo # 
type AttrAllowedOps HyperlinkEndIndexPropertyInfo # 

numberOfAnchors

data HyperlinkNumberOfAnchorsPropertyInfo #

Instances

AttrInfo HyperlinkNumberOfAnchorsPropertyInfo # 
type AttrOrigin HyperlinkNumberOfAnchorsPropertyInfo # 
type AttrLabel HyperlinkNumberOfAnchorsPropertyInfo # 
type AttrGetType HyperlinkNumberOfAnchorsPropertyInfo # 
type AttrBaseTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo # 
type AttrSetTypeConstraint HyperlinkNumberOfAnchorsPropertyInfo # 
type AttrAllowedOps HyperlinkNumberOfAnchorsPropertyInfo # 

selectedLink

data HyperlinkSelectedLinkPropertyInfo #

Instances

AttrInfo HyperlinkSelectedLinkPropertyInfo # 
type AttrOrigin HyperlinkSelectedLinkPropertyInfo # 
type AttrLabel HyperlinkSelectedLinkPropertyInfo # 
type AttrGetType HyperlinkSelectedLinkPropertyInfo # 
type AttrBaseTypeConstraint HyperlinkSelectedLinkPropertyInfo # 
type AttrSetTypeConstraint HyperlinkSelectedLinkPropertyInfo # 
type AttrAllowedOps HyperlinkSelectedLinkPropertyInfo # 

startIndex

data HyperlinkStartIndexPropertyInfo #

Instances

AttrInfo HyperlinkStartIndexPropertyInfo # 
type AttrOrigin HyperlinkStartIndexPropertyInfo # 
type AttrLabel HyperlinkStartIndexPropertyInfo # 
type AttrGetType HyperlinkStartIndexPropertyInfo # 
type AttrBaseTypeConstraint HyperlinkStartIndexPropertyInfo # 
type AttrSetTypeConstraint HyperlinkStartIndexPropertyInfo # 
type AttrAllowedOps HyperlinkStartIndexPropertyInfo # 

Signals

linkActivated