<!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::RelationSet 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::RelationSet Class Reference</h1>Inheritance diagram for Atk::RelationSet:<p><center><img src="classAtk_1_1RelationSet__inherit__graph.png" border="0" usemap="#Atk_1_1RelationSet__inherit__map" alt="Inheritance graph"></center>
<map name="Atk_1_1RelationSet__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_1RelationSet-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_1RelationSet.html#a0">~RelationSet</a> ()</td></tr>
<tr><td nowrap align=right valign=top>AtkRelationSet* </td><td valign=bottom><a class="el" href="classAtk_1_1RelationSet.html#a1">gobj</a> ()</td></tr>
<tr><td nowrap align=right valign=top>const AtkRelationSet* </td><td valign=bottom><a class="el" href="classAtk_1_1RelationSet.html#a2">gobj</a> () const</td></tr>
<tr><td nowrap align=right valign=top>AtkRelationSet* </td><td valign=bottom><a class="el" href="classAtk_1_1RelationSet.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_1RelationSet.html#a4">set_contains</a> (<a class="el" href="group__atkmmEnums.html#a3">RelationType</a> relationship)</td></tr>
<tr><td> </td><td><font size=-1><em>Determines whether the relation set contains a relation that matches the specified type.</em> <a href="#a4"></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_1RelationSet.html#a5">set_remove</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Relation.html">Relation</a>>& relation)</td></tr>
<tr><td> </td><td><font size=-1><em>Removes a relation from the relation set.</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_1RelationSet.html#a6">set_add</a> (const <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Relation.html">Relation</a>>& relation)</td></tr>
<tr><td> </td><td><font size=-1><em>Add a new relation to the current relation set if it is not already present.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classAtk_1_1RelationSet.html#a7">get_n_relations</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Determines the number of relations in a relation set.</em> <a href="#a7"></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><<a class="el" href="classAtk_1_1Relation.html">Relation</a>> </td><td valign=bottom><a class="el" href="classAtk_1_1RelationSet.html#a8">get_relation</a> (gint i)</td></tr>
<tr><td> </td><td><font size=-1><em>Determines the relation at the specified position in the relation set.</em> <a href="#a8"></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><<a class="el" href="classAtk_1_1Relation.html">Relation</a>> </td><td valign=bottom><a class="el" href="classAtk_1_1RelationSet.html#a9">get_relation</a> (<a class="el" href="group__atkmmEnums.html#a3">RelationType</a> relationship)</td></tr>
<tr><td> </td><td><font size=-1><em>Finds a relation that matches the specified type.</em> <a href="#a9"></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><RelationSet> </td><td valign=bottom><a class="el" href="classAtk_1_1RelationSet.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_1RelationSet.html#b0">RelationSet</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::RelationSet> </td><td valign=bottom><a class="el" href="classAtk_1_1RelationSet.html#k0">wrap</a> (AtkRelationSet* object, bool take_copy=false)</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="Atk::RelationSet::~RelationSet"></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::RelationSet::~RelationSet </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::RelationSet::RelationSet"></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::RelationSet::RelationSet </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="d0" doxytag="Atk::RelationSet::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><RelationSet> Atk::RelationSet::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="a7" doxytag="Atk::RelationSet::get_n_relations"></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"> int Atk::RelationSet::get_n_relations </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>
Determines the number of relations in a relation set.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>An integer representing the number of relations in the set. </dd></dl>
</td>
</tr>
</table>
<a name="a9" doxytag="Atk::RelationSet::get_relation"></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><<a class="el" href="classAtk_1_1Relation.html">Relation</a>> Atk::RelationSet::get_relation </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top"><a class="el" href="group__atkmmEnums.html#a3">RelationType</a> </td>
<td class="mdname1" valign="top" nowrap> <em>relationship</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>
Finds a relation that matches the specified type.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>relationship</em> </td><td>An <a class="el" href="group__atkmmEnums.html#a3">Atk::RelationType</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An <a class="el" href="classAtk_1_1Relation.html">Atk::Relation</a>, which is a relation matching the specified type. </dd></dl>
</td>
</tr>
</table>
<a name="a8" doxytag="Atk::RelationSet::get_relation"></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><<a class="el" href="classAtk_1_1Relation.html">Relation</a>> Atk::RelationSet::get_relation </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">gint </td>
<td class="mdname1" valign="top" nowrap> <em>i</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>
Determines the relation at the specified position in the relation set.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>i</em> </td><td>A <code>int</code> representing a position in the set, starting from 0. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classAtk_1_1Relation.html">Atk::Relation</a>, which is the relation at position i in the set. </dd></dl>
</td>
</tr>
</table>
<a name="a2" doxytag="Atk::RelationSet::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 AtkRelationSet* Atk::RelationSet::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::RelationSet::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"> AtkRelationSet* Atk::RelationSet::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::RelationSet::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"> AtkRelationSet* Atk::RelationSet::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="a6" doxytag="Atk::RelationSet::set_add"></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::RelationSet::set_add </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><<a class="el" href="classAtk_1_1Relation.html">Relation</a>>& </td>
<td class="mdname1" valign="top" nowrap> <em>relation</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 relation to the current relation set if it is not already present.
<p>
This function ref's the AtkRelation so the caller of this function should unref it to ensure that it will be destroyed when the AtkRelationSet is destroyed. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>relation</em> </td><td>An <a class="el" href="classAtk_1_1Relation.html">Atk::Relation</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a4" doxytag="Atk::RelationSet::set_contains"></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::RelationSet::set_contains </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top"><a class="el" href="group__atkmmEnums.html#a3">RelationType</a> </td>
<td class="mdname1" valign="top" nowrap> <em>relationship</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>
Determines whether the relation set contains a relation that matches the specified type.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>relationship</em> </td><td>An <a class="el" href="group__atkmmEnums.html#a3">Atk::RelationType</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>true</code> if <em>relationship</em> is the relationship type of a relation in <em>set</em> , <code>false</code> otherwise. </dd></dl>
</td>
</tr>
</table>
<a name="a5" doxytag="Atk::RelationSet::set_remove"></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::RelationSet::set_remove </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><<a class="el" href="classAtk_1_1Relation.html">Relation</a>>& </td>
<td class="mdname1" valign="top" nowrap> <em>relation</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 a relation from the relation set.
<p>
This function unref's the <a class="el" href="classAtk_1_1Relation.html">Atk::Relation</a> so it will be deleted unless there is another reference to it. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>relation</em> </td><td>An <a class="el" href="classAtk_1_1Relation.html">Atk::Relation</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="k0" doxytag="Atk::RelationSet::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::RelationSet> wrap </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">AtkRelationSet* </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="relationset_8h.html">relationset.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>
