RadioButton

A single radio button performs the same basic function as a #GtkCheckButton, as its position in the object hierarchy reflects. It is only when multiple radio buttons are grouped together that they become a different user interface component in their own right.

Every radio button is a member of some group of radio buttons. When one is selected, all other radio buttons in the same group are deselected. A #GtkRadioButton is one way of giving the user a choice from many options.

Radio button widgets are created with gtk.radio_button.RadioButton.new_, passing null as the argument if this is the first radio button in a group. In subsequent calls, the group you wish to add this button to should be passed as an argument. Optionally, gtk.radio_button.RadioButton.newWithLabel can be used if you want a text label on the radio button.

Alternatively, when adding widgets to an existing group of radio buttons, use gtk.radio_button.RadioButton.newFromWidget with a #GtkRadioButton that already has a group assigned to it. The convenience function gtk.radio_button.RadioButton.newWithLabelFromWidget is also provided.

To retrieve the group a #GtkRadioButton is assigned to, use gtk.radio_button.RadioButton.getGroup.

To remove a #GtkRadioButton from one group and make it part of a new one, use gtk.radio_button.RadioButton.setGroup.

The group list does not need to be freed, as each #GtkRadioButton will remove itself and its list item when it is destroyed.

CSS nodes

radiobutton
├── radio
╰── <child>

A GtkRadioButton with indicator (see gtk.toggle_button.ToggleButton.setMode) has a main CSS node with name radiobutton and a subnode with name radio.

button.radio
├── radio
╰── <child>

A GtkRadioButton without indicator changes the name of its main node to button and adds a .radio style class to it. The subnode is invisible in this case.

How to create a group of two radio buttons.

void create_radio_buttons (void) {

   GtkWidget *window, *radio1, *radio2, *box, *entry;
   window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
   box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 2);
   gtk_box_set_homogeneous (GTK_BOX (box), TRUE);

   // Create a radio button with a GtkEntry widget
   radio1 = gtk_radio_button_new (NULL);
   entry = gtk_entry_new ();
   gtk_container_add (GTK_CONTAINER (radio1), entry);


   // Create a radio button with a label
   radio2 = gtk_radio_button_new_with_label_from_widget (GTK_RADIO_BUTTON (radio1),
                                                         "I’m the second radio button.");

   // Pack them into a box, then show all the widgets
   gtk_box_pack_start (GTK_BOX (box), radio1);
   gtk_box_pack_start (GTK_BOX (box), radio2);
   gtk_container_add (GTK_CONTAINER (window), box);
   gtk_widget_show_all (window);
   return;
}

When an unselected button in the group is clicked the clicked button receives the #GtkToggleButton::toggled signal, as does the previously selected button. Inside the #GtkToggleButton::toggled handler, gtk.toggle_button.ToggleButton.getActive can be used to determine if the button has been selected or deselected.

Constructors

this
this(void* ptr, Flag!"Take" take)
this
this(gtk.radio_button.RadioButton[] group)

Creates a new #GtkRadioButton. To be of any practical value, a widget should then be packed into the radio button.

Members

Functions

connectGroupChanged
gulong connectGroupChanged(T callback, Flag!"After" after)

Connect to GroupChanged signal.

getGroup
gtk.radio_button.RadioButton[] getGroup()

Retrieves the group assigned to a radio button.

joinGroup
void joinGroup(gtk.radio_button.RadioButton groupSource)

Joins a #GtkRadioButton object to the group of another #GtkRadioButton object

self
RadioButton self()

Returns this, for use in with statements.

setGroup
void setGroup(gtk.radio_button.RadioButton[] group)

Sets a #GtkRadioButton’s group. It should be noted that this does not change the layout of your interface in any way, so if you are changing the group, it is likely you will need to re-arrange the user interface to reflect these changes.

Properties

_gType
GType _gType [@property getter]
group
gtk.radio_button.RadioButton group [@property setter]

Set group property.

Static functions

_getGType
GType _getGType()
builder
RadioButtonGidBuilder builder()

Get builder for gtk.radio_button.RadioButton

newFromWidget
gtk.radio_button.RadioButton newFromWidget(gtk.radio_button.RadioButton radioGroupMember)

Creates a new #GtkRadioButton, adding it to the same group as radio_group_member. As with gtk.radio_button.RadioButton.new_, a widget should be packed into the radio button.

newWithLabel
gtk.radio_button.RadioButton newWithLabel(gtk.radio_button.RadioButton[] group, string label)

Creates a new #GtkRadioButton with a text label.

newWithLabelFromWidget
gtk.radio_button.RadioButton newWithLabelFromWidget(gtk.radio_button.RadioButton radioGroupMember, string label)

Creates a new #GtkRadioButton with a text label, adding it to the same group as radio_group_member.

newWithMnemonic
gtk.radio_button.RadioButton newWithMnemonic(gtk.radio_button.RadioButton[] group, string label)

Creates a new #GtkRadioButton containing a label, adding it to the same group as group. The label will be created using gtk.label.Label.newWithMnemonic, so underscores in label indicate the mnemonic for the button.

newWithMnemonicFromWidget
gtk.radio_button.RadioButton newWithMnemonicFromWidget(gtk.radio_button.RadioButton radioGroupMember, string label)

Creates a new #GtkRadioButton containing a label. The label will be created using gtk.label.Label.newWithMnemonic, so underscores in label indicate the mnemonic for the button.

Inherited Members

From CheckButton

_getGType
GType _getGType()
_gType
GType _gType [@property getter]
self
CheckButton self()

Returns this, for use in with statements.

builder
CheckButtonGidBuilder builder()

Get builder for gtk.check_button.CheckButton

newWithLabel
gtk.check_button.CheckButton newWithLabel(string label)

Creates a new #GtkCheckButton with a #GtkLabel to the right of it.

newWithMnemonic
gtk.check_button.CheckButton newWithMnemonic(string label)

Creates a new #GtkCheckButton containing a label. The label will be created using gtk.label.Label.newWithMnemonic, so underscores in label indicate the mnemonic for the check button.