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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkradiotoolbutton">
<refnamediv>
<refname>gtk.RadioToolButton</refname> <refpurpose>a toolbar item that
contains a radio button (new in PyGTK 2.4)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.RadioToolButton</classname></ooclass>
<ooclass><classname><link linkend="class-gtktoggletoolbutton">gtk.ToggleToolButton</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtkradiotoolbutton">gtk.RadioToolButton</link></methodname>
<methodparam><parameter role="keyword">group</parameter><initializer>None</initializer></methodparam>
<methodparam><parameter role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkradiotoolbutton--set-group">set_group</link></methodname>
<methodparam><parameter role="keyword">group</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtkradiotoolbutton--get-group">get_group</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkcontainer">gtk.Container</link>
+-- <link linkend="class-gtkbin">gtk.Bin</link>
+-- <link linkend="class-gtktoolitem">gtk.ToolItem</link>
+-- <link linkend="class-gtktoolbutton">gtk.ToolButton</link>
+-- <link linkend="class-gtktoggletoolbutton">gtk.ToggleToolButton</link>
+-- <link linkend="class-gtkradiotoolbutton">gtk.RadioToolButton</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkradiotoolbutton">
<title>gtk.RadioToolButton Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
<para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para>
<para><link linkend="properties-gtktoolbutton">gtk.ToolButton Properties</link></para>
<para><link linkend="properties-gtktoggletoolbutton">gtk.ToggleToolButton Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"group"</entry>
<entry>Write</entry>
<entry>Sets a new group for a radio tool button. This property
is available in GTK+ 2.4 and above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="style-properties-gtkradiotoolbutton">
<title>gtk.RadioToolButton Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<para><link linkend="style-properties-gtktoolbutton">gtk.ToolButton Style Properties</link></para>
</refsect1>
<refsect1 id="signal-prototypes-gtkradiotoolbutton">
<title>gtk.RadioToolButton Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtktoolbutton">gtk.ToolButton Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtktoggletoolbutton">gtk.ToggleToolButton Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<note>
<para>This widget is available in PyGTK 2.4 and above.</para>
</note>
<para>A <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
is a <link
linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> that
contains a radio button, that is, a button that is part of a group of toggle
buttons where only one button can be active at a time. Use the <link
linkend="constructor-gtkradiotoolbutton">gtk.RadioToolButton</link>()
constructor to create a new <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>.</para>
</refsect1>
<refsect1 id="constructor-gtkradiotoolbutton">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.RadioToolButton</methodname>
<methodparam><parameter role="keyword">group</parameter><initializer>None</initializer></methodparam>
<methodparam><parameter role="keyword">stock_id</parameter><initializer>None</initializer></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">group</parameter> :</term>
<listitem><simpara>an existing <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">stock_id</parameter> :</term>
<listitem><simpara> the name of a stock item</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.4 and above.</para>
</note>
<para>Creates a new <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>,
adding it to the same group as the <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
specified by <parameter>group</parameter> if it is not
<literal>None</literal>. The new <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
will contain an icon and label from the stock item specified by
<parameter>stock_id</parameter> if it is not <literal>None</literal>.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtkradiotoolbutton--set-group">
<title>gtk.RadioToolButton.set_group</title>
<programlisting><methodsynopsis language="python">
<methodname>set_group</methodname>
<methodparam><parameter role="keyword">group</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">group</parameter> :</term>
<listitem><simpara>an existing <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname> or <literal>None</literal>.</link></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>set_group</methodname>() method adds the radio
tool button to the same group as the <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
specified by <parameter>group</parameter>.</para>
<para>In PyGTK 2.6.2 and above, if <parameter>group</parameter> is
<literal>None</literal> the radiotoolbutton will be removed from its current
group.</para>
</refsect2>
<refsect2 id="method-gtkradiotoolbutton--get-group">
<title>gtk.RadioToolButton.get_group</title>
<programlisting><methodsynopsis language="python">
<methodname>get_group</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a list containing the <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>s
in the group</simpara> or <parameter> None</parameter></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>get_group</methodname>() method returns a list
containing the <link
linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
objects that are in the same group as the radio tool button or
<literal>None</literal> if the radiotoolbutton is not in a group.</para>
</refsect2>
</refsect1>
</refentry>
|