/usr/share/gtk-doc/html/pygtk/class-gtkcellrenderertoggle.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 28 29 30 31 32 33 34 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.CellRendererToggle</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-gtkcellrenderertext.html" title="gtk.CellRendererText"><link rel="next" href="class-gtkcellview.html" title="gtk.CellView"></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.CellRendererToggle</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkcellrenderertext.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkcellview.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.CellRendererToggle"><a name="class-gtkcellrenderertoggle"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.CellRendererToggle</h2><p>gtk.CellRendererToggle — an object that renders a toggle button into a TreeView
cell</p></div><div class="refsect1" title="Synopsis"><a name="id3636796"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.CellRendererToggle</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-gtkcellrenderertoggle.html#constructor-gtkcellrenderertoggle" title="Constructor">gtk.CellRendererToggle</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcellrenderertoggle.html#method-gtkcellrenderertoggle--get-radio" title="gtk.CellRendererToggle.get_radio">get_radio</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcellrenderertoggle.html#method-gtkcellrenderertoggle--set-radio" title="gtk.CellRendererToggle.set_radio">set_radio</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>radio</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcellrenderertoggle.html#method-gtkcellrenderertoggle--get-active" title="gtk.CellRendererToggle.get_active">get_active</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcellrenderertoggle.html#method-gtkcellrenderertoggle--set-active" title="gtk.CellRendererToggle.set_active">set_active</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcellrenderertoggle.html#method-gtkcellrenderertoggle--get-activatable" title="gtk.CellRendererToggle.get_activatable">get_activatable</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkcellrenderertoggle.html#method-gtkcellrenderertoggle--set-activatable" title="gtk.CellRendererToggle.set_activatable">set_activatable</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3636964"></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-gtkcellrenderertoggle.html" title="gtk.CellRendererToggle">gtk.CellRendererToggle</a>
</pre></div><div class="refsect1" title="gtk.CellRendererToggle Properties"><a name="properties-gtkcellrenderertoggle"></a><h2>gtk.CellRendererToggle 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">"activatable"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code>, the toggle button can be activated</td></tr><tr valign="top"><td valign="top">"active"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code>, the button is active.</td></tr><tr valign="top"><td valign="top">"inconsistent"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code>, the button is in an inconsistent state. GTK+ 2.2 and above.</td></tr><tr valign="top"><td valign="top">"indicator-size"</td><td valign="top">Read-Write</td><td valign="top">Size of check or radio indicator. Allowed values: >= 0. Default value: 12.</td></tr><tr valign="top"><td valign="top">"radio"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code>, draw the toggle button as a radio button</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.CellRendererToggle Signal Prototypes"><a name="signal-prototypes-gtkcellrenderertoggle"></a><h2>gtk.CellRendererToggle 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-gtkcellrenderertoggle.html#signal-gtkcellrenderertoggle--toggled" title='The "toggled" gtk.CellRendererToggle Signal'>toggled</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>cellrenderertoggle</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>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="id3637252"></a><h2>Description</h2><p>The <a class="link" href="class-gtkcellrenderertoggle.html" title="gtk.CellRendererToggle"><code class="classname">gtk.CellRendererToggle</code></a>
manages the rendering of toggle button into a <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>
cell. The button is drawn as a radio- or checkbutton, depending on the
"radio" property. When activated, it emits the toggled signal.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkcellrenderertoggle"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.CellRendererToggle</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-gtkcellrenderertoggle.html" title="gtk.CellRendererToggle"><code class="classname">gtk.CellRendererToggle</code></a>.
The toggle button rendering parameters are adjusted using the 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 "active" property on the cell renderer to a
boolean value in the model, thus causing the check button to reflect the
state of the model.</p></div><div class="refsect1" title="Methods"><a name="id3637356"></a><h2>Methods</h2><div class="refsect2" title="gtk.CellRendererToggle.get_radio"><a name="method-gtkcellrenderertoggle--get-radio"></a><h3>gtk.CellRendererToggle.get_radio</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_radio</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 we're rendering radio toggles rather than checkboxes</td></tr></tbody></table><p>The <code class="methodname">get_radio</code>() method returns
<code class="literal">True</code> if radio toggles rather than checkboxes are being
rendered.</p></div><div class="refsect2" title="gtk.CellRendererToggle.set_radio"><a name="method-gtkcellrenderertoggle--set-radio"></a><h3>gtk.CellRendererToggle.set_radio</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_radio</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>radio</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>radio</code></strong> :</span></p></td><td>If <code class="literal">True</code> make the toggle look like a radio button</td></tr></tbody></table><p>The <code class="methodname">set_radio</code>() method sets the style
of the toggle button. If <em class="parameter"><code>radio</code></em> is
<code class="literal">True</code>, the cell renderer renders a radio toggle (i.e. a
toggle in a group of mutually-exclusive toggles). If
<code class="literal">False</code>, it renders a check toggle (a standalone boolean
option). This can be set globally for the cell renderer, or changed just
before rendering each cell in the model (for <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>, you
set up a per-row setting using <a class="link" href="class-gtktreeviewcolumn.html" title="gtk.TreeViewColumn"><code class="classname">gtk.TreeViewColumn</code></a>
to associate model columns with cell renderer properties).</p></div><div class="refsect2" title="gtk.CellRendererToggle.get_active"><a name="method-gtkcellrenderertoggle--get-active"></a><h3>gtk.CellRendererToggle.get_active</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_active</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 cell renderer is active.</td></tr></tbody></table><p>The <code class="methodname">get_active</code>() method returns
<code class="literal">True</code> if the cell renderer is active. See <a class="link" href="class-gtkcellrenderertoggle.html#method-gtkcellrenderertoggle--set-active" title="gtk.CellRendererToggle.set_active"><code class="function">gtk.CellRendererToggle.set_active()</code></a>.</p></div><div class="refsect2" title="gtk.CellRendererToggle.set_active"><a name="method-gtkcellrenderertoggle--set-active"></a><h3>gtk.CellRendererToggle.set_active</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_active</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</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>setting</code></strong> :</span></p></td><td>the value to set.</td></tr></tbody></table><p>The <code class="methodname">set_active</code>() method activates a
cell renderer if <em class="parameter"><code>setting</code></em> is <code class="literal">True</code>
and or deactivates a cell renderer if <em class="parameter"><code>setting</code></em> is
<code class="literal">False</code>.</p></div><div class="refsect2" title="gtk.CellRendererToggle.get_activatable"><a name="method-gtkcellrenderertoggle--get-activatable"></a><h3>gtk.CellRendererToggle.get_activatable</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_activatable</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 cell renderer is activatable.</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.22 and above.</p></div><p>The <code class="methodname">get_activatable</code>() method returns
<code class="literal">True</code> if the cell renderer is activatable.</p></div><div class="refsect2" title="gtk.CellRendererToggle.set_activatable"><a name="method-gtkcellrenderertoggle--set-activatable"></a><h3>gtk.CellRendererToggle.set_activatable</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_activatable</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</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>setting</code></strong> :</span></p></td><td>the value to set.</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.22 and above.</p></div><p>The <code class="methodname">set_activatable</code>() method sets wether
the cell renderer is activatable.</p></div></div><div class="refsect1" title="Signals"><a name="id3637805"></a><h2>Signals</h2><div class="refsect2" title='The "toggled" gtk.CellRendererToggle Signal'><a name="signal-gtkcellrenderertoggle--toggled"></a><h3>The "toggled" gtk.CellRendererToggle Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>cellrenderertoggle</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>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>cellrenderertoggle</code></em> :</span></p></td><td>the cellrenderertoggle that received the "toggled" signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td><td>the path of the cellrenderertoggle represented as a string</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 "toggled" signal is emitted when the toggle button in the
cell changes state.</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-gtkcellrenderertext.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-gtkcellview.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.CellRendererText </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.CellView</td></tr></table></div></body></html>
|