<!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::Hyperlink 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_1Hyperlink.html">Hyperlink</a></div>
<h1>Accessibility::Hyperlink Interface Reference</h1><!-- doxytag: class="Accessibility::Hyperlink" --><code>import "<a class="el" href="Accessibility__Hyperlink_8idl-source.html">Accessibility_Hyperlink.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"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#91d295ccf1f70fad25da559aeecac15e">getObject</a> (in long i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#56704bdd0f28b6185980ef5598bc27e3">getURI</a> (in long i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#0c1be53852aed53315e1c9ded7c1c1de">isValid</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute short </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#f911700a26c410fc9ecdd1d8989e8aa4">nAnchors</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#de67595afcdb8b60e2ca5b8b7b94f5c0">startIndex</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute long </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#4d7a910fec3e666a2459448b9be44c87">endIndex</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Instances of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> are returned by <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> objects, and are the means by which end users and clients interact with linked, and in some cases embedded, content. Hyperlinks may have multiple "anchors", where an anchor corresponds to a reference to a particular resource with a corresponding resource identified (URI). Hyperlinks may be queried for their URIs, or queried for the objects corresponding to their anchors. The objects thus obtained are instances of <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>, and may be queried, and manipulated via the <a class="el" href="interfaceAccessibility_1_1Action.html">Action</a> interface.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>A <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> implementor is normally NOT an <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>; the preferred usage is for a Hyperlink's associated "objects" (accessed via the getObject method) are Accessibles. This means that Actions such as "open link" are normally invoked on the result of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#91d295ccf1f70fad25da559aeecac15e">Hyperlink::getObject</a> rather than directly on the <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> instance. For historical reasons some implementors of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> implement <a class="el" href="interfaceAccessibility_1_1Action.html">Action</a> as well. This usage on the part of implementing applications and toolkits is discouraged, but clients of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> should be aware of it and prepared to handle such usage. </dd></dl>
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="91d295ccf1f70fad25da559aeecac15e"></a><!-- doxytag: member="Accessibility::Hyperlink::getObject" ref="91d295ccf1f70fad25da559aeecac15e" args="(in long i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> Accessibility::Hyperlink::getObject </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the i'th object, (where i is an integer between 0 and Hyperlink::numAnchors - 1, inclusive) associated with a <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a>. The objects returned are usually actionable (i.e. they should implement <a class="el" href="interfaceAccessibility_1_1Action.html">Accessibility::Action</a>), and the available actions often include "open", "bookmark", "save link as", etc. They may also implement <a class="el" href="interfaceAccessibility_1_1StreamableContent.html">Accessibility::StreamableContent</a>, although clients can normally use getURI to obtain a resource locator via which the object's data may be accessed.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>the most common application for 'multi anchor' hyperlinks in HTML is probably "client side imagemaps". A clickable image which uses the HTML 'usemap' attribute should have one anchor for every <area> element that includes an HREF. The objects corresponding to these map areas may implement <a class="el" href="interfaceAccessibility_1_1Component.html">Accessibility::Component</a>, to represent their onscreen bounding box, and may expose their 'shape' as as name-value pair via Accessibility::Accessible::getAttributeSet.</dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>an <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> object instance representing the Hyperlink's ith anchor, or through which the content associated with the <code>ith</code> anchor can be accessed. </dd></dl>
</div>
</div><p>
<a class="anchor" name="56704bdd0f28b6185980ef5598bc27e3"></a><!-- doxytag: member="Accessibility::Hyperlink::getURI" ref="56704bdd0f28b6185980ef5598bc27e3" args="(in long i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Accessibility::Hyperlink::getURI </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Obtain a resource locator ('URI') which can be used to access the content to which this link "points" or is connected. <dl class="return" compact><dt><b>Returns:</b></dt><dd>a string corresponding to the URI of the Hyperlink's 'ith' anchor, if one exists, or a NIL string otherwise. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0c1be53852aed53315e1c9ded7c1c1de"></a><!-- doxytag: member="Accessibility::Hyperlink::isValid" ref="0c1be53852aed53315e1c9ded7c1c1de" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::Hyperlink::isValid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check the hyperlink to see if a connection to its backing content can be established, or if its URI is valid. <dl class="note" compact><dt><b>Note:</b></dt><dd>instances of invalid hyperlinks include links with malformed URIs, or for which a contact to the service provider specified in the URI cannot be established. </dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>True</code> if the object's content is available, or <code>False</code> if the hyperlink's URI is invalid, or a connection to the resource can not be established. </dd></dl>
</div>
</div><p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="f911700a26c410fc9ecdd1d8989e8aa4"></a><!-- doxytag: member="Accessibility::Hyperlink::nAnchors" ref="f911700a26c410fc9ecdd1d8989e8aa4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute short <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#f911700a26c410fc9ecdd1d8989e8aa4">Accessibility::Hyperlink::nAnchors</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the number of separate anchors associated with this <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a>
</div>
</div><p>
<a class="anchor" name="de67595afcdb8b60e2ca5b8b7b94f5c0"></a><!-- doxytag: member="Accessibility::Hyperlink::startIndex" ref="de67595afcdb8b60e2ca5b8b7b94f5c0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#de67595afcdb8b60e2ca5b8b7b94f5c0">Accessibility::Hyperlink::startIndex</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the starting offset within the containing <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> content with which this <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> is associated
</div>
</div><p>
<a class="anchor" name="4d7a910fec3e666a2459448b9be44c87"></a><!-- doxytag: member="Accessibility::Hyperlink::endIndex" ref="4d7a910fec3e666a2459448b9be44c87" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#4d7a910fec3e666a2459448b9be44c87">Accessibility::Hyperlink::endIndex</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the ending offset within the containing <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> content with which this <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> is associated; that is, the offset of the first element past the range within the <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> associated with this <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a>.
</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__Hyperlink_8idl-source.html">Accessibility_Hyperlink.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>
