ATK Library Reference Manual | |||
---|---|---|---|
<<< Previous Page | Home | Up | Next Page >>> |
struct AtkHyperlink; enum AtkHyperlinkStateFlags; gchar* atk_hyperlink_get_uri (AtkHyperlink *link_, gint i); AtkObject* atk_hyperlink_get_object (AtkHyperlink *link_, gint i); gint atk_hyperlink_get_end_index (AtkHyperlink *link_); gint atk_hyperlink_get_start_index (AtkHyperlink *link_); gboolean atk_hyperlink_is_valid (AtkHyperlink *link_); gboolean atk_hyperlink_is_inline (AtkHyperlink *link_); gint atk_hyperlink_get_n_anchors (AtkHyperlink *link_); |
An ATK object which encapsulates a link or set of links in a hypertext document. It implements the AtkAction interface.
typedef enum { ATK_HYPERLINK_IS_INLINE = 1 << 0 } AtkHyperlinkStateFlags; |
Describes the type of link
Link is inline
gchar* atk_hyperlink_get_uri (AtkHyperlink *link_, gint i); |
Get a the URI associated with the anchor specified by i of link_.
Multiple anchors are primarily used by client-side image maps.
an AtkHyperlink
a (zero-index) integer specifying the desired anchor
a string specifying the URI
AtkObject* atk_hyperlink_get_object (AtkHyperlink *link_, gint i); |
Returns the item associated with this hyperlinks nth anchor. For instance, the returned AtkObject will implement AtkText if link_ is a text hyperlink, AtkImage if link_ is an image hyperlink etc.
Multiple anchors are primarily used by client-side image maps.
an AtkHyperlink
a (zero-index) integer specifying the desired anchor
an AtkObject associated with this hyperlinks i-th anchor
gint atk_hyperlink_get_end_index (AtkHyperlink *link_); |
Gets the index with the hypertext document at which this link ends.
an AtkHyperlink
the index with the hypertext document at which this link ends
gint atk_hyperlink_get_start_index (AtkHyperlink *link_); |
Gets the index with the hypertext document at which this link begins.
an AtkHyperlink
the index with the hypertext document at which this link begins
gboolean atk_hyperlink_is_valid (AtkHyperlink *link_); |
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.
an AtkHyperlink
whether or not this link is still valid
gboolean atk_hyperlink_is_inline (AtkHyperlink *link_); |
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. a *
an AtkHyperlink
whether or not this link displays its content inline.
gint atk_hyperlink_get_n_anchors (AtkHyperlink *link_); |
Gets the number of anchors associated with this hyperlink.
an AtkHyperlink
the number of anchors associated with this hyperlink