gtk.RadioButton



class RadioButton : gtk.CheckButton.CheckButton;
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_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_new_with_label() 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_new_from_widget() with a #GtkRadioButton that already has a group assigned to it. The convenience function gtk_radio_button_new_with_label_from_widget() is also provided.

To retrieve the group a #GtkRadioButton is assigned to, use gtk_radio_button_get_group().

To remove a #GtkRadioButton from one group and make it part of a new one, use gtk_radio_button_set_group().

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 ╰── ]|

A GtkRadioButton with indicator (see gtk_toggle_button_set_mode()) has a main CSS node with name radiobutton and a subnode with name radio.

|[ button.radio ├── radio ╰── ]|

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, TRUE, TRUE, 2); gtk_box_pack_start (GTK_BOX (box), radio2, TRUE, TRUE, 2); 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_get_active() can be used to determine if the button has been selected or deselected.

protected GtkRadioButton* gtkRadioButton ;
the main Gtk struct

GtkRadioButton* getRadioButtonStruct ();
Get the main Gtk struct

protected void* getStruct ();
the main Gtk struct as a void*

this(GtkRadioButton* gtkRadioButton, bool ownedRef = false);
Sets our main struct and passes it to the parent class.

this(ListSG group, string label, bool mnemonic = true);
Creates a new RadioButton with a text label.

Params:
ListSG group an existing radio button group.
string label the text label to display next to the radio button.
bool mnemonic if true the label will be created using gtk_label_new_with_mnemonic(), so underscores in label indicate the mnemonic for the button.

Throws:
ConstructionException GTK+ fails to create the object.

this(RadioButton radioButton, string label, bool mnemonic = true);
Creates a new RadioButton with a text label, adding it to the same group as group.

Params:
RadioButton radioButton an existing RadioButton.
string label a text string to display next to the radio button.
bool mnemonic if true the label will be created using gtk_label_new_with_mnemonic(), so underscores in label indicate the mnemonic for the button.

Throws:
ConstructionException GTK+ fails to create the object.

this(string label, bool mnemonic = true);
Creates a new RadioButton with a text label, and creates a new group.

Params:
string label a text string to display next to the radio button.
bool mnemonic if true the label will be created using gtk_label_new_with_mnemonic(), so underscores in label indicate the mnemonic for the button.

Throws:
ConstructionException GTK+ fails to create the object.

static GType getType ();


this(ListSG group);
Creates a new #GtkRadioButton. To be of any practical value, a widget should then be packed into the radio button.

Params:
ListSG group an existing radio button group, or %NULL if you are creating a new group.

Return:
a new radio button

Throws:
ConstructionException GTK+ fails to create the object.

this(RadioButton radioGroupMember);
Creates a new #GtkRadioButton, adding it to the same group as @radio_group_member. As with gtk_radio_button_new(), a widget should be packed into the radio button.

Params:
RadioButton radioGroupMember an existing #GtkRadioButton.

Return:
a new radio button.

Throws:
ConstructionException GTK+ fails to create the object.

ListSG getGroup ();
Retrieves the group assigned to a radio button.

Return:
a linked list containing all the radio buttons in the same group as @radio_button. The returned list is owned by the radio button and must not be modified or freed.

void joinGroup (RadioButton groupSource);
Joins a #GtkRadioButton object to the group of another #GtkRadioButton object

Use this in language bindings instead of the gtk_radio_button_get_group() and gtk_radio_button_set_group() methods

A common way to set up a group of radio buttons is the following: |[ GtkRadioButton *radio_button; GtkRadioButton *last_button;

while ( ...more buttons to add... ) { radio_button = gtk_radio_button_new (...);

gtk_radio_button_join_group (radio_button, last_button); last_button = radio_button; } ]|

Params:
RadioButton groupSource a radio button object whos group we are joining, or %NULL to remove the radio button from its group

Since:
3.0

void setGroup (ListSG 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.

Params:
ListSG group an existing radio button group, such as one returned from gtk_radio_button_get_group(), or %NULL.

gulong addOnGroupChanged (void delegate(RadioButton) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0);
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.

Since:
2.4

Page was generated with on Fri Jan 6 23:09:20 2017