Skip to main content

SearchableListState

Struct SearchableListState 

Source
pub struct SearchableListState<D: SearchableListDelegate + 'static>{
    pub focus_handle: FocusHandle,
    /* private fields */
}
Expand description

Shared infrastructure for all searchable-list-based components (SelectState, ComboBoxState).

This struct is a plain nested value inside a GPUI entity — it has no entity context of its own and cannot call cx.notify() or cx.emit(). Callers are responsible for those after calling mutable methods.

Fields§

§focus_handle: FocusHandle

Implementations§

Source§

impl<D: SearchableListDelegate + 'static> SearchableListState<D>

Source

pub fn new<P: 'static>( delegate: D, selected_indices: Vec<IndexPath>, on_confirm: impl Fn(Option<IndexPath>, bool, &mut Window, &mut Context<'_, ListState<SearchableListAdapter<D>>>) + 'static, on_cancel: impl Fn(Option<IndexPath>, &mut Window, &mut Context<'_, ListState<SearchableListAdapter<D>>>) + 'static, on_render_empty: impl Fn(&mut Window, &mut App) -> AnyElement + 'static, on_blur: fn(&mut P, &mut Window, &mut Context<'_, P>), window: &mut Window, cx: &mut Context<'_, P>, ) -> Self

Create a new SearchableListState, creating the list entity in the given parent context.

on_confirm, on_cancel, and on_render_empty are forwarded to the underlying adapter. on_blur is a function pointer invoked on the parent entity when focus leaves any of the list’s focus handles.

Source

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

Source

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

Source

pub fn is_open(&self) -> bool

Source

pub fn focus_handle(&self) -> &FocusHandle

Source

pub fn add_selected_index(&mut self, index: IndexPath, cx: &App) -> bool

Add a single index to the selection by looking up the item in the list.

Requires cx only to read the list entity; does not notify.

Source

pub fn remove_selected_index(&mut self, index: IndexPath) -> bool

Remove a single index from the selection.

Source

pub fn set_selected_indices( &mut self, indices: impl IntoIterator<Item = IndexPath>, cx: &App, )

Replace the entire selection, looking up items from the list.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more