Struct druid::widget::Scroll

pub struct Scroll<T, W> { /* fields omitted */ }

A container that scrolls its contents.

This container holds a single child, and uses the wheel to scroll it when the child's bounds are larger than the viewport.

The child is laid out with completely unconstrained layout bounds.

Methods

impl<T, W: Widget<T>> Scroll<T, W>

pub fn new(child: W) -> Scroll<T, W>

Create a new scroll container.

This method will allow scrolling in all directions if child's bounds are larger than the viewport. Use vertical and horizontal methods to limit scroll behavior.

pub fn vertical(self) -> Self

Limit scroll behavior to allow only vertical scrolling (Y-axis). The child is laid out with constrained width and infinite height.

pub fn horizontal(self) -> Self

Limit scroll behavior to allow only horizontal scrolling (X-axis). The child is laid out with constrained height and infinite width.

pub fn child(&self) -> &W

Returns a reference to the child widget.

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

Returns a mutable reference to the child widget.

pub fn scroll(&mut self, delta: Vec2, size: Size) -> bool

Update the scroll.

Returns true if the scroll has been updated.

pub fn reset_scrollbar_fade(&mut self, ctx: &mut EventCtx, env: &Env)

Makes the scrollbars visible, and resets the fade timer.

pub fn offset(&self) -> Vec2

Returns the current scroll offset.

Trait Implementations

impl<T: Data, W: Widget<T>> Widget<T> for Scroll<T, W>

fn event(&mut self, ctx: &mut EventCtx, event: &Event, data: &mut T, env: &Env)

Handle an event.

fn lifecycle(
    &mut self,
    ctx: &mut LifeCycleCtx,
    event: &LifeCycle,
    data: &T,
    env: &Env
)

Handle a life cycle notification.

fn update(&mut self, ctx: &mut UpdateCtx, _old_data: &T, data: &T, env: &Env)

Handle a change of data.

fn layout(
    &mut self,
    ctx: &mut LayoutCtx,
    bc: &BoxConstraints,
    data: &T,
    env: &Env
) -> Size

Compute layout.

fn paint(&mut self, ctx: &mut PaintCtx, data: &T, env: &Env)

Paint the widget appearance.