Skip to main content

ListBox

Struct ListBox 

Source
pub struct ListBox<'a, ID, COL: PixelColor> { /* private fields */ }
Expand description

List box widget for displaying scrollable text lists.

This widget displays a scrollable list of text items with support for selection highlighting. The list can have customizable font, alignment, colors, line spacing, padding, and border.

§Type Parameters

  • 'a - The lifetime of the items array reference
  • ID - The widget ID type implementing WidgetId
  • COL - The pixel color type implementing PixelColor

Implementations§

Source§

impl<'a, ID: WidgetId, COL: PixelColor> ListBox<'a, ID, COL>

Source

pub const fn new( region: &'a Region<ID>, items: &'a [&'a str], ) -> ListBox<'a, ID, COL>

Source

pub const fn with_start(self, start_item: u16) -> Self

Source

pub const fn with_font(self, font: UiFont<'a>) -> Self

Source

pub const fn with_align(self, align: HorizontalAlign) -> Self

Source

pub const fn with_color(self, color: COL) -> Self

Source

pub const fn with_line_spacing(self, spacing: u8) -> Self

Source

pub const fn with_padding(self, inner: u8, outer: u8) -> Self

Source

pub const fn with_border(self, border_width: u8) -> Self

Source

pub const fn with_selected_item(self, selected_item: i32) -> Self

Trait Implementations§

Source§

impl<DRAW: DrawTarget<Color = COL>, ID: WidgetId, COL: PixelColor> Widget<DRAW, COL> for ListBox<'_, ID, COL>

Source§

fn draw(&mut self, ui: &mut Ui<'_, DRAW, COL>) -> GuiResult<Response>

Draws the widget to the UI context. Read more

Auto Trait Implementations§

§

impl<'a, ID, COL> Freeze for ListBox<'a, ID, COL>
where COL: Freeze,

§

impl<'a, ID, COL> RefUnwindSafe for ListBox<'a, ID, COL>
where ID: RefUnwindSafe, COL: RefUnwindSafe,

§

impl<'a, ID, COL> Send for ListBox<'a, ID, COL>
where ID: Sync, COL: Send,

§

impl<'a, ID, COL> Sync for ListBox<'a, ID, COL>
where ID: Sync, COL: Sync,

§

impl<'a, ID, COL> Unpin for ListBox<'a, ID, COL>
where COL: Unpin,

§

impl<'a, ID, COL> UnsafeUnpin for ListBox<'a, ID, COL>
where COL: UnsafeUnpin,

§

impl<'a, ID, COL> UnwindSafe for ListBox<'a, ID, COL>
where ID: RefUnwindSafe, COL: 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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.