IAccessibleHypertext Interface Reference

This interface exposes information about hypertext in a document. More...

import "AccessibleHypertext.idl";

Inheritance diagram for IAccessibleHypertext:

IAccessibleText

List of all members.


Public Member Functions

HRESULT nHyperlinks ([out, retval] long *hyperlinkCount)
 Returns the number of links and link groups contained within this hypertext paragraph.
HRESULT hyperlink ([in] long index,[out, retval] IAccessibleHyperlink **hyperlink)
 Returns the specified link.
HRESULT hyperlinkIndex ([in] long charIndex,[out, retval] long *hyperlinkIndex)
 Returns the index of the hyperlink that is associated with this character index.

Detailed Description

This interface exposes information about hypertext in a document.

The IAccessibleHypertext interface is the main interface to expose hyperlinks in a document, typically a text document, that are used to reference other documents. A typical implementation is to implement this interface the smallest text object such as a paragraph of text.


Member Function Documentation

HRESULT IAccessibleHypertext::hyperlink ( [in] long  index,
[out, retval] IAccessibleHyperlink **  hyperlink 
) [get]

Returns the specified link.

The returned IAccessibleHyperlink object encapsulates the hyperlink and provides several kinds of information describing it.

Parameters:
[in] index This 0 based index specifies the hyperlink to return.
[out] hyperlink If the given index is valid, i.e. lies in the interval from 0 to the number of links minus one, a reference to the specified hyperlink object is returned. If the index is invalid then a NULL pointer is returned.
Return values:
S_OK 
E_INVALIDARG if bad [in] passed, [out] value is NULL

HRESULT IAccessibleHypertext::hyperlinkIndex ( [in] long  charIndex,
[out, retval] long *  hyperlinkIndex 
) [get]

Returns the index of the hyperlink that is associated with this character index.

This is the case when a link spans the given character index.

Parameters:
[in] charIndex A 0 based index of the character for which to return the link index. If IAccessibleText is used to represent the text containing the link, then the character index is only valid if it is greater than or equal to zero and lower than the number of characters in the text.
[out] hyperlinkIndex Returns the 0 based index of the hyperlink that is associated with this character index, or -1 if charIndex is not on a link.
Return values:
S_OK 
S_FALSE if there is nothing to return, [out] value is -1
E_INVALIDARG if bad [in] passed, [out] value is NULL

HRESULT IAccessibleHypertext::nHyperlinks ( [out, retval] long *  hyperlinkCount  )  [get]

Returns the number of links and link groups contained within this hypertext paragraph.

Parameters:
[out] hyperlinkCount The number of links and link groups within this hypertext paragraph. Returns 0 if there is no link.
Return values:
S_OK 


The documentation for this interface was generated from the following file:

To submit feedback on IAccessible2 API Version 1.0.2, please use the Bugzilla interface located at: http://bugs.linuxfoundation.org/. When using Bugzilla please be sure to select IAccessible2 from the list of components. Bugzilla is the preferred method for receiving feedback because it automatically logs one's feedback in the IAccessible2 tracking system without additional human intervention. One may also, however, send email to accessibility-rfc@a11y.org, a publicly archived emailing list. Please address any technical problems you encounter with this document or the resources to which it links, to the Open A11y Webmaster <webmaster@a11y.org>

A stable online reference version of the documentation for IAccessible2 API Version 1.0.2, is available at: http://a11y.org/ia2-spec. A list of known and reported errors in the documentation for IAccessible2 API Version 1.0.2 can be found at: http://a11y.org/ia2-errata


Generated on Mon Oct 13 23:32:04 2008 for IAccessible2 API Version 1.0.2 by  doxygen 1.5.6