Struct imgui::ComboBox

pub struct ComboBox<'ui, Label, Preview = &'static str> {
    pub label: Label,
    pub preview_value: Option<Preview>,
    pub flags: ComboBoxFlags,
    pub ui: &'ui Ui,
}

Builder for a combo box widget

Fields

label: Label

preview_value: Option<Preview>

flags: ComboBoxFlags

ui: &'ui Ui

Implementations

impl<'ui, Label: AsRef<str>> ComboBox<'ui, Label>

pub fn new(ui: &'ui Ui, label: Label) -> Self

👎Deprecated since 0.9.0: Use ui.combo_box_config(...) instead

Constructs a new combo box builder.

impl<'ui, T: AsRef<str>, Preview: AsRef<str>> ComboBox<'ui, T, Preview>

pub fn preview_value<Preview2: AsRef<str>>( self, preview_value: Preview2 ) -> ComboBox<'ui, T, Preview2>

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

pub fn begin(self) -> Option<ComboBoxToken<'ui>>

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<R, F: FnOnce() -> R>(self, f: F) -> Option<R>

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

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

Trait Implementations

impl<'ui, Label: Clone, Preview: Clone> Clone for ComboBox<'ui, Label, Preview>

fn clone(&self) -> ComboBox<'ui, Label, Preview>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ui, Label: Debug, Preview: Debug> Debug for ComboBox<'ui, Label, Preview>

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

Formats the value using the given formatter.

impl<'ui, Label: Copy, Preview: Copy> Copy for ComboBox<'ui, Label, Preview>