RadioButton

A single radio button performs the same basic function as a gtk.CheckButton, 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 gtk.RadioButton is one way of giving the user a choice from many options.

Radio button widgets are created with 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, 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 RadioButton.newFromWidget with a gtk.RadioButton that already has a group assigned to it. The convenience function RadioButton.newWithLabelFromWidget is also provided.

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

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

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

CSS nodes

|[ radiobutton ├── radio ╰── <child>

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

|[<!-- language="plain" -->
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 toggled signal, as does the previously selected button. Inside the toggled handler, ToggleButton.getActive can be used to determine if the button has been selected or deselected.

class RadioButton : CheckButton {

protected

GtkRadioButton* gtkRadioButton;

GtkRadioButton* getRadioButtonStruct(bool transferOwnership);

void* getStruct();

this(GtkRadioButton* gtkRadioButton, bool ownedRef);

this(ListSG group, string label, bool mnemonic);

this(RadioButton radioButton, string label, bool mnemonic);

this(string label, bool mnemonic);

static GType getType();

this(ListSG group);

this(RadioButton radioGroupMember);

ListSG getGroup();

void joinGroup(RadioButton groupSource);

void setGroup(ListSG group);

gulong addOnGroupChanged(void delegate(RadioButton) dlg, ConnectFlags connectFlags);

}

Constructors

this this(GtkRadioButton* gtkRadioButton, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(ListSG group, string label, bool mnemonic): Creates a new RadioButton with a text label.
this this(RadioButton radioButton, string label, bool mnemonic): Creates a new RadioButton with a text label, adding it to the same group as group.
this this(string label, bool mnemonic): Creates a new RadioButton with a text label, and creates a new group.
this this(ListSG group): Creates a new gtk.RadioButton To be of any practical value, a widget should then be packed into the radio button.
this this(RadioButton radioGroupMember): Creates a new gtk.RadioButton, adding it to the same group as radio_group_member. As with RadioButton.new, a widget should be packed into the radio button.

Members

Functions

addOnGroupChanged gulong addOnGroupChanged(void delegate(RadioButton) dlg, ConnectFlags connectFlags): Emitted when the group of radio buttons that a radio button belongs to changes. This is emitted when a radio button switches from being alone to being part of a group of 2 or more buttons, or vice-versa, and when a button is moved from one group of 2 or more buttons to a different one, but not when the composition of the group that a button belongs to changes.
getGroup ListSG getGroup(): Retrieves the group assigned to a radio button.
getRadioButtonStruct GtkRadioButton* getRadioButtonStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
joinGroup void joinGroup(RadioButton groupSource): Joins a gtk.RadioButton object to the group of another gtk.RadioButton object
setGroup void setGroup(ListSG group): Sets a gtk.RadioButton’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.

Static functions

getType GType getType()

Variables

gtkRadioButton GtkRadioButton* gtkRadioButton;: the main Gtk struct

Inherited Members

From CheckButton

gtkCheckButton GtkCheckButton* gtkCheckButton;: the main Gtk struct
getCheckButtonStruct GtkCheckButton* getCheckButtonStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()

gtk RadioButton classes

RadioButton