Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

Accessibility::Hypertext Interface Reference

An interface used for objects which implement linking between multiple resource or content locations, or multiple 'markers' within a single document. More...

import "Accessibility_Hypertext.idl";

List of all members.

Public Member Functions

long getNLinks ()
 Query the hypertext object for the number of Hyperlinks it contains.
Hyperlink getLink (in long linkIndex)
 Get one of the Hyperlinks associated with this Hypertext object, by index.
long getLinkIndex (in long characterIndex)
 Get the hyperlink index, if any, associated with a particular character offset in the Hypertext object.
HyperlinkSet getLinks ()
 Obtain a list containing all of the hyperlinks associated with a Hypertext instance, with their associated text offsets.


Detailed Description

An interface used for objects which implement linking between multiple resource or content locations, or multiple 'markers' within a single document.

A Hypertext instance is associated with one or more Hyperlinks, which are associated with particular offsets within the Hypertext's included content.

Note:
While this interface is derived from Text, there is no requirement that Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets.

Definition at line 38 of file Accessibility_Hypertext.idl.


Member Function Documentation

long Accessibility::Hypertext::getNLinks  ) 
 

Query the hypertext object for the number of Hyperlinks it contains.

Returns:
the number of Hyperlinks associated with this Hypertext object, as a long integer.

Hyperlink Accessibility::Hypertext::getLink in long  linkIndex  ) 
 

Get one of the Hyperlinks associated with this Hypertext object, by index.

Parameters:
linkIndex an integer from 0 to getNLinks() - 1.
Returns:
the Hyperlink in this Hypertext object.

long Accessibility::Hypertext::getLinkIndex in long  characterIndex  ) 
 

Get the hyperlink index, if any, associated with a particular character offset in the Hypertext object.

For Hypertext implementors without textual content, all hyperlinks are associated with character offset '0'.

Returns:
the index of the Hyperlink associated with character offset characterIndex, or -1 if no Hyperlink is associated with that character offset.

HyperlinkSet Accessibility::Hypertext::getLinks  ) 
 

Obtain a list containing all of the hyperlinks associated with a Hypertext instance, with their associated text offsets.

Returns:
a HyperlinkSet containing all of the Hyperlink instances associated with this Hypertext instance.
Since:
AT-SPI 1.7.0


The documentation for this interface was generated from the following file:
Generated on Fri Dec 2 15:20:46 2005 for AT_SPI_IDL by  doxygen 1.4.3