Struct ComboboxState 

pub struct ComboboxState<D: SearchableListDelegate + 'static>
where
    <D::Item as SearchableListItem>::Value: PartialEq + Clone,
{ /* private fields */ }

State of the Combobox component.

Implementations

impl<D> ComboboxState<D>

where D: SearchableListDelegate + 'static, <D::Item as SearchableListItem>::Value: PartialEq + Clone,

pub fn new( delegate: D, selected_indices: Vec<IndexPath>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

Create a new Combobox state.

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

Enable multi-select mode.

When true, clicking an item toggles it in the selection and the popover stays open. When false (default), clicking an item replaces the selection and closes the popover.

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

Enable or disable the search input at the top of the dropdown.

pub fn selected_values(&self) -> Vec<<D::Item as SearchableListItem>::Value>

Return the currently selected values.

pub fn selected_value(&self) -> Option<<D::Item as SearchableListItem>::Value>

Return the first selected value, or None when nothing is selected.

Convenience for single-select mode (.multiple(false)).

pub fn selection(&self) -> &[(IndexPath, D::Item)]

Return the currently selected (IndexPath, Item) pairs.

pub fn set_selected_values( &mut self, values: &[<D::Item as SearchableListItem>::Value], window: &mut Window, cx: &mut Context<'_, Self>, )

Replace the entire selection set by item values.

Values are resolved through the current delegate. Values that cannot be resolved are ignored. This updates the committed selection and snapshot without emitting a ComboboxEvent.

pub fn set_selected_indices( &mut self, indices: impl IntoIterator<Item = IndexPath>, _window: &mut Window, cx: &mut Context<'_, Self>, )

Replace the entire selection set.

pub fn add_selected_index( &mut self, index: IndexPath, cx: &mut Context<'_, Self>, ) -> bool

Add a single index to the selection, if not already present, returning whether it was added.

pub fn remove_selected_index( &mut self, index: IndexPath, cx: &mut Context<'_, Self>, ) -> bool

Remove a single index from the selection, returning whether it was removed.

pub fn clear_selection(&mut self, cx: &mut Context<'_, Self>)

Clear all selected values.

pub fn set_items( &mut self, items: D, _: &mut Window, cx: &mut Context<'_, Self>, )

Replace the underlying delegate (item data source).

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

Focus the trigger.

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

Returns the search query.

pub fn set_query( &self, query: impl Into<SharedString>, window: &mut Window, cx: &mut App, )

Sets the search query and updates the filtered items.

Trait Implementations

impl<D> EventEmitter<ComboboxEvent<D>> for ComboboxState<D>

where D: SearchableListDelegate + 'static, <D::Item as SearchableListItem>::Value: PartialEq + Clone,

impl<D> EventEmitter<DismissEvent> for ComboboxState<D>

where D: SearchableListDelegate + 'static, <D::Item as SearchableListItem>::Value: PartialEq + Clone,

impl<D> Focusable for ComboboxState<D>

where D: SearchableListDelegate + 'static, <D::Item as SearchableListItem>::Value: PartialEq + Clone,

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

Returns the focus handle associated with this view.

impl<D> Render for ComboboxState<D>

where D: SearchableListDelegate + 'static, <D::Item as SearchableListItem>::Value: PartialEq + Clone,

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

Render this view into an element tree.