<!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::StateSet 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_1StateSet.html">Accessibility::StateSet</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::StateSet Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::StateSet" -->
<p><code>import "<a class="el" href="Accessibility__State_8idl_source.html">Accessibility_State.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">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#a7704c3acd93e398801f375ff16904a21">contains</a> (in <a class="el" href="namespaceAccessibility.html#ae820646a33b95416ad4d0ce3587035be">StateType</a> state)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#abeee33e22dba83aeb960e6d7038fbeb3">add</a> (in <a class="el" href="namespaceAccessibility.html#ae820646a33b95416ad4d0ce3587035be">StateType</a> state)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#a7113042d4928fc65f4162ff5297d387b">remove</a> (in <a class="el" href="namespaceAccessibility.html#ae820646a33b95416ad4d0ce3587035be">StateType</a> state)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#ad1e01a8c031df7ef28142da06e221051">equals</a> (in <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> tarStateSet)</td></tr>
<tr><td class="memItemLeft" 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#a752027eb27086d4a37f6a1c63b0b7ea9">compare</a> (in <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> compareState)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1StateSet.html#a5487ed1b62af88eb5f5a6b131d50a390">isEmpty</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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" id="abeee33e22dba83aeb960e6d7038fbeb3"></a><!-- doxytag: member="Accessibility::StateSet::add" ref="abeee33e22dba83aeb960e6d7038fbeb3" 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#ae820646a33b95416ad4d0ce3587035be">StateType</a> </td>
<td class="paramname"> <em>state</em></td>
<td> ) </td>
<td></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. </p>
</div>
</div>
<a class="anchor" id="a752027eb27086d4a37f6a1c63b0b7ea9"></a><!-- doxytag: member="Accessibility::StateSet::compare" ref="a752027eb27086d4a37f6a1c63b0b7ea9" 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></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. </p>
<dl class="return"><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>
<a class="anchor" id="a7704c3acd93e398801f375ff16904a21"></a><!-- doxytag: member="Accessibility::StateSet::contains" ref="a7704c3acd93e398801f375ff16904a21" 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#ae820646a33b95416ad4d0ce3587035be">StateType</a> </td>
<td class="paramname"> <em>state</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Query a <a class="el" href="interfaceAccessibility_1_1StateSet.html">StateSet</a> for a specific StateType. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><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>
<a class="anchor" id="ad1e01a8c031df7ef28142da06e221051"></a><!-- doxytag: member="Accessibility::StateSet::equals" ref="ad1e01a8c031df7ef28142da06e221051" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compare two statesets for equivalence. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><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>
<a class="anchor" id="a5487ed1b62af88eb5f5a6b131d50a390"></a><!-- doxytag: member="Accessibility::StateSet::isEmpty" ref="a5487ed1b62af88eb5f5a6b131d50a390" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><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>
<a class="anchor" id="a7113042d4928fc65f4162ff5297d387b"></a><!-- doxytag: member="Accessibility::StateSet::remove" ref="a7113042d4928fc65f4162ff5297d387b" 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#ae820646a33b95416ad4d0ce3587035be">StateType</a> </td>
<td class="paramname"> <em>state</em></td>
<td> ) </td>
<td></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. </p>
</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__State_8idl_source.html">Accessibility_State.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>
