|  |  |  | AT-SPI C Bindings Reference Manual | |
|---|---|---|---|---|
| Top | Description | ||||
void AccessibleHyperlink_ref (AccessibleHyperlink *obj); void AccessibleHyperlink_unref (AccessibleHyperlink *obj); long AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj); void AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj,long int *startIndex,long int *endIndex); Accessible * AccessibleHyperlink_getObject (AccessibleHyperlink *obj,long int i); char * AccessibleHyperlink_getURI (AccessibleHyperlink *obj,long int i); SPIBoolean AccessibleHyperlink_isValid (AccessibleHyperlink *obj);
void                AccessibleHyperlink_ref             (AccessibleHyperlink *obj);
Increment the reference count for an AccessibleHyperlink object.
| 
 | a pointer to the AccessibleHyperlink object on which to operate. | 
void                AccessibleHyperlink_unref           (AccessibleHyperlink *obj);
Decrement the reference count for an AccessibleHyperlink object.
| 
 | a pointer to the AccessibleHyperlink object on which to operate. | 
long                AccessibleHyperlink_getNAnchors     (AccessibleHyperlink *obj);
Get the total number of anchors which an AccessibleHyperlink 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 AccessibleHyperlink_getURI() and AccessibleHyperlink_getObject().
| 
 | a pointer to the AccessibleHyperlink object on which to operate. | 
| Returns : | a long indicating the number of anchors in this hyperlink. | 
void AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj,long int *startIndex,long int *endIndex);
Get the starting and ending character offsets of the text range associated with a AccessibleHyperlink, in its originating AccessibleHypertext.
| 
 | a pointer to the AccessibleHyperlink implementor on which to operate. | 
| 
 | a pointer to a long integer into which the starting offset of the text associated with this AccessibleHyperlink is returned. | 
| 
 | a pointer to a long integer into which the offset of the first character after the text associated with this AccessibleHyperlink is returned. | 
Accessible * AccessibleHyperlink_getObject (AccessibleHyperlink *obj,long int i);
Get the object associated with a particular hyperlink anchor, as an Accessible.
| 
 | a pointer to the AccessibleHyperlink implementor on which to operate. | 
| 
 | a (zero-index) long integer indicating which hyperlink anchor to query. | 
| Returns : | an Accessible that represents the object associated with the ithanchor
       of the specified AccessibleHyperlink. | 
char * AccessibleHyperlink_getURI (AccessibleHyperlink *obj,long int i);
Get the URI associated with a particular hyperlink anchor.
| 
 | a pointer to the AccessibleHyperlink implementor on which to operate. | 
| 
 | a (zero-index) long integer indicating which hyperlink anchor to query. | 
| Returns : | a UTF-8 string giving the URI of the ithhyperlink anchor. | 
SPIBoolean          AccessibleHyperlink_isValid         (AccessibleHyperlink *obj);
Tell whether an AccessibleHyperlink object is still valid with respect to its originating hypertext object.
| 
 | a pointer to the AccessibleHyperlink on which to operate. | 
| Returns : | TRUE of the specified AccessibleHyperlink is still valid with respect to its originating AccessibleHypertext object, FALSE otherwise. |