Commit c029306b authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkRadioMenuItem

parent c9af1467
......@@ -86,6 +86,7 @@ gtkprintoperation.sgml
gtkprogressbar.sgml
gtkradioaction.sgml
gtkradiobutton.sgml
gtkradiomenuitem.sgml
gtkradiotoolbutton.sgml
gtkrange.sgml
gtkrecentaction.sgml
......
<!-- ##### SECTION Title ##### -->
GtkRadioMenuItem
<!-- ##### SECTION Short_Description ##### -->
A choice from multiple check menu items
<!-- ##### SECTION Long_Description ##### -->
<para>
A radio menu item is a check menu item that belongs to a group. At each
instant exactly one of the radio menu items from a group is selected.
</para>
<para>
The group list does not need to be freed, as each #GtkRadioMenuItem will
remove itself and its list item when it is destroyed.
</para>
<para>
The correct way to create a group of radio menu items is approximatively
this:
</para>
<example>
<title>How to create a group of radio menu items.</title>
<programlisting>
GSList *group = NULL;
GtkWidget *item;
gint i;
for (i = 0; i &lt; 5; i++)
{
item = gtk_radio_menu_item_new_with_label (group, "This is an example");
group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
if (i == 1)
gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE);
}
</programlisting>
</example>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkMenuItem</term>
<listitem><para>because a radio menu item is a menu item.</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkCheckMenuItem</term>
<listitem><para>to know how to handle the check.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkRadioMenuItem ##### -->
<para>
The structure contains only private data that must be accessed through
the interface functions.
</para>
<!-- ##### SIGNAL GtkRadioMenuItem::group-changed ##### -->
<para>
</para>
@radiomenuitem: the object which received the signal.
<!-- ##### ARG GtkRadioMenuItem:group ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_radio_menu_item_new ##### -->
<para>
Creates a new #GtkRadioMenuItem.
</para>
@group: the group to which the radio menu item is to be attached
@Returns: a new #GtkRadioMenuItem
<!-- ##### FUNCTION gtk_radio_menu_item_new_with_label ##### -->
@group:
@label:
@Returns:
<!-- ##### FUNCTION gtk_radio_menu_item_new_with_mnemonic ##### -->
<para>
</para>
@group:
@label:
@Returns:
<!-- ##### FUNCTION gtk_radio_menu_item_new_from_widget ##### -->
<para>
</para>
@group:
@Returns:
<!-- ##### FUNCTION gtk_radio_menu_item_new_with_label_from_widget ##### -->
<para>
</para>
@group:
@label:
@Returns:
<!-- ##### FUNCTION gtk_radio_menu_item_new_with_mnemonic_from_widget ##### -->
<para>
</para>
@group:
@label:
@Returns:
<!-- ##### FUNCTION gtk_radio_menu_item_set_group ##### -->
<para>
Sets the group of a radio menu item, or changes it.
</para>
@radio_menu_item: a #GtkRadioMenuItem.
@group: the new group.
<!-- ##### FUNCTION gtk_radio_menu_item_get_group ##### -->
<para>
</para>
@radio_menu_item:
@Returns:
......@@ -33,6 +33,40 @@
#include "gtkintl.h"
/**
* SECTION:gtkradiomenuitem
* @Short_description: A choice from multiple check menu items
* @Title: GtkRadioMenuItem
* @See_also: #GtkMenuItem, #GtkCheckMenuItem
*
* A radio menu item is a check menu item that belongs to a group. At each
* instant exactly one of the radio menu items from a group is selected.
*
* The group list does not need to be freed, as each #GtkRadioMenuItem will
* remove itself and its list item when it is destroyed.
*
* The correct way to create a group of radio menu items is approximatively
* this:
*
* <example>
* <title>How to create a group of radio menu items.</title>
* <programlisting>
* GSList *group = NULL;
* GtkWidget *item;
* gint i;
*
* for (i = 0; i < 5; i++)
* {
* item = gtk_radio_menu_item_new_with_label (group, "This is an example");
* group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
* if (i == 1)
* gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE);
* }
* </programlisting>
* </example>
*/
struct _GtkRadioMenuItemPrivate
{
GSList *group;
......@@ -59,6 +93,14 @@ static guint group_changed_signal = 0;
G_DEFINE_TYPE (GtkRadioMenuItem, gtk_radio_menu_item, GTK_TYPE_CHECK_MENU_ITEM)
/**
* gtk_radio_menu_item_new:
* @group: the group to which the radio menu item is to be attached
*
* Creates a new #GtkRadioMenuItem.
*
* Returns: a new #GtkRadioMenuItem
*/
GtkWidget*
gtk_radio_menu_item_new (GSList *group)
{
......@@ -112,6 +154,13 @@ gtk_radio_menu_item_get_property (GObject *object,
}
}
/**
* gtk_radio_menu_item_set_group:
* @radio_menu_item: a #GtkRadioMenuItem.
* @group: the new group.
*
* Sets the group of a radio menu item, or changes it.
*/
void
gtk_radio_menu_item_set_group (GtkRadioMenuItem *radio_menu_item,
GSList *group)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment