<html> <head> <title>Interface XAccessibleContext</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="XAccessibleContext-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleContext" 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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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 XAccessibleContext</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Implement this interface for exposing various aspects of a class' content. </dd> <dd><p>This interface serves two purposes: On the one hand it gives access to the tree structure in which all accessible objects are organized. Each node in this tree supports this interface. On the other hand it gives access to objects that expose the represented content. That are role, state, name, description, and relations to other objects. Take an OK button of a dialog as an example. Its role is <b>AccessibleRole::BUTTON</b>, its name is 'OK', and its description is something like 'Accepts all changes made in the dialog'.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 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/XAccessibleContext">Accessibility - XAccessibleContext</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="#getAccessibleChildCount">getAccessibleChildCount</a></td> <td class="imsum_right">Return the number of children. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleChild">getAccessibleChild</a></td> <td class="imsum_right">Returns the i-th child of this object. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleParent">getAccessibleParent</a></td> <td class="imsum_right">Returns the parent of this object. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleIndexInParent">getAccessibleIndexInParent</a></td> <td class="imsum_right">Returns the index of this object in its accessible parent. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleRole">getAccessibleRole</a></td> <td class="imsum_right">Returns the role of this object. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleDescription">getAccessibleDescription</a></td> <td class="imsum_right">Returns the object's description. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleName">getAccessibleName</a></td> <td class="imsum_right">Return the object's localized name. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleRelationSet">getAccessibleRelationSet</a></td> <td class="imsum_right">Returns the set of relations defined for this object. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleStateSet">getAccessibleStateSet</a></td> <td class="imsum_right">Returns the set of states that are currently active for this object. </td> </tr> <tr> <td class="imsum_left"><a href="#getLocale">getLocale</a></td> <td class="imsum_right">Returns the locale of the component. </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="getAccessibleChildCount" class="membertitle">getAccessibleChildCount</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>getAccessibleChildCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return the number of children. </dd> <dd><p>Returns the number of accessible children of the object.</p> </dd> <dt><b>Returns</b></dt> <dd>The returned value is non-negative. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleChild" class="membertitle">getAccessibleChild</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="XAccessible.html">XAccessible</a></td> </tr> <tr> <td valign="top"><b>getAccessibleChild</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> i )</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 i-th child of this object. </dd> <dd><p>The order in which the children are enumerated is implementation dependend.</p> </dd> <dt><b>Parameter i</b></dt> <dd>The index may have any value. If it is outside the range from 0 to n-1, with n being the number of children as returned by <a href="XAccessibleContext.html">XAccessibleContext</a>::<a href="XAccessibleContext.html#getAccessibleChild">getAccessibleChild</a> an empty reference is returned. </dd> <dt><b>Returns</b></dt> <dd>If the object has an i-th child the returned value is a reference to that child. Otherwise an empty reference is returned. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException If no child with the given index exists then an ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> exception is thrown. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleParent" class="membertitle">getAccessibleParent</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="XAccessible.html">XAccessible</a></td> </tr> <tr> <td valign="top"><b>getAccessibleParent</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the parent of this object. </dd> <dd><p>This function may be called for every node, including the root node, of the accessible tree.</p> </dd> <dt><b>Returns</b></dt> <dd>The returned reference points to a valid object for all but the root node. If called for the root node an empty reference is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleIndexInParent" class="membertitle">getAccessibleIndexInParent</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>getAccessibleIndexInParent</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the index of this object in its accessible parent. </dd> <dd><p>If you call getAccessibeChild on the object's parent with the index returned by this function you get a reference to this object.</p> </dd> <dt><b>Returns</b></dt> <dd>The returned index is zero based. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleRole" class="membertitle">getAccessibleRole</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">short</td> </tr> <tr> <td valign="top"><b>getAccessibleRole</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the role of this object. </dd> <dd><p>The role is a generic description of an objects function. The relation between role and name is similar to the relation between class and object.</p> </dd> <dt><b>Returns</b></dt> <dd>The returned value is a role defined in the enumeration AccessibleRole. </dd> <dt><b>See also</b></dt> <dd><a href="AccessibleRole.html">AccessibleRole</a><br> for a list of the available roles. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleDescription" class="membertitle">getAccessibleDescription</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">string</td> </tr> <tr> <td valign="top"><b>getAccessibleDescription</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the object's description. </dd> <dd><p>Returns the object's localized description. The description should complement the more generic descriptions given by an object's role and name.</p> </dd> <dt><b>Returns</b></dt> <dd>The returned string is the object's localized description. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleName" class="membertitle">getAccessibleName</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">string</td> </tr> <tr> <td valign="top"><b>getAccessibleName</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return the object's localized name. </dd> <dd><p>See <a href="XAccessibleContext.html">XAccessibleContext</a>::<a href="XAccessibleContext.html#getAccessibleRole">getAccessibleRole</a>'s documentation for the relation between an object's name and role. Names should be unique, at least between children of the same parent, although the uniqueness is neither enforced nor used inside the API.</p> </dd> <dt><b>Returns</b></dt> <dd>The returned string is the object's localized name. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleRelationSet" class="membertitle">getAccessibleRelationSet</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="XAccessibleRelationSet.html">XAccessibleRelationSet</a></td> </tr> <tr> <td valign="top"><b>getAccessibleRelationSet</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the set of relations defined for this object. </dd> <dd><p>The returned set of relations is a copy of this objects relation set: changing the returned object does not change this objects relations.</p> <p>aThere are two ways to represent an empty list of relations: Return an empty reference or return a valid object that contains an empty list. </dd> <dt><b>Returns</b></dt> <dd>The returned value is either an empty referece or a reference to a valid object that represents a copy of the objects list of relations. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleStateSet" class="membertitle">getAccessibleStateSet</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="XAccessibleStateSet.html">XAccessibleStateSet</a></td> </tr> <tr> <td valign="top"><b>getAccessibleStateSet</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the set of states that are currently active for this object. </dd> <dd><p>The returned state set is a copy: Changing the returned state set will not be refelected by changing the object's set of states. See the documentation of <a href="XAccessibleStateSet.html">XAccessibleStateSet</a> for a description of the individual states.</p> </dd> <dt><b>Returns</b></dt> <dd>A reference to this object's state set or an empty reference if states are not supported. </dd> <dt><b>See also</b></dt> <dd><a href="XAccessibleStateSet.html">XAccessibleStateSet</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLocale" class="membertitle">getLocale</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">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> </tr> <tr> <td valign="top"><b>getLocale</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="IllegalAccessibleComponentStateException.html">IllegalAccessibleComponentStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the locale of the component. </dd> <dd><p>This locale is used for example to determine the language to use for the name and description texts.</p> </dd> <dt><b>Returns</b></dt> <dd>If this object does not have a locale, the locale of its parent is returned. If it does not have (yet) a parent it throws the exception <a href="IllegalAccessibleComponentStateException.html">IllegalAccessibleComponentStateException</a>. </dd> <dt><b>Throws</b></dt> <dd>IllegalAccessibleComponentStateException when this object does not (yet) have a parent. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
702
