GTK+ Reference Manual
<<< PrevHomeUpNext >>>

GtkRadioMenuItem

GtkRadioMenuItem — A choice from multiple check menu items.

Synopsis


#include <gtk/gtk.h>


struct      GtkRadioMenuItem;
GtkWidget*  gtk_radio_menu_item_new         (GSList *group);
GtkWidget*  gtk_radio_menu_item_new_with_label
                                            (GSList *group,
                                             const gchar *label);
GtkWidget*  gtk_radio_menu_item_new_with_mnemonic
                                            (GSList *group,
                                             const gchar *label);
#define     gtk_radio_menu_item_group
void        gtk_radio_menu_item_set_group   (GtkRadioMenuItem *radio_menu_item,
                                             GSList *group);
GSList*     gtk_radio_menu_item_get_group   (GtkRadioMenuItem *radio_menu_item);


Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkBin
                           +----GtkItem
                                 +----GtkMenuItem
                                       +----GtkCheckMenuItem
                                             +----GtkRadioMenuItem

Implemented Interfaces

GtkRadioMenuItem implements AtkImplementorIface

Description

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 correct way to create a group of radio menu items is aproximativly this:

Example 5. How to create a group of radio menu items.

GList *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);
}

Details

struct GtkRadioMenuItem

struct GtkRadioMenuItem;

The structure contains only private data that must be accessed through the interface functions.


gtk_radio_menu_item_new ()

GtkWidget*  gtk_radio_menu_item_new         (GSList *group);

Creates a new GtkRadioMenuItem.

group :

the group to which the radio menu item is to be attached

Returns :

a new GtkRadioMenuItem


gtk_radio_menu_item_new_with_label ()

GtkWidget*  gtk_radio_menu_item_new_with_label
                                            (GSList *group,
                                             const gchar *label);

Creates a new GtkRadioMenuItem whose child is a simple GtkLabel.

group :

the group to which the radio menu item is to be attached

label :

the text for the label

Returns :

a new GtkRadioMenuItem


gtk_radio_menu_item_new_with_mnemonic ()

GtkWidget*  gtk_radio_menu_item_new_with_mnemonic
                                            (GSList *group,
                                             const gchar *label);

Creates a new GtkRadioMenuItem containing a label. The label will be created using gtk_label_new_with_mnemonic(), so underscores in label indicate the mnemonic for the menu item.

group :

group the radio menu item is inside

label :

the text of the button, with an underscore in front of the mnemonic character

Returns :

a new GtkRadioMenuItem


gtk_radio_menu_item_group

#define gtk_radio_menu_item_group gtk_radio_menu_item_get_group

Deprecated compatibility macro. Use gtk_radio_menu_item_get_group() instead.


gtk_radio_menu_item_set_group ()

void        gtk_radio_menu_item_set_group   (GtkRadioMenuItem *radio_menu_item,
                                             GSList *group);

Sets the group of a radio menu item, or changes it.

radio_menu_item :

a GtkRadioMenuItem.

group :

the new group.


gtk_radio_menu_item_get_group ()

GSList*     gtk_radio_menu_item_get_group   (GtkRadioMenuItem *radio_menu_item);

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.

radio_menu_item :

a GtkRadioMenuItem.

Returns :

the group of radio_menu_item.

See Also

GtkMenuItem

because a radio menu item is a menu item.

GtkCheckMenuItem

to know how to handle the check.

<<< PrevHomeUpNext >>>
GtkImageMenuItemGtkCheckMenuItem