Struct egui_autocomplete::AutoCompleteTextEdit

source ·
pub struct AutoCompleteTextEdit<'a, T> { /* private fields */ }
Expand description

An extension to the egui::TextEdit that allows for a dropdown box with autocomplete to popup while typing.

Implementations§

source§

impl<'a, T, S> AutoCompleteTextEdit<'a, T>
where T: IntoIterator<Item = S>, S: AsRef<str>,

source

pub fn new(text_field: &'a mut String, search: T) -> Self

Creates a new AutoCompleteTextEdit.

text_field - Contents of the text edit passed into egui::TextEdit search - Data use as the search term

source§

impl<'a, T, S> AutoCompleteTextEdit<'a, T>
where T: IntoIterator<Item = S>, S: AsRef<str>,

source

pub fn max_suggestions(self, max_suggestions: usize) -> Self

This determines the number of options appear in the dropdown menu

source

pub fn highlight_matches(self, highlight: bool) -> Self

If set to true, characters will be highlighted in the dropdown to show the match

source

pub fn set_text_edit_properties( self, set_properties: impl FnOnce(TextEdit<'_>) -> TextEdit<'_> + 'static, ) -> Self

Can be used to set the properties of the internal egui::TextEdit

§Example
AutoCompleteTextEdit::new(&mut search_field, &inputs)
    .set_text_edit_properties(|text_edit: egui::TextEdit<'_>| {
        text_edit
            .hint_text("Hint Text")
            .text_color(egui::Color32::RED)
    });

Trait Implementations§

source§

impl<'a, T, S> Widget for AutoCompleteTextEdit<'a, T>
where T: IntoIterator<Item = S>, S: AsRef<str>,

source§

fn ui(self, ui: &mut Ui) -> Response

The response returned is the response from the internal text_edit

Auto Trait Implementations§

§

impl<'a, T> Freeze for AutoCompleteTextEdit<'a, T>
where T: Freeze,

§

impl<'a, T> !RefUnwindSafe for AutoCompleteTextEdit<'a, T>

§

impl<'a, T> !Send for AutoCompleteTextEdit<'a, T>

§

impl<'a, T> !Sync for AutoCompleteTextEdit<'a, T>

§

impl<'a, T> Unpin for AutoCompleteTextEdit<'a, T>
where T: Unpin,

§

impl<'a, T> !UnwindSafe for AutoCompleteTextEdit<'a, T>

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, 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, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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.