Struct InputListState 

pub struct InputListState { /* private fields */ }

Represents the state of an input list.

Implementations

impl InputListState

pub const fn new() -> Self

Creates a new InputListState.

pub const fn create(length: usize) -> Self

Creates a new InputListState with the provided list length.

pub fn scroll_up_by(&mut self, val: usize) -> usize

Scrolls down the first by the provided amount.

If the amount scrolls out-of-bounds, the first item is selected.

pub fn scroll_down_by(&mut self, val: usize) -> usize

Scrolls down the list by the provided amount.

If the amount scrolls out-of-bounds, the last item is selected.

pub fn select(&mut self, val: usize) -> usize

Selects the provided index.

If the index is out-of-bounds:

• below offset: offet is selected
• above last item: the last item is selected

pub fn select_first(&mut self) -> usize

Selects the first list entry.

pub fn select_last(&mut self) -> usize

Selects the last list entry.

pub fn select_previous(&mut self) -> usize

Selects the previous list entry.

pub fn select_next(&mut self) -> usize

Selects the next list entry.

pub fn current(&self) -> usize

Gets the current item.

If no item is selected, returns the first item.

impl InputListState

pub const fn length(&self) -> usize

Gets the InputListState length.

pub fn set_length(&mut self, val: usize)

Sets the InputListState length.

pub fn with_length(self, val: usize) -> Self

Builder function that sets the InputListState length.

pub const fn offset(&self) -> usize

Gets the InputListState offset.

pub fn set_offset(&mut self, val: usize)

Sets the InputListState offset.

pub fn with_offset(self, val: usize) -> Self

Builder function that sets the InputListState offset.

impl InputListState

pub const fn selected(&self) -> Option<usize>

Gets the InputListState selected.

pub fn set_selected(&mut self, val: usize)

Sets the InputListState selected.

pub fn unset_selected(&mut self) -> Option<usize>

Unsets the InputListState selected.

pub fn with_selected(self, val: usize) -> Self

Builder function that sets the InputListState selected.

Trait Implementations

impl Clone for InputListState

fn clone(&self) -> InputListState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputListState

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

Formats the value using the given formatter.

impl Default for InputListState

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for InputListState

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for InputListState

impl Eq for InputListState

impl StructuralPartialEq for InputListState