<!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>atkmm: Atk::StateSet Class 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.2 -->
<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="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespaceAtk.html">Atk</a> </li>
<li><a class="el" href="classAtk_1_1StateSet.html">StateSet</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Atk::StateSet Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atk::StateSet" --><!-- doxytag: inherits="Glib::Object" -->
<p>An AtkStateSet determines a component's state set. <a href="#_details">More...</a></p>
<p><code>#include <atkmm/stateset.h></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for Atk::StateSet:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classAtk_1_1StateSet__inherit__graph.png" border="0" usemap="#Atk_1_1StateSet_inherit__map" alt="Inheritance graph"/></div>
<map name="Atk_1_1StateSet_inherit__map" id="Atk_1_1StateSet_inherit__map">
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,160,115,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,131,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="classAtk_1_1StateSet-members.html">List of all members.</a></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"><a class="anchor" id="adbd0e5dba45f3eb59141da59cf7ce8ed"></a><!-- doxytag: member="Atk::StateSet::gobj" ref="adbd0e5dba45f3eb59141da59cf7ce8ed" args="()" -->
AtkStateSet* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#adbd0e5dba45f3eb59141da59cf7ce8ed">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af095ba67a81cc186e6b9f512276f8017"></a><!-- doxytag: member="Atk::StateSet::gobj" ref="af095ba67a81cc186e6b9f512276f8017" args="() const " -->
const AtkStateSet* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#af095ba67a81cc186e6b9f512276f8017">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13da93101f80ad6d3a297fe9dfebb695"></a><!-- doxytag: member="Atk::StateSet::gobj_copy" ref="a13da93101f80ad6d3a297fe9dfebb695" args="()" -->
AtkStateSet* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#a13da93101f80ad6d3a297fe9dfebb695">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#ad60014ebc037244153ce812843ee4dd9">is_empty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the state set is empty, i.e. has no states set. <a href="#ad60014ebc037244153ce812843ee4dd9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#aede4c4b8495f9772d35af9da9e77395d">add_state</a> (Atk::StateType <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01173.html#ga2c2933c16c723af4d77eb939438617ca">type</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a new state for the specified type to the current state set if it is not already present. <a href="#aede4c4b8495f9772d35af9da9e77395d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7534af9c87a8e5af0c4033fafcb05f63"></a><!-- doxytag: member="Atk::StateSet::clear_states" ref="a7534af9c87a8e5af0c4033fafcb05f63" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#a7534af9c87a8e5af0c4033fafcb05f63">clear_states</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes all states from the state set. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#ab49dcdfd6f09d04e5dd11fe66be83d27">contains_state</a> (Atk::StateType <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01173.html#ga2c2933c16c723af4d77eb939438617ca">type</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the state for the specified type is in the specified set. <a href="#ab49dcdfd6f09d04e5dd11fe66be83d27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#a9f01863fb1490e645e58f1013496d7b9">remove_state</a> (Atk::StateType <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01173.html#ga2c2933c16c723af4d77eb939438617ca">type</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes the state for the specified type from the state set. <a href="#a9f01863fb1490e645e58f1013496d7b9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#a770c542a9abc8e97e28e07772d2bf442">and_sets</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> >& compare_set)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the intersection of the two sets, returning <code>0</code> if the intersection is empty. <a href="#a770c542a9abc8e97e28e07772d2bf442"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#a8561d7c446c4d1a7d27be011c2d966e7">or_sets</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> >& compare_set)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the union of the two sets. <a href="#a8561d7c446c4d1a7d27be011c2d966e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#a09d5c551ff86ff3f6b20de3bd746e87c">xor_sets</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> >& compare_set)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the exclusive-or of the two sets, returning <code>0</code> is empty. <a href="#a09d5c551ff86ff3f6b20de3bd746e87c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">Atk::StateSet</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#ab23628405857278092f4fc24ddca4fe9">wrap</a> (AtkStateSet* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#ab23628405857278092f4fc24ddca4fe9"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An AtkStateSet determines a component's state set. </p>
<p>It is composed of a set of Atk::States. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aede4c4b8495f9772d35af9da9e77395d"></a><!-- doxytag: member="Atk::StateSet::add_state" ref="aede4c4b8495f9772d35af9da9e77395d" args="(Atk::StateType type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::StateSet::add_state </td>
<td>(</td>
<td class="paramtype">Atk::StateType </td>
<td class="paramname"> <em>type</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a new state for the specified type to the current state set if it is not already present. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>An Atk::StateType. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the state for <em>type</em> is not already in <em>set</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a770c542a9abc8e97e28e07772d2bf442"></a><!-- doxytag: member="Atk::StateSet::and_sets" ref="a770c542a9abc8e97e28e07772d2bf442" args="(const Glib::RefPtr< StateSet > &compare_set)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1StateSet.html">StateSet</a>> Atk::StateSet::and_sets </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> >& </td>
<td class="paramname"> <em>compare_set</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs the intersection of the two sets, returning <code>0</code> if the intersection is empty. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">compare_set</td><td>Another <a class="el" href="classAtk_1_1StateSet.html" title="An AtkStateSet determines a component's state set.">Atk::StateSet</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classAtk_1_1StateSet.html" title="An AtkStateSet determines a component's state set.">Atk::StateSet</a> which is the intersection of the two sets. </dd></dl>
</div>
</div>
<a class="anchor" id="ab49dcdfd6f09d04e5dd11fe66be83d27"></a><!-- doxytag: member="Atk::StateSet::contains_state" ref="ab49dcdfd6f09d04e5dd11fe66be83d27" args="(Atk::StateType type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::StateSet::contains_state </td>
<td>(</td>
<td class="paramtype">Atk::StateType </td>
<td class="paramname"> <em>type</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks whether the state for the specified type is in the specified set. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>An Atk::StateType. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>type</em> is the state type is in <em>set</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="ad60014ebc037244153ce812843ee4dd9"></a><!-- doxytag: member="Atk::StateSet::is_empty" ref="ad60014ebc037244153ce812843ee4dd9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::StateSet::is_empty </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks whether the state set is empty, i.e. has no states set. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>set</em> has no states set, otherwise <code>false</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a8561d7c446c4d1a7d27be011c2d966e7"></a><!-- doxytag: member="Atk::StateSet::or_sets" ref="a8561d7c446c4d1a7d27be011c2d966e7" args="(const Glib::RefPtr< StateSet > &compare_set)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1StateSet.html">StateSet</a>> Atk::StateSet::or_sets </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> >& </td>
<td class="paramname"> <em>compare_set</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs the union of the two sets. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">compare_set</td><td>Another <a class="el" href="classAtk_1_1StateSet.html" title="An AtkStateSet determines a component's state set.">Atk::StateSet</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classAtk_1_1StateSet.html" title="An AtkStateSet determines a component's state set.">Atk::StateSet</a> which is the union of the two sets, returning <code>0</code> is empty. </dd></dl>
</div>
</div>
<a class="anchor" id="a9f01863fb1490e645e58f1013496d7b9"></a><!-- doxytag: member="Atk::StateSet::remove_state" ref="a9f01863fb1490e645e58f1013496d7b9" args="(Atk::StateType type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Atk::StateSet::remove_state </td>
<td>(</td>
<td class="paramtype">Atk::StateType </td>
<td class="paramname"> <em>type</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes the state for the specified type from the state set. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>An Atk::Type. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>type</em> was the state type is in <em>set</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a09d5c551ff86ff3f6b20de3bd746e87c"></a><!-- doxytag: member="Atk::StateSet::xor_sets" ref="a09d5c551ff86ff3f6b20de3bd746e87c" args="(const Glib::RefPtr< StateSet > &compare_set)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1StateSet.html">StateSet</a>> Atk::StateSet::xor_sets </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> >& </td>
<td class="paramname"> <em>compare_set</em> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs the exclusive-or of the two sets, returning <code>0</code> is empty. </p>
<p>The set returned by this operation contains the states in exactly one of the two sets. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">compare_set</td><td>Another <a class="el" href="classAtk_1_1StateSet.html" title="An AtkStateSet determines a component's state set.">Atk::StateSet</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classAtk_1_1StateSet.html" title="An AtkStateSet determines a component's state set.">Atk::StateSet</a> which contains the states which are in exactly one of the two sets. </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ab23628405857278092f4fc24ddca4fe9"></a><!-- doxytag: member="Atk::StateSet::wrap" ref="ab23628405857278092f4fc24ddca4fe9" args="(AtkStateSet *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1StateSet.html">Atk::StateSet</a> > wrap </td>
<td>(</td>
<td class="paramtype">AtkStateSet * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Mar 30 2011 09:27:41 for atkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
