Skip to main content

CommandBar

Struct CommandBar 

Source
pub struct CommandBar<'a, I: ApplicationInfo> { /* private fields */ }
Expand description

Widget for rendering a command bar.

Implementations§

Source§

impl<'a, I> CommandBar<'a, I>
where I: ApplicationInfo,

Source

pub fn new() -> Self

Create a new widget.

Source

pub fn focus(self, focused: bool) -> Self

Indicate whether the widget is currently focused.

Source

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

Set the style to use for the command bar’s prompt.

If one isn’t provided, then this is the same style specified with CommandBar::style.

Source

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

Set the style to use for the contents of the inner TextBox.

Source

pub fn status(self, msg: Option<Span<'a>>) -> Self

Set a status string that will be displayed instead of the contents when the widget is not currently focused.

Trait Implementations§

Source§

impl<I> Default for CommandBar<'_, I>
where I: ApplicationInfo,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<I> StatefulWidget for CommandBar<'_, I>
where I: ApplicationInfo,

Source§

type State = CommandBarState<I>

State associated with the stateful widget. Read more
Source§

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

Auto Trait Implementations§

§

impl<'a, I> Freeze for CommandBar<'a, I>

§

impl<'a, I> RefUnwindSafe for CommandBar<'a, I>
where I: RefUnwindSafe,

§

impl<'a, I> Send for CommandBar<'a, I>
where I: Send,

§

impl<'a, I> Sync for CommandBar<'a, I>
where I: Sync,

§

impl<'a, I> Unpin for CommandBar<'a, I>
where I: Unpin,

§

impl<'a, I> UnsafeUnpin for CommandBar<'a, I>

§

impl<'a, I> UnwindSafe for CommandBar<'a, I>
where I: UnwindSafe,

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.
Source§

impl<T> Any for T
where T: Any,