pub struct SelectPrompt<'a> { /* private fields */ }Expand description
A prompt widget for choosing one option from a list.
SelectPrompt owns the label and options to render, while SelectState tracks the focused
option, focus state, and completion status. Render the prompt before routing key events so the
state can learn how many options are currently selectable.
When the render area is shorter than the option list, the prompt renders a window around the focused option so the highlighted row remains visible.
Implementations§
Source§impl<'a> SelectPrompt<'a>
impl<'a> SelectPrompt<'a>
Sourcepub const fn new(
label: Cow<'a, str>,
options: SelectOptionList<'a>,
) -> SelectPrompt<'a>
pub const fn new( label: Cow<'a, str>, options: SelectOptionList<'a>, ) -> SelectPrompt<'a>
Creates a select prompt from a label and an ordered option list.
Sourcepub fn with_block(self, block: Block<'a>) -> SelectPrompt<'a>
pub fn with_block(self, block: Block<'a>) -> SelectPrompt<'a>
Wraps the prompt in a Block.
Trait Implementations§
Source§impl<'a> Clone for SelectPrompt<'a>
impl<'a> Clone for SelectPrompt<'a>
Source§fn clone(&self) -> SelectPrompt<'a>
fn clone(&self) -> SelectPrompt<'a>
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<'a> Debug for SelectPrompt<'a>
impl<'a> Debug for SelectPrompt<'a>
Source§impl<'a> Default for SelectPrompt<'a>
impl<'a> Default for SelectPrompt<'a>
Source§fn default() -> SelectPrompt<'a>
fn default() -> SelectPrompt<'a>
Returns the “default value” for a type. Read more
impl<'a> Eq for SelectPrompt<'a>
Source§impl<'a> PartialEq for SelectPrompt<'a>
impl<'a> PartialEq for SelectPrompt<'a>
Source§fn eq(&self, other: &SelectPrompt<'a>) -> bool
fn eq(&self, other: &SelectPrompt<'a>) -> bool
Tests for
self and other values to be equal, and is used by ==.Source§impl Prompt for SelectPrompt<'_>
impl Prompt for SelectPrompt<'_>
Source§fn draw(
self,
frame: &mut Frame<'_>,
area: Rect,
state: &mut <SelectPrompt<'_> as StatefulWidget>::State,
)
fn draw( self, frame: &mut Frame<'_>, area: Rect, state: &mut <SelectPrompt<'_> as StatefulWidget>::State, )
Draws the prompt widget. Read more
Source§impl<'a> StatefulWidget for SelectPrompt<'a>
impl<'a> StatefulWidget for SelectPrompt<'a>
Source§type State = SelectState
type State = SelectState
State associated with the stateful widget. Read more
Source§fn render(
self,
area: Rect,
buf: &mut Buffer,
state: &mut <SelectPrompt<'a> as StatefulWidget>::State,
)
fn render( self, area: Rect, buf: &mut Buffer, state: &mut <SelectPrompt<'a> as StatefulWidget>::State, )
Draws the current state of the widget in the given buffer. That is the only method required
to implement a custom stateful widget.
impl<'a> StructuralPartialEq for SelectPrompt<'a>
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for SelectPrompt<'a>
impl<'a> !Send for SelectPrompt<'a>
impl<'a> !Sync for SelectPrompt<'a>
impl<'a> !UnwindSafe for SelectPrompt<'a>
impl<'a> Freeze for SelectPrompt<'a>
impl<'a> Unpin for SelectPrompt<'a>
impl<'a> UnsafeUnpin for SelectPrompt<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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