<?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-gtkradiomenuitem">
  <refnamediv>
    <refname>gtk.RadioMenuItem</refname>
    <refpurpose>a choice from multiple check menu items.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.RadioMenuItem</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkcheckmenuitem">gtk.CheckMenuItem</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link linkend="constructor-gtkradiomenuitem">gtk.RadioMenuItem</link></methodname>
	<methodparam><parameter role="keyword">group</parameter>
	  <initializer>None</initializer></methodparam>
	<methodparam><parameter role="keyword">label</parameter>
	  <initializer>None</initializer></methodparam>
	<methodparam><parameter role="keyword">use_underline</parameter>
	  <initializer>True</initializer></methodparam>
      </constructorsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkradiomenuitem--get-group">get_group</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkradiomenuitem--set-group">set_group</link></methodname>
	<methodparam><parameter
		       role="keyword">group</parameter></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-gtkitem">gtk.Item</link>
            +-- <link linkend="class-gtkmenuitem">gtk.MenuItem</link>
              +-- <link linkend="class-gtkcheckmenuitem">gtk.CheckMenuItem</link>
                +-- <link linkend="class-gtkradiomenuitem">gtk.RadioMenuItem</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>

  <refsect1 id="properties-gtkradiomenuitem">
    <title>gtk.RadioMenuItem 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-gtkcheckmenuitem">gtk.CheckMenuItem 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="3.5in"/>
        <tbody>

        <row valign="top">
          <entry>"group"</entry>
          <entry>Write</entry>
          <entry>The radio menu item whose group this widget belongs to.
          This property is available in GTK+ 2.8 and above.</entry>
        </row>

        </tbody>
      </tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="style-properties-gtkradiomenuitem">
    <title>gtk.RadioMenuItem Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
    <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para>
    <para><link linkend="style-properties-gtkcheckmenuitem">gtk.CheckMenuItem Style Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkradiomenuitem">
    <title>gtk.RadioMenuItem 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-gtkitem">gtk.Item Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcheckmenuitem">gtk.CheckMenuItem Signal Prototypes</link></para>

    <variablelist>
      <varlistentry>
        <term>"<link linkend="signal-gtkradiomenuitem--group-changed">group-changed</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>radiomenuitem</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>A <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link> 
widget is a check menu item that belongs to a group. Only one of the radio
menu items in a group can be selected.</para>

  </refsect1>

  <refsect1 id="constructor-gtkradiomenuitem">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.RadioMenuItem</methodname>
	<methodparam><parameter role="keyword">group</parameter>
	  <initializer>None</initializer></methodparam>
	<methodparam><parameter role="keyword">label</parameter>
	  <initializer>None</initializer></methodparam>
	<methodparam><parameter role="keyword">use_underline</parameter>
	  <initializer>True</initializer></methodparam>
      </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><parameter role="keyword">group</parameter>&nbsp;:</term>
	<listitem><simpara>a <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link> 
whose group the new radiomenuitem should be added to, or
<literal>None</literal> if a new group should be
created</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">label</parameter>&nbsp;:</term>
	<listitem><simpara>a string to be used as the label text or
<literal>None</literal> if no label is needed</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">use_underline</parameter>&nbsp;:</term>
	<listitem><simpara>if <literal>True</literal>, 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.</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link> 
widget</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
containing a label with its text specified by <parameter>label</parameter>.
<parameter>label</parameter> will be parsed for underscores that indicate
the mnemonic accelerator for the radiomenuitem. The radiomenuitem will be
added to the group containing the <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
specified by <parameter>group</parameter>. If <parameter>group</parameter>
is <literal>None</literal>, a new group will be created to hold the new
radiomenuitem. If <parameter>label</parameter> is <literal>None</literal>
the radiomenuitem is created without a label.</para>

    <para>In PyGTK 2.4 and above the <parameter>use_underline</parameter>
parameter is available and defaults to <literal>True</literal>. If
<parameter>use_underline</parameter> is set to <literal>False</literal> the
label text will not be parsed for mnemonic characters.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkradiomenuitem--get-group">
      <title>gtk.RadioMenuItem.get_group</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_group</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the list of radiomenuitems in the same group
that contains the radiomenuitem</simpara> or
            <literal> None</literal></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_group</methodname>() method returns the list
of <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>s
that are in the same group as the radiomenuitem or <literal>None</literal>
if the radiomenuitem is not in a group.</para>

    </refsect2>

    <refsect2 id="method-gtkradiomenuitem--set-group">
      <title>gtk.RadioMenuItem.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>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link> 
whose group the radiomenuitem will be added to or
<literal>None</literal>.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_group</methodname>() method adds the
radiomenuitem to the group of the <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</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 radiomenuitem will be removed from its current
group.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-gtkradiomenuitem--group-changed">
      <title>The "group-changed" gtk.RadioMenuItem Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>radiomenuitem</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>radiomenuitem</parameter>&nbsp;:</term>
	  <listitem><simpara>the radiomenuitem that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
	<para>This signal is available in GTK+ 2.4 and above.</para>
      </note>

      <para>The "group-changed" signal is emitted when a <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
is added to or removed from the group.</para>

    </refsect2>

  </refsect1>

</refentry>
