AtspiHyperlink

AtspiHyperlink

Synopsis

                    AtspiHyperlink;
struct              AtspiHyperlinkClass;
AtspiHyperlink *    atspi_hyperlink_new                 (AtspiApplication *app,
                                                         const gchar *path);
gint                atspi_hyperlink_get_n_anchors       (AtspiHyperlink *obj,
                                                         GError **error);
gchar *             atspi_hyperlink_get_uri             (AtspiHyperlink *obj,
                                                         int i,
                                                         GError **error);
AtspiAccessible *   atspi_hyperlink_get_object          (AtspiHyperlink *obj,
                                                         gint i,
                                                         GError **error);
AtspiRange *        atspi_hyperlink_get_index_range     (AtspiHyperlink *obj,
                                                         GError **error);
gint                atspi_hyperlink_get_start_index     (AtspiHyperlink *obj,
                                                         GError **error);
gint                atspi_hyperlink_get_end_index       (AtspiHyperlink *obj,
                                                         GError **error);
gboolean            atspi_hyperlink_is_valid            (AtspiHyperlink *obj,
                                                         GError **error);

Object Hierarchy

  GObject
   +----AtspiObject
         +----AtspiHyperlink

Description

Details

AtspiHyperlink

typedef struct _AtspiHyperlink AtspiHyperlink;


struct AtspiHyperlinkClass

struct AtspiHyperlinkClass {
  AtspiObjectClass parent_class;
};


atspi_hyperlink_new ()

AtspiHyperlink *    atspi_hyperlink_new                 (AtspiApplication *app,
                                                         const gchar *path);


atspi_hyperlink_get_n_anchors ()

gint                atspi_hyperlink_get_n_anchors       (AtspiHyperlink *obj,
                                                         GError **error);

Get the total number of anchors which an AtspiHyperlink implementor has. Though typical hyperlinks have only one anchor, client-side image maps and other hypertext objects may potentially activate or refer to multiple URIs. For each anchor there is a corresponding URI and object. see atspi_hyperlink_get_uri() and atspi_hyperlink_get_object().

obj :

a pointer to the AtspiHyperlink object on which to operate.

Returns :

a gint indicating the number of anchors in this hyperlink.

atspi_hyperlink_get_uri ()

gchar *             atspi_hyperlink_get_uri             (AtspiHyperlink *obj,
                                                         int i,
                                                         GError **error);

Get the URI associated with a particular hyperlink anchor.

obj :

a pointer to the AtspiHyperlink implementor on which to operate.

i :

a (zero-index) integer indicating which hyperlink anchor to query.

Returns :

a UTF-8 string giving the URI of the ith hyperlink anchor.

atspi_hyperlink_get_object ()

AtspiAccessible *   atspi_hyperlink_get_object          (AtspiHyperlink *obj,
                                                         gint i,
                                                         GError **error);

Get the object associated with a particular hyperlink anchor, as an Accessible.

obj :

a pointer to the AtspiHyperlink implementor on which to operate.

i :

a (zero-index) long integer indicating which hyperlink anchor to query.

Returns :

an AtspiAccessible that represents the object associated with the ith anchor of the specified AtspiHyperlink. [transfer full]

atspi_hyperlink_get_index_range ()

AtspiRange *        atspi_hyperlink_get_index_range     (AtspiHyperlink *obj,
                                                         GError **error);

Get the starting and ending character offsets of the text range associated with a AtspiHyperlink, in its originating AtspiHypertext.

obj :

a pointer to the AtspiHyperlink implementor on which to operate.

atspi_hyperlink_get_start_index ()

gint                atspi_hyperlink_get_start_index     (AtspiHyperlink *obj,
                                                         GError **error);

Get the starting character offset of the text range associated with a AtspiHyperlink, in its originating AtspiHypertext.

obj :

a pointer to the AtspiHyperlink implementor on which to operate.

atspi_hyperlink_get_end_index ()

gint                atspi_hyperlink_get_end_index       (AtspiHyperlink *obj,
                                                         GError **error);

Get the ending character offset of the text range associated with a AtspiHyperlink, in its originating AtspiHypertext.

obj :

a pointer to the AtspiHyperlink implementor on which to operate.

atspi_hyperlink_is_valid ()

gboolean            atspi_hyperlink_is_valid            (AtspiHyperlink *obj,
                                                         GError **error);

Tell whether an AtspiHyperlink object is still valid with respect to its originating hypertext object.

obj :

a pointer to the AtspiHyperlink on which to operate.

Returns :

TRUE of the specified AtspiHyperlink is still valid with respect to its originating AtspiHypertext object, FALSE otherwise.