<!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::Relation 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_1Relation.html">Accessibility::Relation</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::Relation Interface Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="Accessibility::Relation" --> <p><code>import "<a class="el" href="Accessibility__Relation_8idl_source.html">Accessibility_Relation.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"><a class="el" href="namespaceAccessibility.html#abbcafcdb67ffdf01e14b7351e6de2180">RelationType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Relation.html#a289f47a651f713e1acba4846c0a40c50">getRelationType</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Relation.html#a872389bce90f50e38a9cbcb7369cf303">getRelationTypeName</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Relation.html#a6890b8d64e6a902633a1c57338455dae">getNTargets</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">Object </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Relation.html#a2605607e51d7f2cf8dd2d6f0277b8c01">getTarget</a> (in short index)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>An interface via which objects' non-hierarchical relationships to one another are indicated. An instance of Relations represents a "one-to-many" correspondance.</p> <dl class="note"><dt><b>Note:</b></dt><dd>This interface inherits from a base class implementing ref counts. </dd></dl> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a6890b8d64e6a902633a1c57338455dae"></a><!-- doxytag: member="Accessibility::Relation::getNTargets" ref="a6890b8d64e6a902633a1c57338455dae" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">short Accessibility::Relation::getNTargets </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>the number of objects to which this relationship applies. </dd></dl> </div> </div> <a class="anchor" id="a289f47a651f713e1acba4846c0a40c50"></a><!-- doxytag: member="Accessibility::Relation::getRelationType" ref="a289f47a651f713e1acba4846c0a40c50" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="namespaceAccessibility.html#abbcafcdb67ffdf01e14b7351e6de2180">RelationType</a> Accessibility::Relation::getRelationType </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>the RelationType of this <a class="el" href="interfaceAccessibility_1_1Relation.html">Relation</a>. </dd></dl> </div> </div> <a class="anchor" id="a872389bce90f50e38a9cbcb7369cf303"></a><!-- doxytag: member="Accessibility::Relation::getRelationTypeName" ref="a872389bce90f50e38a9cbcb7369cf303" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">string Accessibility::Relation::getRelationTypeName </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>an unlocalized string representing the relation type. </dd></dl> </div> </div> <a class="anchor" id="a2605607e51d7f2cf8dd2d6f0277b8c01"></a><!-- doxytag: member="Accessibility::Relation::getTarget" ref="a2605607e51d7f2cf8dd2d6f0277b8c01" args="(in short index)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Object Accessibility::Relation::getTarget </td> <td>(</td> <td class="paramtype">in short </td> <td class="paramname"> <em>index</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>an Object which is the 'nth'target of this <a class="el" href="interfaceAccessibility_1_1Relation.html">Relation</a>, e.g. the Object at index i in the list of Objects having the specified relationship to this <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>. </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>This target should always implement <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>, though it is returned as an Object. (In this respect this method is probably ill-specified.) </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__Relation_8idl_source.html">Accessibility_Relation.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>