/usr/share/gtk-doc/html/pygtk/class-gtkradiobutton.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
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 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.RadioButton</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-gtkradioaction.html" title="gtk.RadioAction"><link rel="next" href="class-gtkradiomenuitem.html" title="gtk.RadioMenuItem"></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.RadioButton</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkradioaction.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkradiomenuitem.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.RadioButton"><a name="class-gtkradiobutton"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.RadioButton</h2><p>gtk.RadioButton — a choice of one of multiple check buttons.</p></div><div class="refsect1" title="Synopsis"><a name="id3852625"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.RadioButton</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkcheckbutton.html" title="gtk.CheckButton">gtk.CheckButton</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkradiobutton.html#constructor-gtkradiobutton" title="Constructor">gtk.RadioButton</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>use_underline</code></strong></span><span class="initializer">=True</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkradiobutton.html#method-gtkradiobutton--get-group" title="gtk.RadioButton.get_group">get_group</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkradiobutton.html#method-gtkradiobutton--set-group" title="gtk.RadioButton.set_group">set_group</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3852768"></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-gtkbutton.html" title="gtk.Button">gtk.Button</a>
+-- <a class="link" href="class-gtktogglebutton.html" title="gtk.ToggleButton">gtk.ToggleButton</a>
+-- <a class="link" href="class-gtkcheckbutton.html" title="gtk.CheckButton">gtk.CheckButton</a>
+-- <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton">gtk.RadioButton</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3852839"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</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.RadioButton Properties"><a name="properties-gtkradiobutton"></a><h2>gtk.RadioButton 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-gtkbutton.html#properties-gtkbutton" title="gtk.Button Properties">gtk.Button Properties</a></p><p><a class="link" href="class-gtktogglebutton.html#properties-gtktogglebutton" title="gtk.ToggleButton Properties">gtk.ToggleButton 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">"group"</td><td valign="top">Write</td><td valign="top">The group that the radiobutton is in.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.RadioButton Style Properties"><a name="style-properties-gtkradiobutton"></a><h2>gtk.RadioButton 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-gtkbutton.html#style-properties-gtkbutton" title="gtk.Button Style Properties">gtk.Button Style Properties</a></p><p><a class="link" href="class-gtkcheckbutton.html#style-properties-gtkcheckbutton" title="gtk.CheckButton Style Properties">gtk.CheckButton Style Properties</a></p></div><div class="refsect1" title="gtk.RadioButton Signal Prototypes"><a name="signal-prototypes-gtkradiobutton"></a><h2>gtk.RadioButton 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-gtkbutton.html#signal-prototypes-gtkbutton" title="gtk.Button Signal Prototypes">gtk.Button Signal Prototypes</a></p><p><a class="link" href="class-gtktogglebutton.html#signal-prototypes-gtktogglebutton" title="gtk.ToggleButton Signal Prototypes">gtk.ToggleButton 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-gtkradiobutton.html#signal-gtkradiobutton--group-changed" title='The "group-changed" gtk.RadioButton Signal'>group-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>radiobutton</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="id3853136"></a><h2>Description</h2><p>A single <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</code></a>
performs the same basic function as a <a class="link" href="class-gtkcheckbutton.html" title="gtk.CheckButton"><code class="classname">gtk.CheckButton</code></a>,
as it's position in the object hierarchy reflects. It is only when multiple
radio buttons are grouped together that they become a different user
interface component in their own right. Every radio button is a member of
some group of radio buttons. When one is selected, all other radio buttons
in the same group are deselected. A <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</code></a>
is used to give the user a choice of one of many options.</p><p>Radio button widgets are created with <a class="link" href="class-gtkradiobutton.html#constructor-gtkradiobutton" title="Constructor">gtk.RadioButton</a>() passing
<code class="literal">None</code> as the <em class="parameter"><code>group</code></em> (first) argument
if this is the first radio button in a group. In subsequent calls, pass a
reference to a <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</code></a>
as the first argument to specify the group. The second (optional) argument
to <a class="link" href="class-gtkradiobutton.html#constructor-gtkradiobutton" title="Constructor">gtk.RadioButton</a>() is a
label that is used to specify the text of the button. The label text is
parsed for mnemonic characters (preceded by an underscore) to specify an
accelerator for the radiobutton. See <a class="link" href="class-gtkaccelgroup.html" title="gtk.AccelGroup"><code class="classname">gtk.AccelGroup</code></a>
and <a class="link" href="class-gtkaccellabel.html" title="gtk.AccelLabel"><code class="classname">gtk.AccelLabel</code></a>
for more information on mnemonic accelerators.</p><p>To retrieve the group a <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</code></a>
is assigned to, use the <a class="link" href="class-gtkradiobutton.html#method-gtkradiobutton--get-group" title="gtk.RadioButton.get_group"><code class="methodname">get_group</code>()</a>
method. To remove a <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</code></a>
from one group and make it part of a new one, use the <a class="link" href="class-gtkradiobutton.html#method-gtkradiobutton--set-group" title="gtk.RadioButton.set_group"><code class="methodname">set_group</code>()</a>
method.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkradiobutton"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.RadioButton</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>group</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>label</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>use_underline</code></strong></span><span class="initializer">=True</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>an existing <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</code></a>
or <code class="literal">None</code></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>label</code></strong> :</span></p></td><td>a string to use as the button text or
<code class="literal">None</code></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>use_underline</code></strong> :</span></p></td><td>if <code class="literal">True</code>, 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><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</code></a>
widget</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</code></a>
widget with the label text specified by <em class="parameter"><code>label</code></em>, adding
it to the same group as <em class="parameter"><code>group</code></em>.
<em class="parameter"><code>label</code></em> is parsed for underscore characters that
indicate mnemonic accelerators. If <em class="parameter"><code>label</code></em> is
<code class="literal">None</code>, no label is created. If
<em class="parameter"><code>group</code></em> is <code class="literal">None</code>, the new radiobutton
becomes the first member of a new radiobutton group.</p><p>In PyGTK 2.4 and above the <em class="parameter"><code>use_underline</code></em>
parameter is available and defaults to <code class="literal">True</code>. If
<em class="parameter"><code>use_underline</code></em> is set to <code class="literal">False</code> the
label text will not be parsed for mnemonic characters.</p></div><div class="refsect1" title="Methods"><a name="id3853546"></a><h2>Methods</h2><div class="refsect2" title="gtk.RadioButton.get_group"><a name="method-gtkradiobutton--get-group"></a><h3>gtk.RadioButton.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>the list of radiobuttons in the same group that
contains the radiobutton or <code class="literal">None</code></td></tr></tbody></table><p>The <code class="methodname">get_group</code>() method returns the list
of radiobuttons that are in the same group as the radiobutton or
<code class="literal">None</code> if the radiobutton is not in a group.</p></div><div class="refsect2" title="gtk.RadioButton.set_group"><a name="method-gtkradiobutton--set-group"></a><h3>gtk.RadioButton.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>a <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</code></a>
whose group the radiobutton will be added to or
<code class="literal">None</code></td></tr></tbody></table><p>The <code class="methodname">set_group</code>() method adds the
radiobutton to the group of the radiobutton specified by
<em class="parameter"><code>group</code></em>.</p><p>In PyGTK 2.6.2 and above, if <em class="parameter"><code>group</code></em> is
<code class="literal">None</code> the radiobutton is removed from its current
group.</p></div></div><div class="refsect1" title="Signals"><a name="id3853732"></a><h2>Signals</h2><div class="refsect2" title='The "group-changed" gtk.RadioButton Signal'><a name="signal-gtkradiobutton--group-changed"></a><h3>The "group-changed" gtk.RadioButton Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>radiobutton</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>radiobutton</code></em> :</span></p></td><td>the radiobutton 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 "group-changed" signal is emitted when a <a class="link" href="class-gtkradiobutton.html" title="gtk.RadioButton"><code class="classname">gtk.RadioButton</code></a>
is added to or removed from the group.</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-gtkradioaction.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-gtkradiomenuitem.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.RadioAction </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.RadioMenuItem</td></tr></table></div></body></html>
|