Skip to main content

VirtualizedListState

Struct VirtualizedListState 

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

State for the VirtualizedList widget.

Fields§

§selected: Option<usize>

Currently selected index.

Implementations§

Source§

impl VirtualizedListState

Source

pub fn new() -> Self

Create a new state.

Source

pub fn variable(default_height: u16) -> Self

Create variable-height state before its first render.

Source

pub fn with_predictor(self, config: PredictorConfig) -> Self

Enable category-aware prediction of unmeasured row heights. Measured heights remain exact; unclassified rows use category zero.

Source

pub fn with_remeasure_policy(self, policy: RemeasurePolicy) -> Self

Attach a Value-of-Information remeasurement policy.

Source

pub fn remeasure_policy(&self) -> Option<&RemeasurePolicy>

Borrow the attached VOI remeasurement policy, if any.

Source

pub fn remeasure_policy_mut(&mut self) -> Option<&mut RemeasurePolicy>

Mutably borrow the attached VOI remeasurement policy, if any.

Source

pub fn invalidate(&mut self, idx: usize)

Clear the measured bit for item idx so its height reverts to the unmeasured fill prediction until measured again.

Source

pub fn remeasure_tick( &mut self, frame_idx: u64, widget_id: u64, ) -> Option<RemeasureRequest>

Advance the VOI remeasurement policy by one render tick. When sampling is triggered, invalidates the topmost visible item (scroll_offset) so the next render remeasures it and returns the RemeasureRequest for the frame.

Source

pub fn predicted_height(&self, category: usize) -> u16

Point prediction for a category, or the configured default height.

Source

pub fn predictor_stats(&self) -> Option<PredictorStats>

Statistics from measured rows, when prediction is enabled.

Source

pub fn measure(&mut self, idx: usize, height: u16)

Record the measured height of item idx for a variable-height list. Rendering measures the visible rows itself; call this when an item’s height changed while off-screen so offsets stay exact. Ignored until the first variable-height render creates the tracker.

Source

pub fn measure_in_category(&mut self, idx: usize, height: u16, category: usize)

Record an off-screen measurement together with its item category.

Source

pub fn resize_heights(&mut self, len: usize)

Resize the variable-height Fenwick tracker to len items.

Source

pub fn offset_of_item(&self, idx: usize) -> u32

Return the row offset of item idx (sum of heights of items < idx).

Source

pub fn find_item_at_offset(&self, offset: u32) -> usize

Find the item index containing offset rows from the top.

Source

pub fn selected(&self) -> Option<usize>

Currently selected item index, if any.

Source

pub fn heights(&self) -> Option<&VariableHeightsFenwick>

The variable-height tracker (after the first variable-height render).

Source

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

Create with overscan.

Source

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

Create with follow mode enabled.

Source

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

Create with a persistence ID for state saving. Without one the list has no StateKey and its state is not persisted.

Source

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

Get the persistence ID, if set.

Source

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.

Source

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.

Source

pub fn visible_count(&self) -> usize

Get visible item count (from last render).

Source

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

Scroll by delta (positive = down).

Source

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

Scroll to specific index.

Source

pub fn scroll_to_top(&mut self)

Scroll to top.

Source

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

Scroll to bottom.

Source

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

Page up (scroll by visible count - 1).

Source

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

Page down (scroll by visible count - 1).

Source

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

Select an item.

Source

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

Select previous item.

Source

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

Select next item.

Source

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

Check if at bottom.

Source

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

Enable/disable follow mode.

Source

pub fn follow_mode(&self) -> bool

Check if follow mode is enabled.

Source

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

Start momentum scroll.

Source

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

Apply momentum scrolling tick.

Source

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.

After a ListHeightMode::Variable render the scrollbar works in rows, as it was drawn, and fixed_item_height is ignored: the thumb position maps back to the nearest item start, and a wheel or arrow step always moves at least one item.

Trait Implementations§

Source§

impl Clone for VirtualizedListState

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VirtualizedListState

Source§

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

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

impl Default for VirtualizedListState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Stateful for VirtualizedListState

Source§

type State = VirtualizedListPersistState

The state type that gets persisted. Read more
Source§

fn state_key(&self) -> Option<StateKey>

Unique key identifying this widget instance, or None if it has no stable identity and must not be persisted. Read more
Source§

fn save_state(&self) -> VirtualizedListPersistState

Extract current state for persistence. Read more
Source§

fn restore_state(&mut self, state: VirtualizedListPersistState)

Restore state from persistence. Read more
Source§

fn state_version() -> u32

State schema version for forward-compatible migrations. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more