<html> <head> <title>Interface XAccessibleRelationSet</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XAccessibleRelationSet-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleRelationSet" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">accessibility</a> :: </p> </td> </tr> <tr> <td class="title">interface XAccessibleRelationSet</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Implement this interface to give access to an object's set of relations. </dd> <dd><p>Such relation are modeled with the <a href="AccessibleRelation.html">AccessibleRelation</a> structure. This interface is used for representing sets of relations between <a href="Accessible.html">Accessible</a> objects. Most of the convenience methods of the corresponding AccessibleRelationSet interface of the Java Accessibility API have been removed from this interface in order to clean it up. These methods are <a href="XAccessibleRelationSet.html#add">add</a>, <a href="XAccessibleRelationSet.html#addAll">addAll</a>, <a href="XAccessibleRelationSet.html#clear">clear</a>, and <a href="XAccessibleRelationSet.html#remove">remove</a>. The other methods have been renamed to achieve a greater conformance with the other accessibility interfaces.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 1.1.2</dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleRelationSet">Accessibility - XAccessibleRelationSet</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getRelationCount">getRelationCount</a></td> <td class="imsum_right">Returns the number of relations in this relation set. </td> </tr> <tr> <td class="imsum_left"><a href="#getRelation">getRelation</a></td> <td class="imsum_right">Returns the relation of this relation set that is specified by the given index. </td> </tr> <tr> <td class="imsum_left"><a href="#containsRelation">containsRelation</a></td> <td class="imsum_right">Tests whether the relation set contains a relation matching the specified key. </td> </tr> <tr> <td class="imsum_left"><a href="#getRelationByType">getRelationByType</a></td> <td class="imsum_right">Retrieve and return the relation with the given relation type. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getRelationCount" class="membertitle">getRelationCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getRelationCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the number of relations in this relation set. </dd> <dt><b>Returns</b></dt> <dd>Returns the number of relations or zero if there are none. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRelation" class="membertitle">getRelation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="AccessibleRelation.html">AccessibleRelation</a></td> </tr> <tr> <td valign="top"><b>getRelation</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the relation of this relation set that is specified by the given index. </dd> <dt><b>Parameter nIndex</b></dt> <dd>This index specifies the relation to return. </dd> <dt><b>Returns</b></dt> <dd>For a valid index, i.e. inside the range 0 to the number of relations minus one, the returned value is the requested relation. If the index is invalid then the returned relation has the type INVALID. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="containsRelation" class="membertitle">containsRelation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>containsRelation</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> aRelationType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Tests whether the relation set contains a relation matching the specified key. </dd> <dt><b>Parameter aRelationType</b></dt> <dd>The type of relation to look for in this set of relations. This has to be one of the constants of <a href="AccessibleRelationType.html">AccessibleRelationType</a>. </dd> <dt><b>Returns</b></dt> <dd>Returns <b>true</b> if there is a (at least one) relation of the given type and <b>false</b> if there is no such relation in the set. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRelationByType" class="membertitle">getRelationByType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="AccessibleRelation.html">AccessibleRelation</a></td> </tr> <tr> <td valign="top"><b>getRelationByType</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> aRelationType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Retrieve and return the relation with the given relation type. </dd> <dt><b>Parameter aRelationType</b></dt> <dd>The type of the relation to return. This has to be one of the constants of <a href="AccessibleRelationType.html">AccessibleRelationType</a>. </dd> <dt><b>Returns</b></dt> <dd>If a relation with the given type could be found than (a copy of) this relation is returned. Otherwise a relation with the type INVALID is returned. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
