Skip to main content

SettingsForm

Struct SettingsForm 

Source
pub struct SettingsForm { /* private fields */ }
Expand description

A vertical form of numeric fields with arrow-key navigation.

Arrow up/down navigates between fields. All other keys delegate to the currently selected field. When a field is in edit mode, up/down are blocked until the user confirms (Enter) or cancels (Escape) the edit.

Implementations§

Source§

impl SettingsForm

Source

pub fn new(fields: Vec<NumericField>) -> Self

Source

pub fn selected(&self) -> usize

Index of the currently selected field.

Source

pub fn len(&self) -> usize

Number of fields.

Source

pub fn is_empty(&self) -> bool

Whether the form has no fields.

Source

pub fn is_editing(&self) -> bool

Whether the currently selected field is in edit (text entry) mode.

Source

pub fn values(&self) -> Vec<Option<f64>>

Get all current field values.

Source

pub fn handle_key(&mut self, key: &KeyPress) -> WidgetResult<()>

Handle a key press.

Returns Confirmed(()) when Enter is pressed in browse mode (all fields committed). Returns Cancelled when Escape is pressed in browse mode. Returns Pending for all navigation and edit operations.

Source

pub fn render(&self, frame: &mut Frame<'_>, area: Rect)

Render the form. Each field occupies one row.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.