Skip to main content

CommandPaletteBuilder

Struct CommandPaletteBuilder 

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

Builder for CommandPalette views.

Implementations§

Source§

impl CommandPaletteBuilder

Source

pub fn new() -> Self

Source

pub fn visible(self, visible: bool) -> Self

Set whether the palette is visible.

Source

pub fn query(self, query: impl Into<String>) -> Self

Set the current query.

Source

pub fn commands(self, commands: Vec<PaletteCommand>) -> Self

Set the available commands.

Source

pub fn command(self, command: PaletteCommand) -> Self

Add a single command.

Source

pub fn selected(self, selected: usize) -> Self

Set the selected index.

Source

pub fn on_query_change(self, callback: impl Fn(String) + 'static) -> Self

Set the callback for query changes.

Source

pub fn on_select(self, callback: impl Fn(&'static str) + 'static) -> Self

Set the callback for command selection.

Source

pub fn on_dismiss(self, callback: impl Fn() + 'static) -> Self

Set the callback when dismissed.

Source

pub fn width(self, percent: u16) -> Self

Set the width as percentage of screen.

Source

pub fn height(self, percent: u16) -> Self

Set the height as percentage of screen.

Source

pub fn build(self) -> View

Trait Implementations§

Source§

impl Default for CommandPaletteBuilder

Source§

fn default() -> CommandPaletteBuilder

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

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
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, 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.