Struct kas_widgets::RadioButton

pub struct RadioButton { /* private fields */ }

A radio button with label

See also RadioBox which excludes the label.

Implementations

impl RadioButton

pub fn new<T: Into<AccelString>>(label: T, group: RadioGroup) -> Self

Construct a radio button with a given label and group

RadioButton labels are optional; if no label is desired, use an empty string or use RadioBox instead.

All instances of RadioBox and RadioButton constructed over the same group will be considered part of a single group.

pub fn on_select<F>(self, f: F) -> RadioButtonwhere F: Fn(&mut EventMgr<'_>) + 'static,

Set event handler f

When the radio button is selected, the closure f is called.

No handler is called on deselection.

pub fn new_on<T: Into<AccelString>, F>(label: T, group: RadioGroup, f: F) -> Selfwhere F: Fn(&mut EventMgr<'_>) + 'static,

Construct a radio button with given label, group and event handler f

RadioButton labels are optional; if no label is desired, use an empty string.

All instances of RadioBox and RadioButton constructed over the same group will be considered part of a single group.

When the radio button is selected, the closure f is called.

No handler is called on deselection.

pub fn new_msg<S, M>(label: S, group: RadioGroup, msg: M) -> Selfwhere S: Into<AccelString>, M: Clone + Debug + 'static,

Construct a radio button with given label, group and payload msg

RadioButton labels are optional; if no label is desired, use an empty string.

All instances of RadioBox and RadioButton constructed over the same group will be considered part of a single group.

When the radio button is selected, a clone of msg is returned to the parent widget via EventMgr::push.

No handler is called on deselection.

pub fn with_state(self, state: bool) -> Self

Set the initial state of the radio button.

pub fn select(&mut self, mgr: &mut EventMgr<'_>) -> bool

Select this radio box from the group

This radio box will be set true while all others from the group will be set false. Returns true if newly selected, false if already selected.

This does not call the event handler set by Self::on_select or Self::new_on.

pub fn unset_all(&self, mgr: &mut EventMgr<'_>)

Unset all radio boxes in the group

Note: state will not update until the next draw.

Trait Implementations

impl AutoLayout for RadioButton

fn size_rules(&mut self, size_mgr: SizeMgr<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

fn find_id(&mut self, coord: Coord) -> Option<WidgetId>

Translate a coordinate to a WidgetId

fn draw(&mut self, draw: DrawMgr<'_>)

Draw a widget and its children

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 HasBool for RadioButton

fn get_bool(&self) -> bool

Get the widget’s state

fn set_bool(&mut self, state: bool) -> Action

Set the widget’s state

impl Layout for RadioButton

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

fn find_id(&mut self, coord: Coord) -> Option<WidgetId>

Translate a coordinate to a WidgetId

fn size_rules(&mut self, size_mgr: SizeMgr<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn draw(&mut self, draw: DrawMgr<'_>)

Draw a widget and its children

impl Widget for RadioButton

fn configure(&mut self, mgr: &mut ConfigMgr<'_>)

Configure widget

fn pre_configure(&mut self, _: &mut ConfigMgr<'_>, id: WidgetId)

Pre-configuration

fn nav_next( &mut self, _: &mut ConfigMgr<'_>, reverse: bool, from: Option<usize> ) -> Option<usize>

Navigation in spatial order

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn translation(&self) -> Offset

Get translation of children relative to this widget

fn handle_event(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an Event sent to this widget

fn steal_event( &mut self, mgr: &mut EventMgr<'_>, id: &WidgetId, event: &Event ) -> Response

Potentially steal an event before it reaches a child

fn handle_unused(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an event sent to child index but left unhandled

fn handle_message(&mut self, mgr: &mut EventMgr<'_>)

Handler for messages from children/descendants

fn handle_scroll(&mut self, mgr: &mut EventMgr<'_>, scroll: Scroll)

Handler for scrolling

impl WidgetChildren for RadioButton

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, _index: usize) -> Option<&dyn Widget>

Get a reference to a child widget by index, or None if the index is out of bounds.

fn get_child_mut(&mut self, _index: usize) -> Option<&mut dyn Widget>

Mutable variant of get

fn find_child_index(&self, id: &WidgetId) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn make_child_id(&mut self, index: usize) -> WidgetId

Make an identifier for a child

impl WidgetCore for RadioButton

fn id_ref(&self) -> &WidgetId

Get the widget’s identifier

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

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

Get the name of the widget struct

fn as_widget(&self) -> &dyn Widget

Erase type

fn as_widget_mut(&mut self) -> &mut dyn Widget

Erase type