Skip to main content

ScrollView

Struct ScrollView 

Source
pub struct ScrollView { /* private fields */ }

Implementations§

Source§

impl ScrollView

Source

pub fn new<W>(child: W) -> ScrollView
where W: Widget + 'static,

Source

pub fn vertical<W>(child: W) -> ScrollView
where W: Widget + 'static,

Examples found in repository?
examples/rich_document.rs (line 30)
3fn main() -> Result<()> {
4    let theme = DefaultTheme::dark();
5    let document = RichDocumentModel::from_markdown(
6        r#"# Deployment report
7
8SUI keeps this document selectable across blocks. Follow the [runbook](https://example.test/runbook) for details.
9
10- [x] Build artifacts
11- [x] Run tests
12- [ ] Publish release
13
14```rust
15let status = deploy().await?;
16assert!(status.ready());
17```
18"#,
19    );
20
21    let mut operation = RichExtensionBlock::new("operation-log", "Release operation");
22    operation.status = RichDocumentStatus::Running;
23    operation.summary = Some("2 of 3 stages complete".into());
24    operation.body = "build   complete\ntest    complete\npublish running".into();
25    document.append_extension(operation);
26
27    let view = RichDocumentView::new(document)
28        .theme(theme)
29        .on_link(|destination| println!("Application URL policy received: {destination}"));
30    let root = Surface::window(ScrollView::vertical(view).retain_content_layer())
31        .theme(theme)
32        .padding(Insets::all(24.0))
33        .fill();
34
35    App::new()
36        .window(Window::new("SUI Rich Document").root(root))
37        .run()
38}
Source

pub fn horizontal<W>(child: W) -> ScrollView
where W: Widget + 'static,

Source

pub fn both<W>(child: W) -> ScrollView
where W: Widget + 'static,

Source

pub fn axes(self, axes: ScrollAxes) -> ScrollView

Source

pub fn overflow(self, overflow: Overflow) -> ScrollView

Source

pub fn overflow_x(self, overflow: Overflow) -> ScrollView

Source

pub fn overflow_y(self, overflow: Overflow) -> ScrollView

Source

pub const fn content_width(self, extent: ContentExtent) -> ScrollView

Select how the child width is derived when horizontal overflow is enabled.

Source

pub const fn content_height(self, extent: ContentExtent) -> ScrollView

Select how the child height is derived when vertical overflow is enabled.

Source

pub const fn shrink_height(self, enabled: bool) -> ScrollView

Fit short content while retaining vertical scrolling when it exceeds the available height. Parent minimum constraints still take precedence.

Source

pub fn name(self, name: impl Into<String>) -> ScrollView

Source

pub fn theme(self, theme: DefaultTheme) -> ScrollView

Source

pub fn theme_when<F>(self, theme: F) -> ScrollView
where F: Fn() -> DefaultTheme + 'static,

Source

pub fn state(self, state: ScrollState) -> ScrollView

Source

pub fn overlay_scroll_bars(self, enabled: bool) -> ScrollView

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.

Source

pub fn auto_scroll_on_drag(self, enabled: bool) -> ScrollView

Whether a drag held near an edge scrolls the view. On by default.

Source

pub fn on_offset_change<F>(self, callback: F) -> ScrollView
where F: Fn(Vector) + 'static,

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.

Source

pub fn on_offset_change_with_ctx<F>(self, callback: F) -> ScrollView
where F: Fn(&mut EventCtx, Vector) + 'static,

Source

pub fn scroll_bars(self, enabled: bool) -> ScrollView

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

Source

pub const fn viewport_size_hint(self, enabled: bool) -> ScrollView

Source

pub const fn viewport_width_hint(self, enabled: bool) -> ScrollView

Source

pub const fn viewport_height_hint(self, enabled: bool) -> ScrollView

Source

pub fn retain_content_layer(self) -> ScrollView

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.

Examples found in repository?
examples/rich_document.rs (line 30)
3fn main() -> Result<()> {
4    let theme = DefaultTheme::dark();
5    let document = RichDocumentModel::from_markdown(
6        r#"# Deployment report
7
8SUI keeps this document selectable across blocks. Follow the [runbook](https://example.test/runbook) for details.
9
10- [x] Build artifacts
11- [x] Run tests
12- [ ] Publish release
13
14```rust
15let status = deploy().await?;
16assert!(status.ready());
17```
18"#,
19    );
20
21    let mut operation = RichExtensionBlock::new("operation-log", "Release operation");
22    operation.status = RichDocumentStatus::Running;
23    operation.summary = Some("2 of 3 stages complete".into());
24    operation.body = "build   complete\ntest    complete\npublish running".into();
25    document.append_extension(operation);
26
27    let view = RichDocumentView::new(document)
28        .theme(theme)
29        .on_link(|destination| println!("Application URL policy received: {destination}"));
30    let root = Surface::window(ScrollView::vertical(view).retain_content_layer())
31        .theme(theme)
32        .padding(Insets::all(24.0))
33        .fill();
34
35    App::new()
36        .window(Window::new("SUI Rich Document").root(root))
37        .run()
38}
Source

pub const fn current_offset(&self) -> Vector

Source

pub fn set_offset(&mut self, offset: Vector)

Source

pub fn child_pod(&self) -> &WidgetPod

Source

pub fn child_mut(&mut self) -> &mut WidgetPod

Source

pub fn replace_child<W>(&mut self, child: W)
where W: Widget + 'static,

Trait Implementations§

Source§

impl Widget for ScrollView

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 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 diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)

Publish widget-specific state for an inspector snapshot. Read more
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 layer_properties(&self) -> LayerProperties

Source§

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.
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
Source§

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§

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