/usr/share/gtk-doc/html/pygtk/class-gtktoggleaction.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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.ToggleAction</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-gtktextview.html" title="gtk.TextView"><link rel="next" href="class-gtktogglebutton.html" title="gtk.ToggleButton"></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.ToggleAction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtktextview.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtktogglebutton.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.ToggleAction"><a name="class-gtktoggleaction"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.ToggleAction</h2><p>gtk.ToggleAction — an action which can be
toggled between two states (new in PyGTK 2.4)</p></div><div class="refsect1" title="Synopsis"><a name="id3983733"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.ToggleAction</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkaction.html" title="gtk.Action">gtk.Action</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtktoggleaction.html#constructor-gtktoggleaction" title="Constructor">gtk.ToggleAction</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tooltip</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>stock_id</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--toggled" title="gtk.ToggleAction.toggled">toggled</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--set-active" title="gtk.ToggleAction.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-gtktoggleaction.html#method-gtktoggleaction--get-active" title="gtk.ToggleAction.get_active">get_active</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--set-draw-as-radio" title="gtk.ToggleAction.set_draw_as_radio">set_draw_as_radio</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>draw_as_radio</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtktoggleaction.html#method-gtktoggleaction--get-draw-as-radio" title="gtk.ToggleAction.get_draw_as_radio">get_draw_as_radio</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3983947"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkaction.html" title="gtk.Action">gtk.Action</a>
+-- <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction">gtk.ToggleAction</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3983979"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</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" title="gtk.ToggleAction Properties"><a name="properties-gtktoggleaction"></a><h2>gtk.ToggleAction Properties</h2><p><a class="link" href="class-gtkaction.html#properties-gtkaction" title="gtk.Action Properties">gtk.Action 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="4in"></colgroup><tbody><tr valign="top"><td valign="top">"active"</td><td valign="top">Read-Write</td><td valign="top">If the toggle action should be active in or not. This
property is available in GTK+ 2.10 and above.</td></tr><tr valign="top"><td valign="top">"draw-as-radio"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, the proxies for this action
look like radio action proxies. Available in GTK+ 2.4 and
above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.ToggleAction Signal Prototypes"><a name="signal-prototypes-gtktoggleaction"></a><h2>gtk.ToggleAction Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkaction.html#signal-prototypes-gtkaction" title="gtk.Action Signal Prototypes">gtk.Action 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-gtktoggleaction.html#signal-gtktoggleaction--toggled" title='The "toggled" gtk.ToggleAction 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>toggleaction</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="id3984206"></a><h2>Description</h2><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This object is available in PyGTK 2.4 and above.</p></div><p>A <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</code></a>
which is a subclass of <a class="link" href="class-gtkaction.html" title="gtk.Action"><code class="classname">gtk.Action</code></a>
corresponds roughly to a <a class="link" href="class-gtkcheckmenuitem.html" title="gtk.CheckMenuItem"><code class="classname">gtk.CheckMenuItem</code></a>. It
has an "active" state specifying whether the action has been checked or
not.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtktoggleaction"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.ToggleAction</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>name</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>tooltip</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>stock_id</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>name</code></strong> :</span></p></td><td>a unique name for the action</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>label</code></strong> :</span></p></td><td>the label displayed in menu items and on
buttons</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>tooltip</code></strong> :</span></p></td><td>a tooltip for the action</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>stock_id</code></strong> :</span></p></td><td>the stock icon to display in widgets representing
the action</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</code></a></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 constructor is available in PyGTK 2.4 and above.</p></div><p>Creates a new <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</code></a>
object. To add the action to a <a class="link" href="class-gtkactiongroup.html" title="gtk.ActionGroup"><code class="classname">gtk.ActionGroup</code></a>
and set the accelerator for the action, call the <a class="link" href="class-gtkactiongroup.html#method-gtkactiongroup--add-action-with-accel" title="gtk.ActionGroup.add_action_with_accel"><code class="methodname">gtk.ActionGroup.add_action_with_accel()</code></a>
method.</p></div><div class="refsect1" title="Methods"><a name="id3984470"></a><h2>Methods</h2><div class="refsect2" title="gtk.ToggleAction.toggled"><a name="method-gtktoggleaction--toggled"></a><h3>gtk.ToggleAction.toggled</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">toggled</span>(<span class="methodparam"></span>)</code></pre><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.4 and above.</p></div><p>The <code class="methodname">toggled</code>() method emits the
"toggled" signal on the toggle action.</p></div><div class="refsect2" title="gtk.ToggleAction.set_active"><a name="method-gtktoggleaction--set-active"></a><h3>gtk.ToggleAction.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 action should be
checked</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.4 and above.</p></div><p>The <code class="methodname">set_active</code>() method sets the
checked state on the toggle action.</p></div><div class="refsect2" title="gtk.ToggleAction.get_active"><a name="method-gtktoggleaction--get-active"></a><h3>gtk.ToggleAction.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 action is
checked</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.4 and above.</p></div><p>The <code class="methodname">get_active</code>() method returns
<code class="literal">True</code> if the toggle action is checked.</p></div><div class="refsect2" title="gtk.ToggleAction.set_draw_as_radio"><a name="method-gtktoggleaction--set-draw-as-radio"></a><h3>gtk.ToggleAction.set_draw_as_radio</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_draw_as_radio</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>draw_as_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>draw_as_radio</code></strong> :</span></p></td><td>if <code class="literal">True</code> the action should
have proxies like a radio action</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.4 and above.</p></div><p>The <code class="methodname">set_draw_as_radio</code>() method sets the
"draw-as-radio" property to the value of
<em class="parameter"><code>draw_as_radio</code></em>. If
<em class="parameter"><code>draw_as_radio</code></em> is <code class="literal">True</code> the action
should have proxies like a radio action.</p></div><div class="refsect2" title="gtk.ToggleAction.get_draw_as_radio"><a name="method-gtktoggleaction--get-draw-as-radio"></a><h3>gtk.ToggleAction.get_draw_as_radio</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_draw_as_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 the action should
have proxies like a radio action.</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.4 and above.</p></div><p>The <code class="methodname">get_draw_as_radio</code>() method returns
the value of the "draw-as-radio" property. If "draw-as-radio" is
<code class="literal">True</code> the action should have proxies like a radio
action.</p></div></div><div class="refsect1" title="Signals"><a name="id3984875"></a><h2>Signals</h2><div class="refsect2" title='The "toggled" gtk.ToggleAction Signal'><a name="signal-gtktoggleaction--toggled"></a><h3>The "toggled" gtk.ToggleAction Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>toggleaction</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>toggleaction</code></em> :</span></p></td><td>the toggleaction 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" title="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 action changes
its active 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-gtktextview.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-gtktogglebutton.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.TextView </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.ToggleButton</td></tr></table></div></body></html>
|