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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.ToggleToolButton</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-gtktogglebutton.html" title="gtk.ToggleButton"><link rel="next" href="class-gtktoolbar.html" title="gtk.Toolbar"></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.ToggleToolButton</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtktogglebutton.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtktoolbar.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtktoggletoolbutton"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.ToggleToolButton</h2><p>gtk.ToggleToolButton — A <a class="link" href="class-gtktoolitem.html" title="gtk.ToolItem"><code class="classname">gtk.ToolItem</code></a>
containing a toggle button (new in PyGTK 2.4)</p></div><div class="refsect1" lang="en"><a name="id3568554"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.ToggleToolButton</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtktoolbutton.html" title="gtk.ToolButton">gtk.ToolButton</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtktoggletoolbutton.html#constructor-gtktoggletoolbutton" title="Constructor">gtk.ToggleToolButton</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>stock_id</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktoggletoolbutton.html#method-gtktoggletoolbutton--set-active" title="gtk.ToggleToolButton.set_active">set_active</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>is_active</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktoggletoolbutton.html#method-gtktoggletoolbutton--get-active" title="gtk.ToggleToolButton.get_active">get_active</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3568661"></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-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a class="link" href="class-gtktoolitem.html" title="gtk.ToolItem">gtk.ToolItem</a>
+-- <a class="link" href="class-gtktoolbutton.html" title="gtk.ToolButton">gtk.ToolButton</a>
+-- <a class="link" href="class-gtktoggletoolbutton.html" title="gtk.ToggleToolButton">gtk.ToggleToolButton</a>
</pre></div><div class="refsect1" lang="en"><a name="id3568725"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtktoggletoolbutton.html" title="gtk.ToggleToolButton"><code class="classname">gtk.ToggleToolButton</code></a>
implements
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
</p></div><div class="refsect1" lang="en"><a name="properties-gtktoggletoolbutton"></a><h2>gtk.ToggleToolButton 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-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><p><a class="link" href="class-gtkcontainer.html#properties-gtkcontainer" title="gtk.Container Properties">gtk.Container Properties</a></p><p><a class="link" href="class-gtktoolitem.html#properties-gtktoolitem" title="gtk.ToolItem Properties">gtk.ToolItem Properties</a></p><p><a class="link" href="class-gtktoolbutton.html#properties-gtktoolbutton" title="gtk.ToolButton Properties">gtk.ToolButton 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">"active"</td><td valign="top">Read-Write</td><td valign="top">If the toggle tool button should be pressed in or not.
This property is available in GTK+ 2.8 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtktoggletoolbutton"></a><h2>gtk.ToggleToolButton Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p><p><a class="link" href="class-gtktoolbutton.html#style-properties-gtktoolbutton" title="gtk.ToolButton Style Properties">gtk.ToolButton Style Properties</a></p></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtktoggletoolbutton"></a><h2>gtk.ToggleToolButton 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-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></p><p><a class="link" href="class-gtktoolitem.html#signal-prototypes-gtktoolitem" title="gtk.ToolItem Signal Prototypes">gtk.ToolItem Signal Prototypes</a></p><p><a class="link" href="class-gtktoolbutton.html#signal-prototypes-gtktoolbutton" title="gtk.ToolButton Signal Prototypes">gtk.ToolButton 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-gtktoggletoolbutton.html#signal-gtktoggletoolbutton--toggled" title='The "toggled" gtk.ToggleToolButton 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>toggletoolbutton</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="id3569018"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This widget is available in PyGTK 2.4 and above.</p></div><p>A <a class="link" href="class-gtktoggletoolbutton.html" title="gtk.ToggleToolButton"><code class="classname">gtk.ToggleToolButton</code></a>
is a <a class="link" href="class-gtktoolitem.html" title="gtk.ToolItem"><code class="classname">gtk.ToolItem</code></a> that
contains a toggle button. Use the <a class="link" href="class-gtktoggletoolbutton.html#constructor-gtktoggletoolbutton" title="Constructor">gtk.ToggleToolButton</a>()
constructor to create a new <a class="link" href="class-gtktoggletoolbutton.html" title="gtk.ToggleToolButton"><code class="classname">gtk.ToggleToolButton</code></a>.</p></div><div class="refsect1" lang="en"><a name="constructor-gtktoggletoolbutton"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.ToggleToolButton</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>stock_id</code></strong></span><span class="initializer">=None</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>stock_id</code></strong> :</span></p></td><td>the name of a stock item</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a newly created <a class="link" href="class-gtktoggletoolbutton.html" title="gtk.ToggleToolButton"><code class="classname">gtk.ToggleToolButton</code></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.4 and above.</p></div><p>Creates a new <a class="link" href="class-gtktoggletoolbutton.html" title="gtk.ToggleToolButton"><code class="classname">gtk.ToggleToolButton</code></a>. If
<em class="parameter"><code>stock_id</code></em> is not <code class="literal">None</code> the toggle
tool button contains the image and text from the specified stock
item.</p></div><div class="refsect1" lang="en"><a name="id3569187"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtktoggletoolbutton--set-active"></a><h3>gtk.ToggleToolButton.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>is_active</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>is_active</code></strong> :</span></p></td><td>if <code class="literal">True</code> the toggle tool
button is active</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_active</code>() method sets the status
of the toggle tool button to the value specified by
<em class="parameter"><code>is_active</code></em>. If <em class="parameter"><code>is_active</code></em> is
<code class="literal">True</code> the <a class="link" href="class-gtktogglebutton.html" title="gtk.ToggleButton"><code class="classname">gtk.ToggleButton</code></a>
is 'pressed in' (active). This method causes the toggled signal to be
emitted.</p></div><div class="refsect2" lang="en"><a name="method-gtktoggletoolbutton--get-active"></a><h3>gtk.ToggleToolButton.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 toggle tool
button is pressed in (active)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_active</code>() method returns
<code class="literal">True</code> if the toggle tool button is pressed in (active) and
<code class="literal">False</code> if it is raised.</p></div></div><div class="refsect1" lang="en"><a name="id3569393"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtktoggletoolbutton--toggled"></a><h3>The "toggled" gtk.ToggleToolButton Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>toggletoolbutton</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>toggletoolbutton</code></em> :</span></p></td><td>the toggletoolbutton that received the
signal</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><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.4 and above.</p></div><p>The "toggled" signal is emitted when the toggle tool button
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-gtktogglebutton.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-gtktoolbar.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.ToggleButton </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Toolbar</td></tr></table></div></body></html>
|
