Skip to main content

ScrollState

Struct ScrollState 

Source
pub struct ScrollState { /* private fields */ }
Expand description

Inertial scroll state (single axis Y).

Implementations§

Source§

impl ScrollState

Source

pub fn new() -> Self

Source

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

Enable or disable the overscroll rubber-band effect (enabled by default).

Source

pub fn overscroll_offset(&self) -> f32

Returns the current overscroll offset (negative = pulled down past top, positive = pulled up past bottom).

Source

pub fn set_nested_scroll_parent(&self, conn: NestedScrollConnection)

Set a parent nested scroll connection for coordinated scrolling. This enables parent-child scroll coordination (e.g., collapsing toolbars, pull-to-refresh). Call this before the scroll area is first composed.

Source

pub fn set_show_scrollbar(&self, show: bool)

Enable or disable the scrollbar (enabled by default).

Source

pub fn set_viewport_height(&self, h: f32)

Source

pub fn set_content_height(&self, h: f32)

Source

pub fn set_overscroll(&self, val: f32)

Set the overscroll value directly. Used by pull-to-refresh to reset overscroll when the refresh completes.

Source

pub fn set_offset(&self, off: f32)

Source

pub fn get(&self) -> f32

Source

pub fn scroll_immediate(&self, dy: f32) -> f32

Consume dy (pixels), clamp to bounds, return leftover. When overscroll is enabled and the scroll boundary is reached, applies rubber-band resistance instead of returning leftover.

Source

pub fn tick(&self) -> bool

Advance physics one tick; returns true if animating.

Trait Implementations§

Source§

impl Default for ScrollState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.