Skip to main content

VirtualList

Struct VirtualList 

Source
pub struct VirtualList<K, T> { /* private fields */ }
Expand description

Data-backed retained virtual list with stable keyed row identity.

Only the visible and overscanned rows are realized and measured. Recently hidden rows are retained in a bounded keyed cache; focused and explicitly pinned rows are never recycled.

Implementations§

Source§

impl<K, T> VirtualList<K, T>
where K: Clone + Eq + Hash + PartialEq + 'static, T: Clone + PartialEq + 'static,

Source

pub fn new<S, F, W>( name: impl Into<String>, source: S, row_builder: F, ) -> VirtualList<K, T>
where S: VirtualCollectionSource<K, T> + 'static, F: Fn(&K, Signal<T>) -> W + 'static, W: Widget + 'static,

Source

pub fn state(self, state: VirtualListState<K>) -> VirtualList<K, T>

Source

pub fn theme(self, theme: DefaultTheme) -> VirtualList<K, T>

Source

pub fn theme_when<F>(self, reader: F) -> VirtualList<K, T>
where F: Fn() -> DefaultTheme + 'static,

Source

pub fn estimated_row_height(self, height: f32) -> VirtualList<K, T>

Source

pub fn spacing(self, spacing: f32) -> VirtualList<K, T>

Source

pub fn padding(self, padding: Padding) -> VirtualList<K, T>

Source

pub fn row_padding(self, padding: Padding) -> VirtualList<K, T>

Overrides the theme-provided padding around each row’s custom content.

Virtual lists apply data_row_padding automatically so row builders do not need to repeat edge padding. Pass Insets::ZERO for full-bleed row content while preserving the list’s viewport padding.

Source

pub fn overscan_viewports(self, viewports: f32) -> VirtualList<K, T>

Source

pub fn cache_capacity(self, capacity: usize) -> VirtualList<K, T>

Source

pub fn selection_mode(self, mode: VirtualListSelectionMode) -> VirtualList<K, T>

Source

pub fn chrome(self, chrome: VirtualListChrome) -> VirtualList<K, T>

Source

pub fn stick_to_end(self, enabled: bool) -> VirtualList<K, T>

Source

pub fn overlay_scroll_bars(self, enabled: bool) -> VirtualList<K, T>

Compatibility name for scroll_bars. Built-in bars reserve layout space.

Source

pub fn scroll_bars(self, enabled: bool) -> VirtualList<K, T>

Show built-in scrollbars in their own gutters when content overflows.

Source

pub fn row_name<F>(self, name: F) -> VirtualList<K, T>
where F: Fn(&K, &T) -> String + 'static,

Source

pub fn row_description<F>(self, description: F) -> VirtualList<K, T>
where F: Fn(&K, &T) -> String + 'static,

Source

pub fn on_change<F>(self, on_change: F) -> VirtualList<K, T>
where F: FnMut(K) + 'static,

Source

pub fn on_change_with_ctx<F>(self, on_change: F) -> VirtualList<K, T>
where F: FnMut(K, &mut EventCtx) + 'static,

Source

pub fn on_near_start<F>(self, on_near_start: F) -> VirtualList<K, T>
where F: FnMut() + 'static,

Source

pub fn on_near_start_with_ctx<F>(self, on_near_start: F) -> VirtualList<K, T>
where F: FnMut(&mut EventCtx) + 'static,

Source

pub fn on_near_end<F>(self, on_near_end: F) -> VirtualList<K, T>
where F: FnMut() + 'static,

Source

pub fn on_near_end_with_ctx<F>(self, on_near_end: F) -> VirtualList<K, T>
where F: FnMut(&mut EventCtx) + 'static,

Source

pub fn current_offset(&self) -> Vector

Source

pub fn realized_count(&self) -> usize

Trait Implementations§

Source§

impl<K, T> Widget for VirtualList<K, T>
where K: Clone + Eq + Hash + PartialEq + 'static, T: Clone + PartialEq + 'static,

Source§

fn diagnostics(&self, ctx: &mut WidgetDiagnosticsCtx)

Publish widget-specific state for an inspector snapshot. Read more
Source§

fn event(&mut self, ctx: &mut EventCtx, event: &Event)

Source§

fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size

Source§

fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)

Source§

fn paint(&self, ctx: &mut PaintCtx)

Source§

fn layer_options(&self) -> LayerOptions

Source§

fn semantics(&self, ctx: &mut SemanticsCtx)

Source§

fn accepts_focus(&self) -> bool

Source§

fn focus_changed(&mut self, ctx: &mut EventCtx, _focused: bool)

Source§

fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)

Visit this widget’s logical children. Read more
Source§

fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)

Mutably visit this widget’s logical children. Read more
Source§

fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)

Receive a typed command addressed directly to this widget. Commands are target-only and do not capture or bubble through the widget tree.
Source§

fn debug_name(&self) -> &'static str

Source§

fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size

Compute a provisional size. Containers can override this to query child sizes without committing their final layouts. The default preserves existing custom widgets by delegating to measure; it may mutate state. Child measure calls still commit state. Use child size probes explicitly when only their scalar results are needed. Results must match measure for the same content and constraints. A final measure is still required before arrangement after a probe miss.
Source§

fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32

Query one component of measure_size under exactly the same constraints. Overrides may avoid computing the other component, but must return the same extent. Like size probes, this does not replace final measurement.
Source§

fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize

Report the smallest and preferred extent along one axis. Read more
Source§

fn supports_output_reuse(&self) -> bool

Opt into retaining paint and semantics between targeted invalidations. Output must depend only on widget state, context, and observed sources; changes must invalidate the widget. Untracked readers and callbacks with side effects should keep the default. An opaque descendant also prevents caching its ancestors. Explicit subtree/window requests always rerun them. A source observed only in paint or semantics invalidates that callback, not its descendants. Mutating child state requires a child/subtree request.
Source§

fn layer_properties(&self) -> LayerProperties

Source§

fn stack_host_options(&self) -> Option<StackHostOptions>

Source§

fn stack_surface_options(&self) -> Option<StackSurfaceOptions>

Source§

fn overlay_options(&self) -> Option<OverlayOptions>

Describe this widget as the logical owner of a presented overlay. Read more

Auto Trait Implementations§

§

impl<K, T> !Freeze for VirtualList<K, T>

§

impl<K, T> !RefUnwindSafe for VirtualList<K, T>

§

impl<K, T> !Send for VirtualList<K, T>

§

impl<K, T> !Sync for VirtualList<K, T>

§

impl<K, T> !UnwindSafe for VirtualList<K, T>

§

impl<K, T> Unpin for VirtualList<K, T>
where Arc<dyn VirtualCollectionSource<K, T>>: Unpin, VirtualListState<K>: Unpin, Box<dyn Fn(&K, Signal<T>) -> WidgetPod>: Unpin, Option<Box<dyn Fn(&K, &T) -> String>>: Unpin, Option<Box<dyn FnMut(K)>>: Unpin, Option<Box<dyn FnMut(K, &mut EventCtx)>>: Unpin, Vec<K>: Unpin, HashMap<K, usize>: Unpin, HashMap<K, WidgetId>: Unpin, HashMap<K, RealizedRow<T>>: Unpin, Option<K>: Unpin, RefCell<Option<K>>: Unpin,

§

impl<K, T> UnsafeUnpin for VirtualList<K, T>

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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, 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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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