Struct VirtualizedListState 

pub struct VirtualizedListState {
    pub selected: Option<usize>,
    /* private fields */
}

State for the VirtualizedList widget.

Fields

selected: Option<usize>

Currently selected index.

Implementations

impl VirtualizedListState

pub fn new() -> Self

Create a new state.

pub fn with_overscan(self, overscan: usize) -> Self

Create with overscan.

pub fn with_follow(self, follow: bool) -> Self

Create with follow mode enabled.

pub fn with_persistence_id(self, id: impl Into<String>) -> Self

Create with a persistence ID for state saving.

pub fn persistence_id(&self) -> Option<&str>

Get the persistence ID, if set.

pub fn scroll_offset(&self) -> usize

Get raw scroll offset.

Warning: After scroll_to_bottom, this may return usize::MAX (a lazy sentinel that gets clamped during rendering). Use [scroll_offset_clamped] with a known total_items to get a safe value for display or indexing.

pub fn scroll_offset_clamped(&self, total_items: usize) -> usize

Get scroll offset clamped against a known total item count.

Prefer this over [scroll_offset()] when the total is available, because scroll_to_bottom may store usize::MAX internally.

pub fn visible_count(&self) -> usize

Get visible item count (from last render).

pub fn scroll(&mut self, delta: i32, total_items: usize)

Scroll by delta (positive = down).

pub fn scroll_to(&mut self, idx: usize, total_items: usize)

Scroll to specific index.

pub fn scroll_to_top(&mut self)

Scroll to top.

pub fn scroll_to_bottom(&mut self, total_items: usize)

Scroll to bottom.

pub fn page_up(&mut self, total_items: usize)

Page up (scroll by visible count - 1).

pub fn page_down(&mut self, total_items: usize)

Page down (scroll by visible count - 1).

pub fn select(&mut self, index: Option<usize>)

Select an item.

pub fn select_previous(&mut self, total_items: usize)

Select previous item.

pub fn select_next(&mut self, total_items: usize)

Select next item.

pub fn is_at_bottom(&self, total_items: usize) -> bool

Check if at bottom.

pub fn set_follow(&mut self, follow: bool, total_items: usize)

Enable/disable follow mode.

pub fn follow_mode(&self) -> bool

Check if follow mode is enabled.

pub fn fling(&mut self, velocity: f32)

Start momentum scroll.

pub fn tick(&mut self, dt: Duration, total_items: usize)

Apply momentum scrolling tick.

pub fn handle_mouse( &mut self, event: &MouseEvent, hit: Option<(HitId, HitRegion, u64)>, scrollbar_hit_id: HitId, total_items: usize, viewport_height: u16, fixed_item_height: u16, ) -> MouseResult

Handle mouse events, including scrollbar interaction.

The caller must provide the hit test result and the expected hit ID for the scrollbar.

Trait Implementations

impl Clone for VirtualizedListState

fn clone(&self) -> VirtualizedListState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualizedListState

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

Formats the value using the given formatter.

impl Default for VirtualizedListState

fn default() -> Self

Returns the “default value” for a type.

impl Stateful for VirtualizedListState

type State = VirtualizedListPersistState

The state type that gets persisted.

fn state_key(&self) -> StateKey

Unique key identifying this widget instance.

fn save_state(&self) -> VirtualizedListPersistState

Extract current state for persistence.

fn restore_state(&mut self, state: VirtualizedListPersistState)

Restore state from persistence.

fn state_version() -> u32

State schema version for forward-compatible migrations.