<!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>gtkmm 2.4: Atk::Relation 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%"/> <!-- begin main content --> <div id="content"> <!-- Generated by Doxygen 1.5.1 --> <div class="nav"> <a class="el" href="namespaceAtk.html">Atk</a>::<a class="el" href="classAtk_1_1Relation.html">Relation</a></div> <h1>Atk::Relation Class Reference</h1><!-- doxytag: class="Atk::Relation" --><!-- doxytag: inherits="Glib::Object" -->Inheritance diagram for Atk::Relation:<p><center><img src="classAtk_1_1Relation__inherit__graph.png" border="0" usemap="#Atk_1_1Relation__inherit__map" alt="Inheritance graph"></center> <map name="Atk_1_1Relation__inherit__map"> <area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1Object.html" shape="rect" coords="21,161,115,188" alt=""> <area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html" shape="rect" coords="5,84,131,111" alt=""> <area doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classsigc_1_1trackable.html" shape="rect" coords="12,7,124,33" alt=""> </map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classAtk_1_1Relation-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> An <a class="el" href="classAtk_1_1Relation.html">Atk::Relation</a> describes a relation between an object and one or more other objects. <p> The actual relations that an object has with other objects are defined as an <a class="el" href="classAtk_1_1RelationSet.html">Atk::RelationSet</a>, which is a set of Atk::Relations. <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#4f4ad2f69975201108d77bc34d4337f8">add_target</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>>& target)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds the specified AtkObject to the target for the relation, if it is not already present. <a href="#4f4ad2f69975201108d77bc34d4337f8"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__atkmmEnums.html#g83c3f0442ea6f73e32064b0caab555e5">RelationType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#ef43f2c5985082c6a212c95e68e7877b">get_relation_type</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of <em>relation</em>. <a href="#ef43f2c5985082c6a212c95e68e7877b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<br> const <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#05db84c78ce91a6c168636d39c8f7a21">get_target</a> () const</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<br> <a class="el" href="classAtk_1_1Object.html">Atk::Object</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#43d56433bac5c1ad96901e4bdca5d996">get_target</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const AtkRelation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#38fbcd98289899b537ca1f84f19ae02b">gobj</a> () const</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#38fbcd98289899b537ca1f84f19ae02b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">AtkRelation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#b0f2045c77cc80a3a33234c0b24502b5">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#b0f2045c77cc80a3a33234c0b24502b5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">AtkRelation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#60670602a86a4812af0af5886c9845f7">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. <a href="#60670602a86a4812af0af5886c9845f7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#234ea5c64a7d55128b861d489b8e1eef">~Relation</a> ()</td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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_1Relation.html#c490ab229919dd681d578dc74a5c19d8">create</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>>>& targets, <a class="el" href="group__atkmmEnums.html#g83c3f0442ea6f73e32064b0caab555e5">RelationType</a> relationship=RELATION_NULL)</td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#018bb0da9dbc46d4d079236167f7ee54">Relation</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>>>& targets, <a class="el" href="group__atkmmEnums.html#g83c3f0442ea6f73e32064b0caab555e5">RelationType</a> relationship)</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 class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Relation.html">Atk::Relation</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#48d5c60d3a30600bdf456761fc34ef1f">wrap</a> (AtkRelation* object, bool take_copy=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#48d5c60d3a30600bdf456761fc34ef1f"></a><br></td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="234ea5c64a7d55128b861d489b8e1eef"></a><!-- doxytag: member="Atk::Relation::~Relation" ref="234ea5c64a7d55128b861d489b8e1eef" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Atk::Relation::~Relation </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="018bb0da9dbc46d4d079236167f7ee54"></a><!-- doxytag: member="Atk::Relation::Relation" ref="018bb0da9dbc46d4d079236167f7ee54" args="(const Glib::ArrayHandle< Glib::RefPtr< Atk::Object > > &targets, RelationType relationship)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Atk::Relation::Relation </td> <td>(</td> <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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>targets</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__atkmmEnums.html#g83c3f0442ea6f73e32064b0caab555e5">RelationType</a> </td> <td class="paramname"> <em>relationship</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [explicit, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="4f4ad2f69975201108d77bc34d4337f8"></a><!-- doxytag: member="Atk::Relation::add_target" ref="4f4ad2f69975201108d77bc34d4337f8" args="(const Glib::RefPtr< Atk::Object > &target)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Atk::Relation::add_target </td> <td>(</td> <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Adds the specified AtkObject to the target for the relation, if it is not already present. <p> Since: 1.9 <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>target</em> </td><td>An <a class="el" href="classAtk_1_1Object.html">Atk::Object</a>. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="c490ab229919dd681d578dc74a5c19d8"></a><!-- doxytag: member="Atk::Relation::create" ref="c490ab229919dd681d578dc74a5c19d8" args="(const Glib::ArrayHandle< Glib::RefPtr< Atk::Object > > &targets, RelationType relationship=RELATION_NULL)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Relation.html">Relation</a>> Atk::Relation::create </td> <td>(</td> <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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>targets</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__atkmmEnums.html#g83c3f0442ea6f73e32064b0caab555e5">RelationType</a> </td> <td class="paramname"> <em>relationship</em> = <code>RELATION_NULL</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="ef43f2c5985082c6a212c95e68e7877b"></a><!-- doxytag: member="Atk::Relation::get_relation_type" ref="ef43f2c5985082c6a212c95e68e7877b" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__atkmmEnums.html#g83c3f0442ea6f73e32064b0caab555e5">RelationType</a> Atk::Relation::get_relation_type </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Gets the type of <em>relation</em>. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>The type of <em>relation</em> . </dd></dl> </div> </div><p> <a class="anchor" name="05db84c78ce91a6c168636d39c8f7a21"></a><!-- doxytag: member="Atk::Relation::get_target" ref="05db84c78ce91a6c168636d39c8f7a21" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classAtk_1_1Object.html">Atk::Object</a>>> Atk::Relation::get_target </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="43d56433bac5c1ad96901e4bdca5d996"></a><!-- doxytag: member="Atk::Relation::get_target" ref="43d56433bac5c1ad96901e4bdca5d996" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><<a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Object.html">Atk::Object</a>>> Atk::Relation::get_target </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="38fbcd98289899b537ca1f84f19ae02b"></a><!-- doxytag: member="Atk::Relation::gobj" ref="38fbcd98289899b537ca1f84f19ae02b" args="() const" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const AtkRelation* Atk::Relation::gobj </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Provides access to the underlying C GObject. <p> <p> Reimplemented from <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html#2b7010748d60e770e9e0b3d65c100cf2">Glib::ObjectBase</a>. </div> </div><p> <a class="anchor" name="b0f2045c77cc80a3a33234c0b24502b5"></a><!-- doxytag: member="Atk::Relation::gobj" ref="b0f2045c77cc80a3a33234c0b24502b5" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">AtkRelation* Atk::Relation::gobj </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Provides access to the underlying C GObject. <p> <p> Reimplemented from <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1ObjectBase.html#4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>. </div> </div><p> <a class="anchor" name="60670602a86a4812af0af5886c9845f7"></a><!-- doxytag: member="Atk::Relation::gobj_copy" ref="60670602a86a4812af0af5886c9845f7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">AtkRelation* Atk::Relation::gobj_copy </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <p> </div> </div><p> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="48d5c60d3a30600bdf456761fc34ef1f"></a><!-- doxytag: member="Atk::Relation::wrap" ref="48d5c60d3a30600bdf456761fc34ef1f" args="(AtkRelation *object, bool take_copy=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classAtk_1_1Relation.html">Atk::Relation</a>> wrap </td> <td>(</td> <td class="paramtype">AtkRelation * </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><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p> A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr> <tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="relation_8h.html">relation.h</a></ul> </div> <!-- end main content --> <hr><address><small> Generated for gtkmm 2.4 by <a href="http://www.doxygen.org/index.html"> Doxygen</a> 1.5.1 © 1997-2001</small></address> </body> </html>