Struct imgui::ListBox

#[must_use]pub struct ListBox<'a> { /* fields omitted */ }

Builder for a list box widget

Implementations

impl<'a> ListBox<'a>

pub fn new(label: &'a ImStr) -> ListBox<'a>

Constructs a new list box builder.

pub fn calculate_size(self, items_count: i32, height_in_items: i32) -> Self

Sets the list box size based on the number of items that you want to make visible Size default to hold ~7.25 items. We add +25% worth of item height to allow the user to see at a glance if there are more items up/down, without looking at the scrollbar. We don't add this extra bit if items_count <= height_in_items. It is slightly dodgy, because it means a dynamic list of items will make the widget resize occasionally when it crosses that size.

pub fn size(self, size: [f32; 2]) -> Self

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

#[must_use]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<F: FnOnce()>(self, ui: &Ui<'_>, f: F)

Creates a list box and runs a closure to construct the list contents.

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

impl<'a> ListBox<'a>

Convenience functions

pub fn build_simple<T, L>(
    self,
    ui: &Ui<'_>,
    current_item: &mut usize,
    items: &[T],
    label_fn: &L
) -> bool where
    L: Fn(&'b T) -> Cow<'b, ImStr>, 

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

Trait Implementations

impl<'a> Clone for ListBox<'a>

pub fn clone(&self) -> ListBox<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ListBox<'a>

impl<'a> Debug for ListBox<'a>

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

Formats the value using the given formatter.