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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.CellRendererToggle</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-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" lang="en"><a name="class-gtkcellrenderertoggle"></a><div class="titlepage"><div></div><div></div></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" lang="en"><a name="id3275835"></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 href="class-gtkcellrenderer.html" title="gtk.CellRenderer">gtk.CellRenderer</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a 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 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 href="class-gtkcellrenderertoggle.html#method-gtkcellrenderertoggle--set-radio" title="gtk.CellRendererToggle.set_radio">set_radio</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>radio</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a 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 href="class-gtkcellrenderertoggle.html#method-gtkcellrenderertoggle--set-active" title="gtk.CellRendererToggle.set_active">set_active</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</tt></b></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3305628"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
+-- <a href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a href="class-gtkcellrenderer.html" title="gtk.CellRenderer">gtk.CellRenderer</a>
+-- <a href="class-gtkcellrenderertoggle.html" title="gtk.CellRendererToggle">gtk.CellRendererToggle</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3220819"></a><h2>Properties</h2><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">"activatable"</td><td valign="top">Read/Write</td><td valign="top">If <tt class="literal">TRUE</tt>, 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 <tt class="literal">TRUE</tt>, the button is active.</td></tr><tr valign="top"><td valign="top">"radio"</td><td valign="top">Read/Write</td><td valign="top">If <tt class="literal">TRUE</tt>, draw the toggle button as a
radio button</td></tr><tr valign="top"><td valign="top">"inconsistent"</td><td valign="top">Read/Write</td><td valign="top">If <tt class="literal">TRUE</tt>, the button is in an inconsistent
state. GTK+ 2.2 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3251494"></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-gtkcellrenderertoggle.html#signal-gtkcellrenderertoggle--toggled" title='The "toggled" gtk.CellRendererToggle Signal'>toggled</a>"</span></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>cellrenderertoggle</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>path</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="id3340806"></a><h2>Description</h2><p>The <a href="class-gtkcellrenderertoggle.html" title="gtk.CellRendererToggle"><tt class="classname">gtk.CellRendererToggle</tt></a>
manages the rendering of toggle button into 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="constructor-gtkcellrenderertoggle"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.CellRendererToggle</span>(<span class="methodparam"></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"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the new cell renderer</td></tr></tbody></table><p>Creates a new <a href="class-gtkcellrenderertoggle.html" title="gtk.CellRendererToggle"><tt class="classname">gtk.CellRendererToggle</tt></a>.
The toggle button rendering parameters are adjusted using the object
properties. The object properties can be set globally (with <a href="class-gobject.html#method-gobject--set-property" title="gobject.GObject.set_property"><tt class="methodname">set_property</tt>()</a>).
Also, with <a href="class-gtktreeviewcolumn.html" title="gtk.TreeViewColumn"><tt class="classname">gtk.TreeViewColumn</tt></a>,
you can bind a property to a value in a <a href="class-gtktreemodel.html" title="gtk.TreeModel"><tt class="classname">gtk.TreeModel</tt></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" lang="en"><a name="id3264736"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkcellrenderertoggle--get-radio"></a><h3>gtk.CellRendererToggle.get_radio</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_radio</span>(<span class="methodparam"></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"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if we're rendering
radio toggles rather than checkboxes</td></tr></tbody></table><p>The <tt class="methodname">get_radio</tt>() method returns
<tt class="literal">TRUE</tt> if radio toggles rather than checkboxes are being
rendered.</p></div><div class="refsect2" lang="en"><a name="method-gtkcellrenderertoggle--set-radio"></a><h3>gtk.CellRendererToggle.set_radio</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_radio</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>radio</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>radio</tt></b>:</span></td><td>If <tt class="literal">TRUE</tt> make the toggle look
like a radio button</td></tr></tbody></table><p>The <tt class="methodname">set_radio</tt>() method sets the style
of the toggle button. If <i class="parameter"><tt>radio</tt></i> is
<tt class="literal">TRUE</tt>, the cell renderer renders a radio toggle (i.e. a
toggle in a group of mutually-exclusive toggles). If
<tt class="literal">FALSE</tt>, 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 href="class-gtktreeview.html" title="gtk.TreeView"><tt class="classname">gtk.TreeView</tt></a>, you
set up a per-row setting using <a href="class-gtktreeviewcolumn.html" title="gtk.TreeViewColumn"><tt class="classname">gtk.TreeViewColumn</tt></a>
to associate model columns with cell renderer properties).</p></div><div class="refsect2" lang="en"><a name="method-gtkcellrenderertoggle--get-active"></a><h3>gtk.CellRendererToggle.get_active</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_active</span>(<span class="methodparam"></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"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the cell renderer is
active.</td></tr></tbody></table><p>The <tt class="methodname">get_active</tt>() method returns
<tt class="literal">TRUE</tt> if the cell renderer is active. See <a href="class-gtkcellrenderertoggle.html#method-gtkcellrenderertoggle--set-active" title="gtk.CellRendererToggle.set_active"><tt class="function">gtk.CellRendererToggle.set_active()</tt></a>.</p></div><div class="refsect2" lang="en"><a name="method-gtkcellrenderertoggle--set-active"></a><h3>gtk.CellRendererToggle.set_active</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_active</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</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>setting</tt></b>:</span></td><td>the value to set.</td></tr></tbody></table><p>The <tt class="methodname">set_active</tt>() method activates a
cell renderer if <i class="parameter"><tt>setting</tt></i> is <tt class="literal">TRUE</tt>
and or deactivates a cell renderer if <i class="parameter"><tt>setting</tt></i> is
<tt class="literal">FALSE</tt>.</p></div></div><div class="refsect1" lang="en"><a name="id3331549"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkcellrenderertoggle--toggled"></a><h3>The "toggled" gtk.CellRendererToggle 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>cellrenderertoggle</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>path</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>cellrenderertoggle</tt></i>:</span></td><td>the cellrenderertoggle that received the
"toggled" signal</td></tr><tr><td><span class="term"><i class="parameter"><tt>path</tt></i>:</span></td><td>the path of the
cellrenderertoggle</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 "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>
|
