<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>at-spi-idl: Accessibility::Hypertext Interface Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceAccessibility.html">Accessibility</a>::<a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a></div>
<h1>Accessibility::Hypertext Interface Reference</h1><!-- doxytag: class="Accessibility::Hypertext" --><code>import "<a class="el" href="Accessibility__Hypertext_8idl-source.html">Accessibility_Hypertext.idl</a>";</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hypertext.html#8bba73b733fe47604d40afcf65e53e60">getNLinks</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hypertext.html#762f7dbb00064faba4c0fda4c1c05e13">getLink</a> (in long linkIndex)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hypertext.html#5fdb99ff7e23898992b6a25e4fac3c98">getLinkIndex</a> (in long characterIndex)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An interface used for objects which implement linking between multiple resource or content locations, or multiple 'markers' within a single document. A <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> instance is associated with one or more Hyperlinks, which are associated with particular offsets within the Hypertext's included content.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>While this interface is derived from Text, there is no requirement that <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets. </dd></dl>
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8bba73b733fe47604d40afcf65e53e60"></a><!-- doxytag: member="Accessibility::Hypertext::getNLinks" ref="8bba73b733fe47604d40afcf65e53e60" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Accessibility::Hypertext::getNLinks </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the hypertext object for the number of Hyperlinks it contains.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of Hyperlinks associated with this <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> object, as a long integer. </dd></dl>
</div>
</div><p>
<a class="anchor" name="762f7dbb00064faba4c0fda4c1c05e13"></a><!-- doxytag: member="Accessibility::Hypertext::getLink" ref="762f7dbb00064faba4c0fda4c1c05e13" args="(in long linkIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> Accessibility::Hypertext::getLink </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>linkIndex</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get one of the Hyperlinks associated with this <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> object, by index.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>linkIndex</em> </td><td>an integer from 0 to <a class="el" href="interfaceAccessibility_1_1Hypertext.html#8bba73b733fe47604d40afcf65e53e60">getNLinks()</a> - 1. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> in this <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5fdb99ff7e23898992b6a25e4fac3c98"></a><!-- doxytag: member="Accessibility::Hypertext::getLinkIndex" ref="5fdb99ff7e23898992b6a25e4fac3c98" args="(in long characterIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Accessibility::Hypertext::getLinkIndex </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>characterIndex</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the hyperlink index, if any, associated with a particular character offset in the <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> object. For <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> implementors without textual content, all hyperlinks are associated with character offset '0'.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the index of the <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> associated with character offset <code>characterIndex</code>, or -1 if no <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> is associated with that character offset. </dd></dl>
</div>
</div><p>
<hr>The documentation for this interface was generated from the following file:<ul>
<li>/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__Hypertext_8idl-source.html">Accessibility_Hypertext.idl</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jul 10 10:46:52 2007 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
