Struct ListBox

pub struct ListBox<T> { /* private fields */ }

Builder for a list box widget

Implementations

impl<T> ListBox<T>

where T: AsRef<str>,

pub fn new(label: T) -> ListBox<T>

Constructs a new list box builder.

pub fn size(self, size: impl Into<Vector2<f32>>) -> ListBox<T>

Sets the list box size based on the given width and height If width or height are 0 or smaller, a default value is calculated Helper to calculate the size of a listbox and display a label on the right. Tip: To have a list filling the entire window width, PushItemWidth(-1) and pass an non-visible label e.g. “##empty”

Default: [0.0, 0.0], in which case the combobox calculates a sensible width and height

pub fn begin(self, ui: &Ui) -> Option<ListBoxToken<'_>>

Creates a list box and starts appending to it.

Returns Some(ListBoxToken) if the list box is open. After content has been rendered, the token must be ended by calling .end().

Returns None if the list box is not open and no content should be rendered.

pub fn build<R, F>(self, ui: &Ui, f: F) -> Option<R>

where F: FnOnce() -> R,

Creates a list box and runs a closure to construct the list contents. Returns the result of the closure, if it is called.

Note: the closure is not called if the list box is not open.

impl<T> ListBox<T>

where T: AsRef<str>,

Convenience functions

pub fn build_simple<V, L>( self, ui: &Ui, current_item: &mut usize, items: &[V], label_fn: &L, ) -> bool

where L: for<'b> Fn(&'b V) -> Cow<'b, str>,

Builds a simple list box for choosing from a slice of values

Trait Implementations

impl<T> Clone for ListBox<T>

where T: Clone,

fn clone(&self) -> ListBox<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for ListBox<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Copy for ListBox<T>

where T: Copy,