Struct imgui::ComboBox

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

Builder for a combo box widget

Methods

impl<'a> ComboBox<'a>

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

Constructs a new combo box builder.

pub fn preview_value(self, preview_value: &'a ImStr) -> Self

Sets the preview value displayed in the preview box (if visible).

pub fn flags(self, flags: ComboBoxFlags) -> Self

Replaces all current settings with the given flags.

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

Enables/disables aligning the combo box popup toward the left.

Disabled by default.

pub fn height(self, height: ComboBoxHeight) -> Self

Sets the combo box height.

Default: ComboBoxHeight::Regular

pub fn preview_mode(self, preview_mode: ComboBoxPreviewMode) -> Self

Sets the combo box preview mode.

Default: ComboBoxPreviewMode::Full

#[must_use] pub fn begin(self, ui: &Ui) -> Option<ComboBoxToken>

Creates a combo box and starts appending to it.

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

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

pub fn build<F: FnOnce()>(self, ui: &Ui, f: F)

Creates a combo box and runs a closure to construct the popup contents.

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

impl<'a> ComboBox<'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 combo box for choosing from a slice of values

pub fn build_simple_string<S: ?Sized>(
    self,
    ui: &Ui,
    current_item: &mut usize,
    items: &[&S]
) -> bool where
    S: AsRef<ImStr>, 

Builds a simple combo box for choosing from a slice of strings

Trait Implementations

impl<'a> Clone for ComboBox<'a>

fn clone(&self) -> ComboBox<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ComboBox<'a>

impl<'a> Debug for ComboBox<'a>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.