gtk2/docs/reference/gtk/tmpl/gtkradiomenuitem.sgml

155 lines
3.1 KiB
Plaintext
Raw Normal View History

1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
GtkRadioMenuItem
<!-- ##### SECTION Short_Description ##### -->
A choice from multiple check menu items
1999-08-16 18:51:52 +00:00
<!-- ##### 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:
1999-08-16 18:51:52 +00:00
</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>
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkMenuItem</term>
<listitem><para>because a radio menu item is a menu item.</para></listitem>
</varlistentry>
<varlistentry>
2002-04-20 23:57:41 +00:00
<term>#GtkCheckMenuItem</term>
<listitem><para>to know how to handle the check.</para></listitem>
</varlistentry>
</variablelist>
1999-08-16 18:51:52 +00:00
</para>
2005-06-20 22:06:27 +00:00
<!-- ##### SECTION Stability_Level ##### -->
1999-08-16 18:51:52 +00:00
<!-- ##### STRUCT GtkRadioMenuItem ##### -->
<para>
The structure contains only private data that must be accessed through
the interface functions.
1999-08-16 18:51:52 +00:00
</para>
<!-- ##### SIGNAL GtkRadioMenuItem::group-changed ##### -->
<para>
</para>
@radiomenuitem: the object which received the signal.
2005-06-20 22:06:27 +00:00
<!-- ##### ARG GtkRadioMenuItem:group ##### -->
<para>
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_radio_menu_item_new ##### -->
<para>
Creates a new #GtkRadioMenuItem.
1999-08-16 18:51:52 +00:00
</para>
@group: the group to which the radio menu item is to be attached
@Returns: a new #GtkRadioMenuItem
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_radio_menu_item_new_with_label ##### -->
2010-01-11 18:57:21 +00:00
@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:
<!-- ##### MACRO gtk_radio_menu_item_group ##### -->
1999-08-16 18:51:52 +00:00
<para>
Deprecated compatibility macro. Use gtk_radio_menu_item_get_group() instead.
1999-08-16 18:51:52 +00:00
</para>
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_radio_menu_item_set_group ##### -->
<para>
Sets the group of a radio menu item, or changes it.
1999-08-16 18:51:52 +00:00
</para>
@radio_menu_item: a #GtkRadioMenuItem.
@group: the new group.
1999-08-16 18:51:52 +00:00
<!-- ##### FUNCTION gtk_radio_menu_item_get_group ##### -->
<para>
Returns the group to which the radio menu item belongs, as a #GList of
#GtkRadioMenuItem. The list belongs to GTK+ and should not be freed.
</para>
@radio_menu_item: a #GtkRadioMenuItem.
@Returns: the group of @radio_menu_item.