1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Relation</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkregistry.html" title="atk.Registry"><link rel="next" href="class-atkrelationset.html" title="atk.RelationSet"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">atk.Relation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkregistry.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkrelationset.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-atkrelation"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Relation</h2><p>atk.Relation — an object used to describe a relation between a object and
2
one or more other objects. </p></div><div class="refsect1" lang="en"><a name="id2795670"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Relation</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.Relation</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkregistry.html" title="atk.Registry"><link rel="next" href="class-atkrelationset.html" title="atk.RelationSet"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">atk.Relation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkregistry.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkrelationset.html">Next</a></td></tr></table><hr></div><div class="refentry" title="atk.Relation"><a name="class-atkrelation"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.Relation</h2><p>atk.Relation — an object used to describe a relation between a object and
2
one or more other objects. </p></div><div class="refsect1" title="Synopsis"><a name="id3133613"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.Relation</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
3
3
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-atkrelation.html#constructor-atkrelation" title="atk.Relation">atk.Relation</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>targets</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>relationship</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelation.html#method-atkrelation--get-relation-type" title="atk.Relation.get_relation_type">get_relation_type</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelation.html#method-atkrelation--get-target" title="atk.Relation.get_target">get_target</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><pre class="programlisting">
4
4
<span class="bold"><strong>Functions</strong></span>
6
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelation.html#function-atk--relation-type-register" title="atk.relation_type_register">atk.relation_type_register</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelation.html#function-atk--relation-type-get-name" title="atk.relation_type_get_name">atk.relation_type_get_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relationship</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelation.html#function-atk--relation-type-for-name" title="atk.relation_type_for_name">atk.relation_type_for_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id2802485"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
6
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelation.html#function-atk--relation-type-register" title="atk.relation_type_register">atk.relation_type_register</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelation.html#function-atk--relation-type-get-name" title="atk.relation_type_get_name">atk.relation_type_get_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relationship</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelation.html#function-atk--relation-type-for-name" title="atk.relation_type_for_name">atk.relation_type_for_name</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="id3100977"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
7
7
+-- <a class="link" href="class-atkrelation.html" title="atk.Relation">atk.Relation</a>
8
</pre></div><div class="refsect1" lang="en"><a name="properties-atkrelation"></a><h2>atk.Relation Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"relation-type"</td><td valign="top">Read-Write</td><td valign="top">The type of the relation - one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a>. Default
8
</pre></div><div class="refsect1" title="atk.Relation Properties"><a name="properties-atkrelation"></a><h2>atk.Relation Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="3.5in"></colgroup><tbody><tr valign="top"><td valign="top">"relation-type"</td><td valign="top">Read-Write</td><td valign="top">The type of the relation - one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a>. Default
9
9
value: atk.RELATION_NULL.</td></tr><tr valign="top"><td valign="top">"target"</td><td valign="top">Read-Write</td><td valign="top">An array of the targets for the relation. Default value:
10
None.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-atkrelation"></a><h2>atk.Relation Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p></div><div class="refsect1" lang="en"><a name="id2793912"></a><h2>Description</h2><p>An <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a>
10
None.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="atk.Relation Signal Prototypes"><a name="signal-prototypes-atkrelation"></a><h2>atk.Relation Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p></div><div class="refsect1" title="Description"><a name="id3154184"></a><h2>Description</h2><p>An <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a>
11
11
describes a relation between an object and one or more other
12
12
objects. The actual relations that an object has with other objects are
13
13
defined as an <a class="link" href="class-atkrelationset.html" title="atk.RelationSet"><code class="classname">atk.RelationSet</code></a>,
18
</p></div><div class="refsect1" lang="en"><a name="id2794444"></a><h2>Constructor</h2><div class="refsect2" lang="en"><a name="constructor-atkrelation"></a><h3>atk.Relation</h3><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">atk.Relation</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>targets</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>relationship</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>targets</code></strong> :</span></p></td><td>a sequence of <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code>
18
</p></div><div class="refsect1" title="Constructor"><a name="id3092258"></a><h2>Constructor</h2><div class="refsect2" title="atk.Relation"><a name="constructor-atkrelation"></a><h3>atk.Relation</h3><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">atk.Relation</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>targets</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>relationship</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>targets</code></strong> :</span></p></td><td>a sequence of <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code>
19
19
objects</a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>relationship</code></strong> :</span></p></td><td>one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a> with which to
20
20
create the new <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a></td></tr></tbody></table><p>Create a new relation for the specified
21
21
<em class="parameter"><code>relationship</code></em> type and the specified sequence of
22
<em class="parameter"><code>targets</code></em>.</p></div></div><div class="refsect1" lang="en"><a name="id2814671"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-atkrelation--get-relation-type"></a><h3>atk.Relation.get_relation_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_relation_type</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the relation type - one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a>.</td></tr></tbody></table><p>Gets the relationship type.</p></div><div class="refsect2" lang="en"><a name="method-atkrelation--get-target"></a><h3>atk.Relation.get_target</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_target</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the target list of <em class="parameter"><code>relation</code></em></td></tr></tbody></table><p>Gets the target list of <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
23
objects.</p></div></div><div class="refsect1" lang="en"><a name="id2810181"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-atk--relation-type-register"></a><h3>atk.relation_type_register</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">atk.relation_type_register</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>name</code></strong> :</span></p></td><td>a name string</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a> that is
24
associated with <em class="parameter"><code>name</code></em></td></tr></tbody></table><p>Associate <em class="parameter"><code>name</code></em> with a new one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a>.</p></div><div class="refsect2" lang="en"><a name="function-atk--relation-type-get-name"></a><h3>atk.relation_type_get_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">atk.relation_type_get_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>type</code></strong> :</span></p></td><td>one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the string associated with
22
<em class="parameter"><code>targets</code></em>.</p></div></div><div class="refsect1" title="Methods"><a name="id3109491"></a><h2>Methods</h2><div class="refsect2" title="atk.Relation.get_relation_type"><a name="method-atkrelation--get-relation-type"></a><h3>atk.Relation.get_relation_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_relation_type</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the relation type - one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a>.</td></tr></tbody></table><p>Gets the relationship type.</p></div><div class="refsect2" title="atk.Relation.get_target"><a name="method-atkrelation--get-target"></a><h3>atk.Relation.get_target</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_target</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the target list of <em class="parameter"><code>relation</code></em></td></tr></tbody></table><p>Gets the target list of <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
23
objects.</p></div></div><div class="refsect1" title="Functions"><a name="id3095313"></a><h2>Functions</h2><div class="refsect2" title="atk.relation_type_register"><a name="function-atk--relation-type-register"></a><h3>atk.relation_type_register</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">atk.relation_type_register</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>name</code></strong> :</span></p></td><td>a name string</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a> that is
24
associated with <em class="parameter"><code>name</code></em></td></tr></tbody></table><p>Associate <em class="parameter"><code>name</code></em> with a new one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a>.</p></div><div class="refsect2" title="atk.relation_type_get_name"><a name="function-atk--relation-type-get-name"></a><h3>atk.relation_type_get_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">atk.relation_type_get_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>type</code></strong> :</span></p></td><td>one of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the string associated with
25
25
<em class="parameter"><code>relationship</code></em>.</td></tr></tbody></table><p>Gets the description string describing the relation type
26
specified by <em class="parameter"><code>type</code></em>.</p></div><div class="refsect2" lang="en"><a name="function-atk--relation-type-for-name"></a><h3>atk.relation_type_for_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">atk.relation_type_for_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>name</code></strong> :</span></p></td><td>a string which is the (non-localized) name of
26
specified by <em class="parameter"><code>type</code></em>.</p></div><div class="refsect2" title="atk.relation_type_for_name"><a name="function-atk--relation-type-for-name"></a><h3>atk.relation_type_for_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">atk.relation_type_for_name</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>name</code></strong> :</span></p></td><td>a string which is the (non-localized) name of
27
27
an ATK relation type.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the matching type of the <a class="xref" href="atk-constants.html#atk-relation-type-constants" title="Atk Relation Type Constants">Atk Relation Type Constants</a> corresponding
28
28
to the specified <em class="parameter"><code>name</code></em>, or
29
29
<code class="literal">atk.RELATION_NULL</code> if no matching relation type
added
removed
docs/html/class-atkrelation.html
