1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.CellRendererText</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-gtkcellrendererspin.html" title="gtk.CellRendererSpin"><link rel="next" href="class-gtkcellrenderertoggle.html" title="gtk.CellRendererToggle"></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.CellRendererText</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkcellrendererspin.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkcellrenderertoggle.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkcellrenderertext"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.CellRendererText</h2><p>gtk.CellRendererText — an object that renders text into a <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>
2
cell</p></div><div class="refsect1" lang="en"><a name="id3440709"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.CellRendererText</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkcellrenderer.html" title="gtk.CellRenderer">gtk.CellRenderer</a></span></span>):
3
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkcellrenderertext.html#constructor-gtkcellrenderertext" title="Constructor">gtk.CellRendererText</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcellrenderertext.html#method-gtkcellrenderertext--set-fixed-height-from-font" title="gtk.CellRendererText.set_fixed_height_from_font">set_fixed_height_from_font</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>number_of_rows</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3440776"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.CellRendererText</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-gtkcellrendererspin.html" title="gtk.CellRendererSpin"><link rel="next" href="class-gtkcellrenderertoggle.html" title="gtk.CellRendererToggle"></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.CellRendererText</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkcellrendererspin.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkcellrenderertoggle.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.CellRendererText"><a name="class-gtkcellrenderertext"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.CellRendererText</h2><p>gtk.CellRendererText — an object that renders text into a <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>
2
cell</p></div><div class="refsect1" title="Synopsis"><a name="id3749861"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.CellRendererText</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkcellrenderer.html" title="gtk.CellRenderer">gtk.CellRenderer</a></span></span>):
3
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkcellrenderertext.html#constructor-gtkcellrenderertext" title="Constructor">gtk.CellRendererText</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcellrenderertext.html#method-gtkcellrenderertext--set-fixed-height-from-font" title="gtk.CellRendererText.set_fixed_height_from_font">set_fixed_height_from_font</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>number_of_rows</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3749928"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
4
4
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
5
5
+-- <a class="link" href="class-gtkcellrenderer.html" title="gtk.CellRenderer">gtk.CellRenderer</a>
6
6
+-- <a class="link" href="class-gtkcellrenderertext.html" title="gtk.CellRendererText">gtk.CellRendererText</a>
7
</pre></div><div class="refsect1" lang="en"><a name="properties-gtkcellrenderertext"></a><h2>gtk.CellRendererText Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkcellrenderer.html#properties-gtkcellrenderer" title="gtk.CellRenderer Properties">gtk.CellRenderer Properties</a></p><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">"alignment"</td><td valign="top">Read/Write</td><td valign="top">Specifies how to align the lines of text using one of the
7
</pre></div><div class="refsect1" title="gtk.CellRendererText Properties"><a name="properties-gtkcellrenderertext"></a><h2>gtk.CellRendererText Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkcellrenderer.html#properties-gtkcellrenderer" title="gtk.CellRenderer Properties">gtk.CellRenderer Properties</a></p><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">"alignment"</td><td valign="top">Read/Write</td><td valign="top">Specifies how to align the lines of text using one of the
8
8
<a class="xref" href="pango-constants.html#pango-alignment-constants" title="Pango Alignment Constants">Pango Alignment Constants</a> Default value:
9
9
<code class="literal">pango.ALIGN_LEFT</code>. Note that you probably need the 'xalign' property of
10
10
<PYGTKDOCLINK HREF=""><code class="classname">gtk.CellRenderer</code></PYGTKDOCLINK>
59
59
"wrap-mode" property can be used to influence at what character
60
60
positions the line breaks can be placed. Setting "wrap-width" to
61
61
-1 turns wrapping off. This property is available in GTK+ 2.8 and
62
above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkcellrenderertext"></a><h2>gtk.CellRendererText Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkcellrenderer.html#signal-prototypes-gtkcellrenderer" title="gtk.CellRenderer Signal Prototypes">gtk.CellRenderer Signal Prototypes</a></p><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-gtkcellrenderertext.html#signal-gtkcellrenderertext--edited" title='The "edited" gtk.CellRendererText Signal'>edited</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>cellrenderertext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>path</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>new_text</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="id3441907"></a><h2>Description</h2><p>The <a class="link" href="class-gtkcellrenderertext.html" title="gtk.CellRendererText"><code class="classname">gtk.CellRendererText</code></a>
62
above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.CellRendererText Signal Prototypes"><a name="signal-prototypes-gtkcellrenderertext"></a><h2>gtk.CellRendererText Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkcellrenderer.html#signal-prototypes-gtkcellrenderer" title="gtk.CellRenderer Signal Prototypes">gtk.CellRenderer Signal Prototypes</a></p><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-gtkcellrenderertext.html#signal-gtkcellrenderertext--edited" title='The "edited" gtk.CellRendererText Signal'>edited</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>cellrenderertext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>path</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>new_text</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="id3751059"></a><h2>Description</h2><p>The <a class="link" href="class-gtkcellrenderertext.html" title="gtk.CellRendererText"><code class="classname">gtk.CellRendererText</code></a>
63
63
manages the rendering of text into a <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>
64
64
cell, using the font, color and style information provided by its
65
65
properties. The text will be ellipsized if it is too long and the
66
"ellipsize" property allows it.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkcellrenderertext"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.CellRendererText</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 new cell renderer</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkcellrenderertext.html" title="gtk.CellRendererText"><code class="classname">gtk.CellRendererText</code></a>.
66
"ellipsize" property allows it.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkcellrenderertext"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.CellRendererText</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 new cell renderer</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkcellrenderertext.html" title="gtk.CellRendererText"><code class="classname">gtk.CellRendererText</code></a>.
67
67
The way that text is drawn is changed using object properties. The object
68
68
properties can be set globally (with <PYGTKDOCLINK HREF="method-gobject--set-property"><code class="methodname">set_property</code>()</PYGTKDOCLINK>).
69
69
Also, with <a class="link" href="class-gtktreeviewcolumn.html" title="gtk.TreeViewColumn"><code class="classname">gtk.TreeViewColumn</code></a>,
70
70
you can bind a property to a value in a <a class="link" href="class-gtktreemodel.html" title="gtk.TreeModel"><code class="classname">gtk.TreeModel</code></a>.
71
71
For example, you can bind the "text" property on the cell renderer to a
72
72
string value in the model, thus rendering a different string in each row of
73
the <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>.</p></div><div class="refsect1" lang="en"><a name="id3442015"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkcellrenderertext--set-fixed-height-from-font"></a><h3>gtk.CellRendererText.set_fixed_height_from_font</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_fixed_height_from_font</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>number_of_rows</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>number_of_rows</code></strong> :</span></p></td><td>Number of rows of text each cell renderer is
73
the <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>.</p></div><div class="refsect1" title="Methods"><a name="id3751167"></a><h2>Methods</h2><div class="refsect2" title="gtk.CellRendererText.set_fixed_height_from_font"><a name="method-gtkcellrenderertext--set-fixed-height-from-font"></a><h3>gtk.CellRendererText.set_fixed_height_from_font</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_fixed_height_from_font</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>number_of_rows</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>number_of_rows</code></strong> :</span></p></td><td>Number of rows of text each cell renderer is
74
74
allocated, or -1</td></tr></tbody></table><p>The <code class="methodname">set_fixed_height_from_font</code>() sets
75
75
the height of a renderer to explicitly be determined by the "font" and
76
76
"ypad" properties set on it. This method must be called each time these
78
78
and should really only be used if calculating the size of a cell is too slow
79
79
(i.e. a massive number of cells displayed). If
80
80
<em class="parameter"><code>number_of_rows</code></em> is -1, then the fixed height is unset,
81
and the height is determined by the properties again.</p></div></div><div class="refsect1" lang="en"><a name="id3442097"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkcellrenderertext--edited"></a><h3>The "edited" gtk.CellRendererText Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>cellrenderertext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>path</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>new_text</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>cellrenderertext</code></em> :</span></p></td><td>the cellrenderertext that received the
81
and the height is determined by the properties again.</p></div></div><div class="refsect1" title="Signals"><a name="id3751249"></a><h2>Signals</h2><div class="refsect2" title='The "edited" gtk.CellRendererText Signal'><a name="signal-gtkcellrenderertext--edited"></a><h3>The "edited" gtk.CellRendererText Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>cellrenderertext</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>path</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>new_text</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>cellrenderertext</code></em> :</span></p></td><td>the cellrenderertext that received the
82
82
"edited" signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td><td>the path string of the
83
83
cellrenderertext</td></tr><tr><td><p><span class="term"><em class="parameter"><code>new_text</code></em> :</span></p></td><td>the new text of the
84
84
cellrenderertext</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
added
removed
docs/html/class-gtkcellrenderertext.html
