Struct titanium::desktop::gui::libdruid::widget::Scroll

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

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> Scroll<T, W>where W: Widget<T>,

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 scroll_by<C>(&mut self, ctx: &mut C, delta: Vec2) -> boolwhere C: ChangeCtx,

Scroll by delta units.

Returns true if the scroll offset has changed.

pub fn scroll_to<C>(&mut self, ctx: &mut C, region: Rect) -> boolwhere C: ChangeCtx,

Scroll the minimal distance to show the target region.

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

pub fn scroll_to_on_axis<C>( &mut self, ctx: &mut C, axis: Axis, position: f64 ) -> boolwhere C: ChangeCtx,

Scroll to this position on a particular axis.

Returns true if the scroll offset has changed.

impl<T, W> Scroll<T, W>

pub fn vertical(self) -> Scroll<T, W>

Restrict scrolling to the vertical axis while locking child width.

pub fn horizontal(self) -> Scroll<T, W>

Restrict scrolling to the horizontal axis while locking child height.

pub fn content_must_fill(self, must_fill: bool) -> Scroll<T, W>

Builder-style method to set whether the child must fill the view.

If false (the default) there is no minimum constraint on the child’s size. If true, the child must have at least the same size as the parent Scroll widget.

pub fn disable_scrollbars(self) -> Scroll<T, W>

Disable both scrollbars

pub fn set_content_must_fill(&mut self, must_fill: bool)

Set whether the child’s size must be greater than or equal the size of the Scroll widget.

See content_must_fill for more details.

pub fn set_enabled_scrollbars(&mut self, enabled: ScrollbarsEnabled)

Set which scrollbars should be enabled.

If scrollbars are disabled, scrolling will still occur as a result of scroll events from a trackpad or scroll wheel.

pub fn set_vertical_scroll_enabled(&mut self, enabled: bool)

Set whether the content can be scrolled in the vertical direction.

pub fn set_horizontal_scroll_enabled(&mut self, enabled: bool)

Set whether the content can be scrolled in the horizontal direction.

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 viewport_rect(&self) -> Rect

Returns a Rect representing the currently visible region.

This is relative to the bounds of the content.

pub fn offset_for_axis(&self, axis: Axis) -> f64

Return the scroll offset on a particular axis

Trait Implementations

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

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)

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

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.

fn compute_max_intrinsic( &mut self, axis: Axis, ctx: &mut LayoutCtx<'_, '_>, bc: &BoxConstraints, data: &T, env: &Env ) -> f64

Computes max intrinsic/preferred dimension of a widget on the provided axis.