Skip to main content

ScrollBehavior

Struct ScrollBehavior 

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

How the scrollables under it behave, from the platform it follows.

Two starting points, as in the reference: ScrollBehavior::new, the base, which follows default_target_platform, and ScrollBehavior::material, the one an application installs, which follows Theme::platform. Each can be changed with the with_ methods, the reference’s copyWith: a behaviour with its scrollbars or its overscroll indicator turned off, with physics of its own, or following another platform.

The answers, platform by platform, are the reference’s:

physicsscrollbarsoverscrollfling
Androidclampingnonestretch (base: glow)regression
Fuchsiaclampingnoneglowregression
iOSbouncingnonenonerecent average
macOSbouncing, fastshownnonerecent average, desktop
Linux, Windowsclampingshownnoneregression

Implementations§

Source§

impl ScrollBehavior

Source

pub const fn new() -> Self

The base behaviour: it follows the platform the application runs on (default_target_platform), and shows a glow past the edge on Android and Fuchsia. What ScrollConfiguration::of answers where nothing was installed.

Source

pub const fn material() -> Self

The application’s behaviour: it follows the theme’s platform (Theme::platform), and stretches the content past the edge on Android. What an application installs unless it says otherwise (Application::scroll_behavior).

Source

pub const fn with_scrollbars(self, scrollbars: bool) -> Self

The same behaviour, with its scrollbars on or off. Off, none is drawn on any platform; on, the platform decides.

Source

pub const fn with_overscroll(self, overscroll: bool) -> Self

The same behaviour, with its overscroll indicator on or off. Off, nothing is shown past an edge on any platform; on, the platform decides.

Source

pub const fn with_physics(self, physics: ScrollPhysics) -> Self

The same behaviour, with these physics on every platform.

Source

pub const fn with_platform(self, platform: TargetPlatform) -> Self

The same behaviour, following platform instead of the one it would have followed.

Source

pub fn platform(&self, theme: &Theme) -> TargetPlatform

The platform this behaviour follows under theme: the one it was given, else the theme’s for the application’s behaviour, else the one the application runs on.

Source

pub fn scroll_physics(&self, theme: &Theme) -> ScrollPhysics

The physics a scrollable under this behaviour starts from: bouncing on iOS, bouncing with a faster stop on macOS, clamping elsewhere — unless the behaviour was given its own. A scrollable’s own physics take precedence over these.

Source

pub fn scrollbars(&self, theme: &Theme) -> Scrollbars

Whether a vertical scrollable under this behaviour draws a scrollbar: on Linux, macOS and Windows, where a pointer needs one to find its way; not on a touch screen, where a finger already knows where it is on the page.

Source

pub fn overscroll_indicator(&self, theme: &Theme) -> Option<OverscrollIndicator>

What a scrollable under this behaviour shows when it is pulled past an edge it will not move beyond, or None for nothing: the stretch on Android under the application’s behaviour, a glow on Android under the base one and on Fuchsia under both, nothing on iOS, Linux, macOS and Windows.

Source

pub fn velocity_tracker(&self, theme: &Theme) -> VelocityTracker

How a fling under this behaviour is read from the finger’s last moves: a weighted average of the most recent on iOS and macOS (each with its own weights), a fitted curve elsewhere.

Trait Implementations§

Source§

impl Clone for ScrollBehavior

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 ScrollBehavior

Source§

impl Debug for ScrollBehavior

Source§

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

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

impl Default for ScrollBehavior

Source§

fn default() -> Self

The base behaviour, ScrollBehavior::new.

Source§

impl Eq for ScrollBehavior

Source§

impl Hash for ScrollBehavior

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ScrollBehavior

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ScrollBehavior

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> 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> 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<Msg> IntoMsg<Msg> for Msg

Source§

fn defer(work: impl Fn() -> Msg + 'static) -> Msg

The message that stands for work’s result.
Source§

impl<T> MaybeSend for T
where T: Send,

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.