<!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>atkmm: 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.7.2 -->
<div class="navigation" id="top">
<div 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 class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</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">
<ul>
<li><a class="el" href="namespaceAtk.html">Atk</a> </li>
<li><a class="el" href="classAtk_1_1Relation.html">Relation</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Atk::Relation Class Reference</h1> </div>
</div>
<div class="contents">
<!-- 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><code>#include <atkmm/relation.h></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for Atk::Relation:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classAtk_1_1Relation__inherit__graph.png" border="0" usemap="#Atk_1_1Relation_inherit__map" alt="Inheritance graph"/></div>
<map name="Atk_1_1Relation_inherit__map" id="Atk_1_1Relation_inherit__map">
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,160,115,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,131,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="classAtk_1_1Relation-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0f2045c77cc80a3a33234c0b24502b5"></a><!-- doxytag: member="Atk::Relation::gobj" ref="ab0f2045c77cc80a3a33234c0b24502b5" args="()" -->
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. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf1190c7f5b9bd05a2df6326de3be904"></a><!-- doxytag: member="Atk::Relation::gobj" ref="adf1190c7f5b9bd05a2df6326de3be904" args="() const " -->
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. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60670602a86a4812af0af5886c9845f7"></a><!-- doxytag: member="Atk::Relation::gobj_copy" ref="a60670602a86a4812af0af5886c9845f7" args="()" -->
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. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">RelationType </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">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><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<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>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>
</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 atkmm 1.9:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<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="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">RelationType Atk::Relation::get_relation_type </td>
<td>(</td>
<td class="paramname"> )</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>
<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>
</tr>
<tr>
<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 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="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Mar 30 2011 09:27:41 for atkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
