<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>at-spi-idl: Accessibility::Hypertext Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<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="tabs2">
<ul class="tablist">
<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="navpath">
<ul>
<li><a class="el" href="namespaceAccessibility.html">Accessibility</a> </li>
<li><a class="el" href="interfaceAccessibility_1_1Hypertext.html">Accessibility::Hypertext</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Accessibility::Hypertext Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::Hypertext" -->
<p><code>import "<a class="el" href="Accessibility__Hypertext_8idl_source.html">Accessibility_Hypertext.idl</a>";</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hypertext.html#a71f987d65f51dd401747682405272611">getNLinks</a> ()</td></tr>
<tr><td class="memItemLeft" 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#a226cdcbb38d74eb94dffe085745dd9d5">getLink</a> (in long linkIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hypertext.html#a95eaac341c6e93e846f6708888eb97cc">getLinkIndex</a> (in long characterIndex)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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"><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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a226cdcbb38d74eb94dffe085745dd9d5"></a><!-- doxytag: member="Accessibility::Hypertext::getLink" ref="a226cdcbb38d74eb94dffe085745dd9d5" 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></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><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#a71f987d65f51dd401747682405272611">getNLinks()</a> - 1. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><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>
<a class="anchor" id="a95eaac341c6e93e846f6708888eb97cc"></a><!-- doxytag: member="Accessibility::Hypertext::getLinkIndex" ref="a95eaac341c6e93e846f6708888eb97cc" 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></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"><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>
<a class="anchor" id="a71f987d65f51dd401747682405272611"></a><!-- doxytag: member="Accessibility::Hypertext::getNLinks" ref="a71f987d65f51dd401747682405272611" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query the hypertext object for the number of Hyperlinks it contains.</p>
<dl class="return"><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>
<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></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Sep 27 2010 16:50:43 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
