/usr/share/gtk-doc/html/pygtk/class-gtktreerowreference.html is in python-gtk2-doc 2.24.0-4.
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 26 27 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.TreeRowReference</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="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-pygtktreemodelrowiter.html" title="gtk.TreeModelRowIter"><link rel="next" href="class-gtktreeselection.html" title="gtk.TreeSelection"></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">gtk.TreeRowReference</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-pygtktreemodelrowiter.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtktreeselection.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.TreeRowReference"><a name="class-gtktreerowreference"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.TreeRowReference</h2><p>gtk.TreeRowReference — an object maintaining a persistent reference to a <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>
row (new in PyGTK 2.4)</p></div><div class="refsect1" title="Synopsis"><a name="id4029293"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.TreeRowReference</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtktreerowreference.html#constructor-gtktreerowreference" title="Constructor">gtk.TreeRowReference</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>model</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktreerowreference.html#method-gtktreerowreference--get-path" title="gtk.TreeRowReference.get_path">get_path</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktreerowreference.html#method-gtktreerowreference--get-model" title="gtk.TreeRowReference.get_model">get_model</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktreerowreference.html#method-gtktreerowreference--valid" title="gtk.TreeRowReference.valid">valid</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktreerowreference.html#method-gtktreerowreference--copy" title="gtk.TreeRowReference.copy">copy</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktreerowreference.html#method-gtktreerowreference--free" title="gtk.TreeRowReference.free">free</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Description"><a name="id4029462"></a><h2>Description</h2><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This object is available in PyGTK 2.4 and above.</p></div><p>A <a class="link" href="class-gtktreerowreference.html" title="gtk.TreeRowReference"><code class="classname">gtk.TreeRowReference</code></a>
is an object that points to a row in a <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>
similar to a <a class="link" href="class-gtktreeiter.html" title="gtk.TreeIter"><code class="classname">gtk.TreeIter</code></a>. A
<a class="link" href="class-gtktreerowreference.html" title="gtk.TreeRowReference"><code class="classname">gtk.TreeRowReference</code></a>,
unlike a <a class="link" href="class-gtktreeiter.html" title="gtk.TreeIter"><code class="classname">gtk.TreeIter</code></a>,
maintains a persistent reference in spite of changes in the model.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtktreerowreference"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.TreeRowReference</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>model</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>path</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>model</code></strong> :</span></p></td><td>a <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>path</code></strong> :</span></p></td><td>a valid tree path to monitor</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gtktreerowreference.html" title="gtk.TreeRowReference"><code class="classname">gtk.TreeRowReference</code></a>,
or <code class="literal">None</code></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.4 and above.</p></div><p>Creates a row reference pointing to the treemodel row specified by
<em class="parameter"><code>model</code></em> and <em class="parameter"><code>path</code></em>. This reference
will continue pointing to the node in spite of changes in
<em class="parameter"><code>model</code></em>. It listens to all signals emitted by
<em class="parameter"><code>model</code></em>, and updates its path appropriately. If
<em class="parameter"><code>path</code></em> isn't a valid path in
<em class="parameter"><code>model</code></em>, <code class="literal">None</code> is returned.</p></div><div class="refsect1" title="Methods"><a name="id4029707"></a><h2>Methods</h2><div class="refsect2" title="gtk.TreeRowReference.get_path"><a name="method-gtktreerowreference--get-path"></a><h3>gtk.TreeRowReference.get_path</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_path</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 current path, or
<code class="literal">None</code>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_path</code>() method returns the path
that the row reference currently points to, or <code class="literal">None</code> if
the path pointed to is no longer valid.</p></div><div class="refsect2" title="gtk.TreeRowReference.get_model"><a name="method-gtktreerowreference--get-model"></a><h3>gtk.TreeRowReference.get_model</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_model</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 model, or
<code class="literal">None</code>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">get_model</code>() method returns the
model that the row reference currently monitors, or <code class="literal">None</code>
if the model is not set.</p></div><div class="refsect2" title="gtk.TreeRowReference.valid"><a name="method-gtktreerowreference--valid"></a><h3>gtk.TreeRowReference.valid</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">valid</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><code class="literal">True</code> if the row reference
points to a valid path.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">valid</code>() method returns
<code class="literal">True</code> if the row reference is not <code class="literal">None</code>
and refers to a current valid path.</p></div><div class="refsect2" title="gtk.TreeRowReference.copy"><a name="method-gtktreerowreference--copy"></a><h3>gtk.TreeRowReference.copy</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">copy</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 copy of the row reference</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">copy</code>() method returns a copy of the
tree row reference.</p></div><div class="refsect2" title="gtk.TreeRowReference.free"><a name="method-gtktreerowreference--free"></a><h3>gtk.TreeRowReference.free</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">free</span>(<span class="methodparam"></span>)</code></pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated and should not be used since it may
crash your application.</p></div><p>The free() method frees the tree row reference. The row
reference may be <code class="literal">None</code>.</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-pygtktreemodelrowiter.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtktreeselection.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.TreeModelRowIter </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.TreeSelection</td></tr></table></div></body></html>
|