Atk.Hyperlink¶

Subclasses:	None

Methods¶

Inherited:	GObject.Object (37), Atk.Action (7)
Structs:	GObject.ObjectClass (5)

	`get_end_index` ()
	`get_n_anchors` ()
	`get_object` (i)
	`get_start_index` ()
	`get_uri` (i)
	`is_inline` ()
	`is_selected_link` ()
	`is_valid` ()

Virtual Methods¶

Inherited:	GObject.Object (7), Atk.Action (7)

	`do_get_end_index` ()
	`do_get_n_anchors` ()
	`do_get_object` (i)
	`do_get_start_index` ()
	`do_get_uri` (i)
	`do_is_selected_link` ()
	`do_is_valid` ()
	`do_link_activated` ()
	`do_link_state` ()

Properties¶

Name	Type	Flags	Short Description
`end-index`	`int`	r	The end index of the `Atk.Hyperlink` object
`number-of-anchors`	`int`	r	The number of anchors associated with the `Atk.Hyperlink` object
`selected-link`	`bool`	r	Specifies whether the `Atk.Hyperlink` object is selected `deprecated`
`start-index`	`int`	r	The start index of the `Atk.Hyperlink` object

Signals¶

Inherited:	GObject.Object (1)

Name	Short Description
`link-activated`	The signal link-activated is emitted when a link is activated.

Fields¶

Inherited:	GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Atk.Hyperlink(**kwargs)¶

Bases:	`GObject.Object`, `Atk.Action`
Abstract:	No
Structure:	`Atk.HyperlinkClass`

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 Atk.Action interface. Atk.Hyperlink may also be used to refer to inline embedded content, since it allows specification of a start and end offset within the host Atk.Hypertext object.

get_end_index()[source]¶

Returns:	the index with the hypertext document at which this link ends
Return type:	`int`

Gets the index with the hypertext document at which this link ends.

get_n_anchors()[source]¶

Returns:	the number of anchors associated with this hyperlink
Return type:	`int`

Gets the number of anchors associated with this hyperlink.

get_object(i)[source]¶

Parameters:	i (`int`) – a (zero-index) integer specifying the desired anchor
Returns:	an `Atk.Object` associated with this hyperlinks i-th anchor
Return type:	`Atk.Object`

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

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

get_start_index()[source]¶

Returns:	the index with the hypertext document at which this link begins
Return type:	`int`

Gets the index with the hypertext document at which this link begins.

get_uri(i)[source]¶

Parameters:	i (`int`) – a (zero-index) integer specifying the desired anchor
Returns:	a string specifying the URI
Return type:	`str`

Get a the URI associated with the anchor specified by i of self.

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

is_inline()[source]¶

Returns:	whether or not this link displays its content inline.
Return type:	`bool`

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.

is_selected_link()[source]¶

Returns:	True if the `Atk.Hyperlink` is selected, False otherwise
Return type:	`bool`

Determines whether this Atk.Hyperlink is selected

New in version 1.4.

Deprecated since version 1.8: Please use Atk.StateType.FOCUSABLE for all links, and Atk.StateType.FOCUSED for focused links.

is_valid()[source]¶

Returns:	whether or not this link is still valid
Return type:	`bool`

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.

do_get_end_index() virtual¶

Returns:	the index with the hypertext document at which this link ends
Return type:	`int`

Gets the index with the hypertext document at which this link ends.

do_get_n_anchors() virtual¶

Returns:	the number of anchors associated with this hyperlink
Return type:	`int`

Gets the number of anchors associated with this hyperlink.

do_get_object(i) virtual¶

Parameters:	i (`int`) – a (zero-index) integer specifying the desired anchor
Returns:	an `Atk.Object` associated with this hyperlinks i-th anchor
Return type:	`Atk.Object`

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

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

do_get_start_index() virtual¶

Returns:	the index with the hypertext document at which this link begins
Return type:	`int`

Gets the index with the hypertext document at which this link begins.

do_get_uri(i) virtual¶

Parameters:	i (`int`) – a (zero-index) integer specifying the desired anchor
Returns:	a string specifying the URI
Return type:	`str`

Get a the URI associated with the anchor specified by i of link_.

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

do_is_selected_link() virtual¶

Returns:	True if the `Atk.Hyperlink` is selected, False otherwise
Return type:	`bool`

Determines whether this Atk.Hyperlink is selected

New in version 1.4.

Deprecated since version 1.8: Please use Atk.StateType.FOCUSABLE for all links, and Atk.StateType.FOCUSED for focused links.

do_is_valid() virtual¶

Returns:	whether or not this link is still valid
Return type:	`bool`

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.

do_link_activated() virtual¶

do_link_state() virtual¶

Return type:	`int`

Signal Details¶

Atk.Hyperlink.signals.link_activated(hyperlink)¶

Signal Name:	`link-activated`
Flags:	`RUN_LAST`
Parameters:	hyperlink (`Atk.Hyperlink`) – The object which received the signal

The signal link-activated is emitted when a link is activated.

Property Details¶

Atk.Hyperlink.props.end_index¶

Name:	`end-index`
Type:	`int`
Default Value:	`0`
Flags:	`READABLE`

The end index of the Atk.Hyperlink object

Atk.Hyperlink.props.number_of_anchors¶

Name:	`number-of-anchors`
Type:	`int`
Default Value:	`0`
Flags:	`READABLE`

The number of anchors associated with the Atk.Hyperlink object

Atk.Hyperlink.props.selected_link¶

Name:	`selected-link`
Type:	`bool`
Default Value:	`False`
Flags:	`READABLE`

Selected link

Deprecated since version 1.8: Please use Atk.StateType.FOCUSABLE for all links, and Atk.StateType.FOCUSED for focused links.

Atk.Hyperlink.props.start_index¶

Name:	`start-index`
Type:	`int`
Default Value:	`0`
Flags:	`READABLE`

The start index of the Atk.Hyperlink object