Struct arcdps_imgui::ListBox

source ·
pub struct ListBox<T> { /* private fields */ }
Expand description

Builder for a list box widget

Implementations§

source§

impl<T: AsRef<str>> ListBox<T>

source

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

Constructs a new list box builder.

source

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

source

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

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.

source

pub fn build<R, F: FnOnce() -> R>(self, ui: &Ui<'_>, f: F) -> Option<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.

source§

impl<T: AsRef<str>> ListBox<T>

§Convenience functions

source

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

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

Trait Implementations§

source§

impl<T: Clone> Clone for ListBox<T>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Debug> Debug for ListBox<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: Copy> Copy for ListBox<T>

Auto Trait Implementations§

§

impl<T> Freeze for ListBox<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for ListBox<T>
where T: RefUnwindSafe,

§

impl<T> Send for ListBox<T>
where T: Send,

§

impl<T> Sync for ListBox<T>
where T: Sync,

§

impl<T> Unpin for ListBox<T>
where T: Unpin,

§

impl<T> UnwindSafe for ListBox<T>
where T: UnwindSafe,

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.