File: class-gtkcelleditable.html

package info (click to toggle)
python-gtk2-doc 2.5.2-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 8,304 kB
  • ctags: 3,741
  • sloc: makefile: 38
file content (27 lines) | stat: -rw-r--r-- 10,273 bytes parent folder | download
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=ISO-8859-1"><title>gtk.CellEditable</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.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="previous" 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><div></div></div><div class="refnamediv"><h2>gtk.CellEditable</h2><p>gtk.CellEditable &#8212; an interface for editing a TreeView cell</p></div><div class="refsect1" lang="en"><a name="id3179710"></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>):
<code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkcelleditable.html#method-gtkcelleditable--start-editing" title="gtk.CellEditable.start_editing">start_editing</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>event</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a 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 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="id3286552"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term">"<a href="class-gtkcelleditable.html#signal-gtkcelleditable--editing-done" title='The "editing-done" gtk.CellEditable Signal'>editing-done</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>celleditable</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkcelleditable.html#signal-gtkcelleditable--remove-widget" title='The "remove-widget" gtk.CellEditable Signal'>remove-widget</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>celleditable</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3176182"></a><h2>Description</h2><p>The <a href="class-gtkcelleditable.html" title="gtk.CellEditable"><tt class="classname">gtk.CellEditable</tt></a> 
is an interface that provides editing of a cell in a <a href="class-gtktreeview.html" title="gtk.TreeView"><tt class="classname">gtk.TreeView</tt></a>
cell.</p></div><div class="refsect1" lang="en"><a name="id3225077"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkcelleditable--start-editing"></a><h3>gtk.CellEditable.start_editing</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">start_editing</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>event</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>event</tt></b>:</span></td><td>A <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a>, or
<tt class="literal">None</tt></td></tr></tbody></table><p>The <tt class="methodname">start_editing</tt>() method begins the
editing on a <i class="parameter"><tt>cell_editable</tt></i> widget that has been
reparented over the treeview cell.  <i class="parameter"><tt>event</tt></i> is the
<a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a>
that began the editing process. If the editing was initiated through
programmatic means, <i class="parameter"><tt>event</tt></i> may be
<tt class="literal">None</tt>, .
</p></div><div class="refsect2" lang="en"><a name="method-gtkcelleditable--editing-done"></a><h3>gtk.CellEditable.editing_done</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">editing_done</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">editing_done</tt>() method emits the
"editing_done" signal that notifies the cell renderer to update it's value
from the cell.</p></div><div class="refsect2" lang="en"><a name="method-gtkcelleditable--remove-widget"></a><h3>gtk.CellEditable.remove_widget</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">remove_widget</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The remove_widget() method emits the "remove_widget" signal that
indicates that the cell is finished editing, and the celleditable widget may
now be destroyed.</p></div></div><div class="refsect1" lang="en"><a name="id3100052"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkcelleditable--editing-done"></a><h3>The "editing-done" gtk.CellEditable Signal</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>celleditable</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>celleditable</tt></i>:</span></td><td>the celleditable that received the
signal</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_param1</tt></i>:</span></td><td>the first user parameter (if any) specified
with the <a href="class-gobject.html#method-gobject--connect" title="gobject.GObject.connect"><tt class="methodname">connect</tt>()</a>
method</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i>:</span></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "editing-done" signal is emitted when the <a href="class-gtkcelleditable.html#method-gtkcelleditable--editing-done" title="gtk.CellEditable.editing_done"><tt class="methodname">editing_done</tt>()</a> 
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><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>celleditable</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>celleditable</tt></i>:</span></td><td>the celleditable that received the
signal</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_param1</tt></i>:</span></td><td>the first user parameter (if any) specified
with the <a href="class-gobject.html#method-gobject--connect" title="gobject.GObject.connect"><tt class="methodname">connect</tt>()</a>
method</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i>:</span></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "remove-widget" signal is emitted when the cellrenderer for
the treeview cell has retrieved the edited information and the celleditable
widget can be destroyed.</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-gtkcalendar.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-gtkcelllayout.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Calendar</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.CellLayout</td></tr></table></div></body></html>