<!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>gtkmm: Atk::Relation 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.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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"><a class="el" href="namespaceAtk.html">Atk</a>::<a class="el" href="classAtk_1_1Relation.html">Relation</a>
</div>
</div>
<div class="contents">
<h1>Atk::Relation Class Reference</h1><!-- doxytag: class="Atk::Relation" --><!-- doxytag: inherits="Glib::Object" -->
<p>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> describes a relation between an object and one or more other objects. <a href="#_details">More...</a></p>
<p>Inherits <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a>.</p>
<div class="dynheader">
Collaboration diagram for Atk::Relation:</div>
<div class="dynsection">
<div class="center"><img src="classAtk_1_1Relation__coll__graph.png" border="0" usemap="#Atk_1_1Relation_coll__map" alt="Collaboration graph"/></div>
<map name="Atk_1_1Relation_coll__map" id="Atk_1_1Relation_coll__map">
<area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,160,111,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,125,112"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,119,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classAtk_1_1Relation-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a234ea5c64a7d55128b861d489b8e1eef">~Relation</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">AtkRelation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#ab0f2045c77cc80a3a33234c0b24502b5">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ab0f2045c77cc80a3a33234c0b24502b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const AtkRelation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#adf1190c7f5b9bd05a2df6326de3be904">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#adf1190c7f5b9bd05a2df6326de3be904"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">AtkRelation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a60670602a86a4812af0af5886c9845f7">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="#a60670602a86a4812af0af5886c9845f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__atkmmEnums.html#ga83c3f0442ea6f73e32064b0caab555e5">RelationType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a12a77bd41e0944dcd3092dd44b04a0c6">get_relation_type</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of <em>relation</em>. <a href="#a12a77bd41e0944dcd3092dd44b04a0c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><br class="typebreak"/>
< <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="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a43d56433bac5c1ad96901e4bdca5d996">get_target</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><br class="typebreak"/>
< <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <br class="typebreak"/>
<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#a6e6037c097d3cad3223e88a1af8b0270">get_target</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a4f4ad2f69975201108d77bc34d4337f8">add_target</a> (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><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="#a4f4ad2f69975201108d77bc34d4337f8"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <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_1Relation.html#ac490ab229919dd681d578dc74a5c19d8">create</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <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> > >& targets, <a class="el" href="group__atkmmEnums.html#ga83c3f0442ea6f73e32064b0caab555e5">RelationType</a> relationship=RELATION_NULL)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a018bb0da9dbc46d4d079236167f7ee54">Relation</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <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> > >& targets, <a class="el" href="group__atkmmEnums.html#ga83c3f0442ea6f73e32064b0caab555e5">RelationType</a> relationship)</td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><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_1Relation.html">Atk::Relation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a48d5c60d3a30600bdf456761fc34ef1f">wrap</a> (AtkRelation* 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="#a48d5c60d3a30600bdf456761fc34ef1f"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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> describes a relation between an object and one or more other objects. </p>
<p>The actual relations that an object has with other objects are defined as an <a class="el" href="classAtk_1_1RelationSet.html" title="A set of Atk::Relations, normally the set of AtkRelations which an Atk::Object has...">Atk::RelationSet</a>, which is a set of Atk::Relations. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a234ea5c64a7d55128b861d489b8e1eef"></a><!-- doxytag: member="Atk::Relation::~Relation" ref="a234ea5c64a7d55128b861d489b8e1eef" 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><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a018bb0da9dbc46d4d079236167f7ee54"></a><!-- doxytag: member="Atk::Relation::Relation" ref="a018bb0da9dbc46d4d079236167f7ee54" 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" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <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>targets</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__atkmmEnums.html#ga83c3f0442ea6f73e32064b0caab555e5">RelationType</a> </td>
<td class="paramname"> <em>relationship</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4f4ad2f69975201108d77bc34d4337f8"></a><!-- doxytag: member="Atk::Relation::add_target" ref="a4f4ad2f69975201108d77bc34d4337f8" 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" 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>
<td> ) </td>
<td></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>
<p>See also <a class="el" href="classAtk_1_1Object.html#a8ccf42eed0a5625d4c46444c73412daa" title="Adds a relationship of the specified type with the specified target.">Atk::Object::add_relationship()</a>.</p>
<dl class="since_1_9"><dt><b><a class="el" href="since_1_9.html#_since_1_9000001">Since gtkmm 1.9:</a></b></dt><dd></dd></dl>
<dl><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" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac490ab229919dd681d578dc74a5c19d8"></a><!-- doxytag: member="Atk::Relation::create" ref="ac490ab229919dd681d578dc74a5c19d8" 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" href="../../../glibmm-2.4/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" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <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>targets</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__atkmmEnums.html#ga83c3f0442ea6f73e32064b0caab555e5">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><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a12a77bd41e0944dcd3092dd44b04a0c6"></a><!-- doxytag: member="Atk::Relation::get_relation_type" ref="a12a77bd41e0944dcd3092dd44b04a0c6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__atkmmEnums.html#ga83c3f0442ea6f73e32064b0caab555e5">RelationType</a> Atk::Relation::get_relation_type </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the type of <em>relation</em>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The type of <em>relation</em>. </dd></dl>
</div>
</div>
<a class="anchor" id="a6e6037c097d3cad3223e88a1af8b0270"></a><!-- doxytag: member="Atk::Relation::get_target" ref="a6e6037c097d3cad3223e88a1af8b0270" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <a class="elRef" href="../../../glibmm-2.4/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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a43d56433bac5c1ad96901e4bdca5d996"></a><!-- doxytag: member="Atk::Relation::get_target" ref="a43d56433bac5c1ad96901e4bdca5d996" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< <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>> > Atk::Relation::get_target </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="adf1190c7f5b9bd05a2df6326de3be904"></a><!-- doxytag: member="Atk::Relation::gobj" ref="adf1190c7f5b9bd05a2df6326de3be904" 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> 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" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
</div>
</div>
<a class="anchor" id="ab0f2045c77cc80a3a33234c0b24502b5"></a><!-- doxytag: member="Atk::Relation::gobj" ref="ab0f2045c77cc80a3a33234c0b24502b5" 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><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" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
</div>
</div>
<a class="anchor" id="a60670602a86a4812af0af5886c9845f7"></a><!-- doxytag: member="Atk::Relation::gobj_copy" ref="a60670602a86a4812af0af5886c9845f7" 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></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>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a48d5c60d3a30600bdf456761fc34ef1f"></a><!-- doxytag: member="Atk::Relation::wrap" ref="a48d5c60d3a30600bdf456761fc34ef1f" args="(AtkRelation *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_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><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 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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>atkmm/relation.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:21:42 2010 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
22e237efd6851989a23adf3360bb53d0
>
files
>
52
