Struct CommandPalette 

pub struct CommandPalette { /* private fields */ }

A query field over a list of commands.

The palette owns the query and where the keyboard is; the command list and whether the palette is on screen at all belong to the host.

Implementations

impl CommandPalette

pub fn new( ident: impl Into<Ident>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

pub fn commands(self, commands: impl IntoIterator<Item = Command>) -> Self

pub fn set_commands( &mut self, commands: Vec<Command>, cx: &mut Context<'_, Self>, )

pub fn query(&self, cx: &App) -> SharedString

pub fn set_query( &mut self, query: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Replaces the query from the host side, for example when the palette is opened with something already typed.

pub fn query_input(&self) -> &Entity<TextInput>

pub fn focus_query(&self, window: &mut Window, cx: &mut App)

Moves the keyboard into the query field.

pub fn active_id(&self, cx: &App) -> Option<SharedString>

The command the keyboard is on, or None when nothing can be taken.

Trait Implementations

impl Debug for CommandPalette

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

Formats the value using the given formatter.

impl EventEmitter<CommandPaletteEvent> for CommandPalette

impl Focusable for CommandPalette

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for CommandPalette

fn render( &mut self, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.