Skip to main content

ScrollHandlingOptions

Struct ScrollHandlingOptions 

Source
pub struct ScrollHandlingOptions {
    pub line_height: f32,
    pub smooth: bool,
    pub smooth_duration: Duration,
    pub overscroll_behavior: OverscrollBehavior,
    pub overscroll_style: OverscrollStyle,
    pub axes: PanAxes,
    pub rubber_band: bool,
    pub pan_devices: PointerKindMask,
    pub reduced_motion: bool,
    pub physics: ScrollPhysicsTokens,
}
Expand description

Everything handle_scroll_event needs to know that is not state.

Snapshot, not signals: a scrollable builds one of these in build(), where the theme and the reduced-motion preference are in scope, and the handler closure captures it. Both change through a rebuild, which is the level a density switch and a preference change already mark.

Fields§

§line_height: f32

Pixels one ScrollDelta::Lines unit is worth.

§smooth: bool

Whether a wheel notch tweens to its target instead of jumping. Never consulted on the pan path — a finger is already the animation.

With this on, every ScrollableAxes offset that has a range must be Signal::new_animated — animate_to panics on a plain signal. The qualifier is load-bearing, not a caveat: an axis whose maximum is permanently zero is never written by either path, which is exactly why ScrollableAxes::vertical and ScrollableAxes::horizontal pin their unused axis with a plain Signal::new(0.0) and why ListView, TreeView and GridView each pair ScrollableAxes::vertical with a smooth_scrolling that defaults to true. The rule is stated once on ScrollableAxes itself; this is the same rule.

§smooth_duration: Duration

How long that tween lasts.

§overscroll_behavior: OverscrollBehavior

Whether a boundary scroll chains outward (OverscrollBehavior::Chain) or is absorbed (OverscrollBehavior::Contain).

§overscroll_style: OverscrollStyle

Which overscroll feel this surface asks for when rubber_band is on.

§axes: PanAxes

Which axes a finger may pan. An axis outside this set takes no movement from a pan (the wheel path is unaffected — a wheel has always reached every axis the range allows).

§rubber_band: bool

Whether this surface follows the finger past its own end.

Off by default, and that is the load-bearing default. A band that engages absorbs the movement, so a nested list that rubber-banded at its end would never hand the gesture to the container around it. The band belongs to the outermost surface of a scroll chain; everything inside it clamps and chains, which is also what every desktop toolkit does.

§pan_devices: PointerKindMask

Which pointer kinds may pan this surface. Defaults to PointerKindMask::DIRECT — a mouse scrolls with its wheel and must never be treated as a panning pointer.

§reduced_motion: bool

prefers-reduced-motion, snapshotted at build. Hard-clamps the band.

§physics: ScrollPhysicsTokens

The theme’s scroll-physics constants. Only the rubber-band friction factor is read here — the fling’s constants belong to the tree’s driver, which reads them from the same tokens.

Trait Implementations§

Source§

impl Clone for ScrollHandlingOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for ScrollHandlingOptions

Source§

impl Debug for ScrollHandlingOptions

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ScrollHandlingOptions

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<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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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