pub struct ScrollView { /* private fields */ }Implementations§
Source§impl ScrollView
impl ScrollView
pub fn new<W>(child: W) -> Selfwhere
W: Widget + 'static,
pub fn vertical<W>(child: W) -> Selfwhere
W: Widget + 'static,
pub fn horizontal<W>(child: W) -> Selfwhere
W: Widget + 'static,
pub fn both<W>(child: W) -> Selfwhere
W: Widget + 'static,
pub fn axes(self, axes: ScrollAxes) -> Self
pub fn overflow(self, overflow: Overflow) -> Self
pub fn overflow_x(self, overflow: Overflow) -> Self
pub fn overflow_y(self, overflow: Overflow) -> Self
Sourcepub const fn content_width(self, extent: ContentExtent) -> Self
pub const fn content_width(self, extent: ContentExtent) -> Self
Select how the child width is derived when horizontal overflow is enabled.
Sourcepub const fn content_height(self, extent: ContentExtent) -> Self
pub const fn content_height(self, extent: ContentExtent) -> Self
Select how the child height is derived when vertical overflow is enabled.
Sourcepub const fn shrink_height(self, enabled: bool) -> Self
pub const fn shrink_height(self, enabled: bool) -> Self
Fit short content while retaining vertical scrolling when it exceeds the available height. Parent minimum constraints still take precedence.
pub fn name(self, name: impl Into<String>) -> Self
pub fn theme(self, theme: DefaultTheme) -> Self
pub fn theme_when<F>(self, theme: F) -> Selfwhere
F: Fn() -> DefaultTheme + 'static,
pub fn state(self, state: ScrollState) -> Self
Sourcepub fn overlay_scroll_bars(self, enabled: bool) -> Self
pub fn overlay_scroll_bars(self, enabled: bool) -> Self
Controls the built-in scroll bars beside overflowing content.
Disable this when composing a standalone ScrollBar with the same
ScrollState.
Compatibility name for scroll_bars. Built-in bars reserve layout space.
Sourcepub fn auto_scroll_on_drag(self, enabled: bool) -> Self
pub fn auto_scroll_on_drag(self, enabled: bool) -> Self
Whether a drag held near an edge scrolls the view. On by default.
Sourcepub fn on_offset_change<F>(self, callback: F) -> Self
pub fn on_offset_change<F>(self, callback: F) -> Self
Called with the new offset whenever the view scrolls, whatever moved it: the wheel, a touch drag or fling, keys, a scroll bar, or code. Changes made during layout, such as a scroll bar drag or a jump to an item, arrive on the next animation frame.
pub fn on_offset_change_with_ctx<F>(self, callback: F) -> Self
Sourcepub fn scroll_bars(self, enabled: bool) -> Self
pub fn scroll_bars(self, enabled: bool) -> Self
Show built-in scrollbars in their own gutters when content overflows.
pub const fn viewport_size_hint(self, enabled: bool) -> Self
pub const fn viewport_width_hint(self, enabled: bool) -> Self
pub const fn viewport_height_hint(self, enabled: bool) -> Self
Sourcepub fn retain_content_layer(self) -> Self
pub fn retain_content_layer(self) -> Self
Retains the complete child subtree behind a paint boundary so scrolling can move it with a composition-only transform.
This is best for content that is expensive to repaint but cheap to composite. Very large text or deeply layered scenes may render faster with the default flattened path.
pub const fn current_offset(&self) -> Vector
pub fn set_offset(&mut self, offset: Vector)
pub fn child_pod(&self) -> &WidgetPod
pub fn child_mut(&mut self) -> &mut WidgetPod
pub fn replace_child<W>(&mut self, child: W)where
W: Widget + 'static,
Trait Implementations§
Source§impl Widget for ScrollView
impl Widget for ScrollView
Source§fn supports_output_reuse(&self) -> bool
fn supports_output_reuse(&self) -> bool
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)
Source§fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
Source§fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)
fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)
fn debug_name(&self) -> &'static str
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
Source§fn measure_size(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
) -> Size
fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size
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
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
fn layer_properties(&self) -> LayerProperties
Source§fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
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>
Source§fn hit_test_self(&self) -> bool
fn hit_test_self(&self) -> bool
false so those points reach what is behind
them.