Struct gtk::RadioButton

pub struct RadioButton(_, _);

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

Radio button widgets are created with RadioButton::new, passing None 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::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 RadioButton::new_from_widget with a RadioButton that already has a group assigned to it. The convenience function RadioButton::new_with_label_from_widget is also provided.

To retrieve the group a RadioButton is assigned to, use RadioButtonExt::get_group.

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

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

CSS nodes

radiobutton
├── radio
╰── <child>

A RadioButton with indicator (see ToggleButtonExt::set_mode) has a main CSS node with name radiobutton and a subnode with name radio.

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

A RadioButton 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 ToggleButton::toggled signal, as does the previously selected button. Inside the ToggleButton::toggled handler, ToggleButtonExt::get_active can be used to determine if the button has been selected or deselected.

Implements

RadioButtonExt, CheckButtonExt, ToggleButtonExt, ButtonExt, BinExt, ContainerExt, WidgetExt, glib::object::ObjectExt, BuildableExt, ActionableExt, WidgetExtManual, BuildableExtManual

Implementations

impl RadioButton

pub fn from_widget<P: IsA<RadioButton>>(radio_group_member: &P) -> RadioButton

pub fn with_label_from_widget<P: IsA<RadioButton>>(
    radio_group_member: &P,
    label: &str
) -> RadioButton

pub fn with_mnemonic_from_widget<P: IsA<RadioButton>>(
    radio_group_member: &P,
    label: &str
) -> RadioButton

impl RadioButton

pub fn new() -> RadioButton

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

group

an existing radio button group, or None if you are creating a new group.

Returns

a new radio button

pub fn with_label(label: &str) -> RadioButton

pub fn with_mnemonic(label: &str) -> RadioButton

Trait Implementations

impl Clone for RadioButton

fn clone(&self) -> RadioButton

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RadioButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for RadioButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for RadioButton

impl Hash for RadioButton

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl IsA<Actionable> for RadioButton

impl IsA<Bin> for RadioButton

impl IsA<Buildable> for RadioButton

impl IsA<Button> for RadioButton

impl IsA<CheckButton> for RadioButton

impl IsA<Container> for RadioButton

impl IsA<ToggleButton> for RadioButton

impl IsA<Widget> for RadioButton

impl Ord for RadioButton

fn cmp(&self, other: &RadioButton) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for RadioButton

fn eq(&self, other: &T) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for RadioButton

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for RadioButton

fn static_type() -> Type

Returns the type identifier of Self.