Struct CommandState 

pub struct CommandState { /* private fields */ }

The interaction state of a crate::command::Command palette: its query, focus, scrolling, and highlighted command.

Implementations

impl CommandState

pub fn new( window: &mut Window, cx: &mut Context<'_, CommandState>, ) -> CommandState

Create an empty palette.

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

The current search query.

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

Replace the search query, as if it had been typed.

The input suppresses its own change event for a programmatic write, so the re-filter and query callback happen here instead.

pub fn selected_index(&self) -> Option<IndexPath>

The highlighted item’s path in the model installed by the latest crate::command::Command render, before local filtering.

Ungrouped items occupy section 0 and use their input position as the row. Explicit groups use their group and item positions; when a model mixes both forms, the implicit ungrouped section comes first.

pub fn set_selected_index( &mut self, index: Option<IndexPath>, window: &mut Window, cx: &mut Context<'_, CommandState>, )

Highlight an item by its original, unfiltered model path, or clear the highlight with None.

A path that is currently filtered out or disabled clears the highlight. A visible selection is scrolled into view.

pub fn matched_count(&self) -> usize

The number of items matching the current query.

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

Move focus to the palette’s active control.

pub fn set_loading( &mut self, loading: bool, window: &mut Window, cx: &mut Context<'_, CommandState>, )

Show or hide the search field’s spinner, and suppress the empty message while it spins.

Turn it on while an on_query callback is being answered.

pub fn is_loading(&self) -> bool

Whether the search field is showing its spinner.

Trait Implementations

impl Focusable for CommandState

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

Returns the focus handle associated with this view.

impl Render for CommandState

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

Render this view into an element tree.