<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Atk::StateSet class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head> <body bgcolor="#ffffff"> <table border="0" width="100%"> <tr> <td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td> <td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td> </tr> </table> <center> <a class="qindex" href="../../index.html">Main Page</a> <a href="group__Widgets.html">Widgets</a> <a class="qindex" href="namespaces.html"> Namespaces</a> <a href="../../tutorial/html/index.html"> Book</a> </center> <hr width="100%"/> <!-- Generated by Doxygen 1.3-rc1 --> <h1>Atk::StateSet Class Reference</h1>Inheritance diagram for Atk::StateSet:<p><center><img src="classAtk_1_1StateSet__inherit__graph.png" border="0" usemap="#Atk_1_1StateSet__inherit__map" alt="Inheritance graph"></center> <map name="Atk_1_1StateSet__inherit__map"> <area href="classGlib_1_1Object.html" shape="rect" coords="21,86,101,105" alt=""> <area href="classGlib_1_1ObjectBase.html" shape="rect" coords="7,17,116,36" alt=""> </map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classAtk_1_1StateSet-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a0">~StateSet</a> ()</td></tr> <tr><td nowrap align=right valign=top>AtkStateSet* </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a1">gobj</a> ()</td></tr> <tr><td nowrap align=right valign=top>const AtkStateSet* </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a2">gobj</a> () const</td></tr> <tr><td nowrap align=right valign=top>AtkStateSet* </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a3">gobj_copy</a> ()</td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a4">is_empty</a> () const</td></tr> <tr><td> </td><td><font size=-1><em>Checks whether the state set is empty, i.e. has no states set.</em> <a href="#a4"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a5">add_state</a> (<a class="el" href="group__atkmmEnums.html#a4">StateType</a> type)</td></tr> <tr><td> </td><td><font size=-1><em>Add a new state for the specified type to the current state set if it is not already present.</em> <a href="#a5"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a6">add_states</a> (const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="el" href="group__atkmmEnums.html#a4">StateType</a>>& types)</td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a7">clear_states</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>Removes all states from the state set.</em> <a href="#a7"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a8">contains_state</a> (<a class="el" href="group__atkmmEnums.html#a4">StateType</a> type)</td></tr> <tr><td> </td><td><font size=-1><em>Checks whether the state for the specified type is in the specified set.</em> <a href="#a8"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a9">contains_states</a> (const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="el" href="group__atkmmEnums.html#a4">StateType</a>>& types) const</td></tr> <tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a10">remove_state</a> (<a class="el" href="group__atkmmEnums.html#a4">StateType</a> type)</td></tr> <tr><td> </td><td><font size=-1><em>Removes the state for the specified type from the state set.</em> <a href="#a10"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet> </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a11">and_sets</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet>& compare_set)</td></tr> <tr><td> </td><td><font size=-1><em>Constructs the intersection of the two sets, returning <code>0</code> if the intersection is empty.</em> <a href="#a11"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet> </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a12">or_sets</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet>& compare_set)</td></tr> <tr><td> </td><td><font size=-1><em>Constructs the union of the two sets.</em> <a href="#a12"></a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet> </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#a13">xor_sets</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet>& compare_set)</td></tr> <tr><td> </td><td><font size=-1><em>Constructs the exclusive-or of the two sets, returning <code>0</code> is empty.</em> <a href="#a13"></a><em></em></font><br><br></td></tr> <tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet> </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#d0">create</a> ()</td></tr> <tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#b0">StateSet</a> ()</td></tr> <tr><td colspan=2><br><h2>Related Functions</h2></td></tr> <tr><td colspan=2>(Note that these are not member functions.)<br><br></td></tr> <tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><Atk::StateSet> </td><td valign=bottom><a class="el" href="classAtk_1_1StateSet.html#k0">wrap</a> (AtkStateSet* object, bool take_copy=false)</td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="Atk::StateSet::~StateSet"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual Atk::StateSet::~StateSet </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="b0" doxytag="Atk::StateSet::StateSet"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> Atk::StateSet::StateSet </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [protected]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a name="a5" doxytag="Atk::StateSet::add_state"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Atk::StateSet::add_state </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top"><a class="el" href="group__atkmmEnums.html#a4">StateType</a> </td> <td class="mdname1" valign="top" nowrap> <em>type</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Add a new state for the specified type to the current state set if it is not already present. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>type</em> </td><td>An <a class="el" href="group__atkmmEnums.html#a4">Atk::StateType</a>. </td></tr> </table> </dl> <dl compact><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> </td> </tr> </table> <a name="a6" doxytag="Atk::StateSet::add_states"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Atk::StateSet::add_states </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="el" href="group__atkmmEnums.html#a4">StateType</a>>& </td> <td class="mdname1" valign="top" nowrap> <em>types</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a11" doxytag="Atk::StateSet::and_sets"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet> Atk::StateSet::and_sets </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet>& </td> <td class="mdname1" valign="top" nowrap> <em>compare_set</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Constructs the intersection of the two sets, returning <code>0</code> if the intersection is empty. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>compare_set</em> </td><td>Another Atk::StateSet. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>A new Atk::StateSet which is the intersection of the two sets. </dd></dl> </td> </tr> </table> <a name="a7" doxytag="Atk::StateSet::clear_states"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Atk::StateSet::clear_states </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Removes all states from the state set. <p> </td> </tr> </table> <a name="a8" doxytag="Atk::StateSet::contains_state"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Atk::StateSet::contains_state </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top"><a class="el" href="group__atkmmEnums.html#a4">StateType</a> </td> <td class="mdname1" valign="top" nowrap> <em>type</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Checks whether the state for the specified type is in the specified set. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>type</em> </td><td>An <a class="el" href="group__atkmmEnums.html#a4">Atk::StateType</a>. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if <em>type</em> is the state type is in <em>set</em> . </dd></dl> </td> </tr> </table> <a name="a9" doxytag="Atk::StateSet::contains_states"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Atk::StateSet::contains_states </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">const <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="el" href="group__atkmmEnums.html#a4">StateType</a>>& </td> <td class="mdname1" valign="top" nowrap> <em>types</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="d0" doxytag="Atk::StateSet::create"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet> Atk::StateSet::create </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [static]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a2" doxytag="Atk::StateSet::gobj"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> const AtkStateSet* Atk::StateSet::gobj </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const<code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Reimplemented from <a class="el" href="classGlib_1_1ObjectBase.html#a3">Glib::ObjectBase</a>. </td> </tr> </table> <a name="a1" doxytag="Atk::StateSet::gobj"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> AtkStateSet* Atk::StateSet::gobj </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Reimplemented from <a class="el" href="classGlib_1_1ObjectBase.html#a2">Glib::ObjectBase</a>. </td> </tr> </table> <a name="a3" doxytag="Atk::StateSet::gobj_copy"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> AtkStateSet* Atk::StateSet::gobj_copy </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a name="a4" doxytag="Atk::StateSet::is_empty"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Atk::StateSet::is_empty </td> <td class="md" valign="top">(</td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Checks whether the state set is empty, i.e. has no states set. <p> <dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if <em>set</em> has no states set, otherwise <code>false</code>. </dd></dl> </td> </tr> </table> <a name="a12" doxytag="Atk::StateSet::or_sets"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet> Atk::StateSet::or_sets </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet>& </td> <td class="mdname1" valign="top" nowrap> <em>compare_set</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Constructs the union of the two sets. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>compare_set</em> </td><td>Another Atk::StateSet. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>A new Atk::StateSet which is the union of the two sets, returning <code>0</code> is empty. </dd></dl> </td> </tr> </table> <a name="a10" doxytag="Atk::StateSet::remove_state"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Atk::StateSet::remove_state </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top"><a class="el" href="group__atkmmEnums.html#a4">StateType</a> </td> <td class="mdname1" valign="top" nowrap> <em>type</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Removes the state for the specified type from the state set. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>type</em> </td><td>An Atk::Type. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if <em>type</em> was the state type is in <em>set</em> . </dd></dl> </td> </tr> </table> <a name="a13" doxytag="Atk::StateSet::xor_sets"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet> Atk::StateSet::xor_sets </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><StateSet>& </td> <td class="mdname1" valign="top" nowrap> <em>compare_set</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Constructs the exclusive-or of the two sets, returning <code>0</code> is empty. <p> The set returned by this operation contains the states in exactly one of the two sets. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign=top><em>compare_set</em> </td><td>Another Atk::StateSet. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>A new Atk::StateSet which contains the states which are in exactly one of the two sets. </dd></dl> </td> </tr> </table> <hr><h2>Friends And Related Function Documentation</h2> <a name="k0" doxytag="Atk::StateSet::wrap"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><Atk::StateSet> wrap </td> <td class="md" valign="top">(</td> <td class="md" nowrap valign="top">AtkStateSet* </td> <td class="mdname" nowrap> <em>object</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>bool </td> <td class="mdname" nowrap> <em>take_copy</em> = false</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [related]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="stateset_8h.html">stateset.h</a></ul> <hr><address><small> Generated for gtkmm by <a href="http://www.doxygen.org/index.html"> Doxygen</a> 1.3-rc1 © 1997-2001</small></address> </body> </html>