/usr/share/gtk-doc/html/pygtk/class-gtkradioaction.html is in python-gtk2-doc 2.24.0-4ubuntu1.
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 42 43 44 45 46 47 48 49 50 51 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.RadioAction</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-gtkprogressbar.html" title="gtk.ProgressBar"><link rel="next" href="class-gtkradiobutton.html" title="gtk.RadioButton"></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.RadioAction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkprogressbar.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkradiobutton.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.RadioAction"><a name="class-gtkradioaction"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.RadioAction</h2><p>gtk.RadioAction — an action that can be grouped so that only one can be
active (new in PyGTK 2.4)</p></div><div class="refsect1" title="Synopsis"><a name="id3851200"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.RadioAction</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction">gtk.ToggleAction</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkradioaction.html#constructor-gtkradioaction" title="Constructor">gtk.RadioAction</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>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkradioaction.html#method-gtkradioaction--set-group" title="gtk.RadioAction.set_group">set_group</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkradioaction.html#method-gtkradioaction--get-group" title="gtk.RadioAction.get_group">get_group</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkradioaction.html#method-gtkradioaction--set-current-value" title="gtk.RadioAction.set_current_value">set_current_value</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkradioaction.html#method-gtkradioaction--get-current-value" title="gtk.RadioAction.get_current_value">get_current_value</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3851400"></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>
+-- <a class="link" href="class-gtkradioaction.html" title="gtk.RadioAction">gtk.RadioAction</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3851439"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkradioaction.html" title="gtk.RadioAction"><code class="classname">gtk.RadioAction</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.RadioAction Properties"><a name="properties-gtkradioaction"></a><h2>gtk.RadioAction Properties</h2><p><a class="link" href="class-gtkaction.html#properties-gtkaction" title="gtk.Action Properties">gtk.Action Properties</a></p><p><a class="link" href="class-gtktoggleaction.html#properties-gtktoggleaction" title="gtk.ToggleAction Properties">gtk.ToggleAction 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">"current-value"</td><td valign="top">Read-Write</td><td valign="top">The value property of the currently active member of the
group to which this action belongs. This property is available in
GTK+ 2.10 and above.</td></tr><tr valign="top"><td valign="top">"group"</td><td valign="top">Write</td><td valign="top">Sets a new group for a radio action. This property is
available in GTK+ 2.4 and above</td></tr><tr valign="top"><td valign="top">"value"</td><td valign="top">Read-Write</td><td valign="top">The value is an arbitrary integer which can be used as
a convenient way to determine which action in the group is
currently active in an "activate" or "changed" signal
handler. See the <a class="link" href="class-gtkradioaction.html#method-gtkradioaction--get-current-value" title="gtk.RadioAction.get_current_value"><code class="methodname">get_current_value</code>()</a>
and the <a class="link" href="class-gtkactiongroup.html#method-gtkactiongroup--add-radio-actions" title="gtk.ActionGroup.add_radio_actions"><code class="methodname">gtk.ActionGroup.add_radio_actions</code>()</a>
methods for convenient ways to get and set this property. This
property is available in GTK+ 2.4 and above</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.RadioAction Signal Prototypes"><a name="signal-prototypes-gtkradioaction"></a><h2>gtk.RadioAction 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><p><a class="link" href="class-gtktoggleaction.html#signal-prototypes-gtktoggleaction" title="gtk.ToggleAction Signal Prototypes">gtk.ToggleAction 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-gtkradioaction.html#signal-gtkradioaction--changed" title='The "changed" gtk.RadioAction Signal'>changed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>radioaction</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>current</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="id3851728"></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-gtkradioaction.html" title="gtk.RadioAction"><code class="classname">gtk.RadioAction</code></a>
is a subclass of <a class="link" href="class-gtktoggleaction.html" title="gtk.ToggleAction"><code class="classname">gtk.ToggleAction</code></a>
and similar to <a class="link" href="class-gtkradiomenuitem.html" title="gtk.RadioMenuItem"><code class="classname">gtk.RadioMenuItem</code></a>.
A number of radio actions can be linked together so that only one may be
active at any one time.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkradioaction"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.RadioAction</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>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</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 this 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
this action</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>value</code></strong> :</span></p></td><td>A unique integer value that <a class="link" href="class-gtkradioaction.html#method-gtkradioaction--get-current-value" title="gtk.RadioAction.get_current_value"><code class="methodname">get_current_value()</code></a>
should return if this action is selected.</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-gtkradioaction.html" title="gtk.RadioAction"><code class="classname">gtk.RadioAction</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-gtkradioaction.html" title="gtk.RadioAction"><code class="classname">gtk.RadioAction</code></a>
object suing the properties specified by: <em class="parameter"><code>name</code></em>,
<em class="parameter"><code>label</code></em>, <em class="parameter"><code>tooltip</code></em>,
<em class="parameter"><code>stock_id</code></em> and <em class="parameter"><code>value</code></em>. 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>.</p></div><div class="refsect1" title="Methods"><a name="id3852064"></a><h2>Methods</h2><div class="refsect2" title="gtk.RadioAction.set_group"><a name="method-gtkradioaction--set-group"></a><h3>gtk.RadioAction.set_group</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_group</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</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>group</code></strong> :</span></p></td><td>another <a class="link" href="class-gtkradioaction.html" title="gtk.RadioAction"><code class="classname">gtk.RadioAction</code></a> or <code class="literal">None</code></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_group</code>() method sets the radio
group for the radio action to the same group as the <a class="link" href="class-gtkradioaction.html" title="gtk.RadioAction"><code class="classname">gtk.RadioAction</code></a>
specified by <em class="parameter"><code>group</code></em> i.e. the radio action joins the
group.</p><p>In PyGTK 2.6.2 and above, if <em class="parameter"><code>group</code></em> is
<code class="literal">None</code> the radio action is removed from its current
group.</p></div><div class="refsect2" title="gtk.RadioAction.get_group"><a name="method-gtkradioaction--get-group"></a><h3>gtk.RadioAction.get_group</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_group</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>a list containing the radio actions in the
group or <em class="parameter"><code>None</code></em></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_group</code>() method returns a list
containing the group that the radio action belongs to or
<code class="literal">None</code> if the radio action is not part of a group.</p></div><div class="refsect2" title="gtk.RadioAction.set_current_value"><a name="method-gtkradioaction--set-current-value"></a><h3>gtk.RadioAction.set_current_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_current_value</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"><strong class="parameter"><code>current_value</code></strong> :</span></p></td><td>the new value.</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.10 and above.</p></div><p>The <code class="methodname">get_current_value</code>() method sets the currently
active group member to the member with value property current_value.</p></div><div class="refsect2" title="gtk.RadioAction.get_current_value"><a name="method-gtkradioaction--get-current-value"></a><h3>gtk.RadioAction.get_current_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_current_value</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 value of the currently active group
member</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_current_value</code>() method returns
the "value" property of the the currently active member of the group that
the radio action belongs to.</p></div></div><div class="refsect1" title="Signals"><a name="id3852417"></a><h2>Signals</h2><div class="refsect2" title='The "changed" gtk.RadioAction Signal'><a name="signal-gtkradioaction--changed"></a><h3>The "changed" gtk.RadioAction Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>radioaction</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>current</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>radioaction</code></em> :</span></p></td><td>the radioaction that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>current</code></em> :</span></p></td><td>the currently active <a class="link" href="class-gtkradioaction.html" title="gtk.RadioAction"><code class="classname">gtk.RadioAction</code></a>
in the group</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 "changed" signal is emitted on every member of a radio group
when the active member is changed. The signal gets emitted after the
"activate" signals for the previous and current active members.</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-gtkprogressbar.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-gtkradiobutton.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.ProgressBar </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.RadioButton</td></tr></table></div></body></html>
|