Reference Radio Button

A simple switch that can be toggled on and off. A radio button is always 5 width and 1 height. A radio button can be part of a group (by setting the group property of multiple radio buttons to the same value). A group of radio buttons is mutually exclusive, meaning that when one becomes active, the others become inactive. Often used with on_value_change callbacks. Only the radio button that become active triggers an on_value_change callback.

Properties

active

Property that represents whether the radio button is on (active) or off.

Property type:

bool

Possible values:

true
false

Default value:

false

Usage examples:

In EzLang files:

- Radiobutton:
    active: true

In code:

use ez_term::*;
let (root_widget, mut state_tree, mut scheduler) = load_ui();
let state = state_tree.get_mut("my_radio_button").as_radio_button_mut();

state.set_active(true);

run(root_widget, state_tree, scheduler);

active_symbol

The symbol used to indicate the radio button is active. If for example the symbol is X, then the checkbox will look like this when active: ( X ).

Property type:

String

Possible values:

Any one character string.

Default value:

X

Usage examples:

In EzLang files:

- RadioButton:
    active_symbol: 0

In code:

use ez_term::*;
let (root_widget, mut state_tree, mut scheduler) = load_ui();
let state = state_tree.get_mut("my_radio_button").as_radio_button_mut();

state.set_active_symbol("0");

run(root_widget, state_tree, scheduler);

inactive_symbol

The symbol used to indicate the radio button is inactive. If for example the symbol is -, then the radio button will look like this when inactive: ( - ).

Property type:

String

Possible values:

Any one character string.

Default value:

Usage examples:

In EzLang files:

- RadioButton:
    inactive_symbol: .

In code:

use ez_term::*;
let (root_widget, mut state_tree, mut scheduler) = load_ui();
let state = state_tree.get_mut("my_radio_button").as_radio_button_mut();

state.set_inactive_symbol(".");

run(root_widget, state_tree, scheduler);

group

This property determines which radio buttons belong together, and are therefore mutually exclusive. Set multiple radio buttons to the same group value to make them part of the same group.

Property type:

String

Possible values:

Any string.

Default value:

Empty string

Usage examples:

In EzLang files:

- RadioButton:
    group: my_group

In code:

use ez_term::*;
let (root_widget, mut state_tree, mut scheduler) = load_ui();
let state = state_tree.get_mut("my_radio_button").as_radio_button_mut();

state.set_group("my_group");

run(root_widget, state_tree, scheduler);