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>
impl<K, T> VirtualList<K, T>
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,
pub fn state(self, state: VirtualListState<K>) -> VirtualList<K, T>
pub fn theme(self, theme: DefaultTheme) -> VirtualList<K, T>
pub fn theme_when<F>(self, reader: F) -> VirtualList<K, T>where
F: Fn() -> DefaultTheme + 'static,
pub fn estimated_row_height(self, height: f32) -> VirtualList<K, T>
pub fn gap(self, gap: f32) -> VirtualList<K, T>
pub fn padding(self, padding: Padding) -> VirtualList<K, T>
Sourcepub fn row_padding(self, padding: Padding) -> VirtualList<K, T>
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.
pub fn overscan_viewports(self, viewports: f32) -> VirtualList<K, T>
pub fn cache_capacity(self, capacity: usize) -> VirtualList<K, T>
pub fn selection_mode(self, mode: VirtualListSelectionMode) -> VirtualList<K, T>
pub fn chrome(self, chrome: VirtualListChrome) -> VirtualList<K, T>
pub fn stick_to_end(self, enabled: bool) -> VirtualList<K, T>
Sourcepub fn overlay_scroll_bars(self, enabled: bool) -> VirtualList<K, T>
pub fn overlay_scroll_bars(self, enabled: bool) -> VirtualList<K, T>
Compatibility name for scroll_bars. Built-in bars reserve layout space.
Sourcepub fn scroll_bars(self, enabled: bool) -> VirtualList<K, T>
pub fn scroll_bars(self, enabled: bool) -> VirtualList<K, T>
Show built-in scrollbars in their own gutters when content overflows.
pub fn row_name<F>(self, name: F) -> VirtualList<K, T>
pub fn row_description<F>(self, description: F) -> VirtualList<K, T>
pub fn on_change<F>(self, on_change: F) -> VirtualList<K, T>where
F: FnMut(K) + 'static,
pub fn on_change_with_ctx<F>(self, on_change: F) -> VirtualList<K, T>
pub fn on_near_start<F>(self, on_near_start: F) -> VirtualList<K, T>where
F: FnMut() + 'static,
pub fn on_near_start_with_ctx<F>(self, on_near_start: F) -> VirtualList<K, T>
pub fn on_near_end<F>(self, on_near_end: F) -> VirtualList<K, T>where
F: FnMut() + 'static,
pub fn on_near_end_with_ctx<F>(self, on_near_end: F) -> VirtualList<K, T>
pub fn current_offset(&self) -> Vector
pub fn realized_count(&self) -> usize
Trait Implementations§
Source§impl<K, T> Widget for VirtualList<K, T>
impl<K, T> Widget for VirtualList<K, T>
Source§fn diagnostics(&self, ctx: &mut WidgetDiagnosticsCtx)
fn diagnostics(&self, ctx: &mut WidgetDiagnosticsCtx)
Publish widget-specific state for an inspector snapshot. Read more
fn event(&mut self, ctx: &mut EventCtx, event: &Event)
fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size
fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)
fn paint(&self, ctx: &mut PaintCtx)
fn layer_options(&self) -> LayerOptions
fn semantics(&self, ctx: &mut SemanticsCtx)
fn accepts_focus(&self) -> bool
fn focus_changed(&mut self, ctx: &mut EventCtx, _focused: bool)
Source§fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)
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)
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<'_>)
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.
fn debug_name(&self) -> &'static str
Source§fn measure_size(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
) -> Size
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
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
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
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.
fn layer_properties(&self) -> LayerProperties
Source§fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
Layer properties for the frame shown at
frame_time. Override this
instead of Widget::layer_properties when they come from Motion
values; the runtime refreshes them without repainting when the motion
invalidates Transform or Effect.fn stack_host_options(&self) -> Option<StackHostOptions>
fn stack_surface_options(&self) -> Option<StackSurfaceOptions>
Source§fn overlay_options(&self) -> Option<OverlayOptions>
fn overlay_options(&self) -> Option<OverlayOptions>
Describe this widget as the logical owner of a presented overlay. Read more
Source§fn hit_test_self(&self) -> bool
fn hit_test_self(&self) -> bool
Whether points inside this widget that none of its children take hit
the widget itself. Containers laid over other content, like a layer of
floating views, return
false so those points reach what is behind
them.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> Forget for VirtualList<K, T>
impl<K, T> Move 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(&mut EventCtx, K)>>: 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>where
Arc<dyn VirtualCollectionSource<K, T>>: UnsafeUnpin,
VirtualListState<K>: UnsafeUnpin,
Box<dyn Fn(&K, Signal<T>) -> WidgetPod>: UnsafeUnpin,
Option<Box<dyn Fn(&K, &T) -> String>>: UnsafeUnpin,
Option<Box<dyn FnMut(K)>>: UnsafeUnpin,
Option<Box<dyn FnMut(&mut EventCtx, K)>>: UnsafeUnpin,
Vec<K>: UnsafeUnpin,
HashMap<K, usize>: UnsafeUnpin,
HashMap<K, WidgetId>: UnsafeUnpin,
HashMap<K, RealizedRow<T>>: UnsafeUnpin,
Option<K>: UnsafeUnpin,
RefCell<Option<K>>: UnsafeUnpin,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
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>
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)
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)
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.