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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.ToggleButton</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-gtktoggleaction.html" title="gtk.ToggleAction"><link rel="next" href="class-gtktoggletoolbutton.html" title="gtk.ToggleToolButton"></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.ToggleButton</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtktoggleaction.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gtktoggletoolbutton.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtktogglebutton"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.ToggleButton</h2><p>gtk.ToggleButton — a button that retains its state</p></div><div class="refsect1" lang="en"><a name="id3561140"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.ToggleButton</span></span>(<span class="ooclass"><span class="classname"><a href="class-gtkbutton.html" title="gtk.Button">gtk.Button</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a href="class-gtktogglebutton.html#constructor-gtktogglebutton" title="Constructor">gtk.ToggleButton</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>label</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>use_underline</tt></b></span><span class="initializer">=TRUE</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtktogglebutton.html#method-gtktogglebutton--set-mode" title="gtk.ToggleButton.set_mode">set_mode</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>draw_indicator</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtktogglebutton.html#method-gtktogglebutton--get-mode" title="gtk.ToggleButton.get_mode">get_mode</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtktogglebutton.html#method-gtktogglebutton--set-active" title="gtk.ToggleButton.set_active">set_active</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>is_active</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtktogglebutton.html#method-gtktogglebutton--get-active" title="gtk.ToggleButton.get_active">get_active</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtktogglebutton.html#method-gtktogglebutton--toggled" title="gtk.ToggleButton.toggled">toggled</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtktogglebutton.html#method-gtktogglebutton--set-inconsistent" title="gtk.ToggleButton.set_inconsistent">set_inconsistent</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>setting</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gtktogglebutton.html#method-gtktogglebutton--get-inconsistent" title="gtk.ToggleButton.get_inconsistent">get_inconsistent</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3561327"></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-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
+-- <a href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
+-- <a href="class-gtkbutton.html" title="gtk.Button">gtk.Button</a>
+-- <a href="class-gtktogglebutton.html" title="gtk.ToggleButton">gtk.ToggleButton</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3561382"></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">"active"</td><td valign="top">Read-Write</td><td valign="top">If <tt class="literal">TRUE</tt>, the toggle button should be
pressed in.</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 toggle button is in an
"in between" state.</td></tr><tr valign="top"><td valign="top">"draw-indicator"</td><td valign="top">Read-Write</td><td valign="top">If <tt class="literal">TRUE</tt>, the toggle part of the
button is displayed.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3561499"></a><h2>Attributes</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"draw_indicator"</td><td valign="top">Read</td><td valign="top">If <tt class="literal">TRUE</tt>, the toggle part of the
button is displayed.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3561576"></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-gtktogglebutton.html#signal-gtktogglebutton--toggled" title='The "toggled" gtk.ToggleButton 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>togglebutton</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="id3561628"></a><h2>Description</h2><p>A <a href="class-gtktogglebutton.html" title="gtk.ToggleButton"><tt class="classname">gtk.ToggleButton</tt></a>
is a <a href="class-gtkbutton.html" title="gtk.Button"><tt class="classname">gtk.Button</tt></a> that has
two stable states: 'pressed-in' ("on" or "active") and "normal" ("off" or
"inactive"). The state changes to the alternate state each time the
togglebutton is clicked. The state of a <a href="class-gtktogglebutton.html" title="gtk.ToggleButton"><tt class="classname">gtk.ToggleButton</tt></a>
can be set specifically using the <a href="class-gtktogglebutton.html#method-gtktogglebutton--set-active" title="gtk.ToggleButton.set_active"><tt class="methodname">set_active</tt>()</a>
method, and retrieved using the <a href="class-gtktogglebutton.html#method-gtktogglebutton--get-active" title="gtk.ToggleButton.get_active"><tt class="methodname">get_active</tt>()</a>
method. To simply switch the state of a toggle button, use the <a href="class-gtktogglebutton.html#method-gtktogglebutton--toggled" title="gtk.ToggleButton.toggled"><tt class="methodname">toggled</tt>()</a>
method.</p></div><div class="refsect1" lang="en"><a name="constructor-gtktogglebutton"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.ToggleButton</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>label</tt></b></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>use_underline</tt></b></span><span class="initializer">=TRUE</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>label</tt></b>:</span></td><td>the text to be displayed by the button label
including an underscore to indicate the mnemonic character if desired or
<tt class="literal">None</tt> if no label is required.</td></tr><tr><td><span class="term"><b class="parameter"><tt>use_underline</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt>, an underscore in the
label text indicates the next character should be underlined and used for the
mnemonic accelerator key if it is the first character so
marked. Available in PyGTK 2.4 and above.</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new <a href="class-gtktogglebutton.html" title="gtk.ToggleButton"><tt class="classname">gtk.ToggleButton</tt></a>
widget</td></tr></tbody></table><p>Creates a new <a href="class-gtktogglebutton.html" title="gtk.ToggleButton"><tt class="classname">gtk.ToggleButton</tt></a>
widget with the text label specified by <i class="parameter"><tt>label</tt></i>.
<i class="parameter"><tt>label</tt></i> will be parsed for underscore characters that
indicate mnemonic accelerators. If <i class="parameter"><tt>label</tt></i> is
<tt class="literal">None</tt> or not specified, no label will be created.</p><p>In PyGTK 2.4 and above the <i class="parameter"><tt>use_underline</tt></i>
parameter is available and defaults to <tt class="literal">TRUE</tt>. If
<i class="parameter"><tt>use_underline</tt></i> is set to <tt class="literal">FALSE</tt> the
label text will not be parsed for mnemonic characters.</p></div><div class="refsect1" lang="en"><a name="id3561859"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtktogglebutton--set-mode"></a><h3>gtk.ToggleButton.set_mode</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_mode</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>draw_indicator</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>draw_indicator</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> display the button
as an indicator with a label; if <tt class="literal">FALSE</tt> just display as a
normal button</td></tr></tbody></table><p>The <tt class="methodname">set_mode</tt>() method sets the
"draw-indicator" property to the value of<i class="parameter"><tt>
draw_indicator</tt></i>. If <i class="parameter"><tt>draw_indicator</tt></i> is
<tt class="literal">TRUE</tt> the button is displayed as an indicator with a
label; otherwise, the button is displayed as a normal button.</p><p>This method only affects subclasses of <a href="class-gtktogglebutton.html" title="gtk.ToggleButton"><tt class="classname">gtk.ToggleButton</tt></a>
like <a href="class-gtkcheckbutton.html" title="gtk.CheckButton"><tt class="classname">gtk.CheckButton</tt></a>
and <a href="class-gtkradiobutton.html" title="gtk.RadioButton"><tt class="classname">gtk.RadioButton</tt></a>.</p></div><div class="refsect2" lang="en"><a name="method-gtktogglebutton--get-mode"></a><h3>gtk.ToggleButton.get_mode</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_mode</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 button is
displayed as an indicator with a label; <tt class="literal">FALSE</tt> if
displayed as a normal button.</td></tr></tbody></table><p>The <tt class="methodname">get_mode</tt>() method returns the value
of the "draw-indicator" property. If "draw-indicator" is
<tt class="literal">TRUE</tt> the button is displayed as an indicator with a
label; if <tt class="literal">FALSE</tt>, the button is displayed as a normal
button. See the <a href="class-gtktogglebutton.html#method-gtktogglebutton--set-mode" title="gtk.ToggleButton.set_mode"><tt class="methodname">set_mode</tt>()</a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gtktogglebutton--set-active"></a><h3>gtk.ToggleButton.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>is_active</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>is_active</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> the togglebutton
state is active ("on")</td></tr></tbody></table><p>The <tt class="methodname">set_active</tt>() method sets the
"active" property to the value of <i class="parameter"><tt>is_active</tt></i>. If
<i class="parameter"><tt>is_active</tt></i> is <tt class="literal">TRUE</tt> the <a href="class-gtktogglebutton.html" title="gtk.ToggleButton"><tt class="classname">gtk.ToggleButton</tt></a>
is 'pressed in', and if <tt class="literal">FALSE</tt> it's 'normal'. This method
causes the "toggled" signal to be emitted.</p></div><div class="refsect2" lang="en"><a name="method-gtktogglebutton--get-active"></a><h3>gtk.ToggleButton.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>TRUE if the togglebutton is
active</td></tr></tbody></table><p>The <tt class="methodname">get_active</tt>() method returns the
value of the "active" property. If "active" is <tt class="literal">TRUE</tt> the
togglebutton is 'pressed in'; if <tt class="literal">FALSE</tt>, it's
'normal'.</p></div><div class="refsect2" lang="en"><a name="method-gtktogglebutton--toggled"></a><h3>gtk.ToggleButton.toggled</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">toggled</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">toggled</tt>() method emits the
"toggled" signal on the togglebutton.</p></div><div class="refsect2" lang="en"><a name="method-gtktogglebutton--set-inconsistent"></a><h3>gtk.ToggleButton.set_inconsistent</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_inconsistent</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>if <tt class="literal">TRUE</tt> the state is
inconsistent</td></tr></tbody></table><p>The <tt class="methodname">set_inconsistent</tt>() method sets the
"inconsistent" property to the value of <i class="parameter"><tt>setting</tt></i>. If
<i class="parameter"><tt>setting</tt></i> is <tt class="literal">TRUE</tt> the togglebutton
is displayed in the inconsistent state - an "in between" state. This method
is useful if the user has selected a range of elements (such as some text or
spreadsheet cells) that are affected by a toggle button, and the current
values in that range are inconsistent and you want to indicate that by
setting the toggle button to an "in between" display. Normally you would
turn off the inconsistent state again if the user clicks the toggle
button.</p></div><div class="refsect2" lang="en"><a name="method-gtktogglebutton--get-inconsistent"></a><h3>gtk.ToggleButton.get_inconsistent</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_inconsistent</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 state is
inconsistent</td></tr></tbody></table><p>The <tt class="methodname">get_inconsistent</tt>() method returns
the value of the "inconsistent" property. If "inconsistent" is
<tt class="literal">TRUE</tt> the togglebutton is displayed in an 'in between'
state. See the <a href="class-gtktogglebutton.html#method-gtktogglebutton--set-inconsistent" title="gtk.ToggleButton.set_inconsistent"><tt class="methodname">set_inconsistent</tt>()</a>
method for more details.</p></div></div><div class="refsect1" lang="en"><a name="id3562389"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtktogglebutton--toggled"></a><h3>The "toggled" gtk.ToggleButton 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>togglebutton</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>togglebutton</tt></i>:</span></td><td>the togglebutton that received the
signal</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 togglebutton state
changes either programmatically or by user action.</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-gtktoggleaction.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-gtktoggletoolbutton.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.ToggleAction</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.ToggleToolButton</td></tr></table></div></body></html>
|
