Struct ListView

pub struct ListView<'a, T> {
    pub item_count: usize,
    pub builder: ListBuilder<'a, T>,
    pub scroll_axis: ScrollAxis,
    pub style: Style,
    pub block: Option<Block<'a>>,
    /* private fields */
}

A struct representing a list view. The widget displays a scrollable list of items.

Fields

item_count: usize

The total number of items in the list

builder: ListBuilder<'a, T>

A ListBuilder<T> responsible for constructing the items in the list.

scroll_axis: ScrollAxis

Specifies the scroll axis. Either Vertical or Horizontal.

style: Style

The base style of the list view.

block: Option<Block<'a>>

The base block surrounding the widget list.

Implementations

impl<'a, T> ListView<'a, T>

pub fn new(builder: ListBuilder<'a, T>, item_count: usize) -> Self

Creates a new ListView with a builder an item count.

pub fn is_empty(&self) -> bool

Checks whether the widget list is empty.

pub fn len(&self) -> usize

Returns the length of the widget list.

pub fn block(self, block: Block<'a>) -> Self

Sets the block style that surrounds the whole List.

pub fn style<S: Into<Style>>(self, style: S) -> Self

Set the base style of the List.

pub fn scroll_axis(self, scroll_axis: ScrollAxis) -> Self

Set the scroll axis of the list.

pub fn scroll_padding(self, scroll_padding: u16) -> Self

Set the scroll padding of the list.

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

Specify whether infinite scrolling should be enabled or not.

Trait Implementations

impl<'a, T: Copy + 'a> From<Vec<T>> for ListView<'a, T>

fn from(value: Vec<T>) -> Self

Converts to this type from the input type.

impl<T: Widget> StatefulWidget for ListView<'_, T>

type State = ListState

State associated with the stateful widget.

fn render(self, area: Rect, buf: &mut Buffer, state: &mut Self::State)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom stateful widget.

impl<T> Styled for ListView<'_, T>

type Item = ListView<'_, T>

fn style(&self) -> Style

Returns the style of the object.

fn set_style<S: Into<Style>>(self, style: S) -> Self::Item

Sets the style of the object.