Skip to main content

Combobox

Struct Combobox 

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

A Select you can type into.

It owns the query and whether the menu is open. Which option holds is the caller’s answer, so escape puts the query back to it and reports nothing.

Implementations§

Source§

impl Combobox

Source

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

Source

pub fn options(self, options: impl IntoIterator<Item = SelectOption>) -> Self

Source

pub fn selected(self, id: impl Into<SharedString>) -> Self

Source

pub fn name(self, name: impl Into<SharedString>) -> Self

Names both the combobox and its editable query target.

Source

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

Source

pub fn placeholder(self, placeholder: impl Into<SharedString>) -> Self

Source

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

Source

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

Whether a query nothing answers may be reported as a new value.

With it off the combobox reports nothing at all for such a query, and the list says that this is a closed set rather than drawing an empty list that looks like a list with nothing in it.

Source

pub fn set_options( &mut self, options: Vec<SelectOption>, cx: &mut Context<'_, Self>, )

Source

pub fn set_selected( &mut self, id: Option<SharedString>, cx: &mut Context<'_, Self>, )

Replaces the choice from the host side, and puts its label back in the field so the query and the answer agree again.

Source

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

Source

pub fn selected_id(&self) -> Option<&SharedString>

Source

pub fn selected_option(&self) -> Option<&SelectOption>

Source

pub fn is_open(&self) -> bool

Source

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

Source

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

Source

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

Source

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

Source

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

Trait Implementations§

Source§

impl Debug for Combobox

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Disableable for Combobox

Source§

fn disabled(self, disabled: bool) -> Self

Source§

impl EventEmitter<ComboboxEvent> for Combobox

Source§

impl Focusable for Combobox

Source§

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

Returns the focus handle associated with this view.
Source§

impl Render for Combobox

Source§

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

Render this view into an element tree.
Source§

impl Sizable for Combobox

Source§

fn control_size(self, size: ControlSize) -> Self

Source§

fn xs(self) -> Self

Source§

fn small(self) -> Self

Source§

fn medium(self) -> Self

Source§

fn large(self) -> Self

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
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