AtkHyperlink

Name

AtkHyperlink -- An ATK object which encapsulates a link or set of links in a hypertext document.

Synopsis



struct      AtkHyperlink;
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);
gint        atk_hyperlink_get_n_anchors     (AtkHyperlink *link);

Description

An ATK object which encapsulates a link or set of links in a hypertext document. It implements the AtkAction interface.

Details

struct AtkHyperlink

struct AtkHyperlink
{
  GObject parent;
};


atk_hyperlink_get_uri ()

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.


atk_hyperlink_get_object ()

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.


atk_hyperlink_get_end_index ()

gint        atk_hyperlink_get_end_index     (AtkHyperlink *link);

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


atk_hyperlink_get_start_index ()

gint        atk_hyperlink_get_start_index   (AtkHyperlink *link);

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


atk_hyperlink_is_valid ()

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.


atk_hyperlink_get_n_anchors ()

gint        atk_hyperlink_get_n_anchors     (AtkHyperlink *link);

Gets the number of anchors associated with this hyperlink.