/usr/share/gtk-doc/html/pygtk/class-gtkcellrenderertext.html is in python-gtk2-doc 2.24.0-3.
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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 | <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.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-gtkcellrendererspinner.html" title="gtk.CellRendererSpinner"><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-gtkcellrendererspinner.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>
cell</p></div><div class="refsect1" title="Synopsis"><a name="id3635219"></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>):
<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="id3635287"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtkcellrenderer.html" title="gtk.CellRenderer">gtk.CellRenderer</a>
+-- <a class="link" href="class-gtkcellrenderertext.html" title="gtk.CellRendererText">gtk.CellRendererText</a>
</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
<a class="xref" href="pango-constants.html#pango-alignment-constants" title="Pango Alignment Constants">Pango Alignment Constants</a> Default value:
<code class="literal">pango.ALIGN_LEFT</code>. Note that you probably need the 'xalign' property of
<PYGTKDOCLINK HREF=""><code class="classname">gtk.CellRenderer</code></PYGTKDOCLINK>
if you want to set the horizontal alignment of the whole text.
This property is available in GTK+ 2.10 and above.</td></tr><tr valign="top"><td valign="top">"attributes"</td><td valign="top">Read/Write</td><td valign="top">A list of style attributes to apply to the text of the
renderer.</td></tr><tr valign="top"><td valign="top">"background"</td><td valign="top">Write</td><td valign="top">Background color as a string. Default:
<code class="literal">None</code></td></tr><tr valign="top"><td valign="top">"background-gdk"</td><td valign="top">Read/Write</td><td valign="top">Background color as a gtk.gdk.Color</td></tr><tr valign="top"><td valign="top">"background-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the background
color. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"editable"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> the text can be modified by the
user. GTK+ 2.4 and above. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"editable-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the text
editability. GTK+ 2.4 and above. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"ellipsize"</td><td valign="top">Read/Write</td><td valign="top">The preferred place to ellipsize the string, if the cell
renderer does not have enough room to display the entire string, if at all.
GTK+ 2.6 and above. Default: <code class="literal">pango.ELLIPSIZE_NONE</code></td></tr><tr valign="top"><td valign="top">"ellipsize-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the text
editability. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"family"</td><td valign="top">Read/Write</td><td valign="top">Name of the font family, e.g. Sans, Helvetica, Times,
Monospace. Default: <code class="literal">None</code></td></tr><tr valign="top"><td valign="top">"family-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the font
family. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"font"</td><td valign="top">Read/Write</td><td valign="top">Font description as a string. Default:
<code class="literal">None</code></td></tr><tr valign="top"><td valign="top">"font-desc"</td><td valign="top">Read/Write</td><td valign="top">Font description as a <a class="link" href="class-pangofontdescription.html" title="pango.FontDescription"><code class="classname">pango.FontDescription</code></a></td></tr><tr valign="top"><td valign="top">"foreground"</td><td valign="top">Write</td><td valign="top">Foreground color as a string. Default:
<code class="literal">None</code></td></tr><tr valign="top"><td valign="top">"foreground-gdk"</td><td valign="top">Read/Write</td><td valign="top">Foreground color as a <a class="link" href="class-gdkcolor.html" title="gtk.gdk.Color"><code class="classname">gtk.gdk.Color</code></a></td></tr><tr valign="top"><td valign="top">"foreground-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the foreground
color. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"language"</td><td valign="top">Read/Write</td><td valign="top">The language this text is in, as an ISO code. Pango can use
this as a hint when rendering the text. If you don't understand this parameter,
you probably don't need it. GTK+ 2.4 and above. Default:
<code class="literal">None</code></td></tr><tr valign="top"><td valign="top">"language-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the
language used to render the text. GTK+ 2.4 and above. Default:
<code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"markup"</td><td valign="top">Write</td><td valign="top">Marked up text to render. Default:
<code class="literal">None</code></td></tr><tr valign="top"><td valign="top">"rise"</td><td valign="top">Read/Write</td><td valign="top">Offset of text above the baseline (below the baseline if
rise is negative). Default: 0</td></tr><tr valign="top"><td valign="top">"rise-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the
rise. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"scale"</td><td valign="top">Read/Write</td><td valign="top">Font scaling factor. Allowed values >= 0.
Default: 1</td></tr><tr valign="top"><td valign="top">"scale-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag scales the font.
Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"single-paragraph-mode"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code>, keep all text in a single
paragraph. GTK+ 2.4 and above. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"size"</td><td valign="top">Read/Write</td><td valign="top">Font size. Allowed values >= 0. Default: 0</td></tr><tr valign="top"><td valign="top">"size-points"</td><td valign="top">Read/Write</td><td valign="top">Font size in points. Allowed values >= 0.
Default: 0</td></tr><tr valign="top"><td valign="top">"size-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the font
size. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"stretch"</td><td valign="top">Read/Write</td><td valign="top">Font stretch. Default:
<code class="literal">pango.STRETCH_NORMAL</code></td></tr><tr valign="top"><td valign="top">"stretch-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the font
stretch. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"strikethrough"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> strike through the text.
Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"strikethrough-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the
strikethrough. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"style"</td><td valign="top">Read/Write</td><td valign="top">Font style. Default:
<code class="literal">pango.STYLE_NORMAL</code></td></tr><tr valign="top"><td valign="top">"style-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the font
style. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"text"</td><td valign="top">Read/Write</td><td valign="top">Text to render. Default: <code class="literal">None</code></td></tr><tr valign="top"><td valign="top">"underline"</td><td valign="top">Read/Write</td><td valign="top">Style of underline for this text.
Default: <code class="literal">pango.UNDERLINE_NONE</code></td></tr><tr valign="top"><td valign="top">"underline-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the text
underlining. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"variant"</td><td valign="top">Read/Write</td><td valign="top">Font variant. Default:
<code class="literal">pango.VARIANT_NORMAL</code></td></tr><tr valign="top"><td valign="top">"variant-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the font
variant. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"weight"</td><td valign="top">Read/Write</td><td valign="top">Font weight. Allowed values >= 0. Default value:
400</td></tr><tr valign="top"><td valign="top">"weight-set"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> this tag affects the font
weight. Default: <code class="literal">False</code></td></tr><tr valign="top"><td valign="top">"width-chars"</td><td valign="top">Read/Write</td><td valign="top">The desired width of the cell, in
characters. If this property is set to -1, the width will be
calculated automatically, otherwise the cell will request either 3
characters or the property value, whichever is greater. GTK+ 2.6
and above. Allowed values >= -1. Default value: -1</td></tr><tr valign="top"><td valign="top">"wrap-mode"</td><td valign="top">Read-Write</td><td valign="top">Specifies how to break the string into multiple lines, if
the cell renderer does not have enough room to display the entire
string. This property has no effect unless the "wrap-width"
property is set. This property is available in GTK+ 2.8 and
above.</td></tr><tr valign="top"><td valign="top">"wrap-width"</td><td valign="top">Read-Write</td><td valign="top">Specifies the width at which the text is wrapped. The
"wrap-mode" property can be used to influence at what character
positions the line breaks can be placed. Setting "wrap-width" to
-1 turns wrapping off. This property is available in GTK+ 2.8 and
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="id3636417"></a><h2>Description</h2><p>The <a class="link" href="class-gtkcellrenderertext.html" title="gtk.CellRendererText"><code class="classname">gtk.CellRendererText</code></a>
manages the rendering of text into a <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>
cell, using the font, color and style information provided by its
properties. The text will be ellipsized if it is too long and the
"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>.
The way that text is drawn is changed using object properties. The object
properties can be set globally (with <PYGTKDOCLINK HREF="method-gobject--set-property"><code class="methodname">set_property</code>()</PYGTKDOCLINK>).
Also, with <a class="link" href="class-gtktreeviewcolumn.html" title="gtk.TreeViewColumn"><code class="classname">gtk.TreeViewColumn</code></a>,
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>.
For example, you can bind the "text" property on the cell renderer to a
string value in the model, thus rendering a different string in each row of
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="id3636525"></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
allocated, or -1</td></tr></tbody></table><p>The <code class="methodname">set_fixed_height_from_font</code>() sets
the height of a renderer to explicitly be determined by the "font" and
"ypad" properties set on it. This method must be called each time these
properties are changed to affect the height. This function is inflexible,
and should really only be used if calculating the size of a cell is too slow
(i.e. a massive number of cells displayed). If
<em class="parameter"><code>number_of_rows</code></em> is -1, then the fixed height is unset,
and the height is determined by the properties again.</p></div></div><div class="refsect1" title="Signals"><a name="id3636607"></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
"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
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
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
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "edited" signal is emitted when the text in the cell has
been edited.</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-gtkcellrendererspinner.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-gtkcellrenderertoggle.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.CellRendererSpinner </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.CellRendererToggle</td></tr></table></div></body></html>
|