/usr/share/gtk-doc/html/pygtk/class-atkrelationset.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.RelationSet</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><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-atkrelation.html" title="atk.Relation"><link rel="next" href="class-atkselection.html" title="atk.Selection"></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.RelationSet</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkrelation.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkselection.html">Next</a></td></tr></table><hr></div><div class="refentry" title="atk.RelationSet"><a name="class-atkrelationset"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.RelationSet</h2><p>atk.RelationSet — a set of <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a>
objects, normally the set of <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a>
objects that an <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
has.</p></div><div class="refsect1" title="Synopsis"><a name="id2948011"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.RelationSet</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-atkrelationset.html#constructor-atkrelationset" title="atk.RelationSet">atk.RelationSet</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelationset.html#method-atkrelationset--contains" title="atk.RelationSet.contains">contains</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-atkrelationset.html#method-atkrelationset--remove" title="atk.RelationSet.remove">remove</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relation</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelationset.html#method-atkrelationset--add" title="atk.RelationSet.add">add</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relation</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelationset.html#method-atkrelationset--get-n-relations" title="atk.RelationSet.get_n_relations">get_n_relations</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelationset.html#method-atkrelationset--get-relation" title="atk.RelationSet.get_relation">get_relation</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkrelationset.html#method-atkrelationset--get-relation-by-type" title="atk.RelationSet.get_relation_by_type">get_relation_by_type</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relationship</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id2973473"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-atkrelationset.html" title="atk.RelationSet">atk.RelationSet</a>
</pre></div><div class="refsect1" title="atk.RelationSet Signal Prototypes"><a name="signal-prototypes-atkrelationset"></a><h2>atk.RelationSet Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p></div><div class="refsect1" title="Description"><a name="id2952564"></a><h2>Description</h2><p>The <a class="link" href="class-atkrelationset.html" title="atk.RelationSet"><code class="classname">atk.RelationSet</code></a>
held by an object establishes its relationships with objects beyond the
normal "parent/child" hierarchical relationships that all user interface
objects have. <a class="link" href="class-atkrelationset.html" title="atk.RelationSet"><code class="classname">atk.RelationSet</code></a>
objects establish whether objects are labelled or controlled by other
components, share group membership with other components (for instance
within a radio-button group), or share content which "flows" between
them, among other types of possible relationships.</p></div><div class="refsect1" title="Constructor"><a name="id2973024"></a><h2>Constructor</h2><div class="refsect2" title="atk.RelationSet"><a name="constructor-atkrelationset"></a><h3>atk.RelationSet</h3><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">atk.RelationSet</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>a new <a class="link" href="class-atkrelationset.html" title="atk.RelationSet"><code class="classname">atk.RelationSet</code></a></td></tr></tbody></table><p>Creates a new empty relation set.</p></div></div><div class="refsect1" title="Methods"><a name="id2933775"></a><h2>Methods</h2><div class="refsect2" title="atk.RelationSet.contains"><a name="method-atkrelationset--contains"></a><h3>atk.RelationSet.contains</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">contains</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>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>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if
<em class="parameter"><code>relationship</code></em> is the relationship
type.</td></tr></tbody></table><p>Determines whether the relation set contains a relation that
matches the type specified by
<em class="parameter"><code>relationship</code></em>.</p></div><div class="refsect2" title="atk.RelationSet.remove"><a name="method-atkrelationset--remove"></a><h3>atk.RelationSet.remove</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">remove</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relation</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>relation</code></strong> :</span></p></td><td>an <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a></td></tr></tbody></table><p>Removes a relation from the relation set.</p></div><div class="refsect2" title="atk.RelationSet.add"><a name="method-atkrelationset--add"></a><h3>atk.RelationSet.add</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">add</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>relation</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>relation</code></strong> :</span></p></td><td>an <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a></td></tr></tbody></table><p>Add a new <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a>
to the current relation set if it is not already present.</p></div><div class="refsect2" title="atk.RelationSet.get_n_relations"><a name="method-atkrelationset--get-n-relations"></a><h3>atk.RelationSet.get_n_relations</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_n_relations</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>an integer representing the number of relations
in the set.</td></tr></tbody></table><p>Returns the number of relations in a relation set.</p></div><div class="refsect2" title="atk.RelationSet.get_relation"><a name="method-atkrelationset--get-relation"></a><h3>atk.RelationSet.get_relation</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_relation</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>i</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>i</code></strong> :</span></p></td><td>an index representing a position in the set,
starting from 0.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a>,
that is the relation at position <em class="parameter"><code>i</code></em> in the
set.</td></tr></tbody></table><p>Determines the relation at the specified position in the relation set.</p></div><div class="refsect2" title="atk.RelationSet.get_relation_by_type"><a name="method-atkrelationset--get-relation-by-type"></a><h3>atk.RelationSet.get_relation_by_type</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_relation_by_type</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>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>.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an <a class="link" href="class-atkrelation.html" title="atk.Relation"><code class="classname">atk.Relation</code></a>,
which is a relation matching the specified
type.</td></tr></tbody></table><p>Finds a relation that matches the specified type.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-atkrelation.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="atk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-atkselection.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">atk.Relation </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> atk.Selection</td></tr></table></div></body></html>
|