Struct Choice 

pub struct Choice<'a, T = usize>
where
    T: PartialEq + Clone + Default,
{ /* private fields */ }

Choice.

Select one of a list. No editable mode for this widget.

This doesn’t render itself. into_widgets creates the base part and the popup part, which are rendered separately.

Implementations

impl<'a> Choice<'a, usize>

pub fn auto_items<V: Into<Line<'a>>>( self, items: impl IntoIterator<Item = V>, ) -> Self

Add items with auto-generated values.

pub fn auto_item(self, item: impl Into<Line<'a>>) -> Self

Add an item with an auto generated value.

impl<'a, T> Choice<'a, T>

where T: PartialEq + Clone + Default,

pub fn new() -> Self

pub fn unknown_item(self, unknown: impl Into<Line<'a>>) -> Self

pub fn items<V: Into<Line<'a>>>( self, items: impl IntoIterator<Item = (T, V)>, ) -> Self

Button text.

pub fn item(self, value: T, item: impl Into<Line<'a>>) -> Self

Add an item.

pub fn default_value(self, default: T) -> Self

Can return to default with user interaction.

pub fn styles(self, styles: ChoiceStyle) -> Self

Combined styles.

pub fn style(self, style: Style) -> Self

Base style.

pub fn button_style(self, style: Style) -> Self

Style for the down button.

pub fn select_style(self, style: Style) -> Self

Selection in the list.

pub fn select_marker(self, marker: char) -> Self

Selection in the list.

pub fn focus_style(self, style: Style) -> Self

Focused style.

pub fn block(self, block: Block<'a>) -> Self

Block for the main widget.

pub fn skip_item_render(self, skip: bool) -> Self

Skips rendering the selected item. This is a flag for Combobox, that wants to do its own rendering instead.

pub fn popup_alignment(self, alignment: Alignment) -> Self

Alignment of the popup.

Default Default is Left.

pub fn popup_placement(self, placement: Placement) -> Self

Placement of the popup.

Default Default is BelowOrAbove.

pub fn popup_boundary(self, boundary: Rect) -> Self

Outer boundary for the popup.

pub fn popup_len(self, len: u16) -> Self

Override the popup length.

Default Defaults to the number of items or 5.

pub fn popup_style(self, style: Style) -> Self

Base style for the popup.

pub fn popup_block(self, block: Block<'a>) -> Self

Block for the popup.

pub fn popup_scroll(self, scroll: Scroll<'a>) -> Self

Scroll for the popup.

pub fn popup_offset(self, offset: (i16, i16)) -> Self

Adds an extra offset to the widget area.

This can be used to

• place the widget under the mouse cursor.
• align the widget not by the outer bounds but by the text content.

pub fn popup_x_offset(self, offset: i16) -> Self

Sets only the x offset. See offset

pub fn popup_y_offset(self, offset: i16) -> Self

Sets only the y offset. See offset

pub fn behave_focus(self, focus: ChoiceFocus) -> Self

Sets the behaviour for selecting from the list.

pub fn behave_select(self, select: ChoiceSelect) -> Self

Sets the behaviour for selecting from the list.

pub fn behave_close(self, close: ChoiceClose) -> Self

Sets the behaviour for closing the list.

pub fn width(&self) -> u16

Inherent width.

pub fn height(&self) -> u16

Inherent height.

pub fn into_widgets(self) -> (ChoiceWidget<'a, T>, ChoicePopup<'a, T>)

Choice itself doesn’t render.

This builds the widgets from the parameters set for Choice.

Trait Implementations

impl<'a, T> Clone for Choice<'a, T>

where T: PartialEq + Clone + Default + Clone,

fn clone(&self) -> Choice<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for Choice<'a, T>

where T: PartialEq + Clone + Default + Debug,

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

Formats the value using the given formatter.

impl<T> Default for Choice<'_, T>

where T: PartialEq + Clone + Default,

fn default() -> Self

Returns the “default value” for a type.