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 by default. Restrict to a specific axis with vertical or horizontal. When restricted to scrolling on a specific axis the child's size is locked on the opposite axis.

Implementations

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 scrolling to a specific axis.

pub fn vertical(self) -> Self

Restrict scrolling to the vertical axis while locking child width.

pub fn horizontal(self) -> Self

Restrict scrolling to the horizontal axis while locking child height.

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 child_size(&self) -> Size

Returns the size of the child widget.

pub fn offset(&self) -> Vec2

Returns the current scroll offset.

pub fn scroll_by(&mut self, delta: Vec2) -> bool

Scroll delta units.

Returns true if the scroll offset has changed.

pub fn scroll_to(&mut self, region: Rect) -> bool

Scroll the minimal distance to show the target rect.

If the target region is larger than the viewport, we will display the portion that fits, prioritizing the portion closest to the origin.

Trait Implementations

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

pub fn event(
    &mut self,
    ctx: &mut EventCtx<'_, '_>,
    event: &Event,
    data: &mut T,
    env: &Env
)

Handle an event.

pub fn lifecycle(
    &mut self,
    ctx: &mut LifeCycleCtx<'_, '_>,
    event: &LifeCycle,
    data: &T,
    env: &Env
)

Handle a life cycle notification.

pub fn update(
    &mut self,
    ctx: &mut UpdateCtx<'_, '_>,
    old_data: &T,
    data: &T,
    env: &Env
)

Update the widget's appearance in response to a change in the app's Data or Env.

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

Compute layout.

pub fn paint(&mut self, ctx: &mut PaintCtx<'_, '_, '_>, data: &T, env: &Env)

Paint the widget appearance.