Struct RadioButton

pub struct RadioButton<T> { /* private fields */ }

Variant of Checkbox arranged in group.

RadioButtons are managed by a RadioGroup. A single group can contain several radio buttons, but only one button per group can be active at a time.

RadioButtons are not created directly, but through RadioGroup::button.

Implementations

impl RadioButton<String>

pub fn global_str<S>(key: &str, text: S) -> RadioButton<String>

where S: Into<String>,

Create a new button on the global group pool.

Uses the label itself as value.

If no group exist for the given key and type T, one will be created.

impl<T> RadioButton<T>

where T: 'static + Send + Sync,

pub fn disable(&mut self)

Disables this view.

A disabled view cannot be selected.

pub fn disabled(self) -> RadioButton<T>

Disables this view.

Chainable variant.

pub fn enable(&mut self)

Re-enables this view.

pub fn set_enabled(&mut self, enabled: bool)

Enable or disable this view.

pub fn with_enabled(self, is_enabled: bool) -> RadioButton<T>

Enable or disable this view.

Chainable variant.

pub fn is_enabled(&self) -> bool

Returns true if this view is enabled.

pub fn global<S>(key: &str, value: T, label: S) -> RadioButton<T>

where S: Into<SpannedString<Style>>,

Create a new button on the global group pool.

If no group exist for the given key and type T, one will be created.

pub fn is_selected(&self) -> bool

Returns true if this button is selected.

pub fn select(&mut self) -> EventResult

Selects this button, un-selecting any other in the same group.

pub fn selected(self) -> RadioButton<T>

Selects this button, un-selecting any other in the same group.

Chainable variant.

pub fn from_group<S>( group: &mut RadioGroup<T>, value: T, label: S, ) -> RadioButton<T>

where S: Into<String>,

Build a button from a radio group.

Equivalent to group.button(value, label)

impl RadioButton<String>

pub fn from_group_str<S>( group: &mut RadioGroup<String>, label: S, ) -> RadioButton<String>

where S: Into<String>,

Build a button from a radio group.

Equivalent to group.button_str(label)

Trait Implementations

impl<T> View for RadioButton<T>

where T: 'static + Send + Sync,

fn required_size(&mut self, _: XY<usize>) -> XY<usize>

Returns the minimum size the view requires with the given restrictions.

fn take_focus(&mut self, _: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

fn on_event(&mut self, event: Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn layout(&mut self, _: XY<usize>)

Called once the size for this view has been decided.

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn call_on_any( &mut self, _: &Selector<'_>, _: &mut dyn FnMut(&mut (dyn View + 'static)), )

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, _: &Selector<'_>) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector.

fn important_area(&self, view_size: XY<usize>) -> Rect

What part of the view is important and should be visible?

fn type_name(&self) -> &'static str

Returns the type of this view.