1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.CellEditable</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="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkcalendar.html" title="gtk.Calendar"><link rel="next" href="class-gtkcelllayout.html" title="gtk.CellLayout"></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.CellEditable</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkcalendar.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkcelllayout.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkcelleditable"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.CellEditable</h2><p>gtk.CellEditable — an interface for editing a TreeView cell</p></div><div class="refsect1" lang="en"><a name="id3432840"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.CellEditable</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
2
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcelleditable.html#method-gtkcelleditable--start-editing" title="gtk.CellEditable.start_editing">start_editing</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>event</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcelleditable.html#method-gtkcelleditable--editing-done" title="gtk.CellEditable.editing_done">editing_done</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcelleditable.html#method-gtkcelleditable--remove-widget" title="gtk.CellEditable.remove_widget">remove_widget</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkcelleditable"></a><h2>gtk.CellEditable Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkcelleditable.html#signal-gtkcelleditable--editing-done" title='The "editing-done" gtk.CellEditable Signal'>editing-done</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>celleditable</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkcelleditable.html#signal-gtkcelleditable--remove-widget" title='The "remove-widget" gtk.CellEditable Signal'>remove-widget</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>celleditable</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3433045"></a><h2>Description</h2><p>The <a class="link" href="class-gtkcelleditable.html" title="gtk.CellEditable"><code class="classname">gtk.CellEditable</code></a>
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.CellEditable</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="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkcalendar.html" title="gtk.Calendar"><link rel="next" href="class-gtkcelllayout.html" title="gtk.CellLayout"></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.CellEditable</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkcalendar.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkcelllayout.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.CellEditable"><a name="class-gtkcelleditable"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.CellEditable</h2><p>gtk.CellEditable — an interface for editing a TreeView cell</p></div><div class="refsect1" title="Synopsis"><a name="id3741976"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.CellEditable</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
2
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcelleditable.html#method-gtkcelleditable--start-editing" title="gtk.CellEditable.start_editing">start_editing</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>event</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcelleditable.html#method-gtkcelleditable--editing-done" title="gtk.CellEditable.editing_done">editing_done</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcelleditable.html#method-gtkcelleditable--remove-widget" title="gtk.CellEditable.remove_widget">remove_widget</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="gtk.CellEditable Signal Prototypes"><a name="signal-prototypes-gtkcelleditable"></a><h2>gtk.CellEditable Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkcelleditable.html#signal-gtkcelleditable--editing-done" title='The "editing-done" gtk.CellEditable Signal'>editing-done</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>celleditable</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkcelleditable.html#signal-gtkcelleditable--remove-widget" title='The "remove-widget" gtk.CellEditable Signal'>remove-widget</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>celleditable</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id3742181"></a><h2>Description</h2><p>The <a class="link" href="class-gtkcelleditable.html" title="gtk.CellEditable"><code class="classname">gtk.CellEditable</code></a>
3
3
is an interface that provides editing of a cell in a <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>
4
cell.</p></div><div class="refsect1" lang="en"><a name="id3433068"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkcelleditable--start-editing"></a><h3>gtk.CellEditable.start_editing</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">start_editing</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>event</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>event</code></strong> :</span></p></td><td>A <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>, or
4
cell.</p></div><div class="refsect1" title="Methods"><a name="id3742204"></a><h2>Methods</h2><div class="refsect2" title="gtk.CellEditable.start_editing"><a name="method-gtkcelleditable--start-editing"></a><h3>gtk.CellEditable.start_editing</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">start_editing</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>event</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>event</code></strong> :</span></p></td><td>A <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>, or
5
5
<code class="literal">None</code></td></tr></tbody></table><p>The <code class="methodname">start_editing</code>() method begins the
6
6
editing on a <em class="parameter"><code>cell_editable</code></em> widget that has been
7
7
reparented over the treeview cell. <em class="parameter"><code>event</code></em> is the
9
9
that began the editing process. If the editing was initiated through
10
10
programmatic means, <em class="parameter"><code>event</code></em> may be
11
11
<code class="literal">None</code>, .
12
</p></div><div class="refsect2" lang="en"><a name="method-gtkcelleditable--editing-done"></a><h3>gtk.CellEditable.editing_done</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">editing_done</span>(<span class="methodparam"></span>)</code></pre><p>The <code class="methodname">editing_done</code>() method emits the
12
</p></div><div class="refsect2" title="gtk.CellEditable.editing_done"><a name="method-gtkcelleditable--editing-done"></a><h3>gtk.CellEditable.editing_done</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">editing_done</span>(<span class="methodparam"></span>)</code></pre><p>The <code class="methodname">editing_done</code>() method emits the
13
13
"editing_done" signal that notifies the cell renderer to update it's value
14
from the cell.</p></div><div class="refsect2" lang="en"><a name="method-gtkcelleditable--remove-widget"></a><h3>gtk.CellEditable.remove_widget</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">remove_widget</span>(<span class="methodparam"></span>)</code></pre><p>The remove_widget() method emits the "remove_widget" signal that
14
from the cell.</p></div><div class="refsect2" title="gtk.CellEditable.remove_widget"><a name="method-gtkcelleditable--remove-widget"></a><h3>gtk.CellEditable.remove_widget</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">remove_widget</span>(<span class="methodparam"></span>)</code></pre><p>The remove_widget() method emits the "remove_widget" signal that
15
15
indicates that the cell is finished editing, and the celleditable widget may
16
now be destroyed.</p></div></div><div class="refsect1" lang="en"><a name="id3433240"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkcelleditable--editing-done"></a><h3>The "editing-done" gtk.CellEditable Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>celleditable</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>celleditable</code></em> :</span></p></td><td>the celleditable that received the
16
now be destroyed.</p></div></div><div class="refsect1" title="Signals"><a name="id3742376"></a><h2>Signals</h2><div class="refsect2" title='The "editing-done" gtk.CellEditable Signal'><a name="signal-gtkcelleditable--editing-done"></a><h3>The "editing-done" gtk.CellEditable Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>celleditable</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>celleditable</code></em> :</span></p></td><td>the celleditable that received the
17
17
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
18
18
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
19
19
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
20
20
any)</td></tr></tbody></table><p>The "editing-done" signal is emitted when the <a class="link" href="class-gtkcelleditable.html#method-gtkcelleditable--editing-done" title="gtk.CellEditable.editing_done"><code class="methodname">editing_done</code>()</a>
21
method is called.</p></div><div class="refsect2" lang="en"><a name="signal-gtkcelleditable--remove-widget"></a><h3>The "remove-widget" gtk.CellEditable Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>celleditable</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>celleditable</code></em> :</span></p></td><td>the celleditable that received the
21
method is called.</p></div><div class="refsect2" title='The "remove-widget" gtk.CellEditable Signal'><a name="signal-gtkcelleditable--remove-widget"></a><h3>The "remove-widget" gtk.CellEditable Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>celleditable</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>celleditable</code></em> :</span></p></td><td>the celleditable that received the
22
22
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
23
23
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
24
24
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
added
removed
docs/html/class-gtkcelleditable.html
