<html> <head> <title>Interface XAccessibleStateSet</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="XAccessibleStateSet-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleStateSet" 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 XAccessibleStateSet</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Implement this interface to represent a set of states. </dd> <dd><p>The interface <a href="XAccessibleStateSet.html">XAccessibleStateSet</a> represents a set of states of an accessible object. It can hold any combination of states defined by the constants collection <a href="AccessibleStateType.html">AccessibleStateType</a>.</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/XAccessibleStateSet">Accessibility - XAccessibleStateSet</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="#isEmpty">isEmpty</a></td> <td class="imsum_right">Checks whether the current state set is empty. </td> </tr> <tr> <td class="imsum_left"><a href="#contains">contains</a></td> <td class="imsum_right">Checks if the given state is a member of the state set of the called object. </td> </tr> <tr> <td class="imsum_left"><a href="#containsAll">containsAll</a></td> <td class="imsum_right">Checks if all of the given states are in the state set of the called object. </td> </tr> <tr> <td class="imsum_left"><a href="#getStates">getStates</a></td> <td class="imsum_right">Get all currently set states as a sequence of state ids. </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="isEmpty" class="membertitle">isEmpty</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>isEmpty</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Checks whether the current state set is empty. </dd> <dt><b>Returns</b></dt> <dd>Returns <b>true</b> if there is no state in this state set and <b>false</b> if there is at least one set state in it. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="contains" class="membertitle">contains</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>contains</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> aState );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Checks if the given state is a member of the state set of the called object. </dd> <dt><b>Parameter aState</b></dt> <dd>The state for which to check membership. This has to be one of the constants of <a href="AccessibleStateType.html">AccessibleStateType</a>. </dd> <dt><b>Returns</b></dt> <dd>Returns <b>true</b> if the given state is a memeber of this object's state set and <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="containsAll" class="membertitle">containsAll</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>containsAll</b>(</td> <td valign="top">[in] sequence< short ></td> <td valign="bottom"> aStateSet );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Checks if all of the given states are in the state set of the called object. </dd> <dt><b>Parameter aStateSet</b></dt> <dd>This sequence of states is interpreted as set and every of its members, duplicates are ignored, is checked for membership in this object's state set. Each state has to be one of the constants of <a href="AccessibleStateType.html">AccessibleStateType</a>. </dd> <dt><b>Returns</b></dt> <dd>Returns <b>true</b> if all states of the given state set are members of this object's state set. <b>false</b> is returned if at least one of the states in the given state is not a member of this object's state set. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStates" class="membertitle">getStates</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">sequence< short ></td> </tr> <tr> <td valign="top"><b>getStates</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Get all currently set states as a sequence of state ids. </dd> <dd><p>The purpose of this function is to reduce the communication between accessibility objects and AT. Without this function an AT-Tool had to call <a href="#contains()">contains()</a> for every state type. Now a single call is sufficient.</p> </dd> <dt><b>Returns</b></dt> <dd>The returned sequence contains one entry for every currently set state. This entry is the id of that state. The order of the states in the sequence is undefined. </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
>
724
