<!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::StateSet 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_1StateSet.html">StateSet</a></div>
<h1>Accessibility::StateSet Interface Reference</h1><!-- doxytag: class="Accessibility::StateSet" --><code>import "<a class="el" href="Accessibility__State_8idl-source.html">Accessibility_State.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">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#2dd75d76ef2154cd9c8482a1c2f6c986">contains</a> (in <a class="el" href="namespaceAccessibility.html#b031cd3b44c1273acafd59ea54dd998c">StateType</a> state)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#3ca8bff7aa7759135257847f51916c4b">add</a> (in <a class="el" href="namespaceAccessibility.html#b031cd3b44c1273acafd59ea54dd998c">StateType</a> state)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#c55f1baa87ef832a3275e1eaa5566743">remove</a> (in <a class="el" href="namespaceAccessibility.html#b031cd3b44c1273acafd59ea54dd998c">StateType</a> state)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#79163ff84ed448563745978547827750">equals</a> (in <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> tarStateSet)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#d6fbfdefe84e06683d49991bf104a3c7">compare</a> (in <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> compareState)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#a88b95223adefaddda07020f37b682a9">isEmpty</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> interface encapsulates a collection of state information. It allows comparison of state information between object instances, and comparisons of an object's state with some hypothetical collection of states.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2dd75d76ef2154cd9c8482a1c2f6c986"></a><!-- doxytag: member="Accessibility::StateSet::contains" ref="2dd75d76ef2154cd9c8482a1c2f6c986" args="(in StateType state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::StateSet::contains </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#b031cd3b44c1273acafd59ea54dd998c">StateType</a> </td>
<td class="paramname"> <em>state</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query a <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> for a specific StateType. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>state</em> </td><td>the StateType being queried for. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>TRUE</code> if the <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> contains StateType <em>state</em>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3ca8bff7aa7759135257847f51916c4b"></a><!-- doxytag: member="Accessibility::StateSet::add" ref="3ca8bff7aa7759135257847f51916c4b" args="(in StateType state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::StateSet::add </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#b031cd3b44c1273acafd59ea54dd998c">StateType</a> </td>
<td class="paramname"> <em>state</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a StateType to an existing <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a>, if not already present.
</div>
</div><p>
<a class="anchor" name="c55f1baa87ef832a3275e1eaa5566743"></a><!-- doxytag: member="Accessibility::StateSet::remove" ref="c55f1baa87ef832a3275e1eaa5566743" args="(in StateType state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::StateSet::remove </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#b031cd3b44c1273acafd59ea54dd998c">StateType</a> </td>
<td class="paramname"> <em>state</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a StateType to an existing <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a>, if it is present.
</div>
</div><p>
<a class="anchor" name="79163ff84ed448563745978547827750"></a><!-- doxytag: member="Accessibility::StateSet::equals" ref="79163ff84ed448563745978547827750" args="(in StateSet tarStateSet)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::StateSet::equals </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> </td>
<td class="paramname"> <em>tarStateSet</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compare two statesets for equivalence. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tarStateSet</em> </td><td>the <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> to be compared with this one. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>TRUE</code> if the two <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> objects are composed of the same StateTypes. </dd></dl>
</div>
</div><p>
<a class="anchor" name="d6fbfdefe84e06683d49991bf104a3c7"></a><!-- doxytag: member="Accessibility::StateSet::compare" ref="d6fbfdefe84e06683d49991bf104a3c7" args="(in StateSet compareState)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> Accessibility::StateSet::compare </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> </td>
<td class="paramname"> <em>compareState</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compare two <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> instances and obtain their differences. <dl class="return" compact><dt><b>Returns:</b></dt><dd>a 'difference set', i.e. a <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> consisting of those states not shared by the two sets being compared. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a88b95223adefaddda07020f37b682a9"></a><!-- doxytag: member="Accessibility::StateSet::isEmpty" ref="a88b95223adefaddda07020f37b682a9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::StateSet::isEmpty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>TRUE</code> if the <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> contains no states. </dd></dl>
</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__State_8idl-source.html">Accessibility_State.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>
