<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>atkmm: Atk::RelationSet Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">atkmm  <span id="projectnumber">2.22.7</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <div id="navrow1" 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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceAtk.html">Atk</a></li><li class="navelem"><a class="el" href="classAtk_1_1RelationSet.html">RelationSet</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#related">Related Functions</a> | <a href="classAtk_1_1RelationSet-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Atk::RelationSet Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>A set of Atk::Relations, normally the set of AtkRelations which an <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> has. <a href="classAtk_1_1RelationSet.html#details">More...</a></p> <p><code>#include <atkmm/relationset.h></code></p> <div class="dynheader"> Inheritance diagram for Atk::RelationSet:</div> <div class="dyncontent"> <div class="center"><img src="classAtk_1_1RelationSet__inherit__graph.png" border="0" usemap="#Atk_1_1RelationSet_inherit__map" alt="Inheritance graph"/></div> <map name="Atk_1_1RelationSet_inherit__map" id="Atk_1_1RelationSet_inherit__map"> </map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a0458eadd98421354d95aa6b5082ff860"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0458eadd98421354d95aa6b5082ff860"></a> AtkRelationSet* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#a0458eadd98421354d95aa6b5082ff860">gobj</a> ()</td></tr> <tr class="memdesc:a0458eadd98421354d95aa6b5082ff860"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr> <tr class="separator:a0458eadd98421354d95aa6b5082ff860"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2272065cbea31e7ba19c9053be0b123c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2272065cbea31e7ba19c9053be0b123c"></a> const AtkRelationSet* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#a2272065cbea31e7ba19c9053be0b123c">gobj</a> () const </td></tr> <tr class="memdesc:a2272065cbea31e7ba19c9053be0b123c"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr> <tr class="separator:a2272065cbea31e7ba19c9053be0b123c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4c7b79d440b461e6e425bf829a25f5c5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c7b79d440b461e6e425bf829a25f5c5"></a> AtkRelationSet* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#a4c7b79d440b461e6e425bf829a25f5c5">gobj_copy</a> ()</td></tr> <tr class="memdesc:a4c7b79d440b461e6e425bf829a25f5c5"><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 class="separator:a4c7b79d440b461e6e425bf829a25f5c5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5d8cb7b1214d468fd53ff44317947662"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#a5d8cb7b1214d468fd53ff44317947662">set_contains</a> (RelationType relationship)</td></tr> <tr class="memdesc:a5d8cb7b1214d468fd53ff44317947662"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether the relation set contains a relation that matches the specified type. <a href="#a5d8cb7b1214d468fd53ff44317947662">More...</a><br/></td></tr> <tr class="separator:a5d8cb7b1214d468fd53ff44317947662"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a27c554ac47fd8e328c85521d5ef3d91b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#a27c554ac47fd8e328c85521d5ef3d91b">set_remove</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Relation.html">Relation</a> >& relation)</td></tr> <tr class="memdesc:a27c554ac47fd8e328c85521d5ef3d91b"><td class="mdescLeft"> </td><td class="mdescRight">Removes a relation from the relation set. <a href="#a27c554ac47fd8e328c85521d5ef3d91b">More...</a><br/></td></tr> <tr class="separator:a27c554ac47fd8e328c85521d5ef3d91b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6a80557979af5ef7babed4217b6b994d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#a6a80557979af5ef7babed4217b6b994d">set_add</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Relation.html">Relation</a> >& relation)</td></tr> <tr class="memdesc:a6a80557979af5ef7babed4217b6b994d"><td class="mdescLeft"> </td><td class="mdescRight">Add a new relation to the current relation set if it is not already present. <a href="#a6a80557979af5ef7babed4217b6b994d">More...</a><br/></td></tr> <tr class="separator:a6a80557979af5ef7babed4217b6b994d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aae9807b3bc8a2fccf98a9bac28071121"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#aae9807b3bc8a2fccf98a9bac28071121">get_n_relations</a> () const </td></tr> <tr class="memdesc:aae9807b3bc8a2fccf98a9bac28071121"><td class="mdescLeft"> </td><td class="mdescRight">Determines the number of relations in a relation set. <a href="#aae9807b3bc8a2fccf98a9bac28071121">More...</a><br/></td></tr> <tr class="separator:aae9807b3bc8a2fccf98a9bac28071121"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a538bd38d9d4e663cdfddbdaeca539a1d"><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_1Relation.html">Relation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#a538bd38d9d4e663cdfddbdaeca539a1d">get_relation</a> (gint i)</td></tr> <tr class="memdesc:a538bd38d9d4e663cdfddbdaeca539a1d"><td class="mdescLeft"> </td><td class="mdescRight">Determines the relation at the specified position in the relation set. <a href="#a538bd38d9d4e663cdfddbdaeca539a1d">More...</a><br/></td></tr> <tr class="separator:a538bd38d9d4e663cdfddbdaeca539a1d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a65328bc128f6fbd2105bfa7633db55a5"><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_1Relation.html">Relation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#a65328bc128f6fbd2105bfa7633db55a5">get_relation</a> (RelationType relationship)</td></tr> <tr class="memdesc:a65328bc128f6fbd2105bfa7633db55a5"><td class="mdescLeft"> </td><td class="mdescRight">Finds a relation that matches the specified type. <a href="#a65328bc128f6fbd2105bfa7633db55a5">More...</a><br/></td></tr> <tr class="separator:a65328bc128f6fbd2105bfa7633db55a5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a437be8c938f2229ea22f89b75e12e725"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#a437be8c938f2229ea22f89b75e12e725">add_relation_by_type</a> (RelationType relationship, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> >& target)</td></tr> <tr class="memdesc:a437be8c938f2229ea22f89b75e12e725"><td class="mdescLeft"> </td><td class="mdescRight">Add a new relation of the specified type with the specified target to the current relation set if the relation set does not contain a relation of that type. <a href="#a437be8c938f2229ea22f89b75e12e725">More...</a><br/></td></tr> <tr class="separator:a437be8c938f2229ea22f89b75e12e725"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:ae9a9167c08a3b3d942ed993cf2cfc4f2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9a9167c08a3b3d942ed993cf2cfc4f2"></a> static GType </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#ae9a9167c08a3b3d942ed993cf2cfc4f2">get_type</a> ()</td></tr> <tr class="memdesc:ae9a9167c08a3b3d942ed993cf2cfc4f2"><td class="mdescLeft"> </td><td class="mdescRight">Get the GType for this class, for use with the underlying GObject type system. <br/></td></tr> <tr class="separator:ae9a9167c08a3b3d942ed993cf2cfc4f2"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a> Related Functions</h2></td></tr> <tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p> </td></tr> <tr class="memitem:a5f5c94267804b02ea43df30cf278716a"><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_1RelationSet.html">Atk::RelationSet</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1RelationSet.html#a5f5c94267804b02ea43df30cf278716a">wrap</a> (AtkRelationSet* object, bool take_copy=false)</td></tr> <tr class="memdesc:a5f5c94267804b02ea43df30cf278716a"><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="#a5f5c94267804b02ea43df30cf278716a">More...</a><br/></td></tr> <tr class="separator:a5f5c94267804b02ea43df30cf278716a"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A set of Atk::Relations, normally the set of AtkRelations which an <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a> has. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a437be8c938f2229ea22f89b75e12e725"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Atk::RelationSet::add_relation_by_type </td> <td>(</td> <td class="paramtype">RelationType </td> <td class="paramname"><em>relationship</em>, </td> </tr> <tr> <td class="paramkey"></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_1Object.html">Atk::Object</a> >& </td> <td class="paramname"><em>target</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Add a new relation of the specified type with the specified target to the current relation set if the relation set does not contain a relation of that type. </p> <p>If it is does contain a relation of that typea the target is added to the relation.</p> <dl class="since_1_9"><dt><b><a class="el" href="since_1_9.html#_since_1_9000002">Since atkmm 1.9:</a></b></dt><dd></dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">relationship</td><td>An Atk::RelationType. </td></tr> <tr><td class="paramname">target</td><td>An <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a>. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aae9807b3bc8a2fccf98a9bac28071121"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int Atk::RelationSet::get_n_relations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Determines the number of relations in a relation set. </p> <dl class="section return"><dt>Returns</dt><dd>An integer representing the number of relations in the set. </dd></dl> </div> </div> <a class="anchor" id="a538bd38d9d4e663cdfddbdaeca539a1d"></a> <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_1Relation.html">Relation</a>> Atk::RelationSet::get_relation </td> <td>(</td> <td class="paramtype">gint </td> <td class="paramname"><em>i</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Determines the relation at the specified position in the relation set. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">i</td><td>A <code>int</code> representing a position in the set, starting from 0. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classAtk_1_1Relation.html" title="An Atk::Relation describes a relation between an object and one or more other objects.">Atk::Relation</a>, which is the relation at position i in the set. </dd></dl> </div> </div> <a class="anchor" id="a65328bc128f6fbd2105bfa7633db55a5"></a> <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_1Relation.html">Relation</a>> Atk::RelationSet::get_relation </td> <td>(</td> <td class="paramtype">RelationType </td> <td class="paramname"><em>relationship</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Finds a relation that matches the specified type. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">relationship</td><td>An Atk::RelationType. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="classAtk_1_1Relation.html" title="An Atk::Relation describes a relation between an object and one or more other objects.">Atk::Relation</a>, which is a relation matching the specified type. </dd></dl> </div> </div> <a class="anchor" id="a6a80557979af5ef7babed4217b6b994d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Atk::RelationSet::set_add </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_1Relation.html">Relation</a> >& </td> <td class="paramname"><em>relation</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Add a new relation to the current relation set if it is not already present. </p> <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. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">relation</td><td>An <a class="el" href="classAtk_1_1Relation.html" title="An Atk::Relation describes a relation between an object and one or more other objects.">Atk::Relation</a>. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a5d8cb7b1214d468fd53ff44317947662"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Atk::RelationSet::set_contains </td> <td>(</td> <td class="paramtype">RelationType </td> <td class="paramname"><em>relationship</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Determines whether the relation set contains a relation that matches the specified type. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">relationship</td><td>An Atk::RelationType. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</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> </div> </div> <a class="anchor" id="a27c554ac47fd8e328c85521d5ef3d91b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Atk::RelationSet::set_remove </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_1Relation.html">Relation</a> >& </td> <td class="paramname"><em>relation</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Removes a relation from the relation set. </p> <p>This function unref's the <a class="el" href="classAtk_1_1Relation.html" title="An Atk::Relation describes a relation between an object and one or more other objects.">Atk::Relation</a> so it will be deleted unless there is another reference to it. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">relation</td><td>An <a class="el" href="classAtk_1_1Relation.html" title="An Atk::Relation describes a relation between an object and one or more other objects.">Atk::Relation</a>. </td></tr> </table> </dd> </dl> </div> </div> <h2 class="groupheader">Friends And Related Function Documentation</h2> <a class="anchor" id="a5f5c94267804b02ea43df30cf278716a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <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_1RelationSet.html">Atk::RelationSet</a> > wrap </td> <td>(</td> <td class="paramtype">AtkRelationSet * </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></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">related</span></span> </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 class="params"><dt>Parameters</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="section return"><dt>Returns</dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Wed Apr 24 2013 11:08:12 for atkmm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>